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.

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

[otlpexporter] Document incidental breaking change on Config struct #11178

Merged

Conversation

jade-guiton-dd
Copy link
Contributor

@jade-guiton-dd jade-guiton-dd commented Sep 16, 2024

Description

My PR #11132 introduced a small breaking change in the API of otlpexporter, which I failed to notice at the time. This PR adds a release note about this.

Specifically, the TimeoutSettings field in otlpexporter.Config was renamed to TimeoutConfig (link to the new code). As this is an embedded field, renaming the type of the field renamed the field itself.

(Another option would have been to de-embed the field, and keep the old name. This has less potential for breakage, but would also be a breaking change.)

Link to tracking issue

Indirectly related to #6767

Copy link

codecov bot commented Sep 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.28%. Comparing base (6029f31) to head (77ae2a1).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #11178   +/-   ##
=======================================
  Coverage   92.28%   92.28%           
=======================================
  Files         413      413           
  Lines       19760    19760           
=======================================
  Hits        18236    18236           
  Misses       1152     1152           
  Partials      372      372           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jade-guiton-dd jade-guiton-dd marked this pull request as ready for review September 16, 2024 12:06
@jade-guiton-dd jade-guiton-dd requested review from a team and djaglowski September 16, 2024 12:06
@mx-psi mx-psi merged commit 232dff7 into open-telemetry:main Sep 16, 2024
64 of 66 checks passed
@github-actions github-actions bot added this to the next release milestone Sep 16, 2024
@jade-guiton-dd jade-guiton-dd deleted the 6767-embedded-field-rename branch November 27, 2024 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants