Skip to content

Conversation

@jade-guiton-dd
Copy link
Contributor

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

Description

This PR renames TimeoutSettings and QueueSettings (as well as the corresponding NewDefault functions) to TimeoutConfig and QueueConfig, 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.

@codecov
Copy link

codecov bot commented Sep 11, 2024

Codecov Report

Attention: Patch coverage is 93.10345% with 2 lines in your changes missing coverage. Please review.

Project coverage is 92.26%. Comparing base (936ffbb) to head (543c4f5).
Report is 14 commits behind head on main.

Files with missing lines Patch % Lines
exporter/exporterhelper/queue_sender.go 75.00% 1 Missing ⚠️
exporter/exporterhelper/timeout_sender.go 75.00% 1 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

@jade-guiton-dd jade-guiton-dd marked this pull request as ready for review September 11, 2024 12:06
@jade-guiton-dd jade-guiton-dd requested review from a team and songy23 September 11, 2024 12:06
@songy23 songy23 requested a review from mx-psi September 11, 2024 13:31
@songy23
Copy link
Member

songy23 commented Sep 11, 2024

Test failure: #10927

@songy23 songy23 added the ready-to-merge Code review completed; ready to merge by maintainers label Sep 11, 2024
@mx-psi mx-psi merged commit 6c2697c into open-telemetry:main Sep 11, 2024
@github-actions github-actions bot added this to the next release milestone Sep 11, 2024
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
…11264)

#### Description

Follow-up to #11132 now that 0.110 has been released.

#### Link to tracking issue

Should be the final step for #6767.
jriguera pushed a commit to springernature/opentelemetry-collector-contrib that referenced this pull request Oct 4, 2024
…tings (open-telemetry#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.
jackgopack4 pushed a commit to jackgopack4/opentelemetry-collector that referenced this pull request Oct 8, 2024
…pen-telemetry#11264)

#### Description

Follow-up to open-telemetry#11132 now that 0.110 has been released.

#### Link to tracking issue

Should be the final step for open-telemetry#6767.
@jade-guiton-dd jade-guiton-dd deleted the 6767-exporterhelper-rename-config branch November 27, 2024 13:38
gantrior pushed a commit to gantrior/solarwinds-otel-collector that referenced this pull request Feb 27, 2025
…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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-to-merge Code review completed; ready to merge by maintainers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants