Commit 854dbf9
authored
[chore][VERSIONING.md] Document approach to optional experimental interfaces (#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.1 parent 8dae522 commit 854dbf9
1 file changed
+3
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
65 | 68 | | |
66 | 69 | | |
67 | 70 | | |
| |||
0 commit comments