Skip to content

docs: document infer traces command and /traces shortcut#393

Merged
edenreich merged 1 commit into
mainfrom
docs/issue-390-20260714-1140
Jul 14, 2026
Merged

docs: document infer traces command and /traces shortcut#393
edenreich merged 1 commit into
mainfrom
docs/issue-390-20260714-1140

Conversation

@inference-gateway-maintainer

Copy link
Copy Markdown
Contributor

Summary

Documents the new infer traces command and /traces chat shortcut (from inference-gateway/cli#908, closing inference-gateway/cli#903), plus the local trace files they read.

  • CLI command reference (cli.md): added infer stats and infer traces to the Core Commands table, and a new "Viewing traces" section covering infer traces [session-id], --list, --format json, the indented span-tree example, the JSON output shape, and the [error: ...] marker for failed spans. The viewer reads the per-session trace file offline, with no OTLP collector required.
  • Chat shortcuts (cli.md): added /stats and /traces to the Built-in Shortcuts table and a new "Telemetry Shortcuts" section.
  • Telemetry / observability (observability.md): the CLI Telemetry section now notes that traces are recorded locally per session and can be rendered offline with infer traces.

infer stats / /stats were referenced in the docs but not listed in the command and shortcut tables; added them alongside traces for coherence, matching the pairing described in the issue.

Verified with bun run format:check, bun run lint:md, and bun run build (all pass).

Note for reconciliation

The issue states traces require telemetry.enabled: true, but cli.md currently documents CLI telemetry as "always on - there is no opt-out switch." I kept the new content consistent with that committed wording. If the CLI now gates trace recording behind a config flag, the Telemetry section's "always on" statement should be updated as well.

Closes #390

@inference-gateway-maintainer
inference-gateway-maintainer Bot requested a review from a team as a code owner July 14, 2026 11:53
@edenreich
edenreich merged commit b938a19 into main Jul 14, 2026
6 checks passed
@edenreich
edenreich deleted the docs/issue-390-20260714-1140 branch July 14, 2026 11:59
inference-gateway-releaser Bot added a commit that referenced this pull request Jul 18, 2026
## [0.9.2](0.9.1...0.9.2) (2026-07-18)

### 📚 Documentation

* add CLI telemetry documentation for traces, logs, and metrics ([#392](#392)) ([f8bfcdc](f8bfcdc))
* **adk:** align telemetry docs with A2A_TELEMETRY_ENABLE as single trace gate ([#403](#403)) ([fea405f](fea405f)), references [inference-gateway/adk#234](inference-gateway/adk#234)
* **adl-cli,adk:** document OTel service.name/service.version from ADL manifest metadata ([#408](#408)) ([be1b66e](be1b66e))
* **adl-cli:** move generated skills to .agents/skills layout ([#421](#421)) ([2e4e925](2e4e925))
* align ADK telemetry config with OpenTelemetry ([#400](#400)) ([aa0a862](aa0a862))
* **cli-channels:** document channels-manager OTLP telemetry setup ([#415](#415)) ([283ddff](283ddff))
* **cli,a2a:** document A2A agent liveness probes ([#425](#425)) ([5844ea9](5844ea9)), closes [#424](#424)
* **cli:** document distributed tracing - infer traces, telemetry.receiver_address, a2a-traces example ([#406](#406)) ([4fc24f5](4fc24f5)), references [inference-gateway/cli#909](inference-gateway/cli#909)
* document /tasks output panel and agent inherit_mock ([#388](#388)) ([7f3d72b](7f3d72b))
* document built-in skills and tmux skill ([#386](#386)) ([fc013ab](fc013ab))
* document extended spec.telemetry otel exporter fields ([#399](#399)) ([712f6de](712f6de))
* document infer traces command and /traces shortcut ([#393](#393)) ([b938a19](b938a19))
* document infer-action workflow for infer orchestrator ([#396](#396)) ([4e1d792](4e1d792))
* document W3C trace propagation and OTLP span ingestion ([#394](#394)) ([f26494c](f26494c))
* **llamacpp:** add llama.cpp provider documentation ([#417](#417)) ([356f9ac](356f9ac))
* note Go SDK retry cancellation preserves HTTP error ([#382](#382)) ([e39bcab](e39bcab))
* **observability:** document OTEL_METRICS_EXPORTER and Prometheus pull env vars ([#412](#412)) ([b450177](b450177)), closes [#409](#409)
* **operator:** add Orchestrator CRD telemetry reference ([#413](#413)) ([8210e06](8210e06))
* **rust-adk:** document A2A_OTEL_TRACES_EXPORTER trace gating ([#407](#407)) ([29c5f67](29c5f67))
* **sdks:** add llamacpp to supported providers list ([#422](#422)) ([ed2a466](ed2a466))
* **sdks:** document python responses api and zai provider ([#423](#423)) ([c5b608e](c5b608e))

### 🔧 Miscellaneous

* **deps-dev:** bump the bun group with 2 updates ([#384](#384)) ([fc813d8](fc813d8))
* **deps:** bump infer CLI v0.141.0 -> v0.147.1 ([#411](#411)) ([03b6342](03b6342))
* **release:** update GitHub App credentials to use RELEASER_APP_ID and RELEASER_APP_PRIVATE_KEY ([4275006](4275006))
@inference-gateway-releaser

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 0.9.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] Document infer traces command and /traces shortcut

1 participant