Skip to content

Document OTLP telemetry export - #632

Merged
archandatta merged 6 commits into
mainfrom
archand/kernel-1994/otlp-export-docs
Oct 1, 2026
Merged

archandatta merged 6 commits into
mainfrom
archand/kernel-1994/otlp-export-docs

Conversation

@archandatta

@archandatta archandatta commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • add browsers/telemetry/export.mdx, covering how to create destinations (TS, Python, CLI, dashboard), endpoint rules, selecting a destination at browser create, the OTLP record shape, delivery health, credential rotation, managed auth connections, and delete guards
  • add an "Exporting to your own backend" section and a What's next link to the telemetry overview
  • add the page to the Telemetry group in docs.json

Why

Destinations, export, the SDK methods, and the CLI commands are all shipped, but they only show up in the changelog, so a customer can't set up export from the docs. Every behavioral claim on the new page was checked against current main of kernel/kernel, kernel-images, and cli. The claims most likely to surprise readers:

  • logs only: the relay registers /v1/logs and no other signal path
  • browsers update ignores telemetry.export rather than rejecting it (per the BrowserTelemetryRequestConfig.export contract). Turning capture off stops export, and turning it back on resumes it to the same destination
  • pools reject telemetry.export on create, update, and acquire. The pool-default delete guard isn't documented because nothing customer-facing sets session_pools.otlp_destination_id yet
  • screenshot and monitor events aren't exported (otlpExcludedCategories)
  • managed auth connections store the resolved destination ID, so renaming a destination doesn't redirect later logins
  • consecutive_failures is documented only as zero or non-zero. The relay writes health on state transitions and refreshes successes about once a minute, so the stored count isn't a per-batch counter

Vendor examples are limited to Honeycomb (https://api.honeycomb.io, x-honeycomb-team) and a generic self-hosted collector, so the page makes no unverified claims about other providers' endpoints or headers.

Testing

  • mint broken-links (mint@4.2.930, the version CI pins): no broken links found
  • mint dev: /browsers/telemetry/export and /browsers/telemetry/overview render with HTTP 200
  • end to end against staging with the released SDKs (0.113.0) and CLI, exporting to a public test OTLP/HTTP receiver: created a destination, created browsers with export in TypeScript, Python, and the CLI, ran the page's console.log marker check, and confirmed a console_log record with the marker in text and the configured header arrived. Also created, updated, and logged in to a managed auth connection with the Python examples, and typechecked the TypeScript examples

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only changes with no runtime or API behavior modifications.

Overview
Adds customer-facing documentation for OTLP/HTTP telemetry export, which was previously only mentioned in the changelog.

A new Export Telemetry page (browsers/telemetry/export.mdx) walks through org-level destinations (SDK, CLI, dashboard), endpoint and header rules, binding export at browser create via telemetry.export.otlp.destination, OTLP log record shape, verification and destination health, credential rotation, managed auth parity, and delete 409 guards. It also documents behavioral edges: logs-only (/v1/logs), fixed destination on browsers update, capture toggling export, pool rejection, and non-exported screenshot/monitor categories.

The telemetry overview gains a short “Exporting to your own backend” section and a What's next link; docs.json registers the page under the Telemetry nav group.

Reviewed by Cursor Bugbot for commit 84260f0. Bugbot is set up for automated code reviews on this repo. Configure here.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
Kernel 🟢 Ready View Preview Oct 1, 2026, 1:31 PM

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

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low

Approved. This change is documentation-only.

What changed

  • browsers/telemetry/export.mdx (new): customer guide for OTLP telemetry export, with SDK and CLI examples.
  • browsers/telemetry/overview.mdx: short cross-link and a What's next entry.
  • docs.json: registers the new page in the Telemetry sidebar group.

Why this is Very Low

  • No application code, API implementation, auth, billing, or schema changes.
  • No infrastructure, CI, or deployment config. The docs.json edit only adds a navigation entry.
  • Blast radius is the docs site sidebar and two rendered pages.
  • No code owners file applies to these paths.

No existing approval was present, so this review approves the PR.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low

Approved. This change is documentation-only on the Mintlify docs site.

What changed

  • browsers/telemetry/export.mdx — new customer-facing guide for OTLP telemetry export (SDK, CLI, and dashboard examples)
  • browsers/telemetry/overview.mdx — short section and a What's next link to that guide
  • docs.json — registers the new page under the Telemetry navigation group

Why this is Very Low

  • No application, API, auth, or infrastructure code paths change
  • Blast radius is the docs site navigation and two rendered pages
  • Examples reference environment variables for credentials and do not embed secrets
  • No CODEOWNERS file is present, so code-owner review is not required

The latest update is a merge from main. The diff against main is still only these three documentation files, so the risk level is unchanged.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale Bugbot comment from a previous run.

Comment thread browsers/telemetry/export.mdx
@archandatta
archandatta requested a review from Sayan- September 28, 2026 17:22

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low

Re-checked after 7360a78 (Clarify telemetry flags for managed auth export). Risk is unchanged, so the existing approval stays in place.

What changed since the last approval

  • browsers/telemetry/export.mdx only: one sentence tightened, plus a short CLI note and example for managed auth connection update and login. No other files in that commit.

Full diff against main

  • browsers/telemetry/export.mdx (new customer guide)
  • browsers/telemetry/overview.mdx (cross-link and a What's next entry)
  • docs.json (Telemetry sidebar entry)

Why this is still Very Low

  • Documentation and navigation only. No application code, API implementation, auth, billing, schema, CI, or infrastructure changes.
  • Blast radius is the docs site: one new page, a short overview section, and a nav entry.
  • Examples use environment variables for credentials and do not embed secrets.
  • No CODEOWNERS file applies to these paths.

This review does not re-approve, because an approval from this automation is already on the PR.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@Sayan- Sayan- left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • p1: browsers/telemetry/export.mdx:64 says the dashboard shows stored header values. The dashboard strips those values before rendering and exposes only header names and blank replacement inputs.
  • p2: browsers/telemetry/export.mdx:141 starts a verification walkthrough that never generates or finds an event from the example browser. enabled: true confirms configuration, and destination-wide delivery health can reflect other sessions. Neither establishes that this browser's events arrived.
  • p2: browsers/telemetry/export.mdx:215 demonstrates managed-auth export only through the CLI. There are no TypeScript/Python examples of the connection or per-login browser.telemetry request, despite the repository's requirement for both languages.

Describe dashboard header handling accurately, add a per-browser
export check, and add TypeScript and Python managed auth examples.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 2 potential issues.

There are 3 total unresolved issues (including 1 from previous review).

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 36542c7. Configure here.

Comment thread browsers/telemetry/export.mdx
Comment thread browsers/telemetry/export.mdx Outdated
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@archandatta
archandatta merged commit 02b8d60 into main Oct 1, 2026
3 checks passed
@archandatta
archandatta deleted the archand/kernel-1994/otlp-export-docs branch October 1, 2026 13:32

This branch was successfully deployed

1 active deployment
staging — 84260f03 Deployed Oct 1, 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