@devries-cameron20 / composio-1 / commits / c5513646d
Fork 0

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: remove internal infrastructure references from observability pages

Strip ClickHouse mentions, self-hosted deployment caveats, and "auto-generated reference" phrasing from developer-facing docs. Replace bare reference links with Cards-based "What to read next" sections to match the rest of the docs. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

shams haroon committed Apr 20, 2026 at 12:10 UTC c5513646d6b4c6c6ae8243691885279fc03db617
4 files changed +16 -16
docs/content/changelog/04-17-26.mdx
+1 -1
@@ -19,7 +19,7 @@ See the [tool execution logs guide](/docs/observability/logs).
19
20 ## Usage metering
21
22 -Aggregated counts of tool calls and sessions, sourced from ClickHouse. Summary endpoints return totals; breakdown endpoints group results by tool, toolkit, user, session, or project.
22 +Aggregated counts of tool calls and sessions. Summary endpoints return totals; breakdown endpoints group results by tool, toolkit, user, session, or project.
23
24 - `POST /api/v3.1/org/usage/summary` and `POST /api/v3.1/org/usage/{entity_type}` — org scope (`x-org-api-key` or org JWT).
25 - `POST /api/v3.1/project/usage/summary` and `POST /api/v3.1/project/usage/{entity_type}` — project scope (`x-api-key` or cookie).
docs/content/docs/observability/index.mdx
+1 -3
@@ -14,7 +14,7 @@ Composio exposes two v3.1 REST APIs for inspecting activity in your org or proje
14 | See how many tool calls or sessions happened in a window | [Usage summary](/docs/observability/usage#summary) |
15 | Break usage down by tool, toolkit, user, or session | [Usage breakdown](/docs/observability/usage#breakdown) |
16
17 -Logs record **individual events** and are primarily for debugging. Usage queries return **aggregated counts** from ClickHouse and are primarily for dashboards, billing integrations, and customer-facing analytics.
17 +Logs record **individual events** and are primarily for debugging. Usage queries return **aggregated counts** and are primarily for dashboards, billing integrations, and customer-facing analytics.
18
19 ## Authentication at a glance
20
@@ -30,7 +30,5 @@ The org-level usage endpoints accept a `project_id` filter so you can slice by p
30
31 ## Reference
32
33 -For full request/response schemas, see the auto-generated reference:
34 -
33 - [Organization API reference](/reference/api-reference/organization) — org-level usage endpoints
34 - [Projects API reference](/reference/api-reference/projects) — project-level usage endpoints and project-scoped APIs
docs/content/docs/observability/logs.mdx
+6 -2
@@ -144,6 +144,10 @@ curl https://backend.composio.dev/api/v3.1/logs/tool_execution/log_-jRTWClpBoVo
144 -H "x-api-key: YOUR_PROJECT_API_KEY"
145 ```
146
147 -## Reference
147 +## What to read next
148
149 -See the [Projects API reference](/reference/api-reference/projects) for the generated schema.
149 +<Cards>
150 + <Card icon={<Monitor />} title="Usage metering" href="/docs/observability/usage" description="Query aggregated tool call and session counts for dashboards and billing" />
151 + <Card icon={<Wrench />} title="Tools and toolkits" href="/docs/tools-and-toolkits" description="Understand how tools and toolkits work in Composio" />
152 + <Card icon={<Database />} title="Projects API reference" href="/reference/api-reference/projects" description="Full request and response schemas for project-level endpoints" />
153 +</Cards>
docs/content/docs/observability/usage.mdx
+8 -10
@@ -4,7 +4,7 @@ description: Query aggregated tool call and session counts for your org or proje
4 keywords: ['usage', 'metering', 'analytics', 'billing', 'observability']
5 ---
6
7 -The Usage API returns **aggregated counts** of tool calls and sessions, sourced from ClickHouse. Use it to power billing dashboards, customer-facing analytics, or internal utilization reports. For individual events, use the [Logs API](/docs/observability/logs).
7 +The Usage API returns **aggregated counts** of tool calls and sessions. Use it to power billing dashboards, customer-facing analytics, or internal utilization reports. For individual events, use the [Logs API](/docs/observability/logs).
8
9 There are two query shapes:
10
@@ -191,13 +191,11 @@ curl -X POST https://backend.composio.dev/api/v3.1/project/usage/tool_calls \
191 }'
192 ```
193
194 -## Self-hosted deployments
194 +## What to read next
195
196 -If your Composio instance is self-hosted **without ClickHouse enabled**, the usage endpoints return `500`. The Logs API does not depend on ClickHouse and remains available.
197 -
198 -## Reference
199 -
200 -See the auto-generated reference for full schemas:
201 -
202 -- [Organization API reference](/reference/api-reference/organization) — org-level usage endpoints
203 -- [Projects API reference](/reference/api-reference/projects) — project-level usage endpoints
196 +<Cards>
197 + <Card icon={<Terminal />} title="Tool execution logs" href="/docs/observability/logs" description="Debug individual tool executions with full request/response payloads" />
198 + <Card icon={<Wrench />} title="Tools and toolkits" href="/docs/tools-and-toolkits" description="Understand how tools and toolkits work in Composio" />
199 + <Card icon={<Database />} title="Organization API reference" href="/reference/api-reference/organization" description="Full request and response schemas for org-level usage endpoints" />
200 + <Card icon={<Database />} title="Projects API reference" href="/reference/api-reference/projects" description="Full request and response schemas for project-level usage endpoints" />
201 +</Cards>