prometheus4cats
2.0.0-RC1
API
Generated with
prometheus4cats/prometheus4cats/OutcomeRecorder/ExemplarLabelledOutcomeRecorderSyntax

ExemplarLabelledOutcomeRecorderSyntax

prometheus4cats.OutcomeRecorder$.ExemplarLabelledOutcomeRecorderSyntax
implicit class ExemplarLabelledOutcomeRecorderSyntax[F[_], -A, B](recorder: Aux[F, B, A, [F[_], A, B] =>> Counter[F, A, B]])(implicit ev: Unit =:!= A)

Attributes

Source
OutcomeRecorder.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

final def recordOutcome[C, E](outcome: Outcome[F, E, C], labels: A, recordExemplarOnSucceeded: Boolean, recordExemplarOnErrored: Boolean, recordExemplarOnCanceled: Boolean)(implicit F: FlatMap[F], exemplar: Exemplar[F]): F[Unit]

Record the result of provided cats.effect.kernel.Outcome

Record the result of provided cats.effect.kernel.Outcome

The resulting metrics depend on the underlying implementation. See OutcomeRecorder.fromCounter and OutcomeRecorder.fromGauge for more details.

Value parameters

labels

labels to add to the underlying metric

outcome

the cats.effect.kernel.Outcome to be recorded

Attributes

Source
OutcomeRecorder.scala
final def recordOutcomeWithComputedLabels[C, E](outcome: Outcome[F, E, C], labelsCanceled: A, recordExemplarOnSucceeded: Boolean, recordExemplarOnErrored: Boolean, recordExemplarOnCanceled: Boolean)(labelsSuccess: C => A, labelsError: E => A)(implicit F: FlatMap[F], exemplar: Exemplar[F]): F[Unit]

Record the result of provided cats.effect.kernel.Outcome computing additional labels from the result.

Record the result of provided cats.effect.kernel.Outcome computing additional labels from the result.

The resulting metrics depend on the underlying implementation. See OutcomeRecorder.fromCounter and OutcomeRecorder.fromGauge for more details.

Value parameters

labelsCanceled

labels to add when the operation is canceled

labelsError

function to compute labels from the exception that was raised if the operation is unsuccessful

labelsSuccess

function to compute labels from the result of fb when the operation is successful

outcome

the cats.effect.kernel.Outcome to be recorded

Attributes

Source
OutcomeRecorder.scala
final def surround[C](fb: F[C], labels: A, recordExemplarOnSucceeded: Boolean, recordExemplarOnErrored: Boolean, recordExemplarOnCanceled: Boolean)(implicit F: MonadCancelThrow[F], exemplar: Exemplar[F]): F[C]

Surround an operation and evaluate its outcome using an instance of cats.effect.kernel.MonadCancel.

Surround an operation and evaluate its outcome using an instance of cats.effect.kernel.MonadCancel.

The resulting metrics depend on the underlying implementation. See OutcomeRecorder.fromCounter and OutcomeRecorder.fromGauge for more details.

Value parameters

fb

operation to be evaluated

labels

labels to add to the underlying metric

Attributes

Source
OutcomeRecorder.scala
final def surroundWithComputedLabels[C](fb: F[C], labelsCanceled: A, recordExemplarOnSucceeded: Boolean, recordExemplarOnErrored: Boolean, recordExemplarOnCanceled: Boolean)(labelsSuccess: C => A, labelsError: Throwable => A)(implicit F: MonadCancelThrow[F], exemplar: Exemplar[F]): F[C]

Surround an operation and evaluate its outcome using an instance of cats.effect.kernel.MonadCancel, computing additional labels from the result.

Surround an operation and evaluate its outcome using an instance of cats.effect.kernel.MonadCancel, computing additional labels from the result.

The resulting metrics depend on the underlying implementation. See OutcomeRecorder.fromCounter and OutcomeRecorder.fromGauge for more details.

Value parameters

fb

operation to be evaluated

labelsCanceled

labels to add when the operation is canceled

labelsError

function to compute labels from the exception that was raised if the operation is unsuccessful

labelsSuccess

function to compute labels from the result of fb when the operation is successful

Attributes

Source
OutcomeRecorder.scala
Generated with