客户端配置

最近更新时间:2026-03-23 16:10:42

我的收藏
全链路监控仅支持 Spring Boot + Lettuce 框架。Lettuce 负责命令延迟采集与聚合,Spring Boot 通过 OTLP 模块完成数据上报。本文详细介绍客户端的配置要求,帮助您正确配置上报参数并验证数据采集是否生效。

环境要求

环境
功能说明
版本要求
参考文档
Lettuce
Lettuce 对每个命令进行延迟统计,并按统计窗口聚合同类命令。
建议6.4.2.RELEASE 及以上版本
Spring Boot
Spring Boot 通过 OTLP 模块上报监控数据。
建议3.4.3及以上版本

Spring Boot 配置参数

在项目的 application.properties 配置文件中,参照下表配置上报参数。
# === 必填配置 ===
# 上报认证 Token
management.otlp.metrics.export.resourceAttributes.token=your-token
# 上报地址
management.otlp.metrics.export.url=http://10.0.0.1:8080
# 上报模式(固定值)
management.otlp.metrics.export.aggregationTemporality=delta
# P99 时延统计
management.metrics.distribution.percentiles.lettuce.command.completion=0.99
management.metrics.distribution.percentiles.lettuce.command.firstresponse=0.99
# 将 metrics端点开放为可通过 HTTP 访问的接口
management.endpoints.web.exposure.include=metrics
# === 业务标识 ===
# 业务名称
management.otlp.metrics.export.resourceAttributes.service.name=my-service
# 机器地址
management.otlp.metrics.export.resourceAttributes.report-addr=192.168.1.100:8080

# === 可选配置 ===
# 上报间隔(默认1分钟)
management.otlp.metrics.export.step=60s

参数分类
参数
说明
必选参数
management.otlp.metrics.export.resourceAttributes.token
上报认证凭证,开启全链路功能 所获取的 Token。
management.otlp.metrics.export.url
专有通道上报地址。
开启全链路功能 所获取的上报地址。
格式:http://VIP:VPORT。
management.otlp.metrics.export.aggregationTemporality=delta
数据上报模式,固定填写 delta,表示上传增量数据而非累计量。
management.metrics.distribution.percentiles.lettuce.command.completion
启用命令完成时延的百分位统计。
management.metrics.distribution.percentiles.lettuce.command.firstresponse
启用首字节响应时延的百分位统计。
management.endpoints.web.exposure.include=metrics
开放 Spring Boot Actuator 的 metrics 端点,使其可通过 HTTP 访问指标数据。
业务标识
management.otlp.metrics.export.resourceAttributes.service.name=XXXXX
业务名称,自定义即可。
management.otlp.metrics.export.resourceAttributes.report-addr=IP:PORT
当前客户端 IP 地址和 PORT。
可选
management.otlp.metrics.export.step=XXs
设置上报数据的频率。
单位:秒。
默认值:60s,即每1分钟上报一次监控数据。

验证 Lettuce 采集

配置完成后,访问以下端点可查看 Lettuce 客户端的分布式缓存数据库连接指标:
查看所有指标:/actuator/metrics
查看 Lettuce 命令指标:/actuator/metrics/lettuce.command.completion
查看连接池指标:/actuator/metrics/lettuce.pool.active(如启用连接池)


验证 OTLP 上报

观察 Spring Boot 日志,确认 OTLP 上报无报错。若出现上报错误,请检查:
Token 配置是否正确。
VIP、VPORT 配置是否准确。
与 VIP 之间网络是否连通。

上报正常后,可在 CLS 控制台查看全链路监控数据。具体信息,请参见 可视化展示