Skip to content

docs: update usage reporting docs for dynamic exclusions via VRL expressions#104

Open
Copilot wants to merge 12 commits intomainfrom
copilot/update-documentation-for-changes
Open

docs: update usage reporting docs for dynamic exclusions via VRL expressions#104
Copilot wants to merge 12 commits intomainfrom
copilot/update-documentation-for-changes

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 5, 2026

  • Fix lint errors (oxfmt formatting in telemetry.mdx)

Copilot AI and others added 2 commits May 5, 2026 14:56
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 5, 2026

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the Hive Router documentation to describe excluding operations from usage reporting, including a new dynamic exclusion mechanism via VRL expressions, and refreshes related telemetry/expression references.

Changes:

  • Added an “Excluding Operations” section to usage reporting docs, documenting both legacy operation-name lists and a VRL expression-based format.
  • Expanded the telemetry configuration reference to document the exclude field’s supported formats, with examples (operation name and header-based exclusions).
  • Updated the Expressions overview page to include usage-reporting exclusion as a documented use case.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
packages/documentation/content/docs/router/observability/usage_reporting.mdx Adds a new section explaining how to exclude operations (legacy list vs VRL expression) with examples.
packages/documentation/content/docs/router/configuration/telemetry.mdx Updates the usage_reporting reference to describe/exemplify the new exclude formats.
packages/documentation/content/docs/router/configuration/expressions.mdx Adds a new bullet linking expressions to usage-reporting exclusions.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread packages/documentation/content/docs/router/configuration/telemetry.mdx Outdated
Comment thread packages/documentation/content/docs/router/configuration/telemetry.mdx Outdated
Copilot finished work on behalf of ardatan May 5, 2026 16:10
Copilot AI requested a review from ardatan May 5, 2026 16:10
@ardatan
Copy link
Copy Markdown
Member

ardatan commented May 5, 2026

@copilot resolve the merge conflicts in this pull request

…n, add ip_header

Co-authored-by: ardatan <20847995+ardatan@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented May 5, 2026

@copilot resolve the merge conflicts in this pull request

Resolved in a432e08. The only conflict was in telemetry.mdx — main added ip_header: null # default to the client_identification YAML example while our branch renamed the headers. The resolution keeps both: x-graphql-client-name/version headers and the new ip_header: null # default line.

Comment thread packages/documentation/content/docs/router/observability/usage_reporting.mdx Outdated
… exclude example

Agent-Logs-Url: https://github.com/graphql-hive/docs/sessions/261dd532-74f5-4d19-939b-eaf83497ca2b

Co-authored-by: ardatan <20847995+ardatan@users.noreply.github.com>
Agent-Logs-Url: https://github.com/graphql-hive/docs/sessions/6721615f-e464-4ce1-84f6-2be5cf3d01f0

Co-authored-by: ardatan <20847995+ardatan@users.noreply.github.com>
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.

4 participants