[chore][VERSIONING.md] Document approach to optional experimental interfaces #11482
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 ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #11482 +/- ##
=======================================
Coverage 91.62% 91.63%
=======================================
Files 442 442
Lines 23776 23776
=======================================
+ Hits 21785 21787 +2
+ Misses 1619 1618 -1
+ Partials 372 371 -1 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
dmathieu
reviewed
Oct 18, 2024
|
This PR was marked stale due to lack of activity. It will be closed in 14 days. |
|
This PR was marked stale due to lack of activity. It will be closed in 14 days. |
dmathieu
approved these changes
Nov 20, 2024
djaglowski
pushed a commit
to djaglowski/opentelemetry-collector
that referenced
this pull request
Nov 21, 2024
…erfaces (open-telemetry#11482) <!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description <!-- Issue number if applicable --> Documents the approach we have taken for adding experimental functionality to interfaces. We take this approach with: - `receiver.Factory`, may implement the [`receiverprofiles.Factory`](https://pkg.go.dev/go.opentelemetry.io/collector/receiver/receiverprofiles#Factory) optional interface (similar for other pipeline components) - `component.Host` may implement the [`componentstatus.Reporter`](https://pkg.go.dev/go.opentelemetry.io/collector/component/componentstatus#Reporter) optional interface. - `extension.Extension` may implement the optional interfaces in [`extensioncapabilities`](https://pkg.go.dev/go.opentelemetry.io/collector/extension/extensioncapabilities). In these cases we reserve the right to change the optional, experimental parts of the underlying struct we return. You can also check whether you are using experimental functionality by checking your `go.mod` and seeing if you use one of these experimental modules.
HongChenTW
pushed a commit
to HongChenTW/opentelemetry-collector
that referenced
this pull request
Dec 19, 2024
…erfaces (open-telemetry#11482) <!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description <!-- Issue number if applicable --> Documents the approach we have taken for adding experimental functionality to interfaces. We take this approach with: - `receiver.Factory`, may implement the [`receiverprofiles.Factory`](https://pkg.go.dev/go.opentelemetry.io/collector/receiver/receiverprofiles#Factory) optional interface (similar for other pipeline components) - `component.Host` may implement the [`componentstatus.Reporter`](https://pkg.go.dev/go.opentelemetry.io/collector/component/componentstatus#Reporter) optional interface. - `extension.Extension` may implement the optional interfaces in [`extensioncapabilities`](https://pkg.go.dev/go.opentelemetry.io/collector/extension/extensioncapabilities). In these cases we reserve the right to change the optional, experimental parts of the underlying struct we return. You can also check whether you are using experimental functionality by checking your `go.mod` and seeing if you use one of these experimental modules.
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
Documents the approach we have taken for adding experimental functionality to interfaces. We take this approach with:
receiver.Factory, may implement thereceiverprofiles.Factoryoptional interface (similar for other pipeline components)component.Hostmay implement thecomponentstatus.Reporteroptional interface.extension.Extensionmay implement the optional interfaces inextensioncapabilities.In these cases we reserve the right to change the optional, experimental parts of the underlying struct we return. You can also check whether you are using experimental functionality by checking your
go.modand seeing if you use one of these experimental modules.