docs: add declarative configuration guide and example#5309
Draft
MikeGoldsmith wants to merge 3 commits into
Draft
docs: add declarative configuration guide and example#5309MikeGoldsmith wants to merge 3 commits into
MikeGoldsmith wants to merge 3 commits into
Conversation
Add an SDK documentation page covering declarative (file-based) configuration via OTEL_CONFIG_FILE and the public configuration API, plus a runnable example under docs/examples/declarative-config with a schema-1.0 YAML config.
MikeGoldsmith
added
the
Skip Changelog
Replace the Honeycomb-specific endpoint and headers in the declarative config guide with a generic OTLP endpoint and api-key header.
The check-links CI resolves new URLs; otlp.example.com is not covered by the existing ignore patterns. Use the apex example.com placeholder, which the check_links_config.json ignore list already matches.
29 tasks
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
1 participant
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.
Description
Adds user-facing documentation for declarative (file-based) configuration of the SDK:
docs/sdk/configuration.rstcovering:OTEL_CONFIG_FILEopentelemetry.sdk.configurationAPI (load_config_file+configure_sdk)opentelemetry-sdk[file-configuration]install extra${VAR},${VAR:-default},$$)docs/examples/declarative-config/(a schema-1.0otel-config.yaml,app.py, andREADME.rst).The example YAML was validated against the bundled configuration schema via the loader, and the new pages build with no Sphinx warnings.
Fixes #5308
Dependencies
This PR documents API that is still in flight, so it should merge after:
OTEL_CONFIG_FILEin the SDK configuratoropentelemetry.sdk.configurationnamespaceKept as a draft until those land. Part of #3631.
Type of change