Class/Object

io.chrisdavenport.epimetheus

Gauge

Related Docs: object Gauge | package epimetheus

Permalink

sealed abstract class Gauge[F[_]] extends AnyRef

Gauge metric, to report instantaneous values.

Gauges can go both up and down.

An Example With No Labels:

for {
  cr <- CollectorRegistry.build
  gauge <- Gauge.noLabels(cr, "gauge_value", "Gauge Help")
  _ <- gauge.inc
  _ <- gauge.dec
} yield ()

An Example With Labels:

for {
  cr <- CollectorRegistry.build
  gauge <- Gauge.labelled(cr, "gauge_value", "Gauge Help", Sized("foo"), {s: String => Sized(s)})
  _ <- gauge.label("bar").inc
  _ <- gauge.label("bar").dec
  _ <- gauge.label("baz").inc
  _ <- gauge.label("baz").dec

These can be aggregated and processed together much more easily in the Prometheus server than individual metrics for each labelset.

Source
Gauge.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Gauge
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def dec: F[Unit]

    Permalink
  2. abstract def decBy(d: Double): F[Unit]

    Permalink
  3. abstract def get: F[Double]

    Permalink
  4. abstract def inc: F[Unit]

    Permalink
  5. abstract def incBy(d: Double): F[Unit]

    Permalink
  6. abstract def set(d: Double): F[Unit]

    Permalink

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped