[otlpexporter] Document incidental breaking change on Config struct #11178
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 inotlpexporter.Config
was renamed toTimeoutConfig
(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