MetricDsl

class MetricDsl[F[_], A, M[_[_], _], L[_[_], _, _]]
Companion:
object
Source:
package.scala
class Object
trait Matchable
class Any
class WithCallbacks[F, A, A0, M, L]
class WithCallbacks[F, A, A0]
class AgeBucketsStep[F, A]
class SummaryDsl[F, A]

Value members

Concrete methods

override def build: Resource[F, M[F, A]]

Builds the metric

Builds the metric

Definition Classes
BuildStep
Source:
package.scala
def label[B]: FirstLabelApply[F, A, 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.

Source:
package.scala
def labels[B, N <: Nat](labelNames: Sized[IndexedSeq[Name], N])(f: B => Sized[IndexedSeq[String], N]): LabelsBuildStep[F, A, B, N, L]

Creates a metric whose label sizes are checked at compile time. Takes a sized collection of label name and a function converting some label object B to a sized collection of strings.

Creates a metric whose label sizes are checked at compile time. Takes a sized collection of label name and a function converting some label object B to a sized collection of strings.

This is useful where a single type B translates to multiple labels. Once invoked, this cannot be used with the singular .label syntax.

Type parameters:
B

type to convert into labels

N

size of the label collection

Value parameters:
f

function to convert B in to a sized collection of label values

labelNames

sized collection of labels names

Source:
package.scala
def unsafeLabels(labelNames: IndexedSeq[Name]): BuildStep[F, L[F, A, 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

Source:
package.scala
def unsafeLabels(labelNames: Name*): BuildStep[F, L[F, A, 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

Source:
package.scala

Inherited methods

def map[B](f: M[F, A] => B): BuildStep[F, B]
Inherited from:
BuildStep (hidden)
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

Inherited from:
BuildStep (hidden)
Source:
package.scala