教程

Claude Code OpenTelemetry 监控指南:六步快速配置、8 类指标与 5 类事件 Schema 完整参考

Claude Code OpenTelemetry 监控完整指南:六步快速启动(TELEMETRY/EXPORTER/端点/认证/调试间隔)、管理员 MDM 托管集中配置、完整环境变量(核心/独立信号/隐私控制/基数控制/mTLS)、8 类指标(session/lines_of_code/PR/commit/cost/token/code_edit_decision/active_time)、5 类事件(user.prompt/tool.result/api.request/api.error/tool.decision)、动态 Headers 脚本(29 分钟刷新)和 Grafana 成本告警示例。

2026/3/74分钟 阅读ClaudeEagle

Claude Code 内置 OpenTelemetry(OTel)支持,可将用量数据、成本、工具活动等遥测数据导出到 Prometheus、Grafana、Datadog 等任意兼容 OTel 的监控后端。

六步快速启动

bash
# 第一步:启用遥测
export CLAUDE_CODE_ENABLE_TELEMETRY=1

# 第二步:选择导出器(按需配置)
export OTEL_METRICS_EXPORTER=otlp       # otlp / prometheus / console
export OTEL_LOGS_EXPORTER=otlp          # otlp / console

# 第三步:配置 OTLP 端点
export OTEL_EXPORTER_OTLP_PROTOCOL=grpc
export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317

# 第四步:认证(如需要)
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer your-token"

# 第五步(调试用):缩短导出间隔
export OTEL_METRIC_EXPORT_INTERVAL=10000   # 默认 60000ms
export OTEL_LOGS_EXPORT_INTERVAL=5000      # 默认 5000ms

# 第六步:启动 Claude Code
claude

调试完成后记得将导出间隔恢复为生产值(指标 60s、日志 5s)。

管理员集中配置(托管设置)

json
{
  "env": {
    "CLAUDE_CODE_ENABLE_TELEMETRY": "1",
    "OTEL_METRICS_EXPORTER": "otlp",
    "OTEL_LOGS_EXPORTER": "otlp",
    "OTEL_EXPORTER_OTLP_PROTOCOL": "grpc",
    "OTEL_EXPORTER_OTLP_ENDPOINT": "http://collector.example.com:4317",
    "OTEL_EXPORTER_OTLP_HEADERS": "Authorization=Bearer example-token"
  }
}

可通过 MDM 下发到所有设备,用户无法覆盖。

全部配置环境变量

核心配置

变量说明示例值
CLAUDE_CODE_ENABLE_TELEMETRY启用遥测(必须)1
OTEL_METRICS_EXPORTER指标导出器(逗号分隔)consoleotlpprometheus
OTEL_LOGS_EXPORTER日志/事件导出器consoleotlp
OTEL_EXPORTER_OTLP_PROTOCOLOTLP 协议grpchttp/jsonhttp/protobuf
OTEL_EXPORTER_OTLP_ENDPOINTOTLP Collector 端点http://localhost:4317
OTEL_EXPORTER_OTLP_HEADERSOTLP 认证头Authorization=Bearer token
OTEL_METRIC_EXPORT_INTERVAL指标导出间隔(默认 60000ms)500060000
OTEL_LOGS_EXPORT_INTERVAL日志导出间隔(默认 5000ms)100010000

隐私与基数控制

bash
# 隐私相关(默认禁用,启用前评估影响)
export OTEL_LOG_USER_PROMPTS=1      # 记录用户提示词内容
export OTEL_LOG_TOOL_DETAILS=1      # 记录 MCP 工具名和 Skill 名

# 基数控制(影响存储成本)
export OTEL_METRICS_INCLUDE_SESSION_ID=false    # 默认 true
export OTEL_METRICS_INCLUDE_ACCOUNT_UUID=false  # 默认 true
export OTEL_METRICS_INCLUDE_VERSION=true        # 默认 false

独立信号端点(覆盖通用配置)

bash
export OTEL_EXPORTER_OTLP_METRICS_PROTOCOL=http/protobuf
export OTEL_EXPORTER_OTLP_METRICS_ENDPOINT=http://localhost:4318/v1/metrics
export OTEL_EXPORTER_OTLP_LOGS_ENDPOINT=http://localhost:4317

# mTLS 认证
export OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY=/path/to/client.key
export OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE=/path/to/client.crt

8 类可用指标

指标名类型说明
claude_code.session.countCounter已启动的会话数
claude_code.lines_of_code.countCounter已接受的代码行数
claude_code.pull_request.countCounter已创建的 PR 数
claude_code.commit.countCounter已创建的 Commit 数
claude_code.cost.usageCounterAPI 费用(美元)
claude_code.token.usageCounterToken 用量(输入/输出/缓存分类)
claude_code.code_edit_tool.decision.countCounter代码编辑决策数(接受/拒绝)
claude_code.active_timeCounter用户活跃时间(秒)

Token 分类属性inputoutputcache_readcache_creation

代码编辑决策属性accept(接受)、reject(拒绝)

标准属性(所有指标共有):

session.id, user.account_uuid, app.version, os.type, runtime.name

5 类事件

事件名触发时机关键字段
user.prompt用户发送消息时message_lengthis_first_in_session
tool.result工具执行完成后tool_nameexit_codeduration_ms
api.request发起 API 请求时modelrequest_idinput_tokens
api.errorAPI 请求失败时error_typehttp_status_code
tool.decision工具权限决策时tool_namedecision(allow/deny/ask)

事件关联属性(跨事件追踪):

session.id 关联同一会话 conversation.id 关联同一对话轮次 request.id 关联一次 API 请求及后续工具调用

动态 Headers(企业认证)

json
// settings.json
{ "otelHeadersHelper": "/bin/generate_opentelemetry_headers.sh" }
bash
#!/bin/bash
echo "{\"Authorization\": \"Bearer $(get-jwt-token.sh)\", \"X-Org-ID\": \"my-org\"}"

默认每 29 分钟刷新(CLAUDE_CODE_OTEL_HEADERS_HELPER_DEBOUNCE_MS=1740000)。

实用监控示例

Grafana 成本告警

yaml
# 日成本超过 $50 触发告警
- alert: HighClaudeCodeCost
  expr: increase(claude_code_cost_usage_total[24h]) > 50
  labels:
    severity: warning

Amazon Bedrock 额外监控

通过 Bedrock 访问时,在 AWS CloudWatch 的 AWS/Bedrock 命名空间下还可查看调用次数和 Token 用量。


原文:Monitoring - Claude Code Docs | 来源:Anthropic 官方文档

相关文章推荐

教程Claude Code 模型配置完全指南:opusplan 混合模式、effort 级别、1M 上下文与第三方 Model 固定Claude Code 模型配置完全指南:6 个模型别名(default/sonnet/opus/haiku/sonnet[1m]/opusplan 混合模式)、四种设置优先级(/model 会话 > --model 启动 > ANTHROPIC_MODEL 环境变量 > settings.json)、default 按账号类型说明(Max/Team Premium 默认 Opus/Pro/Standard 默认 Sonnet)、opusplan 规划执行混合模式原理、三级 Effort 级别(low/medium/high 及自适应推理关闭方式)、1M Token 上下文(Beta 可用性/200K 计费门槛/DISABLE_1M_CONTEXT 禁用)、企业 availableModels 白名单、四个模型别名环境变量,以及第三方部署(Bedrock/Vertex/Foundry)固定版本的重要操作和升级流程。2026/3/9教程Claude Code 插件市场创建与分发:marketplace.json 完整 Schema、私有仓库与企业限制Claude Code 插件市场创建与分发完整指南:四步创建流程(插件/marketplace.json/Git 托管/分享用户)、快速上手本地市场示例(/review 代码审查技能)、marketplace.json 完整 Schema(必填/Owner/可选元数据/插件条目)、五种插件来源类型(相对路径/GitHub/Git/子目录/npm)、托管分发(GitHub 推荐/私有仓库认证)、版本与发布频道配置(stable/beta/nightly)、企业 Managed 限制(strictKnownMarketplaces 白名单/blockedMarketplaces 黑名单/pluginTrustMessage),以及七大常见故障排查。2026/3/7教程Claude Code Server-managed Settings(Beta):无 MDM 企业集中配置、安全审批与缓存机制Claude Code Server-managed Settings(Beta)完整指南:适用场景(无 MDM/非受管设备)、前提条件(Teams≥2.1.38/Enterprise≥2.1.30/api.anthropic.com 网络)、与 Endpoint-managed 对比选择、设置下发机制(启动抓取+每小时轮询/首次启动短暂窗口期/缓存网络故障保持)、三类安全审批对话框(Shell 命令/自定义环境变量/Hook 配置)、Owner 角色访问控制、Beta 限制(不支持分组/不支持 MCP 配置)、各提供商平台可用性(Bedrock/Vertex/Foundry 不可用),以及五种边界场景行为表和 ConfigChange Hook 加强方案。2026/3/7教程Claude Code settings.json 完整配置参考:40+ 配置项、作用域继承与插件管理Claude Code settings.json 完整配置参考:四级作用域(Managed 最高不可覆盖/User/Project/Local)及其优先级继承规则、不同功能的配置文件位置(Settings/Subagents/MCP/Plugins/CLAUDE.md)、40+ 配置项速查(基础/认证/界面/工作流/权限/安全企业/MCP/插件),包括 companyAnnouncements 公告、apiKeyHelper 动态 Key、fastModePerSessionOptIn 会话级快速模式、strictKnownMarketplaces 市场限制,以及 /config 命令和验证方法。2026/3/7教程Claude Code 模型配置完全指南:别名、opusplan 模式、努力级别与企业模型限制Claude Code 模型配置完全指南:六种模型别名(default/sonnet/opus/haiku/sonnet[1m]/opusplan)、四种设置方式优先级、opusplan 混合模式原理、努力级别(low/medium/high)、1M Token 超长上下文,以及企业 availableModels 模型锁定和第三方平台(Bedrock/Vertex)部署配置。2026/3/3教程Claude Code MCP 完整使用指南:安装配置主流 MCP 服务器扩展 AI 能力Claude Code MCP(Model Context Protocol)完整使用指南:MCP 是什么(AI 工具扩展标准)、claude mcp 命令管理服务器(add/remove/list)、主流 MCP 服务器安装配置(文件系统/GitHub/PostgreSQL/Brave Search/Slack)、本地 stdio 与远程 SSE 两种连接方式、MCP 服务器安全配置、在 CLAUDE.md 中声明 MCP 工具使用规范,以及自定义 MCP 服务器的快速开发入门。2026/3/18