ONLYOffice DocumentServer 8.2 版本中StatsD监控指标配置指南

背景介绍

在Kubernetes环境中部署OnlyOffice DocumentServer 8.2版本时，许多用户遇到了StatsD监控指标无法正常工作的问题。本文将详细介绍如何正确配置StatsD监控指标，以及排查相关问题的步骤。

问题现象

用户在使用OnlyOffice Kubernetes Helm Chart部署8.2版本时，发现以下问题：

1. 监控指标无法推送到StatsD服务
2. 日志中没有出现预期的"Flushing stats at"等日志消息
3. 在Prometheus中无法获取到预期的编辑和查看统计指标

解决方案

基础配置

在Kubernetes环境中，确保以下配置已正确设置：

1. 在Helm values.yaml文件中启用metrics：

metrics:
  enabled: true
log:
  level: ALL

2. 部署statsd-exporter组件，这是Prometheus获取StatsD指标的桥梁

高级配置

对于需要自定义StatsD配置的情况，可以创建local-production-linux.json配置文件：

{
    "statsd": {
        "useMetrics": true,
        "host": "statsd-exporter-prometheus-statsd-exporter",
        "port": "8125",
        "prefix": "ds."
    }
}

将此配置文件作为Secret挂载到DocumentServer容器中。

验证步骤

1. 确认环境变量配置正确：

cat /proc/<docservice_pid>/environ | grep statsd

2. 检查服务发现：

kubectl get svc | grep statsd-exporter
kubectl get pods | grep statsd-exporter

3. 直接查询StatsD导出器指标：

curl statsd-exporter-prometheus-statsd-exporter:9102/metrics | grep -i ds_

4. 验证Prometheus是否成功采集：

curl http://prometheus-server/api/v1/targets?scrapePool=statsd
curl http://prometheus-server/api/v1/query?query=ds_conv_allconvert_count

关键指标说明

以下是一些重要的监控指标及其含义：

1. ds_expireDoc_connections_edit：当前活跃的编辑会话数量，直接影响许可证使用情况
2. ds_expireDoc_connections_view：当前活跃的查看会话数量
3. ds_coauth_session_edit：编辑会话的持续时间统计
4. ds_coauth_session_view：查看会话的持续时间统计
5. ds_conv_allconvert：文档转换操作的性能指标

常见问题排查

1. 指标不显示：

   • 确认statsd-exporter服务正常运行
   • 检查DocumentServer日志中是否有错误信息
   • 验证网络连接是否通畅

2. 部分指标缺失：

   • 8.2版本中确实存在某些指标缺失的问题
   • 建议升级到8.3.1版本，该版本已修复相关指标问题

3. 许可证监控：

   • 使用ds_expireDoc_connections_edit指标监控许可证使用情况
   • 可以基于此指标设置告警，防止超出许可证限制

最佳实践

1. 对于生产环境，建议使用8.3.1或更高版本
2. 设置基于ds_expireDoc_connections_edit的告警机制
3. 定期检查Prometheus采集状态
4. 考虑使用Grafana可视化监控指标

通过以上配置和验证步骤，可以确保OnlyOffice DocumentServer的监控指标在Kubernetes环境中正常工作，为系统运维和性能优化提供数据支持。