Skip to content
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

Resolve declarative config TODOs #4394

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Resolve declarative config TODOs #4394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion specification/configuration/data-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The data model itself is an abstraction with multiple built-in representations:

### Stability definition

TODO: define stability guarantees and backwards compatibility
See `opentelemetry-configuration` [stability definition](https://github.com/open-telemetry/opentelemetry-configuration?tab=readme-ov-file#stability-definition).
Copy link
Member Author

Choose a reason for hiding this comment

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

The definition of stability is still being proposed reviewed here, but we know that the definition will live in opentelemetry-configuration.


### File-based configuration model

Expand Down
15 changes: 8 additions & 7 deletions specification/configuration/sdk-environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,16 +396,17 @@ configuration models, or overlay values from environment variables on top of a
configuration model. Implementations MAY provide a mechanism to customize the
configuration model parsed from `OTEL_EXPERIMENTAL_CONFIG_FILE`.

Users are encouraged to use the `sdk-config.yaml` (TODO: Add link when
available) as a starting point for `OTEL_EXPERIMENTAL_CONFIG_FILE`. This file
represents a common SDK configuration scenario, and includes environment
variable substitution references to environment variables which are otherwise
ignored.
Users are encouraged to
use [`sdk-migration-config.yaml`](https://github.com/open-telemetry/opentelemetry-configuration/blob/main/examples/sdk-migration-config.yaml)
as a starting point for `OTEL_EXPERIMENTAL_CONFIG_FILE`. This file represents a
common SDK configuration scenario, and includes environment variable
substitution references to environment variables which are otherwise ignored.
Alternatively, [`sdk-config.yaml`](https://github.com/open-telemetry/opentelemetry-configuration/blob/main/examples/sdk-config.yaml)
offers a common SDK configuration starting point without environment variable
substitution references.

TODO: deprecate env vars which are not
compatible ([#3967](https://github.com/open-telemetry/opentelemetry-specification/issues/3967))
TODO: provide solution for platforms to contribute to
configure ([#3966](https://github.com/open-telemetry/opentelemetry-specification/issues/3966))
Copy link
Member Author

Choose a reason for hiding this comment

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

This issue is resolved.


## Language Specific Environment Variables

Expand Down
Loading