Skip to content

docs: add Agent Canvas Docker observability guidance#608

Open
enyst wants to merge 2 commits into
mainfrom
docs/agent-canvas-docker-observability
Open

docs: add Agent Canvas Docker observability guidance#608
enyst wants to merge 2 commits into
mainfrom
docs/agent-canvas-docker-observability

Conversation

@enyst

@enyst enyst commented Jul 6, 2026

Copy link
Copy Markdown
Member
  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes

  • Document that the Agent Canvas Docker image runs OpenHands Agent Server and can use SDK Laminar/OTEL tracing environment variables.
  • Add built-in backend API snippets for inspecting conversations and events when a conversation is not visible in the left panel.
  • Clarify what is built in versus what is an example external backend: SDK trace instrumentation/export and conversation/event APIs are built in; Laminar, Jaeger, Grafana Tempo, Prometheus, Grafana, Datadog, Honeycomb, and New Relic are external systems.
  • Clarify that OpenHands SDK metrics are token/cost/latency tracking, not a Prometheus /metrics endpoint for Agent Canvas Docker.
  • Add Laminar and OTLP docker run examples, including Docker networking caveats for host and containerized collectors.
  • Cross-link the Agent Canvas setup page and SDK observability guide so Docker users can find the guidance.

Validation

  • git diff --check
  • uv run --with pytest --with requests --with pyyaml pytest -q tests/ -k 'not pricing' — 30 passed, 6 deselected

Note: the full docs test suite currently errors in tests/test_pricing_documentation.py because https://raw.githubusercontent.com/OpenHands/OpenHands/main/openhands/utils/llm.py returns 404; this appears unrelated to these docs changes.

This PR was created by an AI agent (OpenHands) on behalf of the user.

Co-authored-by: openhands <openhands@all-hands.dev>
@enyst enyst requested a review from xingyaoww as a code owner July 6, 2026 18:06
@mintlify

mintlify Bot commented Jul 6, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview Jul 6, 2026, 6:13 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Co-authored-by: openhands <openhands@all-hands.dev>
@enyst

enyst commented Jul 6, 2026

Copy link
Copy Markdown
Member Author

@OpenHands /codereview and /qa-changes . Consider that the doc is for people, to understand how to make it work, and make sure the examples given in this PR are accurate. Post your feedback on this PR.

@openhands-ai

openhands-ai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Uh oh! There was an unexpected error starting the job :(

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants