Skip to content

feat(opentelemetry-configuration): support file with format rc.2 #6029

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

Merged
pichlermarc merged 4 commits into from
Oct 20, 2025
Merged

feat(opentelemetry-configuration): support file with format rc.2 #6029

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3419fb0
update exemple
maryliag Oct 20, 2025
a26a583
update tests
maryliag Oct 20, 2025
38b4b68
update changelog
maryliag Oct 20, 2025
34ecb7d
Merge branch 'main' into config-example
maryliag Oct 20, 2025
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
1 change: 1 addition & 0 deletions experimental/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
* feat(opentelemetry-configuration): parse more parameters from config file [#5955](https://github.com/open-telemetry/opentelemetry-js/pull/5955) @maryliag
* feat(exporter-prometheus): support withoutTargetInfo option [#5962](https://github.com/open-telemetry/opentelemetry-js/pull/5962) @cjihrig
* feat(opentelemetry-configuration): parse trace provider from config file [#5992](https://github.com/open-telemetry/opentelemetry-js/pull/5992) @maryliag
* feat(opentelemetry-configuration): parse config file with format 1.0-rc.2 [#6029](https://github.com/open-telemetry/opentelemetry-js/pull/6029) @maryliag

### :bug: Bug Fixes

Expand Down
2 changes: 1 addition & 1 deletion experimental/packages/opentelemetry-configuration/src/FileConfigProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ export function hasValidConfigFile(): boolean {
}

function parseConfigFile(config: ConfigurationModel) {
const supportedFileVersions = ['1.0-rc.1'];
const supportedFileVersions = ['1.0-rc.1', '1.0-rc.2'];
Copy link
Member

@pichlermarc pichlermarc Oct 20, 2025

Choose a reason for hiding this comment

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

not for now, but when we eventually go GA with this we should stop supporting all but the latest version.

const configFile = getStringFromEnv('OTEL_EXPERIMENTAL_CONFIG_FILE') || '';
const file = fs.readFileSync(configFile, 'utf8');
const parsedContent = yaml.parse(file);
Expand Down
2 changes: 1 addition & 1 deletion experimental/packages/opentelemetry-configuration/test/ConfigProvider.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ const defaultConfig: Configuration = {

const configFromFile: Configuration = {
disabled: false,
log_level: DiagLogLevel.DEBUG,
log_level: DiagLogLevel.INFO,
node_resource_detectors: ['all'],
resource: {
schema_url: 'https://opentelemetry.io/schemas/1.16.0',
Expand Down
19 changes: 11 additions & 8 deletions experimental/packages/opentelemetry-configuration/test/fixtures/kitchen-sink.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
# The file format version.
# The yaml format is documented at
# https://github.com/open-telemetry/opentelemetry-configuration/tree/main/schema
file_format: "1.0-rc.1"
file_format: "1.0-rc.2"
# Configure if the SDK is disabled or not.
# If omitted or null, false is used.
disabled: false
# Configure the log level of the internal logger used by the SDK.
# If omitted, info is used.
log_level: debug
log_level: info
# Configure general attribute limits. See also tracer_provider.limits, logger_provider.limits.
attribute_limits:
# Configure max attribute value size.
Expand Down Expand Up @@ -200,12 +200,6 @@ meter_provider:
# Configure port.
# If omitted or null, 9464 is used.
port: 9464
# Configure Prometheus Exporter to produce metrics without a unit suffix or UNIT metadata.
# If omitted or null, false is used.
without_units: false
# Configure Prometheus Exporter to produce metrics without a type suffix.
# If omitted or null, false is used.
without_type_suffix: false
# Configure Prometheus Exporter to produce metrics without a scope info metric.
# If omitted or null, false is used.
without_scope_info: false
Expand All @@ -225,6 +219,15 @@ meter_provider:
# If omitted, .included resource attributes are included.
excluded:
- "service.attr1"
# Configure how Prometheus metrics are exposed. Values include:
#
# * UnderscoreEscapingWithSuffixes, the default. This fully escapes metric names for classic Prometheus metric name compatibility, and includes appending type and unit suffixes.
# * UnderscoreEscapingWithoutSuffixes, metric names will continue to escape special characters to _, but suffixes won't be attached.
# * NoUTF8EscapingWithSuffixes will disable changing special characters to _. Special suffixes like units and _total for counters will be attached.
# * NoTranslation. This strategy bypasses all metric and label name translation, passing them through unaltered.
#
# If omitted or null, UnderscoreEscapingWithSuffixes is used.
translation_strategy: UnderscoreEscapingWithSuffixes
# Configure metric producers.
producers:
- # Configure metric producer to be opencensus.
Expand Down