prometheus4cats-docs
2.0.0
API
Generated with
prometheus4cats-docs/prometheus4cats/OutcomeRecorder

OutcomeRecorder

prometheus4cats.OutcomeRecorder$
See theOutcomeRecorder companion class
object OutcomeRecorder

Attributes

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

Members list

Type members

Classlikes

implicit class ExemplarLabelledOutcomeRecorderSyntax[F[_], -A, B](recorder: Aux[F, B, A, [F[_], A, B] =>> Counter[F, A, B]])(implicit ev: Neq[Unit, A])

Attributes

Source
OutcomeRecorder.scala
Supertypes
class Object
trait Matchable
class Any
implicit class ExemplarOutcomeRecorderSyntax[F[_], A](recorder: Aux[F, A, Unit, [F[_], A, B] =>> Counter[F, A, B]])

Attributes

Source
OutcomeRecorder.scala
Supertypes
class Object
trait Matchable
class Any
implicit class LabelledOutcomeRecorder[F[_], -A](recorder: OutcomeRecorder[F, A])(implicit ev: Neq[Unit, A])

Attributes

Source
OutcomeRecorder.scala
Supertypes
class Object
trait Matchable
class Any
implicit class OutcomeRecorderSyntax[F[_]](recorder: OutcomeRecorder[F, Unit])

Attributes

Source
OutcomeRecorder.scala
Supertypes
class Object
trait Matchable
class Any
object Status

Attributes

Companion
trait
Source
OutcomeRecorder.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Status.type
sealed trait Status

Attributes

Companion
object
Source
OutcomeRecorder.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Canceled.type
object Errored.type
object Succeeded.type

Types

type Aux[F[_], A, B, M[_[_], _, _]] = OutcomeRecorder[F, B] { type Metric = M[F, A, (B, Status)]; }

Attributes

Source
OutcomeRecorder.scala

Value members

Concrete methods

def fromCounter[F[_], A, B](counter: Counter[F, A, (B, Status)]): Aux[F, A, B, [F[_], A, B] =>> Counter[F, A, B]]

Create an OutcomeRecorder from a Counter instance, where its labels type is a tuple of the original labels of the counter and Status.

Create an OutcomeRecorder from a Counter instance, where its labels type is a tuple of the original labels of the counter and Status.

This works by incrementing a counter with a label value that corresponds to the value Status on each invocation.

The best way to construct a counter based OutcomeRecorder is to use the .asOutcomeRecorder on the counter DSL provided by MetricFactory.

Attributes

Returns

an OutcomeRecorder.Aux that is annotated with the type of underlying metric, in this case Counter

Source
OutcomeRecorder.scala
def fromGauge[F[_] : MonadCancelThrow, A, B](gauge: Gauge[F, A, (B, Status)]): Aux[F, A, B, [F[_], A, B] =>> Gauge[F, A, B]]

Create an OutcomeRecorder from a Gauge instance, where its only label type is a tuple of the original labels of the counter and Status.

Create an OutcomeRecorder from a Gauge instance, where its only label type is a tuple of the original labels of the counter and Status.

This works by setting gauge with a label value that corresponds to the value of Status to 1 on each invocation, while the other statuses are set to 0.

The best way to construct a gauge based OutcomeRecorder is to use the .asOutcomeRecorder on the gauge DSL provided by MetricFactory.

Attributes

Returns

an OutcomeRecorder.Aux that is annotated with the type of underlying metric, in this case Gauge

Source
OutcomeRecorder.scala

Implicits

Implicits

final implicit def ExemplarLabelledOutcomeRecorderSyntax[F[_], A, B](recorder: Aux[F, B, A, [F[_], A, B] =>> Counter[F, A, B]])(implicit ev: Neq[Unit, A]): ExemplarLabelledOutcomeRecorderSyntax[F, A, B]

Attributes

Source
OutcomeRecorder.scala
final implicit def ExemplarOutcomeRecorderSyntax[F[_], A](recorder: Aux[F, A, Unit, [F[_], A, B] =>> Counter[F, A, B]]): ExemplarOutcomeRecorderSyntax[F, A]

Attributes

Source
OutcomeRecorder.scala
final implicit def LabelledOutcomeRecorder[F[_], A](recorder: OutcomeRecorder[F, A])(implicit ev: Neq[Unit, A]): LabelledOutcomeRecorder[F, A]

Attributes

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

Attributes

Source
OutcomeRecorder.scala
Generated with