search

argoproj / argo-workflows

Workflow Engine for Kubernetes
https://argo-workflows.readthedocs.io/
Apache License 2.0
15.12k stars 3.21k forks source link

docs: Clarify headless service for promethus scraping #13667

Closed tico24 closed 2 months ago

tico24 commented 2 months ago

Motivation

The docs now separate prometheus and OTEL metrics information, but there was some prometheus stuff hanging towards the bottom of the page. It makes sense to move this up.

Also people struggled to read the last line about using a headless service, so made it more obvious and updated the example to match.

Joibel commented 2 months ago

Did you deliberately drop the port-forwarding docs?

tico24 commented 2 months ago

Yes, but this will give you the impression I really thought about it. My vague reasoning is that you now define the port, path and security of the URL, and we already define the service. If you can't work out that the service points to the metrics and that you could port forward that, then maybe this isn't for you?

Happy to add it back though.

Joibel commented 2 months ago

We document this elsewhere, and for beginners this is a useful way to understand or remember they can see the numbers there to verify where in this kubernetes world of duct tape and string things aren't going well for them today.