prometheus4cats-docs
2.0.0-RC1
API
Generated with
prometheus4cats-docs/prometheus4cats/Timer

Timer

prometheus4cats.Timer$
See theTimer companion class
object Timer

Attributes

Companion
class
Source
Timer.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Timer.type

Members list

Type members

Classlikes

implicit class ExemplarLabelledTimerSyntax[F[_], A](timer: Aux[F, A, [F[_], A, B] =>> Histogram[F, A, B]])(implicit ev: Unit =:!= A) extends LabelledTimerSyntax[F, A]

Attributes

Source
Timer.scala
Supertypes
class LabelledTimerSyntax[F, A]
class Object
trait Matchable
class Any
implicit class ExemplarTimerSyntax[F[_]](timer: Aux[F, Unit, [F[_], A, B] =>> Histogram[F, A, B]]) extends TimerSyntax[F]

Attributes

Source
Timer.scala
Supertypes
class TimerSyntax[F]
class Object
trait Matchable
class Any
implicit class LabelledTimerSyntax[F[_], A](timer: Timer[F, A])(implicit ev: Unit =:!= A)

Attributes

Source
Timer.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
implicit class TimerSyntax[F[_]](timer: Timer[F, Unit])

Attributes

Source
Timer.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Types

type Aux[F[_], A, M[_[_], _, _]] = Timer[F, A] { type Metric = M[F, Double, A]; }

Attributes

Source
Timer.scala

Value members

Concrete methods

def fromGauge[F[_], A](gauge: Gauge[F, Double, A]): Aux[F, A, [F[_], A, B] =>> Gauge[F, A, B]]

Create a Timer from a Gauge instance.

Create a Timer from a Gauge instance.

This delegates to the underlying Gauge instance which will only ever show the last value for duration of the given operation.

Values are recorded in scala.Doubles by converting a scala.concurrent.duration.FiniteDuration to seconds.

The best way to construct a gauge based Timer is to use the .asTimer on the histogram DSL provided by MetricFactory.

Attributes

Returns

a Timer.Aux that is annotated with the type of underlying metrics, in this case Gauge

Source
Timer.scala
def fromHistogram[F[_], A](histogram: Histogram[F, Double, A]): Aux[F, A, [F[_], A, B] =>> Histogram[F, A, B]]

Create a Timer from a Histogram instance.

Create a Timer from a Histogram instance.

This delegates to the underlying Histogram instance and assumes you have already set up sensible buckets for the distribution of values.

Values are recorded in scala.Doubles by converting a scala.concurrent.duration.FiniteDuration to seconds.

The best way to construct a histogram based Timer is to use the .asTimer on the histogram DSL provided by MetricFactory.

Attributes

Returns

a Timer.Aux that is annotated with the type of underlying metrics, in this case Histogram

Source
Timer.scala
def fromSummary[F[_], A](summary: Summary[F, Double, A]): Aux[F, A, [F[_], A, B] =>> Summary[F, A, B]]

Create a Timer from a Summary instance.

Create a Timer from a Summary instance.

This delegates to the underlying Summary instance and assumes you have already set up sensible buckets for the distribution of values.

Values are recorded in scala.Doubles by converting a scala.concurrent.duration.FiniteDuration to seconds.

The best way to construct a histogram based Timer is to use the .asTimer on the summary DSL provided by MetricFactory.

Attributes

Returns

a Timer.Aux that is annotated with the type of underlying metrics, in this case Summary

Source
Timer.scala

Implicits

Implicits

final implicit def ExemplarLabelledTimerSyntax[F[_], A](timer: Aux[F, A, [F[_], A, B] =>> Histogram[F, A, B]])(implicit ev: Unit =:!= A): ExemplarLabelledTimerSyntax[F, A]

Attributes

Source
Timer.scala
final implicit def ExemplarTimerSyntax[F[_]](timer: Aux[F, Unit, [F[_], A, B] =>> Histogram[F, A, B]]): ExemplarTimerSyntax[F]

Attributes

Source
Timer.scala
final implicit def LabelledTimerSyntax[F[_], A](timer: Timer[F, A])(implicit ev: Unit =:!= A): LabelledTimerSyntax[F, A]

Attributes

Source
Timer.scala
final implicit def TimerSyntax[F[_]](timer: Timer[F, Unit]): TimerSyntax[F]

Attributes

Source
Timer.scala
implicit def labelsContravariant[F[_]]: LabelsContravariant[[_] =>> Timer[F, _$24]]

Attributes

Source
Timer.scala
Generated with