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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CallbackRegistry
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def registerDoubleCounterCallback(prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, callback: F[Double]): F[Unit]

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

    Register a counter value that records scala.Double values against a callback 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

    callback

    Some effectful operation that returns a scala.Double

    returns

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

    Attributes
    protected[prometheus4cats]
  2. abstract def registerDoubleGaugeCallback(prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, callback: F[Double]): F[Unit]

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

    Register a gauge value that records scala.Double values against a callback 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

    callback

    Some effectful operation that returns a scala.Double

    returns

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

    Attributes
    protected[prometheus4cats]
  3. abstract def registerDoubleHistogramCallback(prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, buckets: NonEmptySeq[Double], callback: F[Value[Double]]): F[Unit]

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

    Register a histogram value that records scala.Double values against a callback 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

    callback

    Some effectful operation that returns a Histogram.Value parameterised with scala.Double

    returns

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

    Attributes
    protected[prometheus4cats]
  4. abstract def registerDoubleSummaryCallback(prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, callback: F[Value[Double]]): F[Unit]

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

    Register a 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

    callback

    Some effectful operation that returns a Summary.Value parameterised with scala.Double

    returns

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

    Attributes
    protected[prometheus4cats]
  5. abstract def registerLabelledDoubleCounterCallback[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], callback: F[(Double, A)])(f: (A) => IndexedSeq[String]): 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 scala.Long

    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

    Attributes
    protected[prometheus4cats]
  6. abstract def registerLabelledDoubleGaugeCallback[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], callback: F[(Double, A)])(f: (A) => IndexedSeq[String]): 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 scala.Double

    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

    Attributes
    protected[prometheus4cats]
  7. abstract def registerLabelledDoubleHistogramCallback[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], buckets: NonEmptySeq[Double], callback: F[(Value[Double], A)])(f: (A) => IndexedSeq[String]): 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 Histogram.Value parameterised with scala.Double

    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

    Attributes
    protected[prometheus4cats]
  8. abstract def registerLabelledDoubleSummaryCallback[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], callback: F[(Value[Double], A)])(f: (A) => IndexedSeq[String]): 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 Summary.Value parameterised with scala.Double

    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.Labelled wrapped in whatever side effect that was performed in registering it

    Attributes
    protected[prometheus4cats]
  9. abstract def registerLabelledLongCounterCallback[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], callback: F[(Long, A)])(f: (A) => IndexedSeq[String]): 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 scala.Double

    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

    Attributes
    protected[prometheus4cats]
  10. abstract def registerLabelledLongGaugeCallback[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], callback: F[(Long, A)])(f: (A) => IndexedSeq[String]): 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 scala.Long

    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

    Attributes
    protected[prometheus4cats]
  11. abstract def registerLabelledLongHistogramCallback[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], buckets: NonEmptySeq[Long], callback: F[(Value[Long], A)])(f: (A) => IndexedSeq[String]): 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 Histogram.Value parameterised with scala.Long

    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

    Attributes
    protected[prometheus4cats]
  12. abstract def registerLabelledLongSummaryCallback[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], callback: F[(Value[Long], A)])(f: (A) => IndexedSeq[String]): 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 Summary.Value parameterised with scala.Long

    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.Labelled wrapped in whatever side effect that was performed in registering it

    Attributes
    protected[prometheus4cats]
  13. abstract def registerLongCounterCallback(prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, callback: F[Long]): F[Unit]

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

    Register a counter value that records scala.Long values against a callback 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

    callback

    Some effectful operation that returns a scala.Long

    returns

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

    Attributes
    protected[prometheus4cats]
  14. abstract def registerLongGaugeCallback(prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, callback: F[Long]): F[Unit]

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

    Register a gauge value that records scala.Long values against a callback 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

    callback

    Some effectful operation that returns a scala.Long

    returns

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

    Attributes
    protected[prometheus4cats]
  15. abstract def registerLongHistogramCallback(prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, buckets: NonEmptySeq[Long], callback: F[Value[Long]]): F[Unit]

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

    Register a histogram value that records scala.Long values against a callback 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

    callback

    Some effectful operation that returns a Histogram.Value parameterised with scala.Long

    returns

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

    Attributes
    protected[prometheus4cats]
  16. abstract def registerLongSummaryCallback(prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, callback: F[Value[Long]]): F[Unit]

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

    Register a 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

    callback

    Some effectful operation that returns a Summary.Value parameterised with scala.Long

    returns

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

    Attributes
    protected[prometheus4cats]

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(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): 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[_ <: AnyRef]
    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]): 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(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped