Counter

Counter metric, to track counts, running totals, or events.

If your use case can go up or down consider using a Gauge instead. Use the rate() function in Prometheus to calculate the rate of increase of a Counter. By convention, the names of Counters are suffixed by _total.

An Example Counter without Labels:

for {
  cr <- CollectorRegistry.build[IO]
  successCounter <- Counter.noLabels(cr, "example_success_total", "Example Counter of Success")
  failureCounter <- Counter.noLabels(Cr, "example_failure_total", "Example Counter of Failure")
  _ <- IO(println("Action Here")).guaranteeCase{
    case ExitCase.Completed => successCounter.inc
    case _ => failureCounter.inc
  }
} yield ()

An Example of a Counter with Labels:

for {
  cr <- CollectorRegistry.build[IO]
  counter <- Counter.labelled(cr, "example_total", "Example Counter", Sized("foo"), {s: String => Sized(s)})
  _ <- counter.label("bar").inc
  _ <- counter.label("baz").inc
} yield ()

Source: Counter.scala

Linear Supertypes

AnyRef, Any

Abstract Value Members

abstract def get: F[Double]

Access to the current value of this Counter.
abstract def inc: F[Unit]

Increment the value of this Counter by 1.
abstract def incBy(d: Double): F[Unit]

Increment the value of this counter by the provided value.
Increment the value of this counter by the provided value.
d
The value to increase the Counter by.

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Counter | package epimetheus

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

Abstract Value Members

abstract def get: F[Double]

abstract def inc: F[Unit]

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

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped