@devries-cameron20 / composio-1 / commits / 4654d7494
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: retire platform health endpoints guide

Brendan O'Leary [zen] committed Sep 28, 2026 at 16:05 UTC 4654d7494cd98852ed7607495770c1f367e99e3b
6 files changed +32 -100
docs/content/kb/guide/meta.json
-1
@@ -20,7 +20,6 @@
20 "platform-custom-connection-data-fields",
21 "platform-file-storage",
22 "platform-google-oauth",
23 - "platform-health-endpoints",
23 "platform-microsoft-oauth",
24 "platform-pagination",
25 "platform-production-readiness",
docs/content/kb/guide/platform-health-endpoints.mdx deleted
-95
@@ -1,95 +0,0 @@
1 ----
2 -title: "Platform Health Endpoints"
3 -description: "Public reference for Composio on-prem and self-hosted health endpoints."
4 -keywords: ["health-endpoints","platform","errors-and-troubleshooting","sessions-and-execution","/kb/sdk-and-api/platform-health-endpoints","apollo","metrics-export","thermos"]
5 -sources: [{"sourcePath":"platform/health-endpoints/public.md","sourceHeading":"Apollo"},{"sourcePath":"platform/health-endpoints/public.md","sourceHeading":"Thermos"}]
6 -lastVerifiedAt: "2026-08-17"
7 -reviewAfter: "2026-11-15"
8 -freshness: "evergreen"
9 -topics: ["errors-and-troubleshooting","sessions-and-execution"]
10 -aliases: ["/kb/sdk-and-api/platform-health-endpoints","apollo","metrics-export","thermos"]
11 ----
12 -Use this only for Composio on-prem / self-hosted customers who ask whether they can monitor their Composio instance in real time. These endpoints are not general public-cloud customer endpoints.
13 -
14 -Requests must include the Composio admin token header:
15 -
16 -```http
17 -x-composio-admin-token: <COMPOSIO_ADMIN_TOKEN>
18 -```
19 -
20 -## Apollo
21 -
22 -Basic liveness:
23 -
24 -```bash
25 -curl -i "$COMPOSIO_BASE_URL/api/healthz" \
26 - -H "x-composio-admin-token: $COMPOSIO_ADMIN_TOKEN"
27 -```
28 -
29 -Success:
30 -
31 -```json
32 -{
33 - "status": "ok"
34 -}
35 -```
36 -
37 -This only confirms that Apollo can serve the request. It does not check downstream dependencies.
38 -
39 -Deep dependency health:
40 -
41 -```bash
42 -curl -sS "$COMPOSIO_BASE_URL/api/deep_healthz" \
43 - -H "x-composio-admin-token: $COMPOSIO_ADMIN_TOKEN" | jq
44 -```
45 -
46 -Example:
47 -
48 -Apollo deep health checks:
49 -
50 -- `postgres`: `SELECT 1` through Prisma.
51 -
52 -- `redis`: Redis `PING`.
53 -
54 -- `thermos`: generated Thermos client `getHealthcheck()`, which calls Thermos `GET /api`.
55 -
56 -- active object storage backend: response key is either `s3` or `azure_blob_storage`; Apollo writes a zero-byte probe object and deletes it best-effort.
57 -
58 -Important: Apollo deep health returns HTTP `200` for GET requests even when one or more dependencies are unreachable. Monitors should inspect `data.<service>.reachable`, not just HTTP status.
59 -
60 -## Thermos
61 -
62 -Basic liveness:
63 -
64 -```bash
65 -curl -i "$THERMOS_BASE_URL/api" \
66 - -H "x-composio-admin-token: $COMPOSIO_ADMIN_TOKEN"
67 -```
68 -
69 -Example:
70 -
71 -```json
72 -{
73 - "status": "ok",
74 - "time": "2026-06-19T05:37:25Z"
75 -}
76 -```
77 -
78 -Deep dependency health:
79 -
80 -```bash
81 -curl -sS "$THERMOS_BASE_URL/api/health/deep" \
82 - -H "x-composio-admin-token: $COMPOSIO_ADMIN_TOKEN" | jq
83 -```
84 -
85 -Example:
86 -
87 -Required services are `database`, `toolkit_registry_database`, and `temporal`.
88 -
89 -Thermos status behavior:
90 -
91 -- `healthy`: required services are not in `error`.
92 -
93 -- `unhealthy`: required service `database`, `toolkit_registry_database`, or `temporal` is in `error`.
94 -
95 -Thermos returns HTTP `503` only when overall status is `unhealthy`; otherwise it returns HTTP `200`.
docs/kb/manifest.json
+1 -1
@@ -891,7 +891,7 @@
891 "lastVerifiedAt": "2026-08-17",
892 "reviewAfter": "2026-11-15",
893 "freshness": "evergreen",
894 - "state": "published",
894 + "state": "retired",
895 "featured": false
896 },
897 {
docs/lib/kb/support-knowledge.ts
+1 -1
@@ -401,7 +401,7 @@ function guideFor(
401 lastVerifiedAt: document.lastReviewed,
402 reviewAfter: document.reviewBy,
403 freshness: importedFreshness(document),
404 - state: 'published',
404 + state: previousGuide?.state === 'retired' ? 'retired' : 'published',
405 featured: previousGuide?.featured ?? false,
406 ...(previousGuide?.verifyIgnoreToolSlugs?.length
407 ? { verifyIgnoreToolSlugs: previousGuide.verifyIgnoreToolSlugs }
docs/tests/static/kb-import.test.ts
+19
@@ -109,6 +109,25 @@ function previousManifest(): KbManifest {
109 }
110
111 describe('support-knowledge snapshot import', () => {
112 + test('keeps a retired guide unpublished when its public source is refreshed', () => {
113 + const sourceRoot = mkdtempSync(join(tmpdir(), 'support-knowledge-retired-'));
114 + try {
115 + writeDocument(sourceRoot, 'toolkits/github/public.md', publicDocument);
116 + const previous = previousManifest();
117 + previous.guides[0]!.state = 'retired';
118 + const snapshot = buildSupportKnowledgeSnapshot({
119 + sourceRoot,
120 + sourceCommit: 'updated-source',
121 + previousManifest: previous,
122 + now: new Date('2026-08-18T00:00:00Z'),
123 + });
124 +
125 + expect(snapshot.manifest.guides[0]?.state).toBe('retired');
126 + } finally {
127 + rmSync(sourceRoot, { recursive: true, force: true });
128 + }
129 + });
130 +
131 test('verifies the checkout repository and exact source commit', () => {
132 const sourceRoot = mkdtempSync(join(tmpdir(), 'support-knowledge-git-'));
133 git(sourceRoot, 'init');
docs/tests/static/knowledge-corpus.test.ts
+11 -2
@@ -189,7 +189,7 @@ describe('unified public knowledge corpus', () => {
189 }
190 });
191
192 - test('publishes every file in the reconciled public snapshot exactly once', () => {
192 + test('accounts for every snapshot file and excludes retired guides from public discovery', async () => {
193 const manifest = JSON.parse(
194 readFileSync(join(process.cwd(), 'kb/manifest.json'), 'utf8'),
195 ) as KbManifest;
@@ -198,7 +198,16 @@ describe('unified public knowledge corpus', () => {
198 manifest.guides.flatMap(guide => guide.sources.map(source => source.sourcePath)),
199 )].sort();
200
201 - expect(manifest.guides.every(guide => guide.state === 'published')).toBe(true);
201 + const records = await getAlgoliaSearchDocuments();
202 + const sitemapUrls = (await sitemap()).map(entry => entry.url);
203 + const llmsIndex = await (await getLlmsIndex()).text();
204 + for (const guide of manifest.guides.filter(guide => guide.state === 'retired')) {
205 + const path = `/kb/guide/${guide.slug}`;
206 + expect(getPublishedKbGuides().some(published => published.slug === guide.slug)).toBe(false);
207 + expect(records.some(record => record.canonical_url.includes(path))).toBe(false);
208 + expect(sitemapUrls.some(url => url.includes(path))).toBe(false);
209 + expect(llmsIndex).not.toContain(path);
210 + }
211 expect(guideSourcePaths).toEqual(snapshotFiles);
212 });
213 });