Add diagrams to further enhance Target Allocator documentation - #2229 #2230
Conversation
There was a problem hiding this comment.
The collector directly scrapes the metric targets directly. The diagram implies that the target allocator proxies the requests.
There was a problem hiding this comment.
TBH, I was struggling a bit with how to depict this...do you have any suggestions for improvement?
There was a problem hiding this comment.
This is how would do it, tough I would wait for a second opinion on this.
Merge both graphics into one.
The service_discovery looks good, so you can use it as basis
From ServiceMonitor and PodMonitor draw arrows to represent that they are referencing the metric targets and from the receivers draw arrows to the targets too. This represents the scrape requests.
The graphic would also benefit arrow descriptions.
If this are mermaid graphics, you should also add them to the repository so they can be adapted later on.
I hope this helps.
There was a problem hiding this comment.
Thanks @secustor. I also chatted with @jaronoff97 and came up with a revised version of the first diagram. I also put them into Mermaid to make it easier to edit. If these are okay, I can delete the image files.
There was a problem hiding this comment.
Removed the images in favor of the mermaid diagrams.
Co-authored-by: Sebastian Poxhofer <[email protected]>
Co-authored-by: Sebastian Poxhofer <[email protected]>
…-telemetry#2229 (open-telemetry#2230) * Add diagrams to further enhance Target Allocator documentation - open-telemetry#2229 * Update cmd/otel-allocator/README.md Co-authored-by: Sebastian Poxhofer <[email protected]> * Update cmd/otel-allocator/README.md Co-authored-by: Sebastian Poxhofer <[email protected]> * Update TA diagram * Update TA diagram and description * Add mermaid diagrams * Add mermaid diagrams * Remove diagram images (using mermaid instead) --------- Co-authored-by: Sebastian Poxhofer <[email protected]>
Description: Add diagrams to further clarify Target Allocator functionality
Link to tracking Issue: #2229
Testing: n/a
Documentation: Updated Target Allocator readme and added further clarification to turning on multi-container multi-instrumentation functionality in main readme.