trait CallbackRegistry[F[_]] extends AnyRef

Trait for registering callbacks against different backends. May be implemented by anyone for use with MetricFactory.WithCallbacks

Source
CallbackRegistry.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
DoubleCallbackRegistry
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CallbackRegistry
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def registerDoubleCounterCallback[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], callback: F[NonEmptyList[(Double, A)]])(f: (A) ⇒ IndexedSeq[String]): Resource[F, Unit]

    Register a labelled counter value that records scala.Double values against a metrics registry

    Register a labelled counter value that records scala.Double values against a metrics registry

    prefix

    optional Metric.Prefix to be prepended to the metric name

    name

    Counter.Name metric name

    help

    Metric.Help string to describe the metric

    commonLabels

    Metric.CommonLabels map of common labels to be added to the metric

    labelNames

    an scala.IndexedSeq of Label.Names to annotate the metric with

    callback

    Some effectful operation that returns a cats.data.NonEmptyList of scala.Double and label value tuples

    f

    a function from A to an scala.IndexedSeq of java.lang.String that provides label values, which must be paired with their corresponding name in the scala.IndexedSeq of Label.Names

    returns

    An empty side effect to indicate that the callback has been registered

  2. abstract def registerDoubleGaugeCallback[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], callback: F[NonEmptyList[(Double, A)]])(f: (A) ⇒ IndexedSeq[String]): Resource[F, Unit]

    Register a labelled gauge value that records scala.Double values against a metrics registry

    Register a labelled gauge value that records scala.Double values against a metrics registry

    prefix

    optional Metric.Prefix to be prepended to the metric name

    name

    Counter.Name metric name

    help

    Metric.Help string to describe the metric

    commonLabels

    Metric.CommonLabels map of common labels to be added to the metric

    labelNames

    an scala.IndexedSeq of Label.Names to annotate the metric with

    callback

    Some effectful operation that returns a cats.data.NonEmptyList of scala.Double and label value tuples

    f

    a function from A to an scala.IndexedSeq of java.lang.String that provides label values, which must be paired with their corresponding name in the scala.IndexedSeq of Label.Names

    returns

    An empty side effect to indicate that the callback has been registered

  3. abstract def registerDoubleHistogramCallback[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], buckets: NonEmptySeq[Double], callback: F[NonEmptyList[(Value[Double], A)]])(f: (A) ⇒ IndexedSeq[String]): Resource[F, Unit]

    Register a labelled histogram value that records scala.Double values against a metrics registry

    Register a labelled histogram value that records scala.Double values against a metrics registry

    prefix

    optional Metric.Prefix to be prepended to the metric name

    name

    Counter.Name metric name

    help

    Metric.Help string to describe the metric

    commonLabels

    Metric.CommonLabels map of common labels to be added to the metric

    labelNames

    an scala.IndexedSeq of Label.Names to annotate the metric with

    callback

    Some effectful operation that returns a cats.data.NonEmptyList of Histogram.Value parameterised with scala.Double and label value tuples

    f

    a function from A to an scala.IndexedSeq of java.lang.String that provides label values, which must be paired with their corresponding name in the scala.IndexedSeq of Label.Names

    returns

    An empty side effect to indicate that the callback has been registered

  4. abstract def registerDoubleSummaryCallback[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], callback: F[NonEmptyList[(Value[Double], A)]])(f: (A) ⇒ IndexedSeq[String]): Resource[F, Unit]

    Register a labelled summary value that records scala.Double values against a metrics registry

    Register a labelled summary value that records scala.Double values against a metrics registry

    prefix

    optional Metric.Prefix to be prepended to the metric name

    name

    Summary.Name metric name

    help

    Metric.Help string to describe the metric

    commonLabels

    Metric.CommonLabels map of common labels to be added to the metric

    labelNames

    an scala.IndexedSeq of Label.Names to annotate the metric with

    callback

    Some effectful operation that returns a cats.data.NonEmptyList of Summary.Value parameterised with scala.Double and label value tuples

    f

    a function from A to an scala.IndexedSeq of java.lang.String that provides label values, which must be paired with their corresponding name in the scala.IndexedSeq of Label.Names

    returns

    a Summary wrapped in whatever side effect that was performed in registering it

  5. abstract def registerLongCounterCallback[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], callback: F[NonEmptyList[(Long, A)]])(f: (A) ⇒ IndexedSeq[String]): Resource[F, Unit]

    Register a labelled counter value that records scala.Long values against a metrics registry

    Register a labelled counter value that records scala.Long values against a metrics registry

    prefix

    optional Metric.Prefix to be prepended to the metric name

    name

    Counter.Name metric name

    help

    Metric.Help string to describe the metric

    commonLabels

    Metric.CommonLabels map of common labels to be added to the metric

    labelNames

    an scala.IndexedSeq of Label.Names to annotate the metric with

    callback

    Some effectful operation that returns a cats.data.NonEmptyList of scala.Long and label value tuples

    f

    a function from A to an scala.IndexedSeq of java.lang.String that provides label values, which must be paired with their corresponding name in the scala.IndexedSeq of Label.Names

    returns

    An empty side effect to indicate that the callback has been registered

  6. abstract def registerLongGaugeCallback[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], callback: F[NonEmptyList[(Long, A)]])(f: (A) ⇒ IndexedSeq[String]): Resource[F, Unit]

    Register a labelled gauge value that records scala.Long values against a metrics registry

    Register a labelled gauge value that records scala.Long values against a metrics registry

    prefix

    optional Metric.Prefix to be prepended to the metric name

    name

    Counter.Name metric name

    help

    Metric.Help string to describe the metric

    commonLabels

    Metric.CommonLabels map of common labels to be added to the metric

    labelNames

    an scala.IndexedSeq of Label.Names to annotate the metric with

    callback

    Some effectful operation that returns a cats.data.NonEmptyList of scala.Long and label value tuples

    f

    a function from A to an scala.IndexedSeq of java.lang.String that provides label values, which must be paired with their corresponding name in the scala.IndexedSeq of Label.Names

    returns

    An empty side effect to indicate that the callback has been registered

  7. abstract def registerLongHistogramCallback[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], buckets: NonEmptySeq[Long], callback: F[NonEmptyList[(Value[Long], A)]])(f: (A) ⇒ IndexedSeq[String]): Resource[F, Unit]

    Register a labelled histogram value that records scala.Long values against a metrics registry

    Register a labelled histogram value that records scala.Long values against a metrics registry

    prefix

    optional Metric.Prefix to be prepended to the metric name

    name

    Counter.Name metric name

    help

    Metric.Help string to describe the metric

    commonLabels

    Metric.CommonLabels map of common labels to be added to the metric

    labelNames

    an scala.IndexedSeq of Label.Names to annotate the metric with

    callback

    Some effectful operation that returns a cats.data.NonEmptyList of Histogram.Value parameterised with scala.Long and label value tuples

    f

    a function from A to an scala.IndexedSeq of java.lang.String that provides label values, which must be paired with their corresponding name in the scala.IndexedSeq of Label.Names

    returns

    An empty side effect to indicate that the callback has been registered

  8. abstract def registerLongSummaryCallback[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], callback: F[NonEmptyList[(Value[Long], A)]])(f: (A) ⇒ IndexedSeq[String]): Resource[F, Unit]

    Register a labelled summary value that records scala.Long values against a metrics registry

    Register a labelled summary value that records scala.Long values against a metrics registry

    prefix

    optional Metric.Prefix to be prepended to the metric name

    name

    Summary.Name metric name

    help

    Metric.Help string to describe the metric

    commonLabels

    Metric.CommonLabels map of common labels to be added to the metric

    labelNames

    an scala.IndexedSeq of Label.Names to annotate the metric with

    callback

    Some effectful operation that returns a cats.data.NonEmptyList of Summary.Value parameterised with scala.Long and label value tuples

    f

    a function from A to an scala.IndexedSeq of java.lang.String that provides label values, which must be paired with their corresponding name in the scala.IndexedSeq of Label.Names

    returns

    a Summary wrapped in whatever side effect that was performed in registering it

  9. abstract def registerMetricCollectionCallback(prefix: Option[Prefix], commonLabels: CommonLabels, callback: F[MetricCollection]): Resource[F, Unit]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def imapK[G[_]](fk: ~>[F, G], gk: ~>[G, F])(implicit F: MonadCancel[F, _], G: MonadCancel[G, _]): CallbackRegistry[G]

    Given a natural transformation from F to G and from G to F, transforms this CallbackRegistry from effect F to effect G

  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped