[chore] extension/observer: move Endpoints{Lister,Watcher} to a new package #38416
Conversation
This file contains hidden or 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
axw
requested review from
a team,
MovieStoreGuy,
dmitryax,
ChrsMark and
crobert-1
as code owners
axw
force-pushed
the
extension-observer-internal-api
branch
from
ed3fdc7 to
a73133c
Compare
dehaansa
approved these changes
Mar 6, 2025
| "github.com/open-telemetry/opentelemetry-collector-contrib/internal/kafka" | ||
| ) | ||
|
|
||
| var ( | ||
| _ extension.Extension = (*kafkaTopicsObserver)(nil) | ||
| _ observer.EndpointsLister = (*kafkaTopicsObserver)(nil) |
There was a problem hiding this comment.
There are a couple of these compile time assertions removed, is there a reason they were removed?
There was a problem hiding this comment.
I removed the observer.EndpointsLister assertions because that's the contract between the implementations and EndpointsWatcher -- it's an internal detail of the observer. It's only the observer.Observable interface that needs to be implemented for consumers (namely receivercreator:
dehaansa
added
the
ready to merge
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
Move EndpointsLister and EndpointsWatcher to a new "endpointswatcher" package. The intention here is to more clearly delineates the public API of the observer package -- the bits inside endpointswatcher are intended only for implementations of observers. See #38412 (comment) and #38412 (comment) for further motivation.
I've made the new package non-internal in case there are any observer implementations out of tree.
Link to tracking issue
N/A
Testing
Ran/updated unit tests
Documentation
N/A except for adding package doc explaining that endpointswatcher is intended for implementations only.