docs: reconcile OTLP fan-out env var and sanitize package visibility#7534
Merged
Conversation
Copilot
AI
changed the title
[WIP] Add missing documentation for GH_AW_OTLP_ENDPOINTS
docs: reconcile OTLP fan-out env var and sanitize package visibility
Jun 14, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reconciles public and contributor documentation with existing gateway behavior by documenting the GH_AW_OTLP_ENDPOINTS tracing fan-out environment variable and by adding the missing internal/sanitize/ package to the documented project structure.
Changes:
- Documented
GH_AW_OTLP_ENDPOINTSin the README tracing section. - Added
GH_AW_OTLP_ENDPOINTStodocs/ENVIRONMENT_VARIABLES.mdwith supported formats and precedence details. - Updated
CONTRIBUTING.mdproject structure docs to includeinternal/sanitize/and its purpose.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds GH_AW_OTLP_ENDPOINTS to the tracing environment variable table. |
| docs/ENVIRONMENT_VARIABLES.md | Adds detailed GH_AW_OTLP_ENDPOINTS documentation to the tracing variables table. |
| CONTRIBUTING.md | Updates the documented internal/ directory tree and key directories list to include internal/sanitize/. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 3/3 changed files
- Comments generated: 1
| |----------|-------------|---------| | ||
| | `OTEL_EXPORTER_OTLP_ENDPOINT` | OTLP HTTP endpoint for trace export (e.g., `http://localhost:4318`). Tracing is disabled when empty. Sets default for `--otlp-endpoint`. | (disabled) | | ||
| | `OTEL_EXPORTER_OTLP_HEADERS` | Comma-separated `key=value` HTTP headers for OTLP export requests (W3C Baggage format, e.g., `Authorization=Bearer%20token,X-Custom=value`). Used as fallback when `gateway.opentelemetry.headers` / `gateway.tracing.headers` is not set in config. | (none) | | ||
| | `GH_AW_OTLP_ENDPOINTS` | Comma-separated OTLP endpoint URLs, or a JSON array of `{ "url", "headers?" }` objects, for multi-backend fan-out tracing. When set, spans are exported to all listed endpoints (partial-failure tolerant). Takes precedence over `OTEL_EXPORTER_OTLP_ENDPOINT`. Shared headers from `OTEL_EXPORTER_OTLP_HEADERS` / config apply to comma-separated entries. | (none) | |
Collaborator
|
@copilot address review feedback |
Contributor
Author
Addressed in 650176e. I updated |
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
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.
Nightly docs reconciliation found two user-facing gaps:
GH_AW_OTLP_ENDPOINTSwas implemented but undocumented in public docs, andinternal/sanitize/was missing from contributor-facing project structure docs. This PR aligns documentation with current behavior and package layout.Tracing env var docs (user-facing)
GH_AW_OTLP_ENDPOINTSto:README.mdTracing tabledocs/ENVIRONMENT_VARIABLES.mdOpenTelemetry/Tracing variables tableOTEL_EXPORTER_OTLP_ENDPOINTContributor docs: project structure completeness
CONTRIBUTING.mdto includeinternal/sanitize/in:Documentation snippet added