監控

​

快速開始

# 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 (beta)

​

跨度階層

claude_code.interaction
├── claude_code.llm_request
├── claude_code.hook                    (requires detailed beta tracing)
└── claude_code.tool
    ├── claude_code.tool.blocked_on_user
    ├── claude_code.tool.execution
    └── (Agent tool) subagent claude_code.llm_request / claude_code.tool spans

​

跨度屬性

​

動態標頭

​

設定配置

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

​

指令碼需求

#!/bin/bash
# 範例：多個標頭
echo "{\"Authorization\": \"Bearer $(get-token.sh)\", \"X-API-Key\": \"$(get-api-key.sh)\"}"

• /status 輸出
• 使用 --debug 執行或在工作階段中執行 /debug 後的除錯日誌
• stderr，在以 -p 啟動的非互動式工作階段中

​

重新整理行為

​

多團隊組織支援

# 新增自訂屬性以進行團隊識別
export OTEL_RESOURCE_ATTRIBUTES="department=engineering,team.id=platform,cost_center=eng-123"

• 按團隊或部門篩選指標
• 追蹤每個成本中心的成本
• 建立團隊特定的儀表板
• 為特定團隊設定警報

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：在桌面應用程式中選擇的主機工作區目錄，作為字串陣列
• workflow.run_id：執行識別碼，前綴為 wf_，在 API 和工具事件上發出，由屬於 Workflow 工具執行的代理發出。按一個 workflow.run_id 篩選事件會重建該執行的 API 請求和工具結果。識別碼涵蓋工作流程指令碼衍生的代理以及這些代理依次衍生的任何代理，例如 skill 叫用。它符合在 Workflow 工具結果中報告的執行識別碼。在所有其他事件上不存在。需要 Claude Code v2.1.202 或更新版本
• workflow.name：工作流程的名稱，其指令碼的 meta.name，與 workflow.run_id 一起發出。內建工作流程名稱在執行未修改的內建指令碼時按原樣出現。使用者撰寫的名稱（包括內建指令碼的編輯副本）被替換為 custom，除非設定 OTEL_LOG_TOOL_DETAILS=1。需要 Claude Code v2.1.202 或更新版本

​

指標

​

指標詳情

​

工作階段計數器

• 所有標準屬性
• start_type：工作階段的啟動方式。"fresh"、"resume"、"continue" 或 "agents_view" 之一。"agents_view" 值識別 claude agents 儀表板程序，這是使用者啟動的本機 UI，而不是對話工作階段。在您的儀表板中篩選此值以將 UI 程序啟動與對話工作階段分開。

​

程式碼行計數器

• 所有標準屬性
• type：（"added"、"removed"）
• model：進行變更的模型識別碼（例如，“claude-sonnet-5”）

​

提取請求計數器

• 所有標準屬性

​

提交計數器

• 所有標準屬性

​

成本計數器

• 所有標準屬性
• model：模型識別碼（例如，“claude-sonnet-5”）
• query_source：發出請求的子系統的類別。"main"、"subagent" 或 "auxiliary" 之一
• speed：當請求使用快速模式時為 "fast"。否則不存在
• effort：應用於請求的努力等級："low"、"medium"、"high"、"xhigh" 或 "max"。當模型不支援努力時不存在。
• agent.name：發出請求的子代理類型。內建代理名稱和官方市場 plugin 的代理按原樣出現。其他使用者定義的代理名稱被替換為 "custom"。當請求不是由命名的子代理類型發出時不存在。
• skill.name：對請求有效的 Skill，由 Skill 工具、/ 命令設定或由衍生的子代理繼承。內建、捆綁、使用者定義和官方市場 plugin skill 名稱按原樣出現。第三方 plugin skill 名稱被替換為 "third-party"。當沒有 skill 有效時不存在。
• plugin.name：當活躍 skill 或子代理由 plugin 提供時的擁有 plugin。官方市場 plugin 名稱按原樣出現。第三方 plugin 名稱被替換為 "third-party"。當 skill 和子代理都沒有擁有 plugin 時不存在。
• marketplace.name：擁有 plugin 的安裝市場。僅針對官方市場 plugin 發出。否則不存在。
• mcp_server.name：MCP 伺服器，其工具在產生此請求的轉換中執行。內建、claude.ai 代理和官方登錄伺服器名稱按原樣出現。使用者配置的伺服器名稱被替換為 "custom"。當沒有 MCP 工具執行時不存在。
• mcp_tool.name：在產生此請求的轉換中執行的 MCP 工具，與 mcp_server.name 具有相同的編輯。當沒有 MCP 工具執行時不存在。

​

權杖計數器

• 所有標準屬性
• type：（"input"、"output"、"cacheRead"、"cacheCreation"）
• model：模型識別碼（例如，“claude-sonnet-5”）
• query_source：發出請求的子系統的類別。"main"、"subagent" 或 "auxiliary" 之一
• speed：當請求使用快速模式時為 "fast"。否則不存在
• effort：應用於請求的努力等級。詳見成本計數器以了解詳情。
• agent.name、skill.name、plugin.name、marketplace.name、mcp_server.name、mcp_tool.name：請求的 Skill、plugin、代理和 MCP 歸屬。詳見成本計數器以了解定義和編輯行為。

​

程式碼編輯工具決定計數器

• 所有標準屬性
• 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）按輸入方式發出而不是規範名稱。自訂、plugin 和 MCP 命令名稱除非設定 OTEL_LOG_TOOL_DETAILS=1，否則會摺疊為 custom 或 mcp
• command_source：命令的來源（如果存在）：builtin、custom 或 mcp。Plugin 提供的命令報告為 custom

​

助手回應事件

• 所有標準屬性
• event.name："assistant_response"
• event.timestamp：ISO 8601 時間戳
• event.sequence：單調遞增計數器，用於排序工作階段內的事件
• response_length：回應文字的長度（字元數）
• response：回應文字，在 60 KB 處截斷。預設為 <REDACTED>。設定 OTEL_LOG_ASSISTANT_RESPONSES=1 以包含它。當 OTEL_LOG_ASSISTANT_RESPONSES 未設定時，OTEL_LOG_USER_PROMPTS 會控制它，因此設定 OTEL_LOG_ASSISTANT_RESPONSES=0 以在啟用提示記錄時保持回應編輯
• model：模型識別碼（例如，“claude-sonnet-5”）
• request_id：來自回應的 request-id 標頭的 Anthropic API 請求 ID。僅當 API 傳回時才存在
• query_source：發出請求的子系統，例如 "repl_main_thread"、"compact" 或子代理名稱

​

工具結果事件

• 所有標準屬性
• 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"，因為此事件僅在工具執行後發出。拒絕的呼叫不會產生工具結果
• 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）
  • 對於 WorkspaceBash 工具：包括 bash_command、full_command、timeout
  • 對於 MCP 工具：包括 mcp_server_name、mcp_tool_name
  • 對於 Skill 工具：包括 skill_name
  • 對於 Agent 工具或舊版 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-5”）
• cost_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"。當模型不支援努力時不存在。
• agent.name、skill.name、plugin.name、marketplace.name、mcp_server.name、mcp_tool.name：請求的 Skill、plugin、代理和 MCP 歸屬。詳見成本計數器以了解定義和編輯行為。

​

API 錯誤事件

• 所有標準屬性
• event.name："api_error"
• event.timestamp：ISO 8601 時間戳
• event.sequence：單調遞增計數器，用於排序工作階段內的事件
• model：使用的模型（例如，“claude-sonnet-5”）
• 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：應用於請求的努力等級。當模型不支援努力時不存在。
• agent.name、skill.name、plugin.name、marketplace.name、mcp_server.name、mcp_tool.name：請求的 Skill、plugin、代理和 MCP 歸屬。詳見成本計數器以了解定義和編輯行為。

​

API 拒絕事件

• 所有標準屬性
• event.name："api_refusal"
• event.timestamp：ISO 8601 時間戳
• event.sequence：單調遞增計數器，用於排序工作階段內的事件
• model：來自請求的模型識別碼
• request_id：來自回應的 request-id 標頭的 Anthropic API 請求 ID，例如 "req_011..."。僅當 API 傳回時才存在。
• query_source：發出請求的子系統，例如 "repl_main_thread"、"compact" 或子代理名稱。詳見api_request以了解定義。
• speed：當快速模式啟用時為 "fast"，或 "normal"
• attempt：重試嘗試編號。第一次嘗試是 1。
• effort：應用於請求的努力等級。當模型不支援努力時不存在。
• server_fallback_hop：當 API 的伺服器端模型後備已在不同模型上重試此拒絕時為 true，因此使用者沒有看到此特定拒絕。當請求以拒絕結束時為 false。單個轉換可以發出 true hop 事件和稍後的 false 最終事件，當後備模型也拒絕時。
• has_category：當 API 回應帶有 stop_details.category 為 "cyber"、"bio"、"frontier_llm" 或 "reasoning_extraction" 時為 true。當回應沒有類別或值在該集合之外時為 false。當 server_fallback_hop 為 true 時不存在，因為 hop 區塊不帶 stop_details。
• has_explanation：當 API 回應帶有 stop_details.explanation 時為 true，否則為 false。當 server_fallback_hop 為 true 時不存在。
• category：來自 API 回應的 stop_details.category 值。"cyber"、"bio"、"frontier_llm" 或 "reasoning_extraction" 之一。僅當設定 OTEL_LOG_TOOL_DETAILS=1 且 has_category 為 true 時才存在。
• agent.name、skill.name、plugin.name、marketplace.name、mcp_server.name、mcp_tool.name：請求的 Skill、plugin、代理和 MCP 歸屬。詳見成本計數器以了解定義和編輯行為。

​

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"：當使用者選擇「否」時發出。在互動 CLI 中，僅針對該選擇本身發出；符合使用者個人設定中拒絕規則的呼叫發出 "config" 代替。在 Agent SDK 或非互動 -p 工作階段中，符合個人設定中拒絕規則的呼叫發出 "user_reject"。視為拒絕。
• tool_parameters（當 OTEL_LOG_TOOL_DETAILS=1 時）：包含工具特定參數的 JSON 字串。形狀與工具結果事件相同，除了執行後欄位（例如 git_commit_id）。如果權限決定透過 updatedInput 重寫工具輸入，值可能與接受呼叫的 tool_result 不同。使用此屬性查看當 decision 為 "reject" 時拒絕了哪個命令。
  • 對於 Bash 工具：包括 bash_command、full_command、timeout、description、dangerouslyDisableSandbox
  • 對於 WorkspaceBash 工具：包括 bash_command、full_command、timeout
  • 對於 MCP 工具：包括 mcp_server_name、mcp_tool_name
  • 對於 Skill 工具：包括 skill_name
  • 對於 Agent 工具或舊版 Task 工具：包括 subagent_type

​

權限模式變更事件

• 所有標準屬性
• 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：連線失敗時的錯誤碼
• is_plugin：當伺服器由 plugin 提供時為 true，否則為 false
• plugin_id_hash（當 is_plugin 為 true 時）：plugin 名稱和市場的穩定雜湊，用於按 plugin 分組事件而不暴露名稱
• plugin.name（當 is_plugin 為 true 時）：提供伺服器的 plugin 名稱。對於第三方 plugin，除非 OTEL_LOG_TOOL_DETAILS=1，否則這是字面字串 "third-party"；這可保護第三方 plugin 名稱預設不出現在日誌中。來自官方 Anthropic 來源的 Plugin 始終按名稱識別。plugin_id_hash 和 plugin.name 屬性流向您自己的監控後端，不會傳送給 Anthropic
• 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"（如果存在於錯誤上）

​

Plugin 已安裝事件

• 所有標準屬性
• event.name："plugin_installed"
• event.timestamp：ISO 8601 時間戳
• event.sequence：單調遞增計數器，用於排序工作階段內的事件
• marketplace.is_official：如果市場是官方 Anthropic 市場，則為 "true"，否則為 "false"
• install.trigger："cli" 或 "ui"
• plugin.name：已安裝 plugin 的名稱。對於第三方市場，僅當 OTEL_LOG_TOOL_DETAILS=1 時才包含
• plugin.version：Plugin 版本（如果在市場條目中宣告）。對於第三方市場，僅當 OTEL_LOG_TOOL_DETAILS=1 時才包含
• marketplace.name：安裝 plugin 的市場。對於第三方市場，僅當 OTEL_LOG_TOOL_DETAILS=1 時才包含

​

Plugin 已載入事件

• 所有標準屬性
• event.name："plugin_loaded"
• event.timestamp：ISO 8601 時間戳
• event.sequence：單調遞增計數器，用於排序工作階段內的事件
• plugin.name：plugin 的名稱。對於官方市場和內建捆綁之外的 plugin，除非 OTEL_LOG_TOOL_DETAILS=1，否則值為 "third-party"
• marketplace.name：plugin 的安裝市場（如果已知）。在與 plugin.name 相同的條件下編輯為 "third-party"
• plugin.version：來自 plugin 清單的版本。僅當名稱未被編輯且清單宣告版本時才包含
• plugin.scope：plugin 的來源類別："official"、"org"、"user-local" 或 "default-bundle"
• enabled_via：plugin 如何被啟用的方式："default-enable"、"org-policy"、"seed-mount" 或 "user-install"
• plugin_id_hash：plugin 名稱和市場的確定性雜湊，僅傳送到您配置的匯出器。讓您計算整個環境中載入了多少個不同的第三方 plugin，而無需記錄其名稱
• has_hooks：plugin 是否貢獻 hooks
• has_mcp：plugin 是否貢獻 MCP 伺服器
• host_owned_mcp：當 SDK 主機管理此 plugin 的 MCP 連線且 Claude Code 跳過讀取 plugin 的 MCP 伺服器配置時為 true，否則為 false。需要 Claude Code v2.1.172 或更新版本
• skill_path_count：plugin 宣告的 skill 目錄數
• command_path_count：plugin 宣告的命令目錄數
• agent_path_count：plugin 宣告的代理目錄數
• safe_mode：當工作階段以 --safe-mode 啟動時為 "true"，否則為 "false"。在安全模式下，此事件僅報告配置的清單；plugin 的命令、skill、hooks 和 MCP 伺服器不會載入。需要 Claude Code v2.1.169 或更新版本

