-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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.
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
Add TA troubleshooting page #4708
Add TA troubleshooting page #4708
Conversation
Question for @open-telemetry/operator-approvers - I have a working example repo that I'd like to reference on this page, but I think that it's probably best to move this code to an examples folder the OTel Operator repo before doing this. Thoughts? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, this is a really good addition to docs! A few comments and suggestions. Note that the section titles are really long which might look strange in the outline navigation, maybe we can review and shorten them
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Severin Neumann <[email protected]>
Yeah, they do look a bit long. I think that when we had the step numbers, it was a bit easier to distinguish one from the other. Is there a reson why you prefer to leave those out, @svrnm? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good stuff! Added some comments.
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
FYI @svrnm @swiatekm-sumo @theletterf - I had some previous content for troubleshooting auto-instrumentation, so I created a page for that too. |
Can you fork that out in a dedicated PR or is this closely related? |
It's not closely related, so I can definitely create a separate PR. |
Removed auto-instrumentation troubleshooting page. I have created a separate PR for this (#4724). |
@open-telemetry/operator-approvers PTAL! |
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Mikołaj Świątek <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Applying my own updates per feedback below
@swiatekm-sumo thanks for keeping me honest! I've incorporated your suggestions and did another read through. Hopefully I didn't miss any spots where I mis-explained the TA functionality. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few minor comments, but overall this is fantastic and will be massively helpful!
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/target-allocator.md
Outdated
Show resolved
Hide resolved
```json | ||
{ | ||
"otelcol-collector-0": { | ||
"_link": "/jobs/serviceMonitor%2Fopentelemetry%2Fsm-example%2F1/targets?collector_id=otelcol-collector-0", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
would be good to note here that the query parameter collector_id is saying that these are the targets for otelcol-collector-0
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noted!
Co-authored-by: Jacob Aronoff <[email protected]>
THANK YOU @avillela fantastic work here :D :D :D |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice 💪
Adding page to the docs with tips for troubleshooting the OTel Operator's Target Allocator.
This was originally going to be a blog post; however, per suggestion from @svrnm, this is a much better fit.
Reference issue: #4707