监控

Documentation Index

Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

​

快速开始

# 1. 启用遥测
export CLAUDE_CODE_ENABLE_TELEMETRY=1

# 2. 选择导出器（两者都是可选的 - 仅配置您需要的）
export OTEL_METRICS_EXPORTER=otlp       # 选项：otlp、prometheus、console、none
export OTEL_LOGS_EXPORTER=otlp          # 选项：otlp、console、none

# 3. 配置 OTLP 端点（用于 OTLP 导出器）
export OTEL_EXPORTER_OTLP_PROTOCOL=grpc
export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317

# 4. 设置身份验证（如果需要）
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer your-token"

# 5. 用于调试：减少导出间隔
export OTEL_METRIC_EXPORT_INTERVAL=10000  # 10 秒（默认：60000ms）
export OTEL_LOGS_EXPORT_INTERVAL=5000     # 5 秒（默认：5000ms）

# 6. 运行 Claude Code
claude

​

管理员配置

{
  "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"
  }
}

​

配置详情

​

常见配置变量

​

mTLS 身份验证

​

指标基数控制

​

Traces（测试版）

​

Span 层次结构

claude_code.interaction
├── claude_code.llm_request
├── claude_code.hook                    (需要详细的测试版跟踪)
└── claude_code.tool
    ├── claude_code.tool.blocked_on_user
    ├── claude_code.tool.execution
    └── (Task 工具) 子代理 claude_code.llm_request / claude_code.tool span

​

Span 属性

​

动态标头

​

设置配置

{
  "otelHeadersHelper": "/bin/generate_opentelemetry_headers.sh"
}

​

脚本要求

#!/bin/bash
# 示例：多个标头
echo "{\"Authorization\": \"Bearer $(get-token.sh)\", \"X-API-Key\": \"$(get-api-key.sh)\"}"

​

刷新行为

​

多团队组织支持

# 添加自定义属性用于团队识别
export OTEL_RESOURCE_ATTRIBUTES="department=engineering,team.id=platform,cost_center=eng-123"

• 按团队或部门过滤指标
• 按成本中心跟踪成本
• 创建特定于团队的仪表板
• 为特定团队设置警报

# ❌ 无效 - 包含空格
export OTEL_RESOURCE_ATTRIBUTES="org.name=John's Organization"

# ✅ 有效 - 改用下划线或驼峰式大小写
export OTEL_RESOURCE_ATTRIBUTES="org.name=Johns_Organization"
export OTEL_RESOURCE_ATTRIBUTES="org.name=JohnsOrganization"

# ✅ 有效 - 如果需要，对特殊字符进行百分比编码
export OTEL_RESOURCE_ATTRIBUTES="org.name=John%27s%20Organization"

​

示例配置

# 控制台调试（1 秒间隔）
export CLAUDE_CODE_ENABLE_TELEMETRY=1
export OTEL_METRICS_EXPORTER=console
export OTEL_METRIC_EXPORT_INTERVAL=1000

# OTLP/gRPC
export CLAUDE_CODE_ENABLE_TELEMETRY=1
export OTEL_METRICS_EXPORTER=otlp
export OTEL_EXPORTER_OTLP_PROTOCOL=grpc
export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317

# Prometheus
export CLAUDE_CODE_ENABLE_TELEMETRY=1
export OTEL_METRICS_EXPORTER=prometheus

# 多个导出器
export CLAUDE_CODE_ENABLE_TELEMETRY=1
export OTEL_METRICS_EXPORTER=console,otlp
export OTEL_EXPORTER_OTLP_PROTOCOL=http/json

# 指标和日志的不同端点/后端
export CLAUDE_CODE_ENABLE_TELEMETRY=1
export OTEL_METRICS_EXPORTER=otlp
export OTEL_LOGS_EXPORTER=otlp
export OTEL_EXPORTER_OTLP_METRICS_PROTOCOL=http/protobuf
export OTEL_EXPORTER_OTLP_METRICS_ENDPOINT=http://metrics.example.com:4318
export OTEL_EXPORTER_OTLP_LOGS_PROTOCOL=grpc
export OTEL_EXPORTER_OTLP_LOGS_ENDPOINT=http://logs.example.com:4317

# 仅指标（无事件/日志）
export CLAUDE_CODE_ENABLE_TELEMETRY=1
export OTEL_METRICS_EXPORTER=otlp
export OTEL_EXPORTER_OTLP_PROTOCOL=grpc
export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317

# 仅事件/日志（无指标）
export CLAUDE_CODE_ENABLE_TELEMETRY=1
export OTEL_LOGS_EXPORTER=otlp
export OTEL_EXPORTER_OTLP_PROTOCOL=grpc
export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317

​

可用的指标和事件

​

标准属性

• prompt.id：UUID 将用户提示与所有后续事件关联到下一个提示。请参阅 事件关联属性。
• workspace.host_paths：在桌面应用中选择的主机工作区目录，作为字符串数组

​

指标

​

指标详情

​

会话计数器

• 所有 标准属性
• start_type：会话的启动方式。"fresh"、"resume" 或 "continue" 之一

​

代码行计数器

• 所有 标准属性
• type：（"added"、"removed"）

​

拉取请求计数器

• 所有 标准属性

​

提交计数器

• 所有 标准属性

​

成本计数器

• 所有 标准属性
• model：模型标识符（例如，“claude-sonnet-4-6”）
• query_source：发出请求的子系统的类别。"main"、"subagent" 或 "auxiliary" 之一
• speed：当请求使用快速模式时为 "fast"。否则不存在
• effort：应用于请求的 努力级别："low"、"medium"、"high"、"xhigh" 或 "max"。当模型不支持努力时不存在。
• agent.name：发出请求的子代理类型。内置代理名称和来自官方市场插件的代理按原样出现。其他用户定义的代理名称被替换为 "custom"。当请求不是由命名子代理类型发出时不存在。
• skill.name：对请求活跃的技能，由 Skill 工具、/ 命令设置或由生成的子代理继承。内置、捆绑、用户定义和官方市场插件技能名称按原样出现。第三方插件技能名称被替换为 "third-party"。当没有技能活跃时不存在。
• plugin.name：当活跃技能或子代理由插件提供时的拥有插件。官方市场插件名称按原样出现。第三方插件名称被替换为 "third-party"。当技能和子代理都没有拥有插件时不存在。
• marketplace.name：拥有插件安装来源的市场。仅为官方市场插件发出。否则不存在。

​

令牌计数器

• 所有 标准属性
• type：（"input"、"output"、"cacheRead"、"cacheCreation"）
• model：模型标识符（例如，“claude-sonnet-4-6”）
• query_source：发出请求的子系统的类别。"main"、"subagent" 或 "auxiliary" 之一
• speed：当请求使用快速模式时为 "fast"。否则不存在
• effort：应用于请求的 努力级别。有关详情，请参阅 成本计数器。
• agent.name、skill.name、plugin.name、marketplace.name：请求的技能、插件和代理归属。有关定义和编辑行为，请参阅 成本计数器。

​

代码编辑工具决策计数器

• 所有 标准属性
• tool_name：工具名称（"Edit"、"Write"、"NotebookEdit"）
• decision：用户决策（"accept"、"reject"）
• source：决策来源。"config"、"hook"、"user_permanent"、"user_temporary"、"user_abort" 或 "user_reject" 之一。请参阅 工具决策事件 了解每个值的含义。
• language：编辑文件的编程语言，例如 "TypeScript"、"Python"、"JavaScript" 或 "Markdown"。对于无法识别的文件扩展名，返回 "unknown"。

​

活跃时间计数器

• 所有 标准属性
• type："user" 用于键盘交互，"cli" 用于工具执行和 AI 响应

​

事件

​

事件关联属性

​

用户提示事件

• 所有 标准属性
• event.name："user_prompt"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• prompt_length：提示的长度
• prompt：提示内容（默认为已编辑，使用 OTEL_LOG_USER_PROMPTS=1 启用）
• command_name：当提示调用命令时的命令名称。内置和捆绑的命令名称（例如 compact 或 debug）按原样发出；别名（例如 reset）按输入方式发出而不是规范名称。自定义、插件和 MCP 命令名称折叠为 custom 或 mcp，除非设置了 OTEL_LOG_TOOL_DETAILS=1
• command_source：命令存在时的来源：builtin、custom 或 mcp。插件提供的命令报告为 custom

​

工具结果事件

• 所有 标准属性
• event.name："tool_result"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• tool_name：工具的名称
• tool_use_id：此工具调用的唯一标识符。与传递给 hooks 的 tool_use_id 匹配，允许在 OTel 事件和 hook 捕获的数据之间进行关联。
• success："true" 或 "false"
• duration_ms：执行时间（毫秒）
• error_type：工具失败时的错误类别字符串，例如 "Error:ENOENT" 或 "ShellError"
• error（当 OTEL_LOG_TOOL_DETAILS=1 时）：工具失败时的完整错误消息
• decision_type："accept" 或 "reject"
• decision_source：决策来源。"config"、"hook"、"user_permanent"、"user_temporary"、"user_abort" 或 "user_reject" 之一。请参阅 工具决策事件 了解每个值的含义。
• tool_input_size_bytes：JSON 序列化工具输入的大小（字节）
• tool_result_size_bytes：工具结果的大小（字节）
• mcp_server_scope：MCP 服务器范围标识符（用于 MCP 工具）
• tool_parameters（当 OTEL_LOG_TOOL_DETAILS=1 时）：包含工具特定参数的 JSON 字符串：
  • 对于 Bash 工具：包括 bash_command、full_command、timeout、description、dangerouslyDisableSandbox 和 git_commit_id（git commit 命令成功时的提交 SHA）
  • 对于 MCP 工具：包括 mcp_server_name、mcp_tool_name
  • 对于 Skill 工具：包括 skill_name
  • 对于 Task 工具：包括 subagent_type
• tool_input（当 OTEL_LOG_TOOL_DETAILS=1 时）：JSON 序列化的工具参数。超过 512 个字符的单个值被截断，完整有效负载限制为约 4 K 字符。适用于所有工具，包括 MCP 工具。

​

API 请求事件

• 所有 标准属性
• event.name："api_request"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• model：使用的模型（例如，“claude-sonnet-4-6”）
• cost_usd：USD 估计成本
• duration_ms：请求持续时间（毫秒）
• input_tokens：输入令牌数
• output_tokens：输出令牌数
• cache_read_tokens：从缓存读取的令牌数
• cache_creation_tokens：用于缓存创建的令牌数
• request_id：来自响应的 request-id 标头的 Anthropic API 请求 ID，例如 "req_011..."。仅当 API 返回时存在。
• speed："fast" 或 "normal"，指示是否启用了快速模式
• query_source：发出请求的子系统，例如 "repl_main_thread"、"compact" 或子代理名称
• effort：应用于请求的 努力级别："low"、"medium"、"high"、"xhigh" 或 "max"。当模型不支持努力时不存在。

​

API 错误事件

• 所有 标准属性
• event.name："api_error"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• model：使用的模型（例如，“claude-sonnet-4-6”）
• error：错误消息
• status_code：HTTP 状态代码（数字形式）。对于非 HTTP 错误（例如连接失败）不存在。
• duration_ms：请求持续时间（毫秒）
• attempt：进行的总尝试次数，包括初始请求（1 表示没有发生重试）
• request_id：来自响应的 request-id 标头的 Anthropic API 请求 ID，例如 "req_011..."。仅当 API 返回时存在。
• speed："fast" 或 "normal"，指示是否启用了快速模式
• query_source：发出请求的子系统，例如 "repl_main_thread"、"compact" 或子代理名称
• effort：应用于请求的 努力级别。当模型不支持努力时不存在。

​

API 请求主体事件

• 所有 标准属性
• event.name："api_request_body"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• body：JSON 序列化的 Messages API 请求参数（系统提示、消息、工具等），在 60 KB 处截断。先前助手轮次中的扩展思考内容被编辑。仅在内联模式下发出（OTEL_LOG_RAW_API_BODIES=1）。
• body_ref：包含未截断主体的 <dir>/<uuid>.request.json 文件的绝对路径。仅在文件模式下发出（OTEL_LOG_RAW_API_BODIES=file:<dir>）。
• body_length：未截断的主体长度。当 OTEL_LOG_RAW_API_BODIES=file:<dir> 时为 UTF-8 字节，或当 =1 时为 UTF-16 代码单位
• body_truncated：当发生内联截断时为 "true"。在文件模式下和未发生截断时不存在。
• model：来自请求参数的模型标识符
• query_source：发出请求的子系统（例如，"compact"）

​

API 响应主体事件

• 所有 标准属性
• event.name："api_response_body"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• body：JSON 序列化的 Messages API 响应（id、内容块、使用情况、停止原因），在 60 KB 处截断。扩展思考内容被编辑。仅在内联模式下发出（OTEL_LOG_RAW_API_BODIES=1）。
• body_ref：包含未截断主体的 <dir>/<request_id>.response.json 文件的绝对路径。仅在文件模式下发出（OTEL_LOG_RAW_API_BODIES=file:<dir>）。
• body_length：未截断的主体长度。当 OTEL_LOG_RAW_API_BODIES=file:<dir> 时为 UTF-8 字节，或当 =1 时为 UTF-16 代码单位
• body_truncated：当发生内联截断时为 "true"。在文件模式下和未发生截断时不存在。
• model：模型标识符
• query_source：发出请求的子系统
• request_id：来自响应的 request-id 标头的 Anthropic API 请求 ID，例如 "req_011..."。仅当 API 返回时存在。

​

工具决策事件

• 所有 标准属性
• event.name："tool_decision"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• tool_name：工具的名称（例如，“Read”、“Edit”、“Write”、“NotebookEdit”）
• tool_use_id：此工具调用的唯一标识符。与传递给 hooks 的 tool_use_id 匹配，允许在 OTel 事件和 hook 捕获的数据之间进行关联。
• decision："accept" 或 "reject"
• source：决策来源：
  • "config"：基于项目设置、用户个人设置中的允许规则、企业托管策略、--allowedTools 或 --disallowedTools 标志、活跃权限模式、来自同一交互式 CLI 会话中较早提示的会话范围授予或因为工具本身是安全的，自动决策而不提示。事件不指示这些来源中的哪一个匹配。
  • "hook"：PreToolUse 或 PermissionRequest hook 返回了决策。
  • "user_permanent"：当用户在权限提示时选择”是，并且不要再问…”时发出，将允许规则保存到其个人设置。在交互式 CLI 中，仅为该选择本身发出；与保存规则匹配的后续调用发出 "config"。在 Agent SDK 或非交互式 -p 会话中，初始选择和后续规则匹配都发出 "user_permanent"。视为接受。
  • "user_temporary"：当用户在权限提示时选择”是”，或在文件编辑或读取提示上选择”…仅在此会话期间”选项时发出。在交互式 CLI 中，仅为该选择本身发出；与该会话范围允许匹配的后续调用发出 "config"。在 Agent SDK 或非交互式 -p 会话中，选择和后续匹配都发出 "user_temporary"。视为接受。
  • "user_abort"：当用户关闭权限提示而不回答时发出。视为拒绝。
  • "user_reject"：当用户选择”否”时发出，或调用与其个人设置中的拒绝规则匹配。视为拒绝。

​

权限模式更改事件

• 所有 标准属性
• event.name："permission_mode_changed"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• from_mode：前一个权限模式，例如 "default"、"plan"、"acceptEdits"、"auto" 或 "bypassPermissions"
• to_mode：新权限模式
• trigger：导致更改的原因。"shift_tab"、"exit_plan_mode"、"auto_gate_denied" 或 "auto_opt_in" 之一。当转换来自 SDK 或桥接时不存在

​

身份验证事件

• 所有 标准属性
• event.name："auth"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• action："login" 或 "logout"
• success："true" 或 "false"
• auth_method：身份验证方法，例如 "oauth"
• error_category：操作失败时的分类错误类型。永远不包括原始错误消息
• status_code：操作因 HTTP 错误而失败时的 HTTP 状态代码（字符串形式）

​

MCP 服务器连接事件

• 所有 标准属性
• event.name："mcp_server_connection"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• status："connected"、"failed" 或 "disconnected"
• transport_type：服务器传输，例如 "stdio"、"sse" 或 "http"
• server_scope：服务器配置的范围，例如 "user"、"project" 或 "local"
• duration_ms：连接尝试持续时间（毫秒）
• error_code：连接失败时的错误代码
• server_name（当 OTEL_LOG_TOOL_DETAILS=1 时）：配置的服务器名称
• error（当 OTEL_LOG_TOOL_DETAILS=1 时）：连接失败时的完整错误消息

