fiadliel/prometheus_client_scala

Scala client for Prometheus monitoring

Prometheus client for Scala

This Prometheus client offers an idiomatic API for instrumenting applications written in Scala. It tries to provide an API which is efficient, easy to use. Also, as far as possible, it tries to report API usage errors at compile time instead of runtime.

Helper modules support Play controller timing, along with helper syntax for the cats.effect.Sync typeclass, fs2.Task, scalaz.concurrent.Task and monix.eval.Task.

In addition, it offers some extra insight into your program by exposing some useful VM statistics.

Adding the library to your build

libraryDependencies += "org.lyranthe.prometheus" %% "client" % "0.9.0-M1"

Documentation

• Guide
• API

prometheus_client_scala's Issues

Broken links in README

The links for Guide and API in the README are broken. Would be great to update these to the correct URLs to easily get more information of how to use this library

When to reset a counter

Currently counters are not reset when the metric is read from the Registry and published, so I'm not sure how to display a RPM metric.

Am I missing something?

I may suggest to have some sort of Resettable and Unbounded Counters.

Formers are reset to 0 every time they are read, the latter will grow indefinitely.

BUG: registering metrics with duplicate names leads to the "detached" instance

Because result of the registering is ignored here the new metric appears to be registered but no observations are visible on the reading side.

Support HTTPS for PushRegistry

Currently the protocol of the URL is hardcoded in PushRegistry.

Please make it a parameter so one can connect to a https gateway.

Thanks a lot.

Play 2.6.0

Hi.

I just discovered your project... just what I was looking for. 😄

Since Play 2.6.0 was released a few days ago, a corresponding play26_2.11 and play26_2.12 would be nice!

Cheers.

Accept HTTP 200 from gateway

Since gateway release 0.10.0, the response code is 200 instead of 202. The client should be updated accordingly here: https://github.com/fiadliel/prometheus_client_scala/blob/master/client/shared/src/main/scala/org/lyranthe/prometheus/client/PushRegistry.scala#L40

Created 2 Counters with same name, only one displayed.

Started to get familiar with the lib and mistakenly created 2 counters with the same name and in the /metrics could only see one.

While it may be normal to see only one of them, I'm wondering whether or not should be possible to register on the same registry 2 metrics with the same name.

MetricName should check for name format

Something like that would be nice.

case class MetricName(name: String) extends AnyVal {
 assert(PrometheusMetricFormat.findFirstIn(name).isDefined, s"$name does not match required metric format ${PrometheusMetricFormat.regex}"))
}