Skip to content

Repository files navigation

opencode-plugin-otel

npm versionnpm downloadsGitHub starsBuild statusDiscord notificationsLicense

An opencode plugin that exports telemetry via OpenTelemetry (OTLP over gRPC or HTTP/protobuf), mirroring the same signals as Claude Code's monitoring.

What it instruments

Metrics

MetricTypeDescription
opencode.session.countCounterIncremented on each session.created event
opencode.token.usageCounterPer token type: input, output, reasoning, cacheRead, cacheCreation
opencode.cost.usageCounterUSD cost per completed assistant message
opencode.lines_of_code.countCounterGross positive churn, not a net total. Emits the positive delta of additions/deletions since the previous session.diff for the same session; negative deltas (when opencode's cumulative additions or deletions shrinks vs. the last event) are dropped. Summing the counter therefore reports gross lines added/removed across forward transitions — it does not reconcile back to the session's current state after any revert (full or partial). Intra-message rewrites that opencode collapses in its per-message cumulative are not visible here at all. Use opencode.lines_of_code.total for the authoritative live cumulative.
opencode.lines_of_code.totalGaugeAuthoritative live cumulative lines added/removed for the session. Refreshed on every session.diff with opencode's current cumulative value. Drops back to 0 if opencode reports a revert to baseline, and tracks partial reverts faithfully. Query this (not the counter) to answer "what does this session currently amount to".
opencode.commit.countCounterGit commits detected via bash tool
opencode.tool.durationHistogramTool execution time in milliseconds
opencode.cache.countCounterCache activity per message: type=cacheRead or type=cacheCreation
opencode.session.durationHistogramSession duration from created to idle in milliseconds
opencode.message.countCounterCompleted assistant messages per session
opencode.session.token.totalHistogramTotal tokens consumed per session, recorded on idle
opencode.session.cost.totalHistogramTotal cost per session in USD, recorded on idle
opencode.model.usageCounterMessages per model and provider
opencode.retry.countCounterAPI retries observed via session.status events

Log events

EventDescription
session.createdSession started
session.idleSession went idle (includes total tokens, cost, messages)
session.errorSession error
user_promptUser sent a message (includes prompt_length, model, agent; also prompt when OPENCODE_CAPTURE_PROMPT_IN_LOGS is set)
api_requestCompleted assistant message (tokens, cost, duration)
api_errorFailed assistant message (error summary, duration)
tool_resultTool completed or errored (duration, success, output size)
tool_decisionPermission prompt answered (accept/reject)
commitGit commit detected

Installation

Add the plugin to your opencode config at ~/.config/opencode/opencode.json:

{
"$schema": "https://opencode.ai/config.json",
"plugin": ["@devtheops/opencode-plugin-otel"]
}

Or point directly at a local checkout for development:

{
"$schema": "https://opencode.ai/config.json",
"plugin": ["/path/to/opencode-plugin-otel/src/index.ts"]
}

Configuration

The plugin reads its settings from OPENCODE_* environment variables and/or from inline plugin options in opencode.json. When both are present, an option wins over the matching environment variable, which wins over the built-in default.

The environment variables (set them in your shell profile — ~/.zshrc, ~/.bashrc, etc.):

VariableDefaultDescription
OPENCODE_ENABLE_TELEMETRY(unset)Set to any non-empty value to enable the plugin
OPENCODE_OTLP_ENDPOINThttp://localhost:4317OTLP collector endpoint. Always include a URL scheme. For grpc, use the collector URL (for example http://localhost:4317 or grpc://collector:4317). For http/protobuf and http/json, use the base URL and the plugin will append /v1/traces, /v1/metrics, and /v1/logs.
OPENCODE_OTLP_PROTOCOLgrpcOTLP transport protocol: grpc, http/protobuf, or http/json
OPENCODE_OTLP_METRICS_INTERVAL60000Metrics export interval in milliseconds
OPENCODE_OTLP_LOGS_INTERVAL5000Logs export interval in milliseconds
OPENCODE_METRIC_PREFIXopencode.Prefix for all metric names (e.g. set to claude_code. for Claude Code dashboard compatibility)
OPENCODE_DISABLE_METRICS(unset)Comma-separated list of metric name suffixes to disable (e.g. cache.count,session.duration)
OPENCODE_DISABLE_LOGS(unset)Set to any non-empty value to suppress all OTLP log events while leaving metrics and traces unchanged
OPENCODE_CAPTURE_PROMPT_IN_LOGS(unset)Set to any non-empty value to include the full prompt text in the prompt attribute of user_prompt log events. Log events only — trace spans always carry the prompt in input.value regardless of this flag (disable span-level capture separately via OPENCODE_DISABLE_TRACES). Off by default — prompts may contain secrets or PII; enable only for trusted collectors.
OPENCODE_DISABLE_TRACES(unset)Comma-separated list of trace types to disable (session, llm, tool). Use all, *, true, or 1 to disable every trace type
OPENCODE_OTLP_HEADERS(unset)Comma-separated key=value headers added to all OTLP exports. Keep out of version control — may contain sensitive auth tokens.
OPENCODE_OTLP_HEADERS_HELPER(unset)Executable script/binary that returns dynamic OTLP headers as JSON after an auth failure. Helper headers override OPENCODE_OTLP_HEADERS.
OPENCODE_RESOURCE_ATTRIBUTES(unset)Comma-separated key=value pairs merged into the OTel resource. Example: service.version=1.2.3,deployment.environment=production
OPENCODE_SPAN_ATTRIBUTES(unset)Comma-separated key=value pairs attached to every emitted span, log event, and metric data point. Example: team=platform,deployment.environment=production
OPENCODE_OTLP_METRICS_TEMPORALITY(unset)Metrics aggregation temporality: delta, cumulative, or lowmemory. Required for Datadog (delta). Copied to OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE.
OPENCODE_TRACEPARENT(unset)W3C traceparent string. When set, all spans are parented under this remote context so opencode traces nest inside a caller's trace (e.g. a CI job). Invalid values are logged and ignored. Note: with the default ParentBased sampler, a value with the sampled flag off (...-00) suppresses all trace export.
OPENCODE_TRACESTATE(unset)W3C tracestate string, parsed alongside OPENCODE_TRACEPARENT and attached to the remote parent context. Ignored unless a valid OPENCODE_TRACEPARENT is also set.
OPENCODE_TRACE_PROPAGATION_PROVIDERS(unset)Comma-separated opencode provider IDs that receive W3C traceparent and tracestate headers on LLM requests. Use * to explicitly enable every provider.

Prompt logging remains disabled by default. Enable it only when the configured telemetry destination is trusted to receive potentially sensitive prompt contents.

Plugin options (opencode.json)

Every setting can also be passed inline through opencode's plugin tuple form, so nothing has to be exported in a shell. Options take precedence over the matching OPENCODE_* environment variable, which in turn wins over the built-in default.

{
"$schema": "https://opencode.ai/config.json",
"plugin": [
["@devtheops/opencode-plugin-otel", {
"enabled": true,
"endpoint": "http://localhost:4317",
"protocol": "grpc",
"metricPrefix": "claude_code.",
"resourceAttributes": "service.version=1.2.3,deployment.environment=production",
"disabledTraces": ["tool"]
}]
]
}

Option keys mirror the resolved config and map to the environment variables:

OptionEnvironment variable
enabledOPENCODE_ENABLE_TELEMETRY
logsEnabledOPENCODE_DISABLE_LOGS (inverted)
capturePromptInLogsOPENCODE_CAPTURE_PROMPT_IN_LOGS
endpointOPENCODE_OTLP_ENDPOINT
protocolOPENCODE_OTLP_PROTOCOL
metricsIntervalOPENCODE_OTLP_METRICS_INTERVAL
logsIntervalOPENCODE_OTLP_LOGS_INTERVAL
metricPrefixOPENCODE_METRIC_PREFIX
otlpHeadersOPENCODE_OTLP_HEADERS
otlpHeadersHelperOPENCODE_OTLP_HEADERS_HELPER
resourceAttributesOPENCODE_RESOURCE_ATTRIBUTES
spanAttributesOPENCODE_SPAN_ATTRIBUTES
traceparentOPENCODE_TRACEPARENT
tracestateOPENCODE_TRACESTATE
metricsTemporalityOPENCODE_OTLP_METRICS_TEMPORALITY
disabledMetricsOPENCODE_DISABLE_METRICS (array, not a comma string)
disabledTracesOPENCODE_DISABLE_TRACES (array, not a comma string)
tracePropagationProvidersOPENCODE_TRACE_PROPAGATION_PROVIDERS (array, not a comma string)

Security note:opencode.json is frequently committed to version control. Keep secrets such as otlpHeaders in an environment variable or an opencode {env:VAR} substitution (e.g. "otlpHeaders": "{env:OTEL_HEADERS}") rather than inline.

Quick start

export OPENCODE_ENABLE_TELEMETRY=1
export OPENCODE_OTLP_ENDPOINT=http://localhost:4317
export OPENCODE_OTLP_PROTOCOL=grpc
opencode

Always set OPENCODE_OTLP_ENDPOINT to a full URL with a scheme. Scheme-less values like localhost:4317 are rejected.

For OPENCODE_OTLP_PROTOCOL=http/protobuf or OPENCODE_OTLP_PROTOCOL=http/json, set OPENCODE_OTLP_ENDPOINT to the collector base URL rather than a per-signal path. The plugin expands it to /v1/traces, /v1/metrics, and /v1/logs automatically.

Headers and resource attributes

# Auth token for a managed collector (e.g. Honeycomb, Grafana Cloud)export OPENCODE_OTLP_HEADERS="x-honeycomb-team=your-api-key,x-honeycomb-dataset=opencode"# Tag every metric and log with deployment contextexport OPENCODE_RESOURCE_ATTRIBUTES="service.version=1.2.3,deployment.environment=production"# Tag every span, log event, and metric point with filterable attributesexport OPENCODE_SPAN_ATTRIBUTES="team=platform,deployment.environment=production"

Security note:OPENCODE_OTLP_HEADERS typically contains auth tokens. Set it in your shell profile (~/.zshrc, ~/.bashrc) or a secrets manager — never commit it to version control or print it in CI logs.

OPENCODE_RESOURCE_ATTRIBUTES and OPENCODE_SPAN_ATTRIBUTES are independent:

  • Use OPENCODE_RESOURCE_ATTRIBUTES for producer metadata on the OTel Resource.
  • Use OPENCODE_SPAN_ATTRIBUTES for attributes that need to appear on each span, log event, and metric data point for filtering or grouping in backends.

Dynamic headers

Use OPENCODE_OTLP_HEADERS_HELPER when your collector requires short-lived authentication tokens. When this is set, the plugin prewarms the helper once during startup so the first export can use fresh credentials. If a later OTLP export fails with an authentication error (401/403 for HTTP or UNAUTHENTICATED/PERMISSION_DENIED for gRPC), the plugin refreshes headers again, rebuilds the exporter, and retries the failed export once.

export OPENCODE_OTLP_HEADERS_HELPER=/path/to/opencode-otel-headers.sh

Use an absolute helper path. If you need the path to follow the current project, OPENCODE_OTLP_HEADERS_HELPER also supports ${PROJECT_ROOT}, ${WORKTREE}, and ${DIRECTORY} placeholders.

export OPENCODE_OTLP_HEADERS_HELPER='${PROJECT_ROOT}/scripts/opencode-otel-headers.sh'

The helper must be executable and print a JSON object to stdout:

#!/bin/shprintf'{"Authorization":"Bearer %s"}'"$(get-token.sh)"

For a Cloud Run collector using IAM authentication, get-token.sh might be gcloud auth print-identity-token.

If OPENCODE_OTLP_HEADERS is also set, helper-provided headers override static headers with the same name. Header values are never logged.

LLM trace propagation

Use OPENCODE_TRACE_PROPAGATION_PROVIDERS to connect this plugin's LLM spans to spans emitted by an LLM gateway such as LiteLLM or vLLM. For matching provider IDs, the plugin injects the current opencode.llm span as the W3C traceparent header and includes tracestate when present.

export OPENCODE_TRACE_PROPAGATION_PROVIDERS="company-litellm,vllm"

The values are opencode provider IDs, including custom names configured under the provider key in opencode.json. Propagation is disabled when the setting is unset. Use * only when every configured provider should receive trace context.

Only W3C trace context is propagated. The plugin does not inject arbitrary headers or W3C baggage. Configure static provider-specific headers through the provider's native options.headers setting in opencode.json.

Disabling specific metrics

Use OPENCODE_DISABLE_METRICS to suppress individual metrics. The value is a comma-separated list of metric name suffixes (without the prefix).

Disabling a metric only stops the counter/histogram from being incremented — the corresponding log events are still emitted.

# Disable a single metricexport OPENCODE_DISABLE_METRICS="retry.count"# Disable multiple metricsexport OPENCODE_DISABLE_METRICS="cache.count,session.duration,session.token.total,session.cost.total,model.usage,retry.count,message.count"# Disable the new per-session cumulative gauge while keeping the delta counterexport OPENCODE_DISABLE_METRICS="lines_of_code.total"

opencode-only metrics

The following metrics are specific to opencode and have no equivalent in Claude Code's built-in monitoring. If you are using a Claude Code dashboard and want to avoid cluttering it with opencode-only metrics, you can disable them:

export OPENCODE_DISABLE_METRICS="cache.count,session.duration,session.token.total,session.cost.total,model.usage,retry.count,message.count"
Metric suffixWhy it's opencode-only
cache.countTracks cache read/write activity as occurrence counts — not a Claude Code signal
session.durationSession wall-clock duration — not emitted by Claude Code
session.token.totalPer-session token histogram — not emitted by Claude Code
session.cost.totalPer-session cost histogram — not emitted by Claude Code
model.usagePer-model message counter — not emitted by Claude Code
retry.countAPI retry counter — not emitted by Claude Code
message.countCompleted message counter — not emitted by Claude Code

Disabling OTLP logs

Use OPENCODE_DISABLE_LOGS to suppress every OTLP log event emitted by the plugin.

export OPENCODE_DISABLE_LOGS=1

This only disables OTLP logs. Metrics and traces continue to be exported unless they are disabled separately.

Disabling traces

Use OPENCODE_DISABLE_TRACES to suppress one or more trace types.

# Disable one trace typeexport OPENCODE_DISABLE_TRACES="tool"# Disable multiple trace typesexport OPENCODE_DISABLE_TRACES="llm,tool"# Disable every trace type explicitlyexport OPENCODE_DISABLE_TRACES="all"

Accepted explicit "disable all traces" values are all, *, true, and 1.

SigNoz example

export OPENCODE_ENABLE_TELEMETRY=1
export OPENCODE_OTLP_ENDPOINT="https://ingest.us.signoz.cloud:443"export OPENCODE_OTLP_HEADERS="signoz-ingestion-key=<SIGNOZ_INGESTION_KEY>"

Use https://ingest.in.signoz.cloud:443 for India, https://ingest.eu2.signoz.cloud:443 for EU2, etc. See SigNoz setup docs for all regions.

Datadog example

export OPENCODE_ENABLE_TELEMETRY=1
export OPENCODE_OTLP_ENDPOINT=https://otlp.datadoghq.com
export OPENCODE_OTLP_PROTOCOL=http/protobuf
export OPENCODE_OTLP_HEADERS="dd-api-key=YOUR_DATADOG_API_KEY"# Required — Datadog's OTLP intake only accepts delta temporalityexport OPENCODE_OTLP_METRICS_TEMPORALITY=delta

Note: The endpoint is otlp.datadoghq.com (not api.datadoghq.com). Use otlp.datadoghq.eu for EU, otlp.us3.datadoghq.com for US3, etc. See Datadog OTLP docs for all regions.

Honeycomb example

export OPENCODE_ENABLE_TELEMETRY=1
export OPENCODE_OTLP_ENDPOINT=https://api.honeycomb.io
export OPENCODE_OTLP_PROTOCOL=http/protobuf

Grafana Cloud example

export OPENCODE_ENABLE_TELEMETRY=1
export OPENCODE_OTLP_ENDPOINT=https://otlp-gateway-prod-us-central-0.grafana.net/otlp
export OPENCODE_OTLP_PROTOCOL=http/protobuf
export OPENCODE_OTLP_HEADERS="Authorization=Basic <base64-instance-id:api-key>"

Claude Code dashboard compatibility

export OPENCODE_METRIC_PREFIX=claude_code.

Local development

See CONTRIBUTING.md.

GitHub Discord notifications

This repo includes a reusable workflow at .github/workflows/discord-notify.yml that posts a Discord embed for supported GitHub events. The included .github/workflows/discord-events.yml file wires it up for:

  • issues.opened
  • pull_request.opened
  • release.published

Set an org or repo secret named DISCORD_WEBHOOK and the workflow will post to that webhook automatically.

To reuse it from another repository in the DEVtheOPS org:

name: Discord Eventson:
issues:
types: [opened]pull_request:
types: [opened]release:
types: [published]jobs:
notify-discord:
uses: DEVtheOPS/opencode-plugin-otel/.github/workflows/discord-notify.yml@mainwith:
username: DEVtheOPS Bottitle_prefix: "[DEVtheOPS]"include_body: truesecrets:
discord_webhook: ${{ secrets.DISCORD_WEBHOOK }}

Available workflow inputs:

  • username: webhook display name
  • avatar_url: webhook avatar image URL
  • title_prefix: optional title prefix for the embed
  • include_body: include the issue, PR, or release body in the card
  • color: fallback embed color for unsupported events

About

An opencode plugin that exports telemetry via OpenTelemetry (OTLP/gRPC), mirroring the same signals as Claude Code's monitoring.

Resources

Contributing

Security policy

Stars

119 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages