documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Document how to grab internal metrics from clients

Open jpkrohling opened this issue 7 years ago • 2 comments

Each client (Java, Go, possibly others) stores internal metrics, like the number of spans sampled, traces submitted, and so on.

For the Java client, the following issue can be used as a base for this documentation: https://github.com/jaegertracing/jaeger-client-java/issues/350

cc @objectiser , @JStickler

jpkrohling avatar Feb 23 '18 15:02 jpkrohling

I would suggest a separate issue for each client unless you think one person knows enough about all the clients and programming languages to be able to write all the docs at once. Also, reviews could get confusing if one issue covers multiple clients/programming languages. Separate issues would also mean that each issue could get closed as the docs are written for that client instead of this one staying open while each client doc is written.

JStickler avatar Feb 23 '18 19:02 JStickler

Most of the clients expose metrics in a common format, via a REST endpoint, so that tools like Prometheus can get those. Part of this documentation item is to explain that, along with a short description about each of the reported metrics (like, what is span_context_decoding_errors?)

We'd also, potentially, document specific behavior/configuration from the "official" clients, like Java and Go, like how to add the Micrometer integration.

jpkrohling avatar Feb 26 '18 07:02 jpkrohling