Packages

sealed abstract class WithCallbacks[F[_]] extends MetricFactory[F]

Subtype of MetricFactory that can register metric callbacks with the DSL

Source
MetricFactory.scala
Note

Calling MetricFactory.WithCallbacks.mapK will return a MetricFactory only. To change the type of F and return a MetricFactory.WithCallbacks you must you MetricFactory.WithCallbacks.imapK.

Linear Supertypes
MetricFactory[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WithCallbacks
  2. MetricFactory
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type CounterDsl[MDsl[_[_], _, _[_[_], _], _[_[_], _, _]], A] = HelpStep[MDsl[F, A, Counter, Labelled]]
    Definition Classes
    MetricFactory
  2. type GaugeDsl[MDsl[_[_], _, _[_[_], _], _[_[_], _, _]], A] = HelpStep[MDsl[F, A, Gauge, Labelled]]
    Definition Classes
    MetricFactory
  3. type HistogramCallbackDsl[G[_], A, M[_[_], _], L[_[_], _, _]] = internal.MetricDsl.WithCallbacks[G, A, Value[A], M, L]
  4. type HistogramDsl[MDsl[_[_], _, _[_[_], _], _[_[_], _, _]], A] = HelpStep[BucketDsl[MDsl[F, A, Histogram, Labelled], A]]
    Definition Classes
    MetricFactory
  5. type SimpleCallbackDsl[G[_], A, M[_[_], _], L[_[_], _, _]] = internal.MetricDsl.WithCallbacks[G, A, A, M, L]
  6. type SummaryCallbackDsl[A] = HelpStep[internal.summary.SummaryDsl.WithCallbacks[F, A, Value[A]]]
  7. type SummaryDslLambda[A] = HelpStep[Base[F, A]]
    Definition Classes
    MetricFactory

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. val commonLabels: CommonLabels
    Definition Classes
    MetricFactory
  7. def counter(name: Name): TypeStep[[β$8$]HelpStep[internal.MetricDsl.WithCallbacks[F, β$8$, β$8$, Counter, Labelled]]]

    Starts creating a "counter" metric.

    Starts creating a "counter" metric.

    name

    Counter.Name value

    returns

    Counter builder

    Definition Classes
    WithCallbacks → MetricFactory
  8. def dropCommonLabels: WithCallbacks[F]

    Creates a new instance of MetricFactory with any Metric.CommonLabels

    Creates a new instance of MetricFactory with any Metric.CommonLabels

    Definition Classes
    WithCallbacks → MetricFactory
  9. def dropPrefix: WithCallbacks[F]

    Creates a new instance of MetricFactory without a Metric.Prefix set

    Creates a new instance of MetricFactory without a Metric.Prefix set

    Definition Classes
    WithCallbacks → MetricFactory
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. def gauge(name: Name): TypeStep[[β$6$]HelpStep[internal.MetricDsl.WithCallbacks[F, β$6$, β$6$, Gauge, Labelled]]]

    Starts creating a "gauge" metric.

    Starts creating a "gauge" metric.

    name

    Gauge.Name value

    returns

    Gauge builder

    Definition Classes
    WithCallbacks → MetricFactory
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def histogram(name: Name): TypeStep[[β$10$]HelpStep[BucketDsl[internal.MetricDsl.WithCallbacks[F, β$10$, Value[β$10$], Histogram, Labelled], β$10$]]]

    Starts creating a "histogram" metric.

    Starts creating a "histogram" metric.

    name

    Histogram.Name value

    returns

    Histogram builder

    Definition Classes
    WithCallbacks → MetricFactory
  17. def imapK[G[_]](fk: ~>[F, G], gk: ~>[G, F])(implicit F: MonadCancel[F, _], G: MonadCancel[G, _]): WithCallbacks[G]

    Given a natural transformation from F to G and from G to F, transforms this MetricFactory.WithCallbacks from effect F to effect G.

    Given a natural transformation from F to G and from G to F, transforms this MetricFactory.WithCallbacks from effect F to effect G. The G constraint can also be satisfied by requiring a Functor[G].

  18. def info(name: Name): HelpStep[BuildStep[F, Info[F, Map[Name, String]]]]

    Starts creating an "info" metric.

    Starts creating an "info" metric.

    name

    Info.Name value

    returns

    Info builder

    Definition Classes
    MetricFactory
    Example:

    1. metrics.info("app_info").help("my counter help").build
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def mapK[G[_]](fk: ~>[F, G])(implicit F: MonadCancel[F, _], G: MonadCancel[G, _]): MetricFactory[G]

    Given a natural transformation from F to G, transforms this MetricFactory from effect F to effect G.

    Given a natural transformation from F to G, transforms this MetricFactory from effect F to effect G. The G constraint can also be satisfied by requiring a Functor[G].

    Definition Classes
    MetricFactory
  21. def metricCollectionCallback(collection: F[MetricCollection]): BuildStep[F, Unit]
  22. val metricRegistry: MetricRegistry[F]
    Attributes
    protected[prometheus4cats]
    Definition Classes
    WithCallbacks → MetricFactory
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. val prefix: Option[Prefix]
    Definition Classes
    MetricFactory
  27. def summary(name: Name): TypeStep[SummaryCallbackDsl]
    Definition Classes
    WithCallbacks → MetricFactory
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. def withCommonLabels(commonLabels: CommonLabels): WithCallbacks[F]

    Creates a new instance of MetricFactory with the provided Metric.CommonLabels

    Creates a new instance of MetricFactory with the provided Metric.CommonLabels

    Definition Classes
    WithCallbacks → MetricFactory
  34. def withPrefix(prefix: Prefix): WithCallbacks[F]

    Creates a new instance of MetricFactory with the given Metric.Prefix set

    Creates a new instance of MetricFactory with the given Metric.Prefix set

    Definition Classes
    WithCallbacks → MetricFactory

Inherited from MetricFactory[F]

Inherited from AnyRef

Inherited from Any

Ungrouped