[exporterhelper] Rename Timeout/QueueSettings to Config #11132
Merged
+119
−83
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #11132 +/- ##
==========================================
+ Coverage 92.24% 92.26% +0.02%
==========================================
Files 414 414
Lines 19810 19802 -8
==========================================
- Hits 18273 18270 -3
+ Misses 1166 1160 -6
- Partials 371 372 +1 ☔ View full report in Codecov by Sentry. |
songy23
approved these changes
Sep 11, 2024
bogdandrutu
reviewed
Sep 11, 2024
bogdandrutu
approved these changes
Sep 11, 2024
mx-psi
approved these changes
Sep 11, 2024
|
Test failure: #10927 |
songy23
added
the
ready-to-merge
mx-psi
pushed a commit
to open-telemetry/opentelemetry-collector-contrib
that referenced
this pull request
Sep 13, 2024
…tings (#35158) **Description:** `TimeoutSettings` and `QueueSettings` in the `exporterhelper` core collector package were renamed to `TimeoutConfig` and `QueueConfig` for naming consistency reasons, and the related `NewDefault` functions were renamed as well. This PR updates the core libraries to a prerelease version with those changes, and updates opentelemetry-collector-contrib modules to the new names, to plan for the deprecation of the old names in v0.110.0. **Link to tracking Issue:** Related to [this PR](open-telemetry/opentelemetry-collector#11132) and [this issue](open-telemetry/opentelemetry-collector#6767) on the core collector. **Notes:** - `go.opentelemetry.io/collector/cmd/mdatagen` is specifically *not* updated, as it currently has a bug causing a CI test failure. - The `prometheus-compliance-tests` CI failure is unrelated to this PR.
mx-psi
pushed a commit
that referenced
this pull request
Sep 16, 2024
…11178) #### 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](https://github.com/jade-guiton-dd/opentelemetry-collector/blob/543c4f510d3bbcd50e914f4e5d7f22c5fcbda92d/exporter/otlpexporter/config.go#L23)). 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 technically also be a breaking change.) #### Link to tracking issue Indirectly related to #6767
bogdandrutu
pushed a commit
that referenced
this pull request
Sep 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This PR renames
TimeoutSettingsandQueueSettings(as well as the correspondingNewDefaultfunctions) toTimeoutConfigandQueueConfig, for naming consistency reasons.The previous struct/function names are kept as deprecated aliases of the new ones for now.
Link to tracking issue
Updates #6767 (edit: reworded by @mx-psi)
Testing
No behavior changes were made, so no additional testing should be necessary.
The references to the aforementioned structs/functions in existing tests have been renamed as well. This means the deprecated function aliases are not tested, lowering the coverage a bit.
Documentation
The new functions are documented identically to the previous ones.