​

Skill 已啟動事件

• 所有標準屬性
• event.name："skill_activated"
• event.timestamp：ISO 8601 時間戳
• event.sequence：單調遞增計數器，用於排序工作階段內的事件
• skill.name：Skill 的名稱。對於使用者定義和第三方 plugin skill，除非 OTEL_LOG_TOOL_DETAILS=1，否則值為預留位置 "custom_skill"
• invocation_trigger：Skill 的觸發方式（"user-slash"、"claude-proactive" 或 "nested-skill"）
• skill.source：Skill 的載入位置（例如，"bundled"、"userSettings"、"projectSettings"、"plugin"）
• skill.kind：當 skill 是工作流程 skill 時為 "workflow"。否則不存在
• plugin.name（當 OTEL_LOG_TOOL_DETAILS=1 或 plugin 來自官方市場時）：當 skill 由 plugin 提供時的擁有 plugin 名稱
• marketplace.name（當 OTEL_LOG_TOOL_DETAILS=1 或 plugin 來自官方市場時）：當 skill 由 plugin 提供時，擁有 plugin 的安裝市場

​

@ 提及事件

• 所有標準屬性
• 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"
• safe_mode：當工作階段以 --safe-mode 啟動時為 "true"，否則為 "false"。需要 Claude Code v2.1.169 或更新版本
• hook_matcher（當 OTEL_LOG_TOOL_DETAILS=1 時）：hook 配置中的匹配器字串（如果已設定）
• plugin.name（當 hook_source 是 "pluginHook" 時）：貢獻 plugin 的名稱。對於官方市場和內建捆綁之外的 plugin，除非 OTEL_LOG_TOOL_DETAILS=1，否則值為 "third-party"
• plugin_id_hash（當 hook_source 是 "pluginHook" 時）：plugin 名稱和市場的確定性雜湊，僅傳送到您配置的匯出器。讓您計算不同的貢獻 plugin，而無需記錄其名稱

​

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：當僅允許受管原則 hook 時為 "true"
• hook_source："policySettings" 或 "merged"
• safe_mode：當工作階段以 --safe-mode 啟動時為 "true"，否則為 "false"。需要 Claude Code v2.1.169 或更新版本
• hook_definitions：JSON 序列化的 hook 配置。僅當詳細 beta 追蹤和 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：所有匹配 hook 的牆上時間持續時間
• managed_only：當僅允許受管原則 hook 時為 "true"
• hook_source："policySettings" 或 "merged"
• safe_mode：當工作階段以 --safe-mode 啟動時為 "true"，否則為 "false"。需要 Claude Code v2.1.169 或更新版本
• hook_definitions：JSON 序列化的 hook 配置。僅當詳細 beta 追蹤和 OTEL_LOG_TOOL_DETAILS=1 都啟用時才包含

​

Hook plugin 指標事件

• 所有標準屬性
• event.name："hook_plugin_metrics"
• event.timestamp：ISO 8601 時間戳
• event.sequence：單調遞增計數器，用於排序工作階段內的事件
• plugin_id：plugin 識別碼，格式為 <name>@<marketplace>
• hook_event：發出指標的 hook 事件類型
• 最多 20 個 plugin 發出的指標鍵。名稱符合 ^[a-z][a-z0-9_]{0,39}$。值為布林值或數字。

​

壓縮事件

• 所有標準屬性
• event.name："compaction"
• event.timestamp：ISO 8601 時間戳
• event.sequence：單調遞增計數器，用於排序工作階段內的事件
• trigger："auto" 或 "manual"
• success："true" 或 "false"
• duration_ms：壓縮持續時間
• pre_tokens：壓縮前的近似權杖計數
• post_tokens：壓縮後的近似權杖計數
• error：壓縮失敗時的錯誤訊息
• precompute_reuse：僅在 trigger 為 "manual" 時設定。自動壓縮可以在內容視窗填滿之前在背景中準備摘要，此屬性記錄 /compact 是否重複使用該準備的摘要。"hit" 表示它被重複使用；"miss_custom_instructions"、"miss_hook" 和 "miss_not_ready" 給出改為計算新摘要的原因。需要 Claude Code v2.1.153 或更新版本

​

回饋調查事件

• 所有標準屬性
• 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 活動

• tool_result：保留 tool_name 和 mcp_server_scope，省略 mcp_server_name、mcp_tool_name 和引數
• tool_decision：保留 tool_name，省略 tool_parameters
• mcp_server_connection：省略 server_name 和錯誤訊息，但保留 is_plugin、plugin_id_hash 和 plugin.name，非 Anthropic plugin 名稱被編輯為字面上的 "third-party"，因此 plugin 提供的伺服器在沒有詳細日誌的情況下仍然可以區分

​

將安全問題對應到事件

​

將事件傳送到 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、Grafana Cloud）：進階查詢、視覺化、警報

​

對於事件/日誌

• 日誌聚合系統（例如，Elasticsearch、Loki）：全文搜尋、日誌分析
• 欄式存儲（例如，ClickHouse）：結構化事件分析
• 功能完整的可觀測性平台（例如，Honeycomb、Datadog、Grafana Cloud）：指標和事件之間的關聯

​

對於追蹤

• 分散式追蹤系統（例如，Jaeger、Zipkin、Grafana Tempo）：跨度視覺化、請求瀑布圖、延遲分析
• 功能完整的可觀測性平台（例如，Honeycomb、Datadog、Grafana Cloud）：追蹤搜尋和與指標和日誌的關聯

​

服務資訊

• 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 的獨立營運遙測以及如何停用它，請參閱資料使用
• 原始檔案內容和程式碼片段不包含在指標或事件中。追蹤跨度是單獨的資料路徑：請參閱下面的 OTEL_LOG_TOOL_CONTENT 項目
• 透過 OAuth 驗證時，user.email 包含在遙測屬性中。如果這對您的組織是個問題，請與您的遙測後端合作以篩選或編輯此欄位
• 預設不收集使用者提示內容。僅記錄提示長度。若要包含提示內容，請設定 OTEL_LOG_USER_PROMPTS=1
• 助理回應文字預設不收集。僅記錄回應長度。若要包含回應文字，請設定 OTEL_LOG_ASSISTANT_RESPONSES=1。如同 Claude Code 的所有 OpenTelemetry 資料，回應文字僅傳送到您配置的 OTel 端點，絕不會傳送到 Anthropic。當此變數未設定時，OTEL_LOG_USER_PROMPTS 會用作備用方案，因此如果您想要提示內容而不要回應內容，請設定 OTEL_LOG_ASSISTANT_RESPONSES=0
• 工具輸入引數和參數預設不記錄。若要包含它們，請設定 OTEL_LOG_TOOL_DETAILS=1。此資料僅傳送到您配置的 OTEL 端點，絕不會傳送到 Anthropic。引數仍可能包含敏感值，因此請根據需要配置您的遙測後端以篩選或編輯這些屬性。啟用時：
  • tool_result 和 tool_decision 事件包含 tool_parameters 屬性，其中包含 Bash 命令、MCP 伺服器和工具名稱以及技能名稱。full_command 等欄位未截斷地發出
  • tool_result 事件另外包含 tool_input 屬性，其中包含檔案路徑、URL、搜尋模式和其他引數。超過 512 個字元的個別值會被截斷，總計上限約為 4 K 字元
  • user_prompt 事件包含自訂、plugin 和 MCP 命令的逐字 command_name
  • 追蹤跨度包含相同的 tool_input 屬性和輸入衍生屬性，例如 file_path，截斷方式與 tool_input 相同
• 工具輸入和輸出內容預設不在追蹤跨度中記錄。若要包含它，請設定 OTEL_LOG_TOOL_CONTENT=1。啟用時，跨度事件包含完整工具輸入和輸出內容，在每個跨度處截斷 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 路徑而不是內聯主體。使用日誌收集器或邊車傳送目錄，而不是透過遙測流。在兩種模式中，主體包含完整的對話歷史記錄（系統提示、每個先前的使用者和助手輪次、工具結果），因此啟用此選項意味著同意其他 OTEL_LOG_* 內容旗標會揭露的所有內容。Claude 的擴展思考內容始終從這些主體中編輯，無論其他設定如何

​

在 Amazon Bedrock 上監控 Claude Code