otelconfig: new module as a copy of config module which is being deprecated #6796

mikeblum · 2025-02-17T18:32:06Z

Towards #5597

Add go.opentelemetry.io/contrib/otelconf module which is a replacement for go.opentelemetry.io/contrib/config.
Deprecate go.opentelemetry.io/contrib/config module in favor of go.opentelemetry.io/contrib/otelconf. This is the last release of this module.

pellared

We should not remove the existing module but keep it for one release to give the users time to migrate.

Related comment: #5597 (comment)

config/config.go

otelconf/go.mod

versions.yaml

pellared

This looks closer to the desired solution.

config/v0.2.0/config.go

pellared · 2025-02-20T12:31:31Z

I encourage checking with pkgsite instead of godoc. See: https://github.com/open-telemetry/opentelemetry-go/blob/main/CONTRIBUTING.md#documentation

pellared · 2025-02-20T17:17:40Z

@mikeblum, make sure to not lose recent changes of config module: https://github.com/open-telemetry/opentelemetry-go-contrib/commits/main/config

mikeblum · 2025-02-20T18:31:03Z

❯ diff config otelconf
diff --color config/doc.go otelconf/doc.go
4,9c4
< // Package config is deprecated.
< //
< // Deprecated: use [go.opentelemetry.io/contrib/otelconf] instead.
< // This is the last release of this module.
< //
< // Package config can be used to parse a configuration file that follows
---
> // Package otelconf can be used to parse a configuration file that follows
13c8
< // go.opentelemetry.io/contrib/config/v0.3.0 includes code that supports the
---
> // go.opentelemetry.io/contrib/otelconf/v0.3.0 includes code that supports the
15c10
< package config // import "go.opentelemetry.io/contrib/config"
---
> package otelconf // import "go.opentelemetry.io/contrib/otelconf"
diff --color config/go.mod otelconf/go.mod
1,2c1
< // Deprecated: use [go.opentelemetry.io/contrib/otelconf] instead.
< module go.opentelemetry.io/contrib/config
---
> module go.opentelemetry.io/contrib/otelconf
Common subdirectories: config/testdata and otelconf/testdata
Common subdirectories: config/v0.2.0 and otelconf/v0.2.0
Common subdirectories: config/v0.3.0 and otelconf/v0.3.0

is the current diff between the two modules as of:

commit 39ff1c57e213e67753fa7f72a51c22bc1b4a7cba (upstream/main, main)
Author: Damien Mathieu <[email protected]>
Date:   Thu Feb 20 18:55:31 2025 +0100

    Add http semantic conventions notice to changelog (#6737)

MrAlias · 2025-02-20T18:49:49Z

SIG meeting notes:

We would like to merge [config] Allow prometheus to configure IPv6 by using the standard net host port joining #6815 prior to this. Which will require those changes to be merged into this
After that we would like to not make any other modifications to the config package
This should be merged and released
The config package needs to then be removed
All other config packages will then need to rebase their changes into this otelconf package.

pellared

nit comments only.
Thanks on working on this.

CHANGELOG.md

config/go.mod

config/v0.2.0/config.go

config/v0.3.0/config.go

dmathieu · 2025-02-21T08:30:43Z

The Prometheus PR has been merged. You can now apply its changes to your PR.

pellared

Just waiting for "sync" 👍

versions.yaml

CHANGELOG.md

docs(config): deprecate contrib/config -> contrib/otelconf

Co-authored-by: Robert Pająk <[email protected]>

mikeblum · 2025-02-21T14:53:33Z

cc @pellared

sync 🔁 complete ✅ - fetched upstream/main and pulled in the prom changes. diff report is below 👇
~~do i need to squash / rebase down to a single commit locally first or can we squash in the GH UI? Didn't want to wipe out the commit log during review.~~ squash happens on merge.

❯ diff config otelconf
diff --color config/doc.go otelconf/doc.go
4,9c4
< // Package config is deprecated.
< //
< // Deprecated: use [go.opentelemetry.io/contrib/otelconf] instead.
< // This is the last release of this module.
< //
< // Package config can be used to parse a configuration file that follows
---
> // Package otelconf can be used to parse a configuration file that follows
13c8
< // go.opentelemetry.io/contrib/config/v0.3.0 includes code that supports the
---
> // go.opentelemetry.io/contrib/otelconf/v0.3.0 includes code that supports the
15c10
< package config // import "go.opentelemetry.io/contrib/config"
---
> package otelconf // import "go.opentelemetry.io/contrib/otelconf"
diff --color config/go.mod otelconf/go.mod
1,3c1
< // Deprecated: use go.opentelemetry.io/contrib/otelconf instead.
< // This is the last release of this module.
< module go.opentelemetry.io/contrib/config
---
> module go.opentelemetry.io/contrib/otelconf
Common subdirectories: config/testdata and otelconf/testdata
Common subdirectories: config/v0.2.0 and otelconf/v0.2.0
Common subdirectories: config/v0.3.0 and otelconf/v0.3.0

dmathieu · 2025-02-21T15:30:40Z

No need to squash. Merging the PR will do that automatically.

…ing the standard net host port joining (open-telemetry#6815)

pellared

More changes need to be applied in otelconf (tests do not pass).

codecov · 2025-02-22T00:05:37Z

Codecov Report

Attention: Patch coverage is 81.35033% with 395 lines in your changes missing coverage. Please review.

Project coverage is 76.1%. Comparing base (74e6d32) to head (a128e28).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
otelconf/v0.3.0/config_json.go	49.2%	96 Missing and 47 partials ⚠️
otelconf/v0.2.0/generated_config.go	43.5%	70 Missing and 35 partials ⚠️
otelconf/v0.3.0/metric.go	89.4%	34 Missing and 10 partials ⚠️
otelconf/v0.2.0/metric.go	88.7%	34 Missing and 8 partials ⚠️
otelconf/v0.3.0/config_yaml.go	62.5%	12 Missing and 6 partials ⚠️
otelconf/v0.2.0/config.go	80.3%	8 Missing and 4 partials ⚠️
otelconf/v0.3.0/config.go	89.7%	7 Missing and 3 partials ⚠️
otelconf/v0.3.0/log.go	95.5%	4 Missing and 3 partials ⚠️
otelconf/v0.2.0/log.go	94.3%	3 Missing and 3 partials ⚠️
otelconf/v0.2.0/trace.go	97.1%	2 Missing and 2 partials ⚠️
... and 1 more

Additional details and impacted files

@@           Coverage Diff           @@
##            main   #6796     +/-   ##
=======================================
+ Coverage   75.5%   76.1%   +0.5%     
=======================================
  Files        206     219     +13     
  Lines      19195   21313   +2118     
=======================================
+ Hits       14498   16224   +1726     
- Misses      4259    4529    +270     
- Partials     438     560    +122

Files with missing lines	Coverage Δ
config/v0.2.0/config.go	`80.3% <ø> (ø)`
config/v0.3.0/config.go	`89.7% <ø> (ø)`
otelconf/v0.2.0/resource.go	`100.0% <100.0%> (ø)`
otelconf/v0.3.0/resource.go	`100.0% <100.0%> (ø)`
otelconf/v0.2.0/trace.go	`97.1% <97.1%> (ø)`
otelconf/v0.3.0/trace.go	`97.4% <97.4%> (ø)`
otelconf/v0.2.0/log.go	`94.3% <94.3%> (ø)`
otelconf/v0.3.0/log.go	`95.5% <95.5%> (ø)`
otelconf/v0.3.0/config.go	`89.7% <89.7%> (ø)`
otelconf/v0.2.0/config.go	`80.3% <80.3%> (ø)`
... and 5 more

... and 1 file with indirect coverage changes

github-actions bot requested review from codeboten and pellared February 17, 2025 18:43

mikeblum marked this pull request as ready for review February 17, 2025 18:47

mikeblum requested a review from a team as a code owner February 17, 2025 18:47

pellared requested changes Feb 17, 2025

View reviewed changes

config/config.go Outdated Show resolved Hide resolved

otelconf/go.mod Outdated Show resolved Hide resolved

mikeblum force-pushed the gh-5597-rename-config-to-otelconf branch 4 times, most recently from 7b87b23 to f7257fa Compare February 19, 2025 03:39

mikeblum requested a review from pellared February 19, 2025 03:40

dmathieu approved these changes Feb 19, 2025

View reviewed changes

mikeblum force-pushed the gh-5597-rename-config-to-otelconf branch from bd3f672 to f084515 Compare February 19, 2025 20:57

dmathieu requested changes Feb 20, 2025

View reviewed changes

versions.yaml Show resolved Hide resolved

pellared requested changes Feb 20, 2025

View reviewed changes

config/v0.2.0/config.go Outdated Show resolved Hide resolved

MrAlias added this to the v1.35.0 milestone Feb 20, 2025

mikeblum force-pushed the gh-5597-rename-config-to-otelconf branch from f084515 to 68c1aee Compare February 20, 2025 18:10

mikeblum requested review from dmathieu and pellared February 20, 2025 18:35

MrAlias added the area: file-config Related to file-based configuration label Feb 20, 2025

This was referenced Feb 20, 2025

config: add support for parsing env variables in configuration #6215

Open

config: Handle null attributes as invalid #6645

Draft

config: add support for configuring propagators #6727

Open

Add 'config' example #6788

Open

MrAlias approved these changes Feb 20, 2025

View reviewed changes

pellared approved these changes Feb 20, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

config/go.mod Outdated Show resolved Hide resolved

config/v0.2.0/config.go Outdated Show resolved Hide resolved

config/v0.3.0/config.go Outdated Show resolved Hide resolved

dmathieu approved these changes Feb 21, 2025

View reviewed changes

pellared reviewed Feb 21, 2025

View reviewed changes

versions.yaml Outdated Show resolved Hide resolved

pellared reviewed Feb 21, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

pellared reviewed Feb 21, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

mikeblum and others added 6 commits February 21, 2025 08:39

refactor(config): refactor contrib/config package to contrib/otelconf

d7dd3a6

docs(config): deprecate contrib/config -> contrib/otelconf

fix: revive package comments

e0126d9

fix: deprecation docstring fixes

bb1e293

rebase: upstream/main config module into otelconf module

496873f

docs: CHANGELOG

ae5e3ed

Apply copy suggestions from code review

ef42bbf

Co-authored-by: Robert Pająk <[email protected]>

mikeblum force-pushed the gh-5597-rename-config-to-otelconf branch 2 times, most recently from a3ae741 to d936a53 Compare February 21, 2025 14:47

mikeblum requested a review from pellared February 21, 2025 14:49

mikeblum added 2 commits February 21, 2025 11:05

refactor(otelconf): [config] Allow prometheus to configure IPv6 by us…

7047465

…ing the standard net host port joining (open-telemetry#6815)

copy edits for CHANGELOG + versions.yaml

f744694

mikeblum force-pushed the gh-5597-rename-config-to-otelconf branch from d936a53 to f744694 Compare February 21, 2025 17:06

pellared approved these changes Feb 21, 2025

View reviewed changes

pellared changed the title ~~refactor(config): refactor contrib/config package to contrib/otelconf~~ New otelconfig moduleas a copy of config module which is being deprecated Feb 21, 2025

pellared changed the title ~~New otelconfig moduleas a copy of config module which is being deprecated~~ New otelconfig module as a copy of config module which is being deprecated Feb 21, 2025

pellared changed the title ~~New otelconfig module as a copy of config module which is being deprecated~~ otelconfig: New module as a copy of config module which is being deprecated Feb 21, 2025

pellared changed the title ~~otelconfig: New module as a copy of config module which is being deprecated~~ otelconfig: new module as a copy of config module which is being deprecated Feb 21, 2025

pellared requested changes Feb 21, 2025

View reviewed changes

fix tests

a128e28

pellared approved these changes Feb 22, 2025

View reviewed changes

pellared merged commit 6f9495e into open-telemetry:main Feb 22, 2025
32 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

otelconfig: new module as a copy of config module which is being deprecated #6796

otelconfig: new module as a copy of config module which is being deprecated #6796

mikeblum commented Feb 17, 2025 •

edited by pellared

Loading

pellared left a comment •

edited

Loading

pellared left a comment

pellared commented Feb 20, 2025

pellared commented Feb 20, 2025

mikeblum commented Feb 20, 2025 •

edited

Loading

MrAlias commented Feb 20, 2025

pellared left a comment

dmathieu commented Feb 21, 2025

pellared left a comment

mikeblum commented Feb 21, 2025 •

edited

Loading

dmathieu commented Feb 21, 2025

pellared left a comment •

edited

Loading

codecov bot commented Feb 22, 2025 •

edited

Loading

otelconfig: new module as a copy of config module which is being deprecated #6796

otelconfig: new module as a copy of config module which is being deprecated #6796

Conversation

mikeblum commented Feb 17, 2025 • edited by pellared Loading

pellared left a comment • edited Loading

Choose a reason for hiding this comment

pellared left a comment

Choose a reason for hiding this comment

pellared commented Feb 20, 2025

pellared commented Feb 20, 2025

mikeblum commented Feb 20, 2025 • edited Loading

MrAlias commented Feb 20, 2025

pellared left a comment

Choose a reason for hiding this comment

dmathieu commented Feb 21, 2025

pellared left a comment

Choose a reason for hiding this comment

mikeblum commented Feb 21, 2025 • edited Loading

dmathieu commented Feb 21, 2025

pellared left a comment • edited Loading

Choose a reason for hiding this comment

codecov bot commented Feb 22, 2025 • edited Loading

Codecov Report

mikeblum commented Feb 17, 2025 •

edited by pellared

Loading

pellared left a comment •

edited

Loading

mikeblum commented Feb 20, 2025 •

edited

Loading

mikeblum commented Feb 21, 2025 •

edited

Loading

pellared left a comment •

edited

Loading

codecov bot commented Feb 22, 2025 •

edited

Loading