mirror of
https://github.com/openclaw/openclaw.git
synced 2026-08-17 16:12:21 -06:00
SunnyShu
3bc188efe5
* [AI] fix(diagnostics-otel): keep telemetry exporting across in-process restarts Owned diagnostics-otel generations previously registered their OpenTelemetry providers globally and only shut the providers down on stop. The pinned sdk-node registers globals without override and never unregisters them, so a second in-process generation (config-watcher reload, OPENCLAW_NO_RESPAWN=1, containers) kept exporting through the first, already-shutdown providers and telemetry silently stopped. Switch owned mode to private BasicTracerProvider + MeterProvider instances whose handles are injected directly into the existing recorder runtime, and keep the preloaded (OPENCLAW_OTEL_PRELOADED=1) mode on the host's global providers without ever registering or replacing globals. Resource detection honors the pinned NodeSDK OTEL_NODE_RESOURCE_DETECTORS contract (unset defaults to env+process+host; none/subset/all are respected), and the unused @opentelemetry/sdk-node dependency is removed with a minimal lockfile update. Adds a real-SDK two-generation restart regression, real-SDK resource-detector selection coverage, migrates the unit mocks to the provider lifecycle, and updates the OpenTelemetry docs. Fixes #119997 Co-Authored-By: glm-5.2 <noreply@anthropic.com> * [AI] test(diagnostics-otel): restore OpenTelemetry globals after restart test The restart regression disables global context, metrics, propagation, and trace APIs and forces OPENCLAW_OTEL_PRELOADED=0, but its cleanup only reset diagnostic events, so a later test in the same worker could inherit no-op providers. Snapshot the prior global registrations and preloaded env at module load, and re-register/restore them in afterEach, matching the existing exporter-health integration test pattern. Co-Authored-By: glm-5.2 <noreply@anthropic.com> * [AI] fix(diagnostics-otel): reconcile private providers with OTEL_SDK_DISABLED Rebase onto main after #119961 (honor OTEL_SDK_DISABLED) changed the disabled admission path to return before SDK construction. Restore the removed getBooleanFromEnv import, drop the stale ownedNodeSdkDisabled guard, and update disabled-mode tests to the new semantics (all routes off, disabled runtime registered) plus the private-provider signal path for the integration suite. Related to #119997 Co-Authored-By: Claude <noreply@anthropic.com> * fix(diagnostics-otel): isolate restartable provider generations * test(diagnostics-otel): prove same-pid generation routing * test(diagnostics-otel): use supported watcher reload mode * test(diagnostics-otel): satisfy ownership proof gates * test(diagnostics-otel): use managed proof cleanup * test(diagnostics-otel): verify injected trace ancestry --------- Co-authored-by: glm-5.2 <noreply@anthropic.com> Co-authored-by: Vincent Koc <vincentkoc@ieee.org>
767 lines
52 KiB
Markdown
767 lines
52 KiB
Markdown
---
|
|
summary: "Export OpenClaw diagnostics to OpenTelemetry collectors or stdout JSONL via the diagnostics-otel plugin"
|
|
title: "OpenTelemetry export"
|
|
read_when:
|
|
- You want to send OpenClaw model usage, message flow, or session metrics to an OpenTelemetry collector
|
|
- You are wiring traces, metrics, or logs into Grafana, Datadog, Honeycomb, New Relic, Tempo, or another OTLP backend
|
|
- You need the exact metric names, span names, or attribute shapes to build dashboards or alerts
|
|
---
|
|
|
|
OpenClaw exports diagnostics through the official `diagnostics-otel` plugin
|
|
using **OTLP/HTTP (protobuf)**. Logs can also be written as stdout JSONL for
|
|
container and sandbox log pipelines. Any collector or backend that accepts
|
|
OTLP/HTTP works without code changes. For local file logs, see
|
|
[Logging](/logging).
|
|
|
|
- **Diagnostics events** are structured, in-process records emitted by the
|
|
Gateway and bundled plugins for model runs, message flow, sessions, queues,
|
|
and exec.
|
|
- **`diagnostics-otel`** subscribes to those events and exports them as
|
|
OpenTelemetry **metrics**, **traces**, and **logs** over OTLP/HTTP, and can
|
|
mirror log records to stdout JSONL.
|
|
- **Provider calls** receive a W3C `traceparent` header from the actual current
|
|
OpenTelemetry model-call span when the provider transport accepts custom
|
|
headers. Diagnostic IDs remain local correlation keys, and plugin-emitted
|
|
trace context is not propagated.
|
|
- Exporters attach only when both the diagnostics surface and the plugin are
|
|
enabled, so in-process cost stays near zero by default.
|
|
|
|
## Quick start
|
|
|
|
```bash
|
|
openclaw plugins install clawhub:@openclaw/diagnostics-otel
|
|
```
|
|
|
|
```json5
|
|
{
|
|
plugins: {
|
|
allow: ["diagnostics-otel"],
|
|
entries: {
|
|
"diagnostics-otel": { enabled: true },
|
|
},
|
|
},
|
|
diagnostics: {
|
|
enabled: true,
|
|
otel: {
|
|
enabled: true,
|
|
endpoint: "http://otel-collector:4318",
|
|
protocol: "http/protobuf",
|
|
serviceName: "openclaw-gateway",
|
|
traces: true,
|
|
metrics: true,
|
|
logs: true,
|
|
sampleRate: 0.2,
|
|
flushIntervalMs: 60000,
|
|
},
|
|
},
|
|
}
|
|
```
|
|
|
|
Or enable the plugin from the CLI: `openclaw plugins enable diagnostics-otel`.
|
|
|
|
<Note>
|
|
`diagnostics.otel.protocol` accepts only `http/protobuf`. If a persisted config,
|
|
including a value supplied through `${VAR}` interpolation, still resolves this
|
|
field to the retired `grpc` value, run
|
|
[`openclaw doctor --fix`](/cli/doctor). Doctor repairs directly authored values
|
|
and a sole internal single-file include that owns the top-level `diagnostics`
|
|
section. For root or array includes, nested include chains, sibling overrides,
|
|
external include targets, or another ambiguous source, Doctor leaves the files
|
|
unchanged and lists the candidate source file or files to edit manually.
|
|
|
|
When `diagnostics.otel.protocol` is unset, each plugin-owned OTLP signal first
|
|
checks its nonblank `OTEL_EXPORTER_OTLP_*_PROTOCOL` value, then
|
|
`OTEL_EXPORTER_OTLP_PROTOCOL`, then defaults to `http/protobuf`. Doctor does not
|
|
rewrite process environment variables. An unsupported value disables only that
|
|
plugin-owned OTLP signal; supported sibling signals continue, as does the stdout
|
|
branch of `logsExporter: "both"`. Preloaded trace and metric SDKs own their own
|
|
transport selection and are not rejected by this plugin.
|
|
</Note>
|
|
|
|
## Signals exported
|
|
|
|
| Signal | What goes in it |
|
|
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| **Metrics** | Counters/histograms for token usage, cost, run duration, failover, skill usage, message flow, Talk events, queue lanes, session state/recovery, tool execution, exec, memory, liveness, and exporter health. |
|
|
| **Traces** | Spans for model usage, model calls, harness lifecycle, skill usage, tool execution, exec, webhook/message processing, context assembly, and tool loops. |
|
|
| **Logs** | Structured `logging.file` records exported over OTLP or stdout JSONL when `diagnostics.otel.logs` is enabled; log bodies are withheld unless content capture is explicitly enabled. |
|
|
|
|
Toggle `traces`, `metrics`, and `logs` independently. Traces and metrics
|
|
default to on when `diagnostics.otel.enabled` is true; logs default to off
|
|
and export only when `diagnostics.otel.logs` is explicitly `true`. Log export
|
|
defaults to OTLP; set `diagnostics.otel.logsExporter` to `stdout` for JSONL on
|
|
stdout, or `both` for both.
|
|
|
|
<Note>
|
|
The shared `endpoint` and `OTEL_EXPORTER_OTLP_ENDPOINT` are bases for all
|
|
enabled signals. OpenClaw appends `/v1/traces`, `/v1/metrics`, or `/v1/logs`
|
|
to root and custom collector paths. For compatibility with hosted frontends,
|
|
a shared endpoint already ending in one of those signal paths keeps that path
|
|
for its matching signal and replaces the terminal segment for the others.
|
|
|
|
Signal-specific `tracesEndpoint`, `metricsEndpoint`, and `logsEndpoint`
|
|
settings, plus their matching `OTEL_EXPORTER_OTLP_*_ENDPOINT` fallbacks, are
|
|
passed to the exporter as exact URLs. OpenClaw does not append or rewrite their
|
|
paths.
|
|
</Note>
|
|
|
|
## Which processes export
|
|
|
|
- **Gateway** starts the exporter at startup and exports from the Gateway
|
|
process for every run it executes, including `openclaw agent` turns
|
|
dispatched to it.
|
|
- **One-shot local runs** (`openclaw agent --local`) execute in the CLI
|
|
process. When OTel export is configured and
|
|
the plugin is enabled, that same CLI process starts one exporter instance for
|
|
the run and flushes buffered spans, metrics, and logs before the process exits.
|
|
The CLI waits at most 5 seconds for the diagnostic-event queue to drain and 10
|
|
more for the flush, so an unreachable collector cannot hold the command open.
|
|
A collector that accepts the connection but never answers can still delay exit
|
|
until the exporter's own request timeout (`OTEL_EXPORTER_OTLP_TIMEOUT`).
|
|
In JSON output mode, these one-shot runs suppress only the stdout JSONL log
|
|
sink so command stdout stays reserved for the JSON response; OTLP traces,
|
|
metrics, and logs continue when configured.
|
|
- `openclaw agent exec` also runs the agent embedded in the CLI process, but
|
|
does not yet start this exporter, so its runs export no telemetry. Dispatch
|
|
through the Gateway, or use `openclaw agent --local`, when you need traces
|
|
from a headless run.
|
|
|
|
## Exporter health
|
|
|
|
`openclaw doctor` and `openclaw status --all` show a bounded, redacted snapshot
|
|
of the running Gateway's latest trusted exporter state for each signal and
|
|
transport. For `diagnostics-otel`, the snapshot distinguishes:
|
|
|
|
- OTLP/HTTP protobuf with an endpoint supplied by config or an `OTEL_*`
|
|
environment fallback.
|
|
- OTLP/HTTP protobuf using the exporter dependency's default endpoint because
|
|
no endpoint was supplied.
|
|
- Stdout log export.
|
|
- Trace or metric export owned by an externally preloaded OpenTelemetry SDK.
|
|
|
|
OTLP export failure and recovery transitions are recorded from the exporter's
|
|
final result callback, after dependency-owned retries finish. A retryable
|
|
response that later succeeds is therefore not reported as a failure. Startup,
|
|
log preparation or emit, export, and shutdown failures use fixed reason
|
|
categories rather than raw errors.
|
|
|
|
The snapshot never includes endpoint values, headers, certificates, payloads,
|
|
or raw error messages. Transport is retained only in this local health
|
|
projection. It is not added to the existing
|
|
`openclaw.telemetry.exporter.events` metric attributes, and existing Prometheus
|
|
label sets are unchanged.
|
|
|
|
## Configuration reference
|
|
|
|
```json5
|
|
{
|
|
diagnostics: {
|
|
enabled: true,
|
|
otel: {
|
|
enabled: true,
|
|
endpoint: "http://otel-collector:4318",
|
|
tracesEndpoint: "http://otel-collector:4318/v1/traces",
|
|
metricsEndpoint: "http://otel-collector:4318/v1/metrics",
|
|
logsEndpoint: "http://otel-collector:4318/v1/logs",
|
|
protocol: "http/protobuf",
|
|
serviceName: "openclaw-gateway", // unset falls back to OTEL_SERVICE_NAME, then "openclaw"
|
|
metricNamePrefix: "acme.", // optional; include the separator
|
|
headers: { "x-collector-token": "..." },
|
|
traces: true,
|
|
metrics: true,
|
|
logs: true,
|
|
logsExporter: "otlp", // otlp | stdout | both
|
|
sampleRate: 0.2, // root-span sampler, 0.0..1.0
|
|
flushIntervalMs: 60000, // metric export interval (min 1000ms)
|
|
captureContent: false,
|
|
},
|
|
},
|
|
}
|
|
```
|
|
|
|
`metricNamePrefix` replaces the default `openclaw.` prefix only on
|
|
OpenClaw-owned metrics. For example, `"acme."` exports `openclaw.tokens` as
|
|
`acme.tokens`; set it to `""` to export `tokens` with no prefix. Non-empty
|
|
values must start with an ASCII letter, use only letters, digits, underscores,
|
|
dots, hyphens, and slashes, and contain at most 128 characters. Set it to
|
|
`"acme.openclaw."` if you want `acme.openclaw.tokens`. Standard
|
|
semantic-convention metrics such as
|
|
`gen_ai.client.token.usage` and `gen_ai.client.operation.duration` keep their
|
|
original names. Leave the option unset to preserve every current metric name.
|
|
Enabling or changing this option renames the affected metric series, so update
|
|
dashboards, alerts, and recording rules that query the old names.
|
|
|
|
### Environment variables
|
|
|
|
| Variable | Purpose |
|
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `OTEL_EXPORTER_OTLP_ENDPOINT` | Fallback for `diagnostics.otel.endpoint` when the config key is unset. |
|
|
| `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` / `OTEL_EXPORTER_OTLP_METRICS_ENDPOINT` / `OTEL_EXPORTER_OTLP_LOGS_ENDPOINT` | Signal-specific endpoint fallbacks used when the matching `diagnostics.otel.*Endpoint` config key is unset. Signal-specific config wins over signal-specific env, which wins over the shared endpoint. |
|
|
| `OTEL_SERVICE_NAME` | Fallback for `diagnostics.otel.serviceName` when the config key is unset. Default service name is `openclaw`. |
|
|
| `OTEL_EXPORTER_OTLP_PROTOCOL` | Shared process-environment fallback used when `diagnostics.otel.protocol` and the signal-specific protocol variable are unset. Only `http/protobuf` enables a plugin-owned OTLP exporter. |
|
|
| `OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` / `OTEL_EXPORTER_OTLP_METRICS_PROTOCOL` / `OTEL_EXPORTER_OTLP_LOGS_PROTOCOL` | Signal-specific protocol fallbacks used when `diagnostics.otel.protocol` is unset. A nonblank signal-specific value wins over the shared protocol value. Unsupported values disable only that plugin-owned OTLP signal. |
|
|
| `OTEL_PROPAGATORS` | Propagators registered for each plugin-owned generation, including when `OTEL_SDK_DISABLED=true`. Defaults to `tracecontext,baggage`; `none` disables automatic propagation. Values are case-insensitive. Unavailable values and deprecated `jaeger` usage emit a plugin warning. |
|
|
| `OTEL_SDK_DISABLED` | A case-insensitive `true` disables all plugin-owned trace, metric, log, and stdout routes before endpoint, protocol, or TLS setup. Any other value leaves the SDK enabled; unrecognized values emit a plugin warning and fall back to `false`. Async context and `OTEL_PROPAGATORS` remain active. |
|
|
| `OTEL_NODE_RESOURCE_DETECTORS` | Selects resource detectors for plugin-owned trace and metric providers. Supported tokens are `env`, `host`, `os`, `process`, and `serviceinstance`; `all` runs them in host, OS, service-instance, process, environment order, while `none` disables detection. The default is environment, process, then host. Explicit OpenClaw service config wins detector attributes. |
|
|
| `OTEL_TRACES_SAMPLER` / `OTEL_TRACES_SAMPLER_ARG` | Standard OpenTelemetry sampler selection used when `diagnostics.otel.sampleRate` is unset. An explicit `sampleRate` remains the higher-precedence OpenClaw sampler. |
|
|
| `OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT` / `OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT` / `OTEL_SPAN_EVENT_COUNT_LIMIT` / `OTEL_SPAN_LINK_COUNT_LIMIT` / `OTEL_SPAN_ATTRIBUTE_PER_EVENT_COUNT_LIMIT` / `OTEL_SPAN_ATTRIBUTE_PER_LINK_COUNT_LIMIT` | Standard OpenTelemetry span limits applied by each plugin-owned tracer provider. |
|
|
| `OTEL_BSP_MAX_QUEUE_SIZE` / `OTEL_BSP_MAX_EXPORT_BATCH_SIZE` / `OTEL_BSP_SCHEDULE_DELAY` / `OTEL_BSP_EXPORT_TIMEOUT` | Batch span processor settings for plugin-owned trace export. Values must be positive; invalid values use OpenTelemetry defaults. Export batch size is capped at queue size. |
|
|
| `OTEL_METRIC_EXPORT_INTERVAL` / `OTEL_METRIC_EXPORT_TIMEOUT` | Periodic metric export interval and timeout for plugin-owned metrics. Values must be positive; invalid values use OpenTelemetry defaults, and timeout is capped at the active interval. `diagnostics.otel.flushIntervalMs` overrides the interval. |
|
|
| `OTEL_NODE_EXPERIMENTAL_SDK_METRICS` | Enables OpenTelemetry SDK self-observation metrics for the private meter, tracer, and batch span processor when set to `true`. |
|
|
| `OTEL_LOG_LEVEL` | Owned mode does not replace the process-global OpenTelemetry diagnostic logger because the public SDK APIs expose no generation-private equivalent. A preload or host may configure this variable before OpenClaw starts; the plugin preserves that external diagnostic owner. |
|
|
| `OTEL_SEMCONV_STABILITY_OPT_IN` | Set to `gen_ai_latest_experimental` to emit the latest GenAI inference span shape: `{gen_ai.operation.name} {gen_ai.request.model}` span names, `CLIENT` span kind, and `gen_ai.provider.name` instead of the legacy `gen_ai.system`. GenAI metrics always use bounded, low-cardinality attributes regardless. |
|
|
| `OPENCLAW_OTEL_PRELOADED` | Set to `1` when another preload or host process already registered global OpenTelemetry providers. The plugin consumes external trace, metric, context, propagation, and logger ownership without registering, replacing, disabling, unregistering, or shutting it down. With `OTEL_SDK_DISABLED=true`, external ownership remains active while plugin-owned logs stay disabled. |
|
|
|
|
Without `OPENCLAW_OTEL_PRELOADED=1`, trace, metric, and log providers are
|
|
generation-private. The plugin publishes only its async context manager and
|
|
propagator through the public OpenTelemetry APIs, and removes them only while
|
|
those public behaviors still match the generation being stopped. A replacement
|
|
host or later generation therefore keeps ownership through cleanup.
|
|
|
|
## Continue an upstream WebSocket trace
|
|
|
|
An authenticated Gateway WebSocket client can attach a W3C `traceparent` to
|
|
each request frame:
|
|
|
|
```json
|
|
{
|
|
"type": "req",
|
|
"id": "eval-item-42",
|
|
"method": "agent",
|
|
"params": {},
|
|
"traceparent": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01"
|
|
}
|
|
```
|
|
|
|
The Gateway creates a child request context that preserves the upstream trace
|
|
ID and sampling flags. Agent, harness, model-call, provider, tool-execution, and
|
|
exec spans created inside the request remain on that trace, including spans
|
|
recorded after their parent run has already finished. This allows a local
|
|
experiment runner to create one Langfuse/OpenTelemetry trace per dataset item and
|
|
correlate the corresponding OpenClaw execution.
|
|
|
|
Trace context is request-scoped, not connection-scoped. On a long-lived
|
|
WebSocket, generate or inject the appropriate `traceparent` independently for
|
|
every RPC. Concurrent requests remain isolated even when their work
|
|
interleaves.
|
|
|
|
The field is accepted only after the existing Gateway authentication handshake
|
|
and does not affect authentication or method authorization. A `traceparent` on
|
|
the initial `connect` frame is ignored. Missing or syntactically malformed
|
|
values within the 128-character field limit silently fall back to a fresh
|
|
request trace; longer values make the request frame invalid. `tracestate` and
|
|
`baggage` are not accepted by the Gateway WebSocket protocol.
|
|
|
|
## Privacy and content capture
|
|
|
|
Raw model/tool content is **not** exported by default. Spans carry bounded
|
|
identifiers (channel, provider, model, error category, hash-only request ids,
|
|
tool source, tool owner, skill name/source) and never include prompt text,
|
|
response text, tool inputs, tool outputs, skill file paths, or session keys.
|
|
Values that look like scoped agent session keys (for example starting with
|
|
`agent:`) are replaced with `unknown` on low-cardinality attributes. OTLP log
|
|
records keep severity, logger, code location, trusted trace context, and
|
|
sanitized attributes by default; the raw log message body is exported only
|
|
when `diagnostics.otel.captureContent` is `true`. Talk metrics export only
|
|
bounded event metadata (mode, transport, provider, event type) - no
|
|
transcripts, audio payloads, session ids, turn ids, call ids, room ids, or
|
|
handoff tokens.
|
|
|
|
When `diagnostics-otel` tracing is active, outbound model requests may include
|
|
a W3C `traceparent` header from the actual exporter-owned model-call span.
|
|
Diagnostic trace IDs and span IDs only correlate events to that span; they are
|
|
not used as outbound OTel identities. If the exporter cannot resolve a real
|
|
span context, OpenClaw omits the header instead of naming an unexported parent.
|
|
Existing caller-supplied `traceparent` headers are removed or replaced, so
|
|
plugins or custom provider options cannot spoof cross-service trace ancestry.
|
|
|
|
Set `diagnostics.otel.captureContent` to `true` only when your collector and
|
|
retention policy are approved for prompt, response, tool, and tool-definition
|
|
text. This enables bounded, redacted input messages, output messages, tool
|
|
inputs, tool outputs, tool definitions, and OTLP log bodies. System prompts
|
|
remain excluded. Provider-internal `thinking` and `redacted_thinking` payloads
|
|
are also excluded: compatibility attributes retain only a redacted structural
|
|
marker, while GenAI message attributes omit those parts.
|
|
|
|
`toolInputs`/`toolOutputs` content is captured for the built-in agent
|
|
runtime's tool executions (`openclaw.content.tool_input` and
|
|
`gen_ai.tool.call.arguments` on completed/error spans;
|
|
`openclaw.content.tool_output` and `gen_ai.tool.call.result` on completed
|
|
spans). The `openclaw.content.*` names remain the stable OpenClaw attribute
|
|
names; the `gen_ai.tool.call.*` copies mirror them for semconv-native viewers.
|
|
External harness tool calls (Codex, Claude CLI) emit
|
|
`tool.execution.*` spans without content payloads. Captured content travels on a
|
|
trusted, listener-only channel and is never placed on the public diagnostic event
|
|
bus.
|
|
|
|
## Sampling and flushing
|
|
|
|
- **Traces:** `diagnostics.otel.sampleRate` sets a `TraceIdRatioBasedSampler`
|
|
on the root span only (`0.0` drops all, `1.0` keeps all). Unset uses the
|
|
OpenTelemetry SDK default (always-on).
|
|
- **Metrics:** `diagnostics.otel.flushIntervalMs` (clamped to a minimum of
|
|
`1000`); unset uses the SDK's periodic-export default.
|
|
- **Logs:** OTLP logs respect `logging.level` (file log level) and use the
|
|
diagnostic log-record redaction path, not console formatting. High-volume
|
|
installs should prefer OTLP collector sampling/filtering over local
|
|
sampling. Set `diagnostics.otel.logsExporter: "stdout"` when your platform
|
|
already ships stdout/stderr to a log processor and you have no OTLP logs
|
|
collector. Stdout records are one JSON object per line with `ts`, `signal`,
|
|
`service.name`, severity, body, redacted attributes, and trusted trace
|
|
fields when available.
|
|
- **File-log correlation:** JSONL file logs include top-level `traceId`,
|
|
`spanId`, `parentSpanId`, and `traceFlags` when the log call carries a valid
|
|
diagnostic trace context, letting log processors join local log lines with
|
|
exported spans.
|
|
- **Request correlation:** Gateway HTTP requests and WebSocket frames create
|
|
an internal request trace scope. Logs and diagnostic events inside that
|
|
scope inherit the request trace by default, while agent run and model-call
|
|
spans are created as children so provider `traceparent` headers stay on the
|
|
same trace.
|
|
- **Model-call correlation:** `openclaw.model.call` spans include safe prompt
|
|
component sizes by default and per-call token attributes when the provider
|
|
result exposes usage. `openclaw.model.usage` remains the run-level
|
|
accounting span for aggregate cost, context, and channel dashboards, and
|
|
stays on the same diagnostic trace when the emitting runtime has trusted
|
|
trace context.
|
|
|
|
### Model-call observation units
|
|
|
|
Every `openclaw.model.call` span identifies what its lifecycle measures through
|
|
`openclaw.model_call.observation_unit`:
|
|
|
|
- `request` - one observable model/provider request. Native embedded model
|
|
calls use this unit, and exporters treat a missing value as `request` for
|
|
compatibility with older or external emitters.
|
|
- `turn` - one opaque agent CLI turn that may contain hidden model requests,
|
|
retries, tool work, or background work. Claude Code CLI and Codex app-server
|
|
calls use this unit.
|
|
|
|
Both units remain model-call spans so trace backends can render model input,
|
|
output, usage, and hierarchy. Request spans use the API-derived GenAI operation
|
|
(`chat`, `generate_content`, or `text_completion`), while turn spans use
|
|
`gen_ai.operation.name = invoke_agent`. Both contribute to
|
|
`gen_ai.client.operation.duration`, where the operation name keeps direct
|
|
request latency separate from full-turn latency. OpenClaw's OTEL model-call
|
|
metrics also include `openclaw.model_call.observation_unit`; the Prometheus
|
|
model-call metrics expose the equivalent `observation_unit` label.
|
|
|
|
### Claude Code CLI model-call fidelity
|
|
|
|
Claude Code CLI turns emit one synthetic, turn-level `openclaw.model.call`
|
|
span. These are not Anthropic HTTP request spans. They use `openclaw.api =
|
|
claude-code`, `openclaw.model_call.observation_unit = turn`, and identify
|
|
the operation as `gen_ai.operation.name = invoke_agent`. They identify
|
|
OpenClaw's CLI boundary through
|
|
`openclaw.transport`:
|
|
|
|
- `stdio` - one-shot local Claude Code process.
|
|
- `stdio-live` - one turn on a managed persistent Claude stdio session.
|
|
- `paired-node-cli` - one-shot Claude Code execution delegated to a paired
|
|
node.
|
|
|
|
Claude CLI diagnostics are instantiated only while the process diagnostic
|
|
dispatcher is enabled and an internal or trusted event listener is attached.
|
|
With no observability plugin or other listener active, Claude CLI turns skip
|
|
the synthetic trace hierarchy, content buffers, and diagnostic stream-byte
|
|
accounting. When content capture is enabled, prompt and system-prompt fields
|
|
are capped at 128 KiB each; assistant output is capped at 128 KiB across at
|
|
most 200 envelopes, with 16 KiB and one item reserved for a final visible
|
|
fallback response. A marker records truncation when the limit is reached.
|
|
|
|
OpenClaw gives Claude CLI turns the same ownership hierarchy used by other
|
|
agent runtimes: `openclaw.harness.run` (`openclaw.harness.id = claude-cli`)
|
|
contains `openclaw.run`, which contains the Claude `openclaw.model.call`
|
|
span. The harness and run spans are synthetic OpenClaw turn boundaries, not
|
|
Claude Code internal phases. One-shot and managed stdio turns use the same
|
|
hierarchy; a real fresh-session retry creates another model-call child inside
|
|
the same OpenClaw run.
|
|
|
|
The span starts when OpenClaw admits the prepared CLI turn and ends only after
|
|
that turn succeeds or fails. For managed sessions, an interim success result
|
|
does not end the span while Claude reports result-holding background agents or
|
|
workflows; the final post-drain result does. Abort, timeout, process failure,
|
|
output/parse failure, and other turn failures end the same span with an error.
|
|
|
|
Claude Code reports per-assistant-message usage and may also report cumulative
|
|
usage on its terminal result. OpenClaw reply accounting continues to use the
|
|
last assistant message so existing cost semantics do not change; the
|
|
turn-level model-call span uses terminal cumulative usage when available,
|
|
including cache-read and cache-creation tokens.
|
|
|
|
For these CLI spans, byte and timing fields describe the observable OpenClaw
|
|
CLI boundary:
|
|
|
|
- `openclaw.model_call.request_bytes` is the UTF-8 size of the prompt value
|
|
sent over one-shot stdin/argv, or the managed stdio JSONL user envelope. It
|
|
is not the size of Claude Code's hidden model request.
|
|
- `openclaw.model_call.response_bytes` is the UTF-8 size of Claude CLI stdout
|
|
observed during the turn. It is not Anthropic HTTP response size.
|
|
- `openclaw.model_call.time_to_first_byte_ms` is time to the first observable
|
|
Claude CLI stdout or stderr output. It is not network TTFB.
|
|
|
|
With `captureContent` enabled, the span exports the effective prompt OpenClaw
|
|
sends to Claude Code and visible assistant text/tool-call identity
|
|
through `gen_ai.input.messages` and `gen_ai.output.messages`. Tool arguments,
|
|
internal thinking, opaque thinking signatures, tool results, and system prompts
|
|
are omitted from the Claude assistant envelope. OpenClaw does not
|
|
claim access to Claude Code's private system prompt, hidden resumed or
|
|
compacted request payload, native internal tool schemas, raw Anthropic HTTP
|
|
request, internal retries, upstream request id, or true network TTFB. Because
|
|
Claude Code does not expose its effective native tool definitions accurately,
|
|
these spans do not populate `gen_ai.tool.definitions`.
|
|
|
|
External Claude harness tool spans remain metadata-only even when tool content
|
|
capture is enabled. As with every model span, captured Claude CLI content uses
|
|
the trusted listener-only path and the exporter's existing redaction and size
|
|
bounds; content remains off by default.
|
|
|
|
## Exported metrics
|
|
|
|
### Model usage
|
|
|
|
- `openclaw.tokens` (counter, attrs: `openclaw.token`, `openclaw.channel`, `openclaw.provider`, `openclaw.model`, `openclaw.agent`)
|
|
- `openclaw.cost.usd` (counter, attrs: `openclaw.channel`, `openclaw.provider`, `openclaw.model`)
|
|
- `openclaw.run.duration_ms` (histogram, attrs: `openclaw.channel`, `openclaw.provider`, `openclaw.model`)
|
|
- `openclaw.context.tokens` (histogram, attrs: `openclaw.context`, `openclaw.channel`, `openclaw.provider`, `openclaw.model`)
|
|
- `gen_ai.client.token.usage` (histogram, GenAI semantic-conventions metric, attrs: `gen_ai.token.type` = `input`/`output`, `gen_ai.provider.name`, `gen_ai.operation.name`, `gen_ai.request.model`)
|
|
- `gen_ai.client.operation.duration` (histogram, seconds, GenAI semantic-conventions metric for model requests and synthetic agent turns; attrs: `gen_ai.provider.name`, `gen_ai.operation.name`, `gen_ai.request.model`, optional `error.type`; turn observations use `gen_ai.operation.name = invoke_agent`)
|
|
- `openclaw.model_call.duration_ms` (histogram, attrs: `openclaw.provider`, `openclaw.model`, `openclaw.api`, `openclaw.transport`, `openclaw.model_call.observation_unit`, plus `openclaw.errorCategory` and `openclaw.failureKind` on classified errors)
|
|
- `openclaw.model_call.request_bytes` (histogram, UTF-8 byte size of the final model request payload; for Claude Code CLI, the observable prompt input/envelope described above; no raw payload content)
|
|
- `openclaw.model_call.response_bytes` (histogram, UTF-8 byte size of streamed response chunk payloads; high-frequency text, thinking, and tool-call deltas count only incremental `delta` bytes; for Claude Code CLI, observed stdout bytes; no raw response content)
|
|
- `openclaw.model_call.time_to_first_byte_ms` (histogram, elapsed time before the first streamed response event; for Claude Code CLI, first observable CLI output rather than network TTFB)
|
|
- `openclaw.model.failover` (counter, attrs: `openclaw.provider`, `openclaw.model`, `openclaw.failover.to_provider`, `openclaw.failover.to_model`, `openclaw.failover.reason`, `openclaw.failover.suspended`, `openclaw.lane`)
|
|
- `openclaw.skill.used` (counter, attrs: `openclaw.skill.name`, `openclaw.skill.source`, `openclaw.skill.activation`, optional `openclaw.agent`, optional `openclaw.toolName`)
|
|
|
|
### Message flow
|
|
|
|
- `openclaw.webhook.received` (counter, attrs: `openclaw.channel`, `openclaw.webhook`)
|
|
- `openclaw.webhook.error` (counter, attrs: `openclaw.channel`, `openclaw.webhook`)
|
|
- `openclaw.webhook.duration_ms` (histogram, attrs: `openclaw.channel`, `openclaw.webhook`)
|
|
- `openclaw.message.queued` (counter, attrs: `openclaw.channel`, `openclaw.source`)
|
|
- `openclaw.message.received` (counter, attrs: `openclaw.channel`, `openclaw.source`)
|
|
- `openclaw.message.dispatch.started` (counter, attrs: `openclaw.channel`, `openclaw.source`)
|
|
- `openclaw.message.dispatch.completed` (counter, attrs: `openclaw.channel`, `openclaw.outcome`, `openclaw.reason`, `openclaw.source`)
|
|
- `openclaw.message.dispatch.duration_ms` (histogram, attrs: `openclaw.channel`, `openclaw.outcome`, `openclaw.reason`, `openclaw.source`)
|
|
- `openclaw.message.processed` (counter, attrs: `openclaw.channel`, `openclaw.outcome`)
|
|
- `openclaw.message.duration_ms` (histogram, attrs: `openclaw.channel`, `openclaw.outcome`)
|
|
- `openclaw.message.delivery.started` (counter, attrs: `openclaw.channel`, `openclaw.delivery.kind`)
|
|
- `openclaw.message.delivery.duration_ms` (histogram, attrs: `openclaw.channel`, `openclaw.delivery.kind`, `openclaw.outcome`, `openclaw.errorCategory`)
|
|
|
|
### Talk
|
|
|
|
- `openclaw.talk.event` (counter, attrs: `openclaw.talk.event_type`, `openclaw.talk.mode`, `openclaw.talk.transport`, `openclaw.talk.brain`, `openclaw.talk.provider`)
|
|
- `openclaw.talk.event.duration_ms` (histogram, attrs: same as `openclaw.talk.event`; emitted when a Talk event reports duration)
|
|
- `openclaw.talk.audio.bytes` (histogram, attrs: same as `openclaw.talk.event`; emitted for Talk audio frame events that report byte length)
|
|
|
|
### Queues and sessions
|
|
|
|
- `openclaw.queue.lane.enqueue` (counter, attrs: `openclaw.lane`)
|
|
- `openclaw.queue.lane.dequeue` (counter, attrs: `openclaw.lane`)
|
|
- `openclaw.queue.depth` (histogram, attrs: `openclaw.lane` or `openclaw.channel=heartbeat`)
|
|
- `openclaw.queue.wait_ms` (histogram, attrs: `openclaw.lane`)
|
|
- `openclaw.session.state` (counter, attrs: `openclaw.state`, `openclaw.reason`)
|
|
- `openclaw.session.stuck` (counter, attrs: `openclaw.state`; emitted for recoverable stale session bookkeeping)
|
|
- `openclaw.session.stuck_age_ms` (histogram, attrs: `openclaw.state`; emitted for recoverable stale session bookkeeping)
|
|
- `openclaw.session.turn.created` (counter, attrs: `openclaw.agent`, `openclaw.channel`, `openclaw.trigger`)
|
|
- `openclaw.session.recovery.requested` (counter, attrs: `openclaw.state`, `openclaw.action`, `openclaw.active_work_kind`, `openclaw.reason`)
|
|
- `openclaw.session.recovery.completed` (counter, attrs: `openclaw.state`, `openclaw.action`, `openclaw.status`, `openclaw.active_work_kind`, `openclaw.reason`)
|
|
- `openclaw.session.recovery.age_ms` (histogram, attrs: same as the matching recovery counter)
|
|
- `openclaw.run.attempt` (counter, attrs: `openclaw.attempt`)
|
|
|
|
### Session liveness telemetry
|
|
|
|
A `processing` session does not age toward the built-in liveness threshold while OpenClaw observes reply, tool, status, block, or ACP runtime progress. Typing keepalives do not count as progress, so a silent model or harness can still be detected.
|
|
|
|
OpenClaw classifies sessions by the work it can still observe:
|
|
|
|
- `session.long_running`: active embedded work, model calls, or tool calls
|
|
are still making progress. Owned silent model calls also report as long-running before the built-in abort threshold, so slow or non-streaming model providers do not look like stalled gateway sessions while abort-observable.
|
|
- `session.stalled`: active work exists, but the active run has not reported
|
|
recent progress. Owned model calls switch from `session.long_running` to
|
|
`session.stalled` at or after the built-in abort threshold; ownerless
|
|
stale model/tool activity is not treated as harmless long-running work.
|
|
Stalled embedded runs stay observe-only at first, then abort-drain after
|
|
the abort threshold with no progress so queued turns behind the lane can resume.
|
|
- `session.stuck`: stale session bookkeeping with no active work, or an idle
|
|
queued session with stale ownerless model/tool activity. This releases the
|
|
affected session lane immediately after recovery gates pass.
|
|
|
|
Recovery emits structured `session.recovery.requested` and
|
|
`session.recovery.completed` events. Diagnostic session state is marked idle
|
|
only after a mutating recovery outcome (`aborted` or `released`) and only if
|
|
the same processing generation is still current.
|
|
|
|
Only `session.stuck` emits the `openclaw.session.stuck` counter, the
|
|
`openclaw.session.stuck_age_ms` histogram, and the `openclaw.session.stuck`
|
|
span. Repeated `session.stuck` diagnostics back off while the session remains
|
|
unchanged, so dashboards should alert on sustained increases rather than
|
|
every heartbeat tick. For the config knob and defaults, see
|
|
[Configuration reference](/gateway/configuration-reference#diagnostics).
|
|
|
|
Liveness warnings also emit:
|
|
|
|
- `openclaw.liveness.warning` (counter, attrs: `openclaw.liveness.reason`)
|
|
- `openclaw.liveness.event_loop_delay_p99_ms` (histogram, attrs: `openclaw.liveness.reason`)
|
|
- `openclaw.liveness.event_loop_delay_max_ms` (histogram, attrs: `openclaw.liveness.reason`)
|
|
- `openclaw.liveness.event_loop_utilization` (histogram, attrs: `openclaw.liveness.reason`)
|
|
- `openclaw.liveness.cpu_core_ratio` (histogram, attrs: `openclaw.liveness.reason`)
|
|
|
|
### Harness lifecycle
|
|
|
|
- `openclaw.harness.duration_ms` (histogram, attrs: `openclaw.harness.id`, `openclaw.harness.plugin`, `openclaw.outcome`, `openclaw.harness.phase` on errors)
|
|
|
|
### Tool execution and loop detection
|
|
|
|
- `openclaw.tool.execution.duration_ms` (histogram, attrs: `gen_ai.tool.name`, `openclaw.toolName`, `openclaw.tool.source`, `openclaw.tool.owner`, `openclaw.tool.params.kind`, plus `openclaw.errorCategory` on errors)
|
|
- `openclaw.tool.execution.blocked` (counter, attrs: `gen_ai.tool.name`, `openclaw.toolName`, `openclaw.tool.source`, `openclaw.tool.owner`, `openclaw.tool.params.kind`, `openclaw.deniedReason`)
|
|
- `openclaw.tool.loop` (counter, attrs: `openclaw.toolName`, `openclaw.loop.level`, `openclaw.loop.action`, `openclaw.loop.detector`, `openclaw.loop.count`, optional `openclaw.loop.paired_tool`; emitted when a repetitive tool-call loop is detected)
|
|
|
|
### Exec
|
|
|
|
- `openclaw.exec.duration_ms` (histogram, attrs: `openclaw.exec.target`, `openclaw.exec.mode`, `openclaw.outcome`, `openclaw.failureKind`)
|
|
|
|
### Diagnostics internals (memory, payloads, exporter health)
|
|
|
|
- `openclaw.payload.large` (counter, attrs: `openclaw.payload.surface`, `openclaw.payload.action`, `openclaw.channel`, `openclaw.plugin`, `openclaw.reason`)
|
|
- `openclaw.payload.large_bytes` (histogram, attrs: same as `openclaw.payload.large`)
|
|
- `openclaw.memory.rss_bytes` / `openclaw.memory.heap_used_bytes` / `openclaw.memory.heap_total_bytes` / `openclaw.memory.external_bytes` / `openclaw.memory.array_buffers_bytes` (histograms, no attrs; process memory samples)
|
|
- `openclaw.memory.pressure` (counter, attrs: `openclaw.memory.level`, `openclaw.memory.reason`)
|
|
- `openclaw.diagnostic.async_queue.dropped` (counter, attrs: `openclaw.diagnostic.async_queue.drop_class`; internal diagnostic-queue backpressure drops)
|
|
- `openclaw.telemetry.exporter.events` (counter, attrs: `openclaw.exporter`, `openclaw.signal`, `openclaw.status`, optional `openclaw.reason`, optional `openclaw.errorCategory`; exporter lifecycle/failure self-telemetry)
|
|
|
|
## Exported spans
|
|
|
|
- `openclaw.model.usage`
|
|
- `openclaw.channel`, `openclaw.provider`, `openclaw.model`
|
|
- Optional host-derived `openclaw.plugin` only for trusted plugin runtime completions
|
|
- `openclaw.tokens.*` (input/output/cache_read/cache_write/total)
|
|
- `gen_ai.system` by default, or `gen_ai.provider.name` when the latest GenAI semantic conventions are opted in
|
|
- `gen_ai.request.model`, `gen_ai.operation.name`, `gen_ai.usage.*`
|
|
|
|
Plugin attribution is span-only. It does not add a plugin dimension to shared
|
|
OpenTelemetry metrics or change Prometheus metric labels.
|
|
|
|
- `openclaw.run`
|
|
- `openclaw.outcome`, `openclaw.channel`, `openclaw.provider`, `openclaw.model`, `openclaw.errorCategory`
|
|
- `openclaw.model.call`
|
|
- `gen_ai.system` by default, or `gen_ai.provider.name` when the latest GenAI semantic conventions are opted in
|
|
- `gen_ai.request.model`, `gen_ai.operation.name`, `openclaw.provider`, `openclaw.model`, `openclaw.api`, `openclaw.transport`, `openclaw.model_call.observation_unit` (`request` or `turn`)
|
|
- `openclaw.errorCategory`, `error.type`, and optional `openclaw.failureKind` on errors
|
|
- `openclaw.model_call.request_bytes`, `openclaw.model_call.response_bytes`, `openclaw.model_call.time_to_first_byte_ms`
|
|
- `openclaw.model_call.prompt.input_messages_count`, `openclaw.model_call.prompt.input_messages_chars`, `openclaw.model_call.prompt.system_prompt_chars`, `openclaw.model_call.prompt.tool_definitions_count`, `openclaw.model_call.prompt.tool_definitions_chars`, `openclaw.model_call.prompt.total_chars` (safe component sizes only, no prompt text)
|
|
- `openclaw.model_call.usage.*` and `gen_ai.usage.*` when the result carries usage for that request or aggregate turn
|
|
- Span event `openclaw.provider.request` with attribute `openclaw.upstreamRequestIdHash` (bounded, hash-based) when the upstream provider result exposes a request id; raw ids are never exported
|
|
- With `OTEL_SEMCONV_STABILITY_OPT_IN=gen_ai_latest_experimental`, request spans use the latest GenAI inference span name `{gen_ai.operation.name} {gen_ai.request.model}`. Turn spans use `invoke_agent` because OpenClaw does not claim a native agent name from the opaque CLI boundary. Both use `CLIENT` span kind instead of `openclaw.model.call`.
|
|
- `openclaw.harness.run`
|
|
- `openclaw.harness.id`, `openclaw.harness.plugin`, `openclaw.outcome`, `openclaw.provider`, `openclaw.model`, `openclaw.channel`
|
|
- On completion: `openclaw.harness.result_classification`, `openclaw.harness.yield_detected`, `openclaw.harness.items.started`, `openclaw.harness.items.completed`, `openclaw.harness.items.active`
|
|
- On error: `openclaw.harness.phase`, `openclaw.errorCategory`, optional `openclaw.harness.cleanup_failed`
|
|
- `openclaw.tool.execution`
|
|
- `gen_ai.tool.name`, `gen_ai.operation.name` (`execute_tool`), `openclaw.toolName`, `openclaw.tool.source`, optional `gen_ai.tool.call.id`, `openclaw.tool.owner`, `openclaw.tool.params.*`
|
|
- Optional `openclaw.errorCategory`/`openclaw.errorCode` on errors, `openclaw.deniedReason` and `openclaw.outcome=blocked` when denied by policy or sandbox
|
|
- `openclaw.exec`
|
|
- `openclaw.exec.target`, `openclaw.exec.mode`, `openclaw.outcome`, `openclaw.failureKind`, `openclaw.exec.command_length`, `openclaw.exec.exit_code`, `openclaw.exec.exit_signal`, `openclaw.exec.timed_out`
|
|
- `openclaw.webhook.processed`
|
|
- `openclaw.channel`, `openclaw.webhook`
|
|
- `openclaw.webhook.error`
|
|
- `openclaw.channel`, `openclaw.webhook`, `openclaw.error`
|
|
- `openclaw.message.processed`
|
|
- `openclaw.channel`, `openclaw.outcome`, `openclaw.reason`
|
|
- `openclaw.message.delivery`
|
|
- `openclaw.channel`, `openclaw.delivery.kind`, `openclaw.outcome`, `openclaw.errorCategory`, `openclaw.delivery.result_count`
|
|
- `openclaw.session.stuck`
|
|
- `openclaw.state`, `openclaw.ageMs`, `openclaw.queueDepth`
|
|
- `openclaw.context.assembled`
|
|
- `openclaw.prompt.size`, `openclaw.history.size`, `openclaw.context.tokens`, `openclaw.errorCategory` (no prompt, history, response, or session-key content)
|
|
- `openclaw.tool.loop`
|
|
- `openclaw.toolName`, `openclaw.loop.level`, `openclaw.loop.action`, `openclaw.loop.detector`, `openclaw.loop.count`, optional `openclaw.loop.paired_tool` (no loop messages, params, or tool output)
|
|
- `openclaw.memory.pressure`
|
|
- `openclaw.memory.level`, `openclaw.memory.reason`, `openclaw.memory.rss_bytes`, `openclaw.memory.heap_used_bytes`, `openclaw.memory.heap_total_bytes`, `openclaw.memory.external_bytes`, `openclaw.memory.array_buffers_bytes`, optional `openclaw.memory.threshold_bytes`/`openclaw.memory.rss_growth_bytes`/`openclaw.memory.window_ms`
|
|
|
|
When content capture is explicitly enabled, model and tool spans can also
|
|
include bounded, redacted `openclaw.content.*` attributes for the specific
|
|
content classes you opted into.
|
|
|
|
## Diagnostic event catalog
|
|
|
|
The events below back the metrics and spans above. Public events are also
|
|
available for direct plugin subscription; trusted core events such as
|
|
`model.usage` are restricted to authorized internal consumers.
|
|
`run.progress` and `run.execution_phase` are direct-only lifecycle signals;
|
|
the diagnostics-otel plugin does not export them as standalone OTLP signals.
|
|
Event kinds and `run.execution_phase.phase` values are additive. TypeScript
|
|
consumers should keep default branches instead of assuming either union is
|
|
permanently exhaustive.
|
|
|
|
**Model usage**
|
|
|
|
`model.usage` is a trusted, in-process diagnostic event, not a JSONL log
|
|
record. A representative event has this shape:
|
|
|
|
```json
|
|
{
|
|
"type": "model.usage",
|
|
"ts": 1735689600000,
|
|
"seq": 42,
|
|
"provider": "openai",
|
|
"model": "gpt-5.4",
|
|
"channel": "webchat",
|
|
"agentId": "main",
|
|
"sessionId": "session-123",
|
|
"sessionKey": "agent:main:main",
|
|
"usage": {
|
|
"input": 120,
|
|
"output": 40,
|
|
"cacheRead": 30,
|
|
"cacheWrite": 10,
|
|
"promptTokens": 160,
|
|
"total": 200
|
|
},
|
|
"lastCallUsage": {
|
|
"input": 120,
|
|
"output": 40,
|
|
"cacheRead": 30,
|
|
"cacheWrite": 10,
|
|
"total": 200
|
|
},
|
|
"context": { "limit": 128000, "used": 160 },
|
|
"costUsd": 0.0012,
|
|
"durationMs": 850,
|
|
"trace": {
|
|
"traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
|
|
"spanId": "00f067aa0ba902b7",
|
|
"traceFlags": "01"
|
|
}
|
|
}
|
|
```
|
|
|
|
- `ts` is a Unix timestamp in milliseconds; `seq` is process-local.
|
|
- `usage` holds turn-level token counts. `promptTokens` includes `input`,
|
|
`cacheRead`, and `cacheWrite`; `lastCallUsage`, when available, describes the
|
|
final model call.
|
|
- `context.used` is the current prompt/context snapshot and can be lower than
|
|
`usage.total` when cached input or tool-loop calls are involved.
|
|
- Provider/model/session identifiers, token buckets, `lastCallUsage`,
|
|
`context`, `costUsd`, `durationMs`, and `trace` fields are optional.
|
|
`costUsd` is an estimate and can be absent when model pricing is unavailable;
|
|
it is not provider-reported billing. Trace context can also include
|
|
`parentSpanId`.
|
|
|
|
The Gateway's `/tmp/openclaw/openclaw-YYYY-MM-DD.log` JSONL file and
|
|
`diagnostics.otel.logsExporter: "stdout"` contain ordinary log records, not raw
|
|
`model.usage` events. Public diagnostic subscriptions and
|
|
`diagnostics.stability` do not expose trusted core usage events. The
|
|
diagnostics-otel plugin converts them to metrics such as `openclaw.tokens` and
|
|
`openclaw.cost.usd` and to `openclaw.model.usage` spans; those usage metrics
|
|
and spans intentionally omit session identifiers.
|
|
|
|
For an external integration that needs session-correlated usage, query the
|
|
authenticated Gateway instead:
|
|
|
|
```bash
|
|
openclaw gateway call sessions.usage --params '{"range":"30d","agentScope":"all"}' --json
|
|
openclaw gateway usage-cost --days 30 --all-agents --json
|
|
```
|
|
|
|
Both commands require `operator.read`. `sessions.usage` can include per-session
|
|
`sessionId`, provider/model details, and token/cost summaries; per-session usage
|
|
can be temporarily `null` while its cache refreshes. `usage-cost` provides
|
|
aggregate estimates. Omit `agentScope` or `--all-agents` to scope the report
|
|
to the default agent. For continuously updated clients,
|
|
[subscribe to session changes instead of polling usage reports](/gateway/clients#subscribe-instead-of-polling-usage).
|
|
See the [Gateway RPC method reference](/gateway/protocol#rpc-method-families)
|
|
for usage methods and request options.
|
|
|
|
**Message flow**
|
|
|
|
- `webhook.received` / `webhook.processed` / `webhook.error`
|
|
- `message.queued` / `message.processed`
|
|
- `message.delivery.started` / `message.delivery.completed` / `message.delivery.error`
|
|
|
|
**Queue and session**
|
|
|
|
- `queue.lane.enqueue` / `queue.lane.dequeue`
|
|
- `session.state` / `session.long_running` / `session.stalled` / `session.stuck`
|
|
- `run.attempt` / `run.progress`
|
|
- `run.execution_phase` (public, session-correlated embedded-runner startup milestones)
|
|
- `diagnostic.heartbeat` (aggregate counters: webhooks/queue/session)
|
|
|
|
**Harness lifecycle**
|
|
|
|
- `harness.run.started` / `harness.run.completed` / `harness.run.error` -
|
|
per-run lifecycle for the agent harness. Includes `harnessId`, optional
|
|
`pluginId`, provider/model/channel, and run id. Completion adds
|
|
`durationMs`, `outcome`, optional `resultClassification`, `yieldDetected`,
|
|
and `itemLifecycle` counts. Errors add `phase`
|
|
(`prepare`/`start`/`send`/`resolve`/`cleanup`), `errorCategory`, and
|
|
optional `cleanupFailed`.
|
|
|
|
**Exec**
|
|
|
|
- `exec.process.completed` - terminal outcome, duration, target, mode, exit
|
|
code, and failure kind. Command text and working directories are not
|
|
included.
|
|
- `exec.approval.followup_suppressed` - stale approval follow-up dropped
|
|
after a session rebound. Includes `approvalId`, `reason`
|
|
(`session_rebound`), `phase` (`direct_delivery` or `gateway_preflight`),
|
|
and the dispatcher timestamp. Session keys, routes, and command text are
|
|
not included.
|
|
|
|
## Without an exporter
|
|
|
|
Keep diagnostics events available to plugins or custom sinks without running
|
|
`diagnostics-otel`:
|
|
|
|
```json5
|
|
{
|
|
diagnostics: { enabled: true },
|
|
}
|
|
```
|
|
|
|
For targeted debug output without raising `logging.level`, use diagnostics
|
|
flags. Flags are case-insensitive and support wildcards (`telegram.*` or
|
|
`*`):
|
|
|
|
```json5
|
|
{
|
|
diagnostics: { flags: ["telegram.http"] },
|
|
}
|
|
```
|
|
|
|
Or as a one-off env override:
|
|
|
|
```bash
|
|
OPENCLAW_DIAGNOSTICS=telegram.http,telegram.payload openclaw gateway
|
|
```
|
|
|
|
Flag output goes to the standard log file (`logging.file`) and is still
|
|
redacted by the always-on log redaction policy. Full guide:
|
|
[Diagnostics flags](/diagnostics/flags).
|
|
|
|
## Disable
|
|
|
|
```json5
|
|
{
|
|
diagnostics: { otel: { enabled: false } },
|
|
}
|
|
```
|
|
|
|
Or leave `diagnostics-otel` out of `plugins.allow`, or run
|
|
`openclaw plugins disable diagnostics-otel`.
|
|
|
|
When the plugin would otherwise own NodeSDK, keep propagation available while
|
|
disabling every plugin-owned exporter, listener, health route, and stdout sink:
|
|
|
|
```bash
|
|
OTEL_SDK_DISABLED=true openclaw gateway
|
|
```
|
|
|
|
## Related
|
|
|
|
- [Logging](/logging) - file logs, console output, CLI tailing, and the Control UI Logs tab
|
|
- [Gateway logging internals](/gateway/logging) - WS log styles, subsystem prefixes, and console capture
|
|
- [Diagnostics flags](/diagnostics/flags) - targeted debug-log flags
|
|
- [Diagnostics export](/gateway/diagnostics) - operator support-bundle tool (separate from OTEL export)
|
|
- [Configuration reference](/gateway/configuration-reference#diagnostics) - full `diagnostics.*` field reference
|