Skip to content

docs(self-hosted): document cost_usd telemetry fields#30

Open
brunobuddy wants to merge 1 commit into
mainfrom
feat/telemetry-cost-fields
Open

docs(self-hosted): document cost_usd telemetry fields#30
brunobuddy wants to merge 1 commit into
mainfrom
feat/telemetry-cost-fields

Conversation

@brunobuddy
Copy link
Copy Markdown
Member

Summary

Pairs with mnfst/manifest#1888, which adds two optional cost fields to the daily telemetry payload. Update the self-hosted telemetry docs so the published "What gets sent" table matches what installs actually ship.

  • Bump the field count from thirteen to fifteen.
  • Add rows for cost_usd_total and cost_usd_by_provider with concrete examples and the same plain-language purpose column as the other rows.
  • Mark both with a footnote: optional (older installs omit them), receivers should feature-detect on presence rather than schema_version, and clarify that no new data leaves the box — cost is a rollup of token counts × the in-process pricing table.
  • Tighten the schema_version row's purpose column to call out the additive-vs-breaking rule directly, since two new fields just landed without a version bump.

Why

Without this change the public docs disagree with the actual on-wire shape as soon as mnfst/manifest#1888 ships. Operators reading the docs would think the payload tops out at thirteen fields and be surprised when their reverse-proxy or in-house telemetry sink sees cost fields.

Test plan

  • Render locally (npx mintlify dev) and confirm the new rows + footnote display correctly
  • Confirm footnote daggers (<sup>†</sup>) render in Mintlify's MDX flavor

mnfst/manifest now ships two optional cost fields in the daily
telemetry payload — cost_usd_total and cost_usd_by_provider — both
rounded to cents and derived from agent_messages.cost_usd.

Update the "What gets sent" table to fifteen rows, mark the new
fields with a footnote explaining they're optional (older installs
omit them) and that they're a rollup of token counts × pricing —
no new data leaves the box. Clarify the schema_version row to call
out the additive-vs-breaking rule.
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.

1 participant