[component] Refactor to use pipeline.ID and pipeline.Signal #11204
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
TylerHelmuth
force-pushed
the
component-refactor-datatype
branch
5 times, most recently
from
fe90c10 to
1225ae3
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #11204 +/- ##
==========================================
- Coverage 91.80% 91.41% -0.39%
==========================================
Files 424 424
Lines 20094 20198 +104
==========================================
+ Hits 18447 18465 +18
- Misses 1268 1349 +81
- Partials 379 384 +5 ☔ View full report in Codecov by Sentry. |
TylerHelmuth
commented
Sep 18, 2024
mx-psi
reviewed
Sep 18, 2024
TylerHelmuth
force-pushed
the
component-refactor-datatype
branch
from
1225ae3 to
3a776d6
Compare
mx-psi
reviewed
Sep 19, 2024
mx-psi
pushed a commit
that referenced
this pull request
Sep 20, 2024
#### Description To facilitate the work in #11204 as some breaking changes and some deprecations, this PR adds the new pipeline module separately so that future PRs can handle the breaking changes and deprecations. In order to make `Signal` uninstantiable outside of this repo, while still being extendable in places like `componentprofiles`, a new internal module is added to handle the `Signal` logic. To reduce the dependency sprawl that would happen if `signal` was an internal package in `go.opentelemetry.io/collector`, I made it a module, similar to `globalgates`. <!-- Issue number if applicable --> #### Link to tracking issue Related to #10947 <!--Describe what testing was performed and which tests were added.--> #### Testing Added unit tests <!--Describe the documentation added.--> #### Documentation Added godoc comments
mx-psi
approved these changes
Sep 20, 2024
TylerHelmuth
added
the
release:blocker
codeboten
reviewed
Sep 20, 2024
codeboten
approved these changes
Sep 23, 2024
codeboten
pushed a commit
that referenced
this pull request
Sep 23, 2024
#### Description As part of #11204 I left `host`'s implementation of `GetExporters` alone, thinking I didn't need to change a deprecated interface implementation. But `GetExporters` depends on `component.DataType`, so we won't be able to remove `component.DataType` unless `GetExporters` is updated to use `pipeline.Signal` instead. This PR deprecates the deprecated `GetExporters` interface with `GetExportersWithSignal`, which uses `pipeline.Signal`. Then we'll follow the process to rename `GetExportersWithSignal` back to `GetExporters`.
TylerHelmuth
added a commit
to open-telemetry/opentelemetry-collector-contrib
that referenced
this pull request
Sep 23, 2024
**Description:** Update core libraries. Handle deprecations and breaking changes from open-telemetry/opentelemetry-collector#11204
HongChenTW
pushed a commit
to HongChenTW/opentelemetry-collector
that referenced
this pull request
Sep 24, 2024
…emetry#11204) #### Description Depends on open-telemetry#11209 This PR is a non-breaking implementation of open-telemetry#10947. It adds a new module, `pipeline`, which houses a `pipeline.ID` and `pipeline.Signal`. `pipeline.ID` is used to identify a pipeline within the service. `pipeline.Signal` is uses to identify the signal associated to a pipeline. I do this work begrudgingly. As the PR shows, this is a huge refactor when done in a non-breaking way, will require 3 full releases, and doesn't benefit our [End Users or, in my opinion, our Component Developers or Collector Library Users](https://github.com/open-telemetry/opentelemetry-collector/blob/main/CONTRIBUTING.md#target-audiences). I view this refactor as a Nice-To-Have, not a requirement for Component 1.0. <!-- Issue number if applicable --> #### Link to tracking issue Works towards open-telemetry#9429
HongChenTW
pushed a commit
to HongChenTW/opentelemetry-collector
that referenced
this pull request
Sep 24, 2024
#### Description As part of open-telemetry#11204 I left `host`'s implementation of `GetExporters` alone, thinking I didn't need to change a deprecated interface implementation. But `GetExporters` depends on `component.DataType`, so we won't be able to remove `component.DataType` unless `GetExporters` is updated to use `pipeline.Signal` instead. This PR deprecates the deprecated `GetExporters` interface with `GetExportersWithSignal`, which uses `pipeline.Signal`. Then we'll follow the process to rename `GetExportersWithSignal` back to `GetExporters`.
jriguera
pushed a commit
to springernature/opentelemetry-collector-contrib
that referenced
this pull request
Oct 4, 2024
**Description:** Update core libraries. Handle deprecations and breaking changes from open-telemetry/opentelemetry-collector#11204
HongChenTW
pushed a commit
to HongChenTW/opentelemetry-collector
that referenced
this pull request
Dec 19, 2024
#### Description To facilitate the work in open-telemetry#11204 as some breaking changes and some deprecations, this PR adds the new pipeline module separately so that future PRs can handle the breaking changes and deprecations. In order to make `Signal` uninstantiable outside of this repo, while still being extendable in places like `componentprofiles`, a new internal module is added to handle the `Signal` logic. To reduce the dependency sprawl that would happen if `signal` was an internal package in `go.opentelemetry.io/collector`, I made it a module, similar to `globalgates`. <!-- Issue number if applicable --> #### Link to tracking issue Related to open-telemetry#10947 <!--Describe what testing was performed and which tests were added.--> #### Testing Added unit tests <!--Describe the documentation added.--> #### Documentation Added godoc comments
HongChenTW
pushed a commit
to HongChenTW/opentelemetry-collector
that referenced
this pull request
Dec 19, 2024
…emetry#11204) #### Description Depends on open-telemetry#11209 This PR is a non-breaking implementation of open-telemetry#10947. It adds a new module, `pipeline`, which houses a `pipeline.ID` and `pipeline.Signal`. `pipeline.ID` is used to identify a pipeline within the service. `pipeline.Signal` is uses to identify the signal associated to a pipeline. I do this work begrudgingly. As the PR shows, this is a huge refactor when done in a non-breaking way, will require 3 full releases, and doesn't benefit our [End Users or, in my opinion, our Component Developers or Collector Library Users](https://github.com/open-telemetry/opentelemetry-collector/blob/main/CONTRIBUTING.md#target-audiences). I view this refactor as a Nice-To-Have, not a requirement for Component 1.0. <!-- Issue number if applicable --> #### Link to tracking issue Works towards open-telemetry#9429
HongChenTW
pushed a commit
to HongChenTW/opentelemetry-collector
that referenced
this pull request
Dec 19, 2024
#### Description As part of open-telemetry#11204 I left `host`'s implementation of `GetExporters` alone, thinking I didn't need to change a deprecated interface implementation. But `GetExporters` depends on `component.DataType`, so we won't be able to remove `component.DataType` unless `GetExporters` is updated to use `pipeline.Signal` instead. This PR deprecates the deprecated `GetExporters` interface with `GetExportersWithSignal`, which uses `pipeline.Signal`. Then we'll follow the process to rename `GetExportersWithSignal` back to `GetExporters`.
gantrior
pushed a commit
to gantrior/solarwinds-otel-collector
that referenced
this pull request
Feb 27, 2025
**Description:** Update core libraries. Handle deprecations and breaking changes from open-telemetry/opentelemetry-collector#11204
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
Depends on #11209
This PR is a non-breaking implementation of #10947. It adds a new module,
pipeline, which houses apipeline.IDandpipeline.Signal.pipeline.IDis used to identify a pipeline within the service.pipeline.Signalis uses to identify the signal associated to a pipeline.I do this work begrudgingly. As the PR shows, this is a huge refactor when done in a non-breaking way, will require 3 full releases, and doesn't benefit our End Users or, in my opinion, our Component Developers or Collector Library Users. I view this refactor as a Nice-To-Have, not a requirement for Component 1.0.
Link to tracking issue
Works towards #9429