[receiver/receivercreator] Make receivercreator expose its required interface #34234
Conversation
TylerHelmuth
added
the
Skip Changelog
receiver/receivercreator/receiver.go
Outdated
| @@ -34,16 +34,27 @@ func newReceiverCreator(params receiver.Settings, cfg *Config) receiver.Metrics | |||
| } | |||
| } | |||
|
|
|||
| // Host is an interface that the component.Host passed to receivercreator's Start function must implement | |||
| type Host interface { | |||
There was a problem hiding this comment.
does it need to be exported?
There was a problem hiding this comment.
I guess it's good to have the interface so that the component explicitly says what it needs from the component.Host. If it's controversial though, maybe we can make it private for now, enshrine it on some documentation on how to deal with this case, and make it public then?
There was a problem hiding this comment.
I can hide it for now.
There was a problem hiding this comment.
I am asking if it can be unexported because in general we are trying to keep the public API of any component down to its config struct if possible.
Do we see any code import this module and use this host interface?
There was a problem hiding this comment.
Do we see any code import this module and use this host interface?
No, it doesn't need to be public at this time.
receiver/receivercreator/receiver.go
Outdated
| @@ -34,16 +34,27 @@ func newReceiverCreator(params receiver.Settings, cfg *Config) receiver.Metrics | |||
| } | |||
| } | |||
|
|
|||
| // Host is an interface that the component.Host passed to receivercreator's Start function must implement | |||
| type Host interface { | |||
There was a problem hiding this comment.
I guess it's good to have the interface so that the component explicitly says what it needs from the component.Host. If it's controversial though, maybe we can make it private for now, enshrine it on some documentation on how to deal with this case, and make it public then?
<!--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 --> Adds a note to the `component.Host` interface documenting that components may require additional interfaces. I think this is the only sustainable pattern post 1.0, since we won't be able to add any new methods to the `component.Host` interface. This pattern is also used today by: - The zpages extension (https://github.com/open-telemetry/opentelemetry-collector/blob/91f13c309d00eef5b997a2e810effb2a4ccd95d4/extension/zpagesextension/zpagesextension.go#L58-L66) - The receiver creator (after open-telemetry/opentelemetry-collector-contrib/pull/34234) - Some contrib components (open-telemetry/opentelemetry-collector-contrib/pull/32498) #### Link to tracking issue Fixes #10181
Description:
Updates receivercreator in preparation for
component.Host.GetFactoryto be removed.Link to tracking Issue:
Related to open-telemetry/opentelemetry-collector#9511
Testing:
Unit tests.
I cant add a unit test yet that fails the interface check since being compliant with
component.Hoststill requires theGetFactorymethod.