Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
docs: add observability narrative for logs + usage APIs (#3235)
## Summary Documents the v3.1 observability APIs shipped in hermes#9393 (tool execution logs) and hermes#9249 (org + project usage summary/breakdown). Three new pages under `/docs/observability` plus a sidebar entry and a changelog. Closes PLEN-1847 (usage metering) and PLEN-2096 (logs). Metrics API is intentionally descoped — not yet shipped. ## What's new - `content/docs/observability/index.mdx` — landing page with a "which API should I use?" decision table and auth scopes at a glance - `content/docs/observability/logs.mdx` — `POST /api/v3.1/logs/tool_execution` (list with filters + cursor pagination) and `GET /api/v3.1/logs/tool_execution/{id}` (full payload incl. timings, context, source, request/response bodies) - `content/docs/observability/usage.mdx` — `org` and `project` variants of `/usage/summary` and `/usage/{entity_type}` (breakdown), entity types `tool_calls` and `sessions`, group_by matrix, 366-day range cap, ClickHouse self-hosted caveat - `content/docs/meta.json` — inserts `observability` in the Features section - `content/changelog/04-17-26.mdx` — user-facing changelog entry - `.gitleaksignore` — allowlists the `curl-auth-header` false positives for the new files (placeholder `YOUR_PROJECT_API_KEY` values trip the rule; same pattern already allowlisted for `importing-existing-connections.mdx`, `common-faq.mdx`, etc.) ## Verified against a live backend All six endpoint families exercised end-to-end with real project + org keys: - project summary, project breakdown grouped by `toolkit_slug` / `tool_slug` / `user_id`, sessions by `user_id` - logs list, logs detail, cursor pagination, `toolkit_slug` / `status` filters - org summary, org breakdown by `project_id` / `toolkit_slug`, org sessions by `project_id` - 366-day range cap returns 400 `Metering_ValidationError` - auth isolation: org key on project endpoint → 401; project key on org endpoint → 401 - org `filters.project_id` correctly narrows totals to match the project-scoped summary One docs-vs-reality gap was found and fixed before publishing: the project endpoints silently accept (and ignore) `filters.project_id`, so the "Org endpoints only" wording was softened to "Only meaningful on org endpoints; ignored on project endpoints." ## Note on reference index pages The "See the reference" links on each page resolve to `/reference/api-reference/projects` and `/reference/api-reference/organization` — those pages are auto-regenerated by the `docs-update-data` cron. They won't list the new `/logs/*` and `/usage/*` rows until the next cron run opens a fresh auto-data PR. Purely cosmetic, self-healing within ~5h — no action needed on merge order. ## Test plan - [x] `bun run build` — all pages compile (1371/1371 locally) - [x] `bun run scripts/validate-links.ts` — 0 broken internal links locally - [x] All six endpoint families verified against live backend with real keys - [x] Secrets Detection passes after allowlist - [ ] Preview deploy: verify `/docs/observability`, `/docs/observability/logs`, `/docs/observability/usage` render - [ ] Changelog entry shows under 2026-04-17 :robot: Generated with [Claude Code](https://claude.com/claude-code)
No changes.