Skip to content

docs: add Agent Canvas Docker observability guidance - #608

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

enyst wants to merge 4 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 the OpenHands Agent Server, so SDK Laminar/OTEL tracing variables work when passed with -e.
  • Add Laminar and OTLP docker run examples, with Docker networking notes for host and containerized collectors.
  • State what the image provides (SDK trace instrumentation and export) and what it does not (a trace backend or a Prometheus /metrics endpoint).
  • Add backend API snippets for listing conversations and their most recent events, including conversations that do not appear in the left panel.
  • Say where the generated LOCAL_BACKEND_API_KEY is saved (~/.openhands/agent-canvas/api-key.txt). The entrypoint logs only the path, not the key.
  • Cross-link the Agent Canvas setup page and the SDK observability guide.

Source verification (OpenHands/OpenHands docker/entrypoint.sh, OpenHands/software-agent-sdk main)

  • The entrypoint starts openhands-agent-server with the container environment, routes /api/* to it, and uses X-Session-API-Key for the session key.
  • The SDK enables tracing when LMNR_PROJECT_API_KEY, OTEL_ENDPOINT, OTEL_EXPORTER_OTLP_TRACES_ENDPOINT, or OTEL_EXPORTER_OTLP_ENDPOINT is set; lmnr is a core SDK dependency.
  • GET /api/conversations/search and GET /api/conversations/{id}/events/search exist; event search defaults to ascending timestamps, so the example passes sort_order=TIMESTAMP_DESC.

Validation

  • uv run --with pytest --with requests --with pyyaml pytest -q tests/ -k 'not pricing': 30 passed

This PR was created by an AI agent (OpenHands) on behalf of the user, and updated on 2026-10-04 by an AI agent (Claude Opus 5.5) helping Engel Nyst (@enyst).

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
all-hands-ai 🟢 Ready View Preview Oct 9, 2026, 7:41 PM

💡 Tip: Enable Automations 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 :(

Resolve conflicts with the telemetry and Docker-in-Docker sections now on main.

- The entrypoint saves a generated API key to
  ~/.openhands/agent-canvas/api-key.txt and logs only the path, so point
  readers there instead of the container logs.
- Sort event search by TIMESTAMP_DESC so the example returns the most
  recent events, as described.
- Move tracing setup before the boundary notes, and keep the conversation
  API section separate from tracing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@enyst
enyst requested review from all-hands-bot and removed request for xingyaoww October 4, 2026 20:13
@enyst
enyst requested review from all-hands-bot and removed request for all-hands-bot October 4, 2026 21:19

This branch was successfully deployed

1 active deployment
staging — 198fa756 Deployed Oct 9, 2026 by mintlify[bot]
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