opentelemetry-collector icon indicating copy to clipboard operation
opentelemetry-collector copied to clipboard

[chore] mark confignet as stable

Open codeboten opened this issue 2 years ago • 11 comments
trafficstars

This contents of this module have not changed in over 2 years

codeboten avatar Jun 21 '23 19:06 codeboten

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 90.39%. Comparing base (9553bfe) to head (770eaf1). Report is 52 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7954      +/-   ##
==========================================
+ Coverage   90.34%   90.39%   +0.04%     
==========================================
  Files         346      346              
  Lines       18194    18194              
==========================================
+ Hits        16438    16446       +8     
+ Misses       1422     1416       -6     
+ Partials      334      332       -2     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Jun 21 '23 19:06 codecov[bot]

Can you give me until mid July before marking any config stable? I want to also discuss somewhere and document things like:

  • Adding new validation rules means breaking change?
  • Should we offer a "NewDefaul...." for each config and say that the behavior of the config is stable only if initialized with NewDefault?
  • Adding new fields means breaking change? Let's assume someone "squash" the message into another message, then adding a field with same mapstruct value will be a breaking change, what do we do with that? What are the rules we follow.

There may be other things to document (just added some in my mind) but would like others to think of any special implications for configs that are not defined by the golang conventions of breaking compatibility,.

bogdandrutu avatar Jun 22 '23 01:06 bogdandrutu

@codeboten the time in my comment was to give us time to address my concerns, so I do believe someone (who is working full time, not like me until Sept) should address them and clarify what is possible and what is not in a stable config package.

bogdandrutu avatar Jun 26 '23 18:06 bogdandrutu

Filed #8002 to discuss the stability guarantees for configuration structures. One of these was already discussed on the VERSIONING.md document (adding new fields was deemed to be fine).

mx-psi avatar Jun 29 '23 12:06 mx-psi

This PR was marked stale due to lack of activity. It will be closed in 14 days.

github-actions[bot] avatar Jul 14 '23 03:07 github-actions[bot]

Closed as inactive. Feel free to reopen if this PR is still being worked on.

github-actions[bot] avatar Jul 29 '23 03:07 github-actions[bot]

Reopening this PR, with the questions answered in https://github.com/open-telemetry/opentelemetry-collector/pull/8812

codeboten avatar Dec 07 '23 19:12 codeboten

One thing that we need to agree on, is that we should suffix everything with Config probably (instead of Settings) as discussed in one of the issues.

bogdandrutu avatar Dec 19 '23 18:12 bogdandrutu

Another thing is to make sure we pass "context" everywhere. Maybe TelemetrySettings as well

bogdandrutu avatar Dec 19 '23 18:12 bogdandrutu

This PR was marked stale due to lack of activity. It will be closed in 14 days.

github-actions[bot] avatar Jan 06 '24 03:01 github-actions[bot]

This PR was marked stale due to lack of activity. It will be closed in 14 days.

github-actions[bot] avatar Jan 25 '24 03:01 github-actions[bot]

This PR was marked stale due to lack of activity. It will be closed in 14 days.

github-actions[bot] avatar Feb 23 '24 03:02 github-actions[bot]

Closed as inactive. Feel free to reopen if this PR is still being worked on.

github-actions[bot] avatar Mar 09 '24 03:03 github-actions[bot]