Skip to content

feat(docs): document Metering & Billing plugin event dimensions - #6538

Open
gergely-kurucz-konghq wants to merge 2 commits into
fix/OM-426-mb-onboarding-guidesfrom
feat/OM-433-document-mb-plugin-event-dimensions
Open

feat(docs): document Metering & Billing plugin event dimensions#6538
gergely-kurucz-konghq wants to merge 2 commits into
fix/OM-426-mb-onboarding-guidesfrom
feat/OM-433-document-mb-plugin-event-dimensions

Conversation

@gergely-kurucz-konghq

Copy link
Copy Markdown

Description

What

  • Adds a Captured event dimensions section to the Metering & Billing plugin page (## How it works), with a table per emitted event type (kong.api_request, kong.llm_request) plus the conditional portal/application fields. Rendered from a new _data file via an include.
  • Links each guide's "Create a meter" step to that reference.

Why

The plugin page said it "captures standard Kong Gateway metadata" but never listed the fields it emits — that dimension catalog was undocumented. The how-to guides show only a curated subset, so readers had nowhere to find the complete set.

How

Field lists are transcribed from the plugin source cloudevent.lua (create_api_event / create_ai_event). The table is data-driven (app/_data/plugins/metering-and-billing.yaml + app/_includes/plugins/metering-and-billing/event_dimensions.md), following the existing OTel metric_tables.md pattern. Operator-configured custom attributes are documented as an extension mechanism (they can't be enumerated from source). Render-checked locally: both event tables + portal table render, and both guide links resolve to #captured-event-dimensions.

Fixes https://konghq.atlassian.net/browse/OM-433

Preview Links

  • /plugins/metering-and-billing/#captured-event-dimensions
  • /metering-and-billing/get-started/#create-a-meter
  • /how-to/meter-llm-traffic/#create-a-meter

Checklist

  • Tested how-to docs. Render-verified the plugin page and both guide links locally.
  • All pages contain metadata.
  • Any new docs link to existing docs.
  • All autogenerated instructions render correctly (API, decK, Konnect, Kong Manager).
  • Style guide (capitalized gateway entities, placeholder URLs) implemented correctly.
  • Every page has a description entry in frontmatter.
  • Add new pages to the product documentation index (if applicable). — N/A, no new pages (a section on an existing page).

The plugin page said it "captures standard Kong Gateway metadata" but never
listed the fields the plugin emits on its CloudEvents. Add a "Captured event
dimensions" section under "How it works" with a table per event type
(kong.api_request, kong.llm_request) plus the conditional portal/application
fields, rendered from a new data file via an include (otel metric_tables
pattern). Fields transcribed from the plugin source cloudevent.lua.
The guides show a curated subset of meter dimensions. Add a line in each
"Create a meter" step linking to the new event dimensions reference on the
Metering & Billing plugin page for the complete list.
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@gergely-kurucz-konghq
gergely-kurucz-konghq marked this pull request as ready for review August 3, 2026 11:52
@gergely-kurucz-konghq
gergely-kurucz-konghq requested a review from a team as a code owner August 3, 2026 11:52
@lena-larionova lena-larionova self-assigned this Aug 3, 2026
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.

3 participants