docs: add optional variables section to OpenTelemetry configuration g…#15
Merged
RishabhS7 merged 6 commits intoJun 3, 2026
Merged
Conversation
…uide Introduced a new section detailing optional environment variables for OpenTelemetry configuration, enhancing clarity and usability for users.
Contributor
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/how-tos/chain-events/opentelemetry.md`:
- Line 24: The document currently lists
OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION in the main required
configuration block and also in the Optional Variables table, causing confusion;
remove OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION from the main
configuration snippet (the line showing
OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION=explicit_bucket_histogram)
so it only appears in the Optional Variables section, and update any surrounding
text to indicate that only the first three variables are required while
OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION remains optional.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 28f7c079-022f-4db3-b0de-1dbe7dd9d156
📒 Files selected for processing (1)
docs/how-tos/chain-events/opentelemetry.md
…ation Removed the `OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION` entry to streamline the OpenTelemetry configuration guide and eliminate potential confusion for users.
…ration Reintroduced the `OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION` variable in the optional variables section to provide clear guidance on its usage for Prometheus-compatible histograms.
Included a warning in the scaling documentation to emphasize the necessity of a database when running multiple replicas to prevent duplicate events. Explained how the database facilitates lease management and progress persistence for replicas.
Replaced instances of the GitHub Container Registry image with the Docker Hub image for consistency across the quick start, registry API, and scaling documentation. This change simplifies the instructions for users by standardizing the image source.
…entation Changed the note regarding database requirements to a warning to better emphasize the necessity of configuring `DB_HOST` for registry management endpoints. This update enhances clarity for users regarding the implications of not having a connected database.
RishabhS7
approved these changes
Jun 3, 2026
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
2 participants
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.
…uide
Introduced a new section detailing optional environment variables for OpenTelemetry configuration, enhancing clarity and usability for users.
Summary by CodeRabbit