certificates icon indicating copy to clipboard operation
certificates copied to clipboard

Telemetry endpoint

Open jpds opened this issue 3 years ago • 7 comments

What would you like to be added

Prometheus metrics endpoint with some metric examples:

  • Latencies observed of HTTP service requests
  • Number of HTTP requests seen
  • Number of certificates issued
  • Number of challenge types observed
  • Number of errors encountered issuing certs
  • Timestamp for when CAs expire
  • Timestamp for when issued certificates expire

jpds avatar Jan 08 '22 14:01 jpds

  • open-telemetry (comment as a reminder)

dopey avatar Jan 12 '22 18:01 dopey

Hey @jpds, thanks for opening the issue! We agree that step-ca needs a metrics endpoint. A few members on the team mentioned that we might want to implement the metrics in open telemetry format (I believe prometheus can parse that).

We love the idea but unfortunately we don't have time short term to focus on this project. If anyone in the community is interested in contributing, let us know and we'd be happy to have a design discussion. Cheers 🍻

dopey avatar Jan 12 '22 19:01 dopey

An OpenTelemetry integration could also be a good approach for instrumenting the step client one day, if that's something we would want to reconsider.

tashian avatar Jan 12 '22 20:01 tashian

Has this been implemented? If so, in what release?

gdbelvin avatar Jan 20 '22 17:01 gdbelvin

Hey, is there any update on this?

MCWertGaming avatar May 18 '23 10:05 MCWertGaming

Hey, apologies for the radio silence. The best update I can give is that this is still on the roadmap, but it's not prioritized.

For context, we have support for this in our product platform and porting support to open source is not a priority at this time. However, priorities change - if this priority changes we will come back here and update.

dopey avatar Jun 13 '23 18:06 dopey

Several of the metrics mentioned in the OP are implemented in https://github.com/smallstep/certificates/pull/1669 and will be in the next release.

hslatman avatar Feb 27 '24 10:02 hslatman