feat(opentelemetry): circuit breaker in hive tracing

[ardatan]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @ardatan, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the OpenTelemetry tracing capabilities within Hive by integrating a circuit breaker pattern into the span export mechanism. This change aims to improve the robustness and reliability of trace data submission, preventing cascading failures if the tracing backend becomes unavailable or slow, thereby ensuring the stability of the main application.

Highlights

• Circuit Breaker Implementation: Introduced a new CircuitBreakerExporter to wrap existing OpenTelemetry span exporters, providing resilience against failing trace export destinations. This uses the opossum library to manage the circuit breaker logic.
• Integration with Hive Tracing: The HiveTracingSpanProcessor has been updated to utilize the new CircuitBreakerExporter when an endpoint configuration is provided, allowing for configurable circuit breaker behavior for trace exports.
• Dependency Updates: Added opossum as a production dependency and @types/opossum as a development dependency to support the circuit breaker functionality.

Changelog

• .changeset/cyan-dolphins-add.md
  • Added a new changeset file documenting the circuit breaker feature for Hive Tracing.
• packages/plugins/opentelemetry/package.json
  • Added opossum as a new dependency for circuit breaker functionality.
  • Added @types/opossum for TypeScript type definitions.
• packages/plugins/opentelemetry/src/circuit-breaker-exporter.ts
  • Created a new CircuitBreakerExporter class that wraps a SpanExporter with circuit breaker logic.
• packages/plugins/opentelemetry/src/hive-span-processor.ts
  • Imported CircuitBreakerConfiguration and CircuitBreakerExporter.
  • Updated HiveTracingSpanProcessorOptions to include circuitBreaker configuration.
  • Modified the HiveTracingSpanProcessor constructor to instantiate CircuitBreakerExporter around OTLPTraceExporter when an endpoint is configured.
• yarn.lock
  • Updated the yarn.lock file to include the new opossum and @types/opossum dependencies.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a circuit breaker to the Hive tracing functionality using the opossum library. The changes include adding a new CircuitBreakerExporter that wraps the OTLP exporter and updating the HiveTracingSpanProcessor to use it.

My review identifies a few critical and high-severity issues in the new CircuitBreakerExporter implementation that could lead to incorrect behavior, such as ignoring user configuration and improper handling of an open circuit. I've also suggested making the circuit breaker feature optional to avoid a breaking change and improve flexibility. The provided code suggestions should help address these points.

[theguild-bot]

🚀 Snapshot Release (alpha)

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

Package	Version	Info
@graphql-hive/gateway	2.5.1-alpha-003401fe140f7b52fa8028715dd09013a6e178bd	npm ↗︎ unpkg ↗︎
@graphql-hive/nestjs	2.0.42-alpha-003401fe140f7b52fa8028715dd09013a6e178bd	npm ↗︎ unpkg ↗︎
@graphql-hive/plugin-opentelemetry	1.4.0-alpha-003401fe140f7b52fa8028715dd09013a6e178bd	npm ↗︎ unpkg ↗︎

[theguild-bot]

🚀 Snapshot Release (Binary for macOS-ARM64)

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

[theguild-bot]

🚀 Snapshot Release (Binary for Linux-ARM64)

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

[theguild-bot]

🚀 Snapshot Release (Binary for Linux-X64)

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

[theguild-bot]

🚀 Snapshot Release (Binary for macOS-X64)

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

[theguild-bot]

🚀 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.5.1-alpha-003401fe140f7b52fa8028715dd09013a6e178bd-bun

[theguild-bot]

🚀 Snapshot Release (Binary for Windows-X64)

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

[theguild-bot]

🚀 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.5.1-alpha-003401fe140f7b52fa8028715dd09013a6e178bd