Skip to content

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

Open
Copilot wants to merge 14 commits into
mainfrom
copilot/update-documentation-for-changes
Open

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

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 5, 2026

  • Inspect PR comment and current Apollo Router usage reporting docs
  • Run existing validation commands before edits (bun run lint, bun run build, bun run test); build passes, lint has pre-existing warnings, and tests currently fail because http://localhost:1440 is already in use
  • Add the matching usage-reporting docs/example to packages/documentation/content/docs/other-integrations/apollo-router.mdx
  • Re-run relevant formatting/lint checks for the updated docs
  • Run final validation

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 AI temporarily deployed to storybook-preview May 5, 2026 19:00 Inactive
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>
@dotansimha
Copy link
Copy Markdown
Member

Copilot AI and others added 2 commits May 11, 2026 17:33
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.

5 participants