Skip to content

feat(opentelemetry): allow more customization for hive tracing setup #1611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

feat(opentelemetry): allow more customization for hive tracing setup #1611

wants to merge 8 commits into from
+256 −170

Conversation

@EmrysMyrddin
Copy link
Collaborator

@EmrysMyrddin EmrysMyrddin commented Oct 14, 2025 •
edited
Loading

This PR allows to pass the same configuration options that can be passed to the classic openTelemetrySetup.

The main interest is to allow user to define its own resource (with service name and version) and it's own samplingRate to limit the Hive Console Tracing traffic.

Copilot AI review requested due to automatic review settings October 14, 2025 14:47
Copilot AI reviewed Oct 14, 2025
View reviewed changes
Copy link
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 refactors the OpenTelemetry tracing setup to allow more customization for Hive tracing configuration. It extracts common options into a reusable BaseOptions type and simplifies resource creation logic.

  • Extracted BaseOptions type from the original OpentelemetrySetupOptions to enable reuse across different setup functions
  • Refactored resource creation logic into a dedicated createResource helper function for better maintainability
  • Updated hiveTracingSetup to accept BaseOptions and provide default service name/version attributes

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

packages/plugins/opentelemetry/src/setup.ts Outdated
Comment on lines 298 to 300
export type HiveTracingSetupOptions = BaseOptions & HiveTracingOptions;

export function hiveTracingSetup(config: HiveTracingSetupOptions) {
Copy link

Copilot AI Oct 14, 2025

Choose a reason for hiding this comment

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

The hiveTracingSetup function signature change removes the contextManager and log parameters that were previously required. This is a breaking change - existing callers that pass these parameters separately will fail. Consider maintaining backward compatibility or documenting this as a breaking change.

Copilot uses AI. Check for mistakes.
packages/plugins/opentelemetry/src/setup.ts
return baseResource.merge(
resourceFromAttributes({
[ATTR_SERVICE_NAME]: userResource.serviceName,
[ATTR_SERVICE_VERSION]: userResource.serviceVersion,
Copy link

Copilot AI Oct 14, 2025

Choose a reason for hiding this comment

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

Potential undefined access: userResource.serviceVersion is accessed without checking if it exists. If userResource has serviceName but not serviceVersion, this will set the service version to undefined.

Suggested change
[ATTR_SERVICE_VERSION]: userResource.serviceVersion,
...(userResource.serviceVersion !== undefined && { [ATTR_SERVICE_VERSION]: userResource.serviceVersion }),

Copilot uses AI. Check for mistakes.
@theguild-bot
Copy link
Collaborator

theguild-bot commented Oct 14, 2025 •
edited
Loading

🚀 Snapshot Release (alpha)

The latest changes of this PR are available as alpha on npm (based on the declared changesets):

Package Version Info
@graphql-tools/batch-delegate 10.0.2-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-tools/delegate 11.0.2-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-tools/federation 4.0.6-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-mesh/fusion-runtime 1.2.6-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-hive/gateway 2.1.11-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-hive/logger 1.0.7-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-hive/nestjs 2.0.16-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-hive/plugin-aws-sigv4 2.0.11-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-hive/plugin-opentelemetry 1.1.0-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-mesh/plugin-prometheus 2.0.14-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-hive/gateway-runtime 2.1.10-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-tools/stitch 10.0.3-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-tools/stitching-directives 4.0.2-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-mesh/transport-common 1.0.7-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-mesh/transport-http 1.0.7-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-mesh/transport-http-callback 1.0.7-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-mesh/transport-ws 2.0.7-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎
@graphql-tools/wrap 11.0.2-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84 npm ↗︎ unpkg ↗︎

@theguild-bot
Copy link
Collaborator

theguild-bot commented Oct 14, 2025 •
edited
Loading

🚀 Snapshot Release (Binary for Linux-ARM64)

The latest changes of this PR are available for download (based on the declared changesets).

Download

@theguild-bot
Copy link
Collaborator

theguild-bot commented Oct 14, 2025 •
edited
Loading

🚀 Snapshot Release (Binary for Linux-X64)

The latest changes of this PR are available for download (based on the declared changesets).

Download

@theguild-bot
Copy link
Collaborator

theguild-bot commented Oct 14, 2025 •
edited
Loading

🚀 Snapshot Release (Binary for macOS-ARM64)

The latest changes of this PR are available for download (based on the declared changesets).

Download

@theguild-bot
Copy link
Collaborator

theguild-bot commented Oct 14, 2025 •
edited
Loading

🚀 Snapshot Release (Binary for Windows-X64)

The latest changes of this PR are available for download (based on the declared changesets).

Download

@theguild-bot
Copy link
Collaborator

theguild-bot commented Oct 14, 2025 •
edited
Loading

🚀 Snapshot Release (Binary for macOS-X64)

The latest changes of this PR are available for download (based on the declared changesets).

Download

@theguild-bot
Copy link
Collaborator

theguild-bot commented Oct 14, 2025 •
edited
Loading

🚀 Snapshot Release (Node Docker Image)

The latest changes of this PR are available as image on GitHub Container Registry (based on the declared changesets):

ghcr.io/graphql-hive/gateway:2.1.11-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84

@theguild-bot
Copy link
Collaborator

theguild-bot commented Oct 14, 2025 •
edited
Loading

🚀 Snapshot Release (Bun Docker Image)

The latest changes of this PR are available as image on GitHub Container Registry (based on the declared changesets):

ghcr.io/graphql-hive/gateway:2.1.11-alpha-c7cbc7a0bab8db3c4c9bf185db48a118d6612a84-bun

@n1ru4l n1ru4l self-requested a review October 14, 2025 18:26
@EmrysMyrddin EmrysMyrddin requested a review from Copilot October 27, 2025 09:56
Copilot AI reviewed Oct 27, 2025
View reviewed changes
Copy link
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

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

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

@EmrysMyrddin EmrysMyrddin force-pushed the feat/otel/error-based-sampling branch from ef2d546 to 22c9152 Compare October 27, 2025 10:34
@EmrysMyrddin EmrysMyrddin enabled auto-merge (squash) October 27, 2025 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@n1ru4l n1ru4l Awaiting requested review from n1ru4l

@enisdenjo enisdenjo Awaiting requested review from enisdenjo

@ardatan ardatan Awaiting requested review from ardatan

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@EmrysMyrddin @theguild-bot