Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

k8s observer extension is missing detailed documentation #34740

Closed
abhishekmahajan0709222 opened this issue Aug 19, 2024 · 3 comments · Fixed by #35323
Closed

k8s observer extension is missing detailed documentation #34740

abhishekmahajan0709222 opened this issue Aug 19, 2024 · 3 comments · Fixed by #35323
Labels
documentation Improvements or additions to documentation extension/observer/k8sobserver

Comments

@abhishekmahajan0709222
Copy link

Component(s)

extension/observer/k8sobserver

Describe the issue you're reporting

I am trying to add extension to my current configuration but unable to find what information or metrics it will create for endpoint monitoring in ingress.
@abhishekmahajan0709222 abhishekmahajan0709222 added the needs triage New item requiring triage label Aug 19, 2024
@github-actions GitHub Actions
Copy link
Contributor

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@crobert-1 crobert-1 added the documentation Improvements or additions to documentation label Aug 19, 2024
@crobert-1
Copy link
Member

Hello @abhishekmahajan0709222, if it's helpful, the receiver creator README has a pretty extensive list of examples and rules for how to properly discover endpoints, as well as configuration examples.

Let us know if there's anything in particular that you'd like more information on. 👍

@github-actions github-actions bot mentioned this issue Aug 20, 2024
Closed
This was referenced Aug 27, 2024
Closed
Closed
This was referenced Sep 10, 2024
Closed
Closed
@ChrsMark ChrsMark mentioned this issue Sep 20, 2024
Merged
@ChrsMark
Copy link
Member

ChrsMark commented Sep 20, 2024 •
edited
Loading

It's true that k8sobserver's docs might look like missing content. Users need to check back to the receiver creator README as it was pointed out, but that's not always obvious. I filed #35323 to make this explicit in the `k8sobserver''s docs.

@crobert-1 crobert-1 removed the needs triage New item requiring triage label Sep 20, 2024
jriguera pushed a commit to springernature/opentelemetry-collector-contrib that referenced this issue Oct 4, 2024
@ChrsMark @jriguera
improve receiver_creator and k8sobserver docs (open-telemetry#35323)
09eb259 
**Description:** 
This PR includes the `k8s.ingress` type in the list of supported types
and adds a note in `k8sobserver`'s back to the `receiver_creator`'s docs
so as users can find more extensive configuration examples.

**Link to tracking Issue:** <Issue number if applicable> Fixes
open-telemetry#34740

---------

Signed-off-by: ChrsMark <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation extension/observer/k8sobserver
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

improve receiver_creator and k8sobserver docs ChrsMark/opentelemetry-collector-contrib
3 participants
@ChrsMark @crobert-1 @abhishekmahajan0709222