Skip to content

Commit

Permalink
Editorial: Resolve declarative config TODOs (#4394)
Browse files Browse the repository at this point in the history
Related to #4374.

Remove a couple of TODOs which already have resolutions.
  • Loading branch information
jack-berg authored Feb 6, 2025
1 parent 6813f6f commit eef399b
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 8 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ release.
- Define syntax for escaping declarative configuration environment variable
references.
([#4375](https://github.com/open-telemetry/opentelemetry-specification/pull/4375))
- Resolve various declarative config TODOs.
([#4394](https://github.com/open-telemetry/opentelemetry-specification/pull/4394))

### Common

Expand Down
2 changes: 1 addition & 1 deletion specification/configuration/data-model.md
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).

### File-based configuration model

Expand Down
15 changes: 8 additions & 7 deletions specification/configuration/sdk-environment-variables.md
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))

## Language Specific Environment Variables

Expand Down

0 comments on commit eef399b

Please sign in to comment.