prometheus4cats
2.0.0-RC1
API
Generated with
prometheus4cats/prometheus4cats/prometheus4cats.internal/MetricDsl/WithCallbacks

WithCallbacks

prometheus4cats.internal.MetricDsl$.WithCallbacks
class WithCallbacks[F[_], A, A0, L[_[_], _, _]](makeMetric: LabelledMetricPartiallyApplied[F, A, L], makeCallback: LabelledCallbackPartiallyApplied[F, A0])(implicit evidence$5: Functor[F]) extends MetricDsl[F, A, L], CallbackStep[F, A0]

Attributes

Source
package.scala
Graph
Supertypes
trait CallbackStep[F, A0]
class MetricDsl[F, A, L]
trait BuildStep[F, L[F, A, Unit]]
class Object
trait Matchable
class Any
Show all
Known subtypes
class WithCallbacks[F, A, A0]

Members list

Value members

Concrete methods

override def label[B]: WithCallbacks[F, A, A0, B, L]

Sets the first label of the metric. Requires either a Show instance for the label type, or a method converting the label value to a String.

Sets the first label of the metric. Requires either a Show instance for the label type, or a method converting the label value to a String.

Attributes

Definition Classes
Source
package.scala
override def labels[B](labels: (Name, B => Value)*): WithCallbacks[F, A, A0, B, L]

Sets the first labels for a metric coming from a single type. Takes a collection of label name and a function converting some label object B to a string pairs.

Sets the first labels for a metric coming from a single type. Takes a collection of label name and a function converting some label object B to a string pairs.

This is useful where a single type B translates to multiple labels.

Type parameters

B

type to convert into labels

N

size of the label collection

Value parameters

labelNames

collection of labels name & function to convert B in to a label value pairs

Attributes

Definition Classes
Source
package.scala
override def labelsFrom[B](implicit encoder: Encoder[B]): WithCallbacks[F, A, A0, B, L]

Attributes

Definition Classes
Source
package.scala
override def unsafeLabels(labelNames: IndexedSeq[Name]): CallbackBuildStep[F, L[F, A, Map[Name, String]], NonEmptyList[(A0, Map[Name, String])]]

Creates a metric whose labels aren't checked at compile time. Provides a builder for a labelled metric that takes a map of label names to their values.

Creates a metric whose labels aren't checked at compile time. Provides a builder for a labelled metric that takes a map of label names to their values.

This should be used when the labels are not known at compile time and potentially come from some source at runtime.

Value parameters

labelNames

names of the labels

Attributes

Definition Classes
Source
package.scala
override def unsafeLabels(labelNames: Name*): CallbackBuildStep[F, L[F, A, Map[Name, String]], NonEmptyList[(A0, Map[Name, String])]]

Creates a metric whose labels aren't checked at compile time. Provides a builder for a labelled metric that takes a map of label names to their values.

Creates a metric whose labels aren't checked at compile time. Provides a builder for a labelled metric that takes a map of label names to their values.

This should be used when the labels are not known at compile time and potentially come from some source at runtime.

Value parameters

labelNames

glob of names of the labels

Attributes

Definition Classes
Source
package.scala

Inherited methods

override def build: Resource[F, L[F, A, Unit]]

Builds the metric

Builds the metric

Attributes

Definition Classes
Inherited from:
MetricDsl
Source
package.scala
def callback(callback: F[A0]): BuildStep[F, Unit]

Attributes

Inherited from:
CallbackStep
Source
package.scala
def contramapCallback[B](f: B => A0)(implicit F: Functor[F]): CallbackStep[F, B]

Attributes

Inherited from:
CallbackStep
Source
package.scala
def map[B](f: L[F, A, Unit] => B): BuildStep[F, B]

Attributes

Inherited from:
BuildStep
Source
package.scala
def unsafeBuild(implicit F: MonadCancelThrow[F]): F[A]

Unsafely builds the metric, but does not deallocate

Unsafely builds the metric, but does not deallocate

Attributes

Inherited from:
BuildStep
Source
package.scala
Generated with