​

内部错误事件

• 所有 标准属性
• event.name："internal_error"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• error_name：错误类名，例如 "TypeError" 或 "SyntaxError"
• error_code：Node.js errno 代码，例如错误上存在时的 "ENOENT"

​

插件已安装事件

• 所有 标准属性
• event.name："plugin_installed"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• marketplace.is_official：如果市场是官方 Anthropic 市场，则为 "true"，否则为 "false"
• install.trigger："cli" 或 "ui"
• plugin.name：已安装插件的名称。对于第三方市场，仅当 OTEL_LOG_TOOL_DETAILS=1 时才包含
• plugin.version：在市场条目中声明时的插件版本。对于第三方市场，仅当 OTEL_LOG_TOOL_DETAILS=1 时才包含
• marketplace.name：插件安装来源的市场。对于第三方市场，仅当 OTEL_LOG_TOOL_DETAILS=1 时才包含

​

插件已加载事件

• 所有 标准属性
• event.name："plugin_loaded"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• plugin.name：插件的名称。对于官方市场外和内置捆绑的插件，除非 OTEL_LOG_TOOL_DETAILS=1，否则值为 "third-party"
• marketplace.name：插件安装来源的市场（已知时）。在与 plugin.name 相同的条件下编辑为 "third-party"
• plugin.version：来自插件清单的版本。仅当名称未被编辑且清单声明版本时才包含
• plugin.scope：插件的来源类别："official"、"org"、"user-local" 或 "default-bundle"
• enabled_via：插件如何被启用的方式："default-enable"、"org-policy"、"seed-mount" 或 "user-install"
• plugin_id_hash：插件名称和市场的确定性哈希，仅发送到您配置的导出器。让您计算整个队伍中加载了多少个不同的第三方插件，而无需记录其名称
• has_hooks：插件是否贡献 hooks
• has_mcp：插件是否贡献 MCP 服务器
• skill_path_count：插件声明的技能目录数
• command_path_count：插件声明的命令目录数
• agent_path_count：插件声明的代理目录数

​

技能激活事件

• 所有 标准属性
• event.name："skill_activated"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• skill.name：技能的名称。对于用户定义和第三方插件技能，除非 OTEL_LOG_TOOL_DETAILS=1，否则值为占位符 "custom_skill"
• invocation_trigger：技能的触发方式（"user-slash"、"claude-proactive" 或 "nested-skill"）
• skill.source：技能加载的位置（例如，"bundled"、"userSettings"、"projectSettings"、"plugin"）
• plugin.name（当 OTEL_LOG_TOOL_DETAILS=1 或插件来自官方市场时）：当技能由插件提供时的拥有插件的名称
• marketplace.name（当 OTEL_LOG_TOOL_DETAILS=1 或插件来自官方市场时）：当技能由插件提供时，拥有插件安装来源的市场

​

@提及事件

• 所有 标准属性
• event.name："at_mention"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• mention_type：提及的类型（"file"、"directory"、"agent"、"mcp_resource"）
• success：提及是否成功解析（"true" 或 "false"）

​

API 重试耗尽事件

• 所有 标准属性
• event.name："api_retries_exhausted"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• model：使用的模型
• error：最终错误消息
• status_code：HTTP 状态代码（数字形式）。对于非 HTTP 错误不存在。
• total_attempts：进行的总尝试次数
• total_retry_duration_ms：所有尝试的总实际时钟时间
• speed："fast" 或 "normal"

​

Hook 已注册事件

• 所有 标准属性
• event.name："hook_registered"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• hook_event：hook 事件类型，例如 "PreToolUse" 或 "PostToolUse"
• hook_type：hook 实现类型："command"、"prompt"、"mcp_tool"、"http" 或 "agent"
• hook_source：hook 定义的位置："userSettings"、"projectSettings"、"localSettings"、"flagSettings"、"policySettings" 或 "pluginHook"
• hook_matcher（当 OTEL_LOG_TOOL_DETAILS=1 时）：hook 配置中的匹配器字符串（设置时）
• plugin.name（当 hook_source 是 "pluginHook" 时）：贡献插件的名称。对于官方市场外和内置捆绑的插件，除非 OTEL_LOG_TOOL_DETAILS=1，否则值为 "third-party"
• plugin_id_hash（当 hook_source 是 "pluginHook" 时）：插件名称和市场的确定性哈希，仅发送到您配置的导出器。让您计算不同的贡献插件数而无需记录其名称

​

Hook 执行开始事件

• 所有 标准属性
• event.name："hook_execution_start"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• hook_event：Hook 事件类型，例如 "PreToolUse" 或 "PostToolUse"
• hook_name：完整 hook 名称，包括匹配器，例如 "PreToolUse:Write"
• num_hooks：匹配 hook 命令的数量
• managed_only：当仅允许托管策略 hooks 时为 "true"
• hook_source："policySettings" 或 "merged"
• hook_definitions：JSON 序列化的 hook 配置。仅当启用了详细的测试版跟踪和 OTEL_LOG_TOOL_DETAILS=1 时才包含

​

Hook 执行完成事件

• 所有 标准属性
• event.name："hook_execution_complete"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• hook_event：Hook 事件类型
• hook_name：完整 hook 名称，包括匹配器
• num_hooks：匹配 hook 命令的数量
• num_success：成功完成的计数
• num_blocking：返回阻止决策的计数
• num_non_blocking_error：失败但未阻止的计数
• num_cancelled：在完成前取消的计数
• total_duration_ms：所有匹配 hooks 的实际时钟持续时间
• managed_only：当仅允许托管策略 hooks 时为 "true"
• hook_source："policySettings" 或 "merged"
• hook_definitions：JSON 序列化的 hook 配置。仅当启用了详细的测试版跟踪和 OTEL_LOG_TOOL_DETAILS=1 时才包含

​

压缩事件

• 所有 标准属性
• event.name："compaction"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• trigger："auto" 或 "manual"
• success："true" 或 "false"
• duration_ms：压缩持续时间
• pre_tokens：压缩前的近似令牌计数
• post_tokens：压缩后的近似令牌计数
• error：压缩失败时的错误消息

​

反馈调查事件

• 所有 标准属性
• event.name："feedback_survey"
• event.timestamp：ISO 8601 时间戳
• event.sequence：单调递增的计数器，用于在会话内排序事件
• event_type：调查生命周期事件，例如 "appeared"、"responded" 或 "transcript_prompt_appeared"
• appearance_id：唯一 ID，链接为一个调查实例发出的事件
• survey_type：哪个调查产生了事件。"session" 是”Claude 做得怎么样？“评分提示
• response：用户在 responded 事件上的选择
• enabled_via_override：当设置了 CLAUDE_CODE_ENABLE_FEEDBACK_SURVEY_FOR_OTEL 时为 true。作为布尔值而不是字符串发出。在 session 调查事件上存在。过滤此属性以确认覆盖在整个队伍中应用

​

解释指标和事件数据

​

使用情况监控

​

成本监控

• 跟踪团队或个人的使用趋势
• 识别高使用会话以进行优化
• 通过 skill.name、plugin.name 和 agent.name 属性将支出归属于特定技能、插件或子代理类型

​

警报和分段

• 成本激增
• 异常的令牌消耗
• 来自特定用户的高会话量

​

检测重试耗尽

​

事件分析

• 最常用的工具
• 工具成功率
• 平均工具执行时间
• 按工具类型的错误模式

​

审计安全事件

​

将属性操作归属于用户

export OTEL_RESOURCE_ATTRIBUTES="enduser.id=jdoe@example.com,enduser.directory_id=S-1-5-21-..."

​

审计 MCP 活动

​

将安全问题映射到事件

​

将事件发送到 SIEM

{
  "env": {
    "CLAUDE_CODE_ENABLE_TELEMETRY": "1",
    "OTEL_LOGS_EXPORTER": "otlp",
    "OTEL_LOG_TOOL_DETAILS": "1",
    "OTEL_EXPORTER_OTLP_LOGS_PROTOCOL": "http/protobuf",
    "OTEL_EXPORTER_OTLP_LOGS_ENDPOINT": "https://siem.example.com:4318/v1/logs",
    "OTEL_EXPORTER_OTLP_HEADERS": "Authorization=Bearer your-siem-token"
  }
}

​

后端考虑事项

​

对于指标

• 时间序列数据库（例如，Prometheus）：速率计算、聚合指标
• 列式存储（例如，ClickHouse）：复杂查询、唯一用户分析
• 全功能可观测性平台（例如，Honeycomb、Datadog）：高级查询、可视化、警报

​

对于事件/日志

• 日志聚合系统（例如，Elasticsearch、Loki）：全文搜索、日志分析
• 列式存储（例如，ClickHouse）：结构化事件分析
• 全功能可观测性平台（例如，Honeycomb、Datadog）：指标和事件之间的关联

​

对于跟踪

• 分布式跟踪系统（例如，Jaeger、Zipkin、Grafana Tempo）：Span 可视化、请求瀑布、延迟分析
• 全功能可观测性平台（例如，Honeycomb、Datadog）：跟踪搜索和与指标和日志的关联

​

服务信息

• service.name：claude-code
• service.version：当前 Claude Code 版本
• os.type：操作系统类型（例如，linux、darwin、windows）
• os.version：操作系统版本字符串
• host.arch：主机架构（例如，amd64、arm64）
• wsl.version：WSL 版本号（仅在 Windows Subsystem for Linux 上运行时出现）
• 仪表名称：com.anthropic.claude_code

​

ROI 测量资源

​

安全和隐私

• OpenTelemetry 导出到您的后端是可选的，需要显式配置。有关 Anthropic 的单独操作遥测以及如何禁用它，请参阅 数据使用
• 原始文件内容和代码片段不包含在指标或事件中。Trace spans 是一个单独的数据路径：请参阅下面的 OTEL_LOG_TOOL_CONTENT 项目符号
• 通过 OAuth 认证时，user.email 包含在遥测属性中。如果这对您的组织是一个问题，请与您的遥测后端合作以过滤或编辑此字段
• 默认情况下不收集用户提示内容。仅记录提示长度。要包含提示内容，请设置 OTEL_LOG_USER_PROMPTS=1
• 默认情况下不记录工具输入参数和参数。要包含它们，请设置 OTEL_LOG_TOOL_DETAILS=1。启用后，tool_result 事件包含 tool_parameters 属性，其中包含 Bash 命令、MCP 服务器和工具名称、技能名称，以及包含文件路径、URL、搜索模式和其他参数的 tool_input 属性。user_prompt 事件包含自定义、插件和 MCP 命令的逐字 command_name。Trace spans 包含相同的 tool_input 属性和输入派生属性，例如 file_path。超过 512 个字符的单个值被截断，总数限制为约 4 K 字符，但参数仍可能包含敏感值。根据需要配置您的遥测后端以过滤或编辑这些属性
• 默认情况下，trace spans 中不记录工具输入和输出内容。要包含它，请设置 OTEL_LOG_TOOL_CONTENT=1。启用后，span 事件包含完整的工具输入和输出内容，在每个 span 处截断为 60 KB。这可能包括 Read 工具结果中的原始文件内容和 Bash 命令输出。根据需要配置您的遥测后端以过滤或编辑这些属性
• 默认情况下不记录原始 Anthropic Messages API 请求和响应主体。要包含它们，请设置 OTEL_LOG_RAW_API_BODIES。使用 =1 时，每个 API 调用发出 api_request_body 和 api_response_body 日志事件，其 body 属性是 JSON 序列化的有效负载，在 60 KB 处截断。使用 =file:<dir> 时，未截断的主体写入该目录下的 .request.json 和 .response.json 文件，事件携带 body_ref 路径而不是内联主体。使用日志收集器或 sidecar 而不是通过遥测流传输目录。在两种模式下，主体包含完整的对话历史（系统提示、每个先前的用户和助手轮次、工具结果），因此启用此选项意味着同意其他 OTEL_LOG_* 内容标志会揭示的所有内容。Claude 的扩展思考内容始终从这些主体中编辑，无论其他设置如何

​

在 Amazon Bedrock 上监控 Claude Code