feat(docs): document Metering & Billing plugin event dimensions - #6538
Open
gergely-kurucz-konghq wants to merge 2 commits into
Open
Conversation
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.
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
What
## 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_datafile via an include.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 OTelmetric_tables.mdpattern. Operator-configured customattributesare 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
Checklist
descriptionentry in frontmatter.