Object/Class

io.chrisdavenport.epimetheus

Histogram

Related Docs: class Histogram | package epimetheus

Permalink

object Histogram

Histogram Constructors, Convenience Methods and Unsafe Histogram Access

Convenience function exposed here will also be exposed as implicit syntax enhancements on the Histogram

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

Type Members

  1. final class UnlabelledHistogram[F[_], A] extends AnyRef

    Permalink

    Generic UnlabelledHistorgram

    Generic UnlabelledHistorgram

    It is necessary to apply a value of type A to this histogram to be able to take any measurements.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. object Unsafe

    Permalink

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. val defaults: List[Double]

    Permalink

    Default Buckets

    Default Buckets

    Intended to cover a typical web/rpc request from milliseconds to seconds.

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  14. def labelled[F[_], A, N <: Nat](cr: CollectorRegistry[F], name: Name, help: String, labels: Sized[IndexedSeq[Label], N], f: (A) ⇒ Sized[IndexedSeq[String], N])(implicit arg0: Sync[F]): F[UnlabelledHistogram[F, A]]

    Permalink

    Constructor for a labelled Histogram.

    Constructor for a labelled Histogram. Default buckets are defaults and are intended to cover a typical web/rpc request from milliseconds to seconds.

    This generates a specific number of labels via Sized, in combination with a function to generate an equally Sized set of labels from some type. Values are applied by position.

    This counter needs to have a label applied to the UnlabelledHistogram in order to be measureable or recorded.

    cr

    CollectorRegistry this Histogram will be registred with

    name

    The name of the Histogram.

    help

    The help string of the metric

    labels

    The name of the labels to be applied to this metric

    f

    Function to take some value provided in the future to generate an equally sized list of strings as the list of labels. These are assigned to labels by position.

  15. def labelledBuckets[F[_], A, N <: Nat](cr: CollectorRegistry[F], name: Name, help: String, labels: Sized[IndexedSeq[Label], N], f: (A) ⇒ Sized[IndexedSeq[String], N], buckets: Double*)(implicit arg0: Sync[F]): F[UnlabelledHistogram[F, A]]

    Permalink

    Constructor for a labelled Histogram.

    Constructor for a labelled Histogram. Default buckets are defaults and are intended to cover a typical web/rpc request from milliseconds to seconds.

    This generates a specific number of labels via Sized, in combination with a function to generate an equally Sized set of labels from some type. Values are applied by position.

    This counter needs to have a label applied to the UnlabelledHistogram in order to be measureable or recorded.

    cr

    CollectorRegistry this Histogram will be registred with

    name

    The name of the Histogram.

    help

    The help string of the metric

    labels

    The name of the labels to be applied to this metric

    f

    Function to take some value provided in the future to generate an equally sized list of strings as the list of labels. These are assigned to labels by position.

    buckets

    The buckets to measure observations by.

  16. def labelledExponentialBuckets[F[_], A, N <: Nat](cr: CollectorRegistry[F], name: Name, help: String, labels: Sized[IndexedSeq[Label], N], f: (A) ⇒ Sized[IndexedSeq[String], N], start: Double, factor: Double, count: Int)(implicit arg0: Sync[F]): F[UnlabelledHistogram[F, A]]

    Permalink

  17. def labelledLinearBuckets[F[_], A, N <: Nat](cr: CollectorRegistry[F], name: Name, help: String, labels: Sized[IndexedSeq[Label], N], f: (A) ⇒ Sized[IndexedSeq[String], N], start: Double, factor: Double, count: Int)(implicit arg0: Sync[F]): F[UnlabelledHistogram[F, A]]

    Permalink

  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  19. def noLabels[F[_]](cr: CollectorRegistry[F], name: Name, help: String)(implicit arg0: Sync[F]): F[Histogram[F]]

    Permalink

    Constructor for a Histogram with no labels.

    Constructor for a Histogram with no labels. Default buckets are defaults and are intended to cover a typical web/rpc request from milliseconds to seconds.

    cr

    CollectorRegistry this Histogram will be registered with

    name

    The name of the Histogram

    help

    The help string of the metric

  20. def noLabelsBuckets[F[_]](cr: CollectorRegistry[F], name: Name, help: String, buckets: Double*)(implicit arg0: Sync[F]): F[Histogram[F]]

    Permalink

    Constructor for a Histogram with no labels.

    Constructor for a Histogram with no labels. Default buckets are defaults and are intended to cover a typical web/rpc request from milliseconds to seconds.

    cr

    CollectorRegistry this Histogram will be registered with

    name

    The name of the Gauge

    help

    The help string of the metric

    buckets

    The buckets to measure observations by.

  21. def noLabelsExponentialBuckets[F[_]](cr: CollectorRegistry[F], name: Name, help: String, start: Double, factor: Double, count: Int)(implicit arg0: Sync[F]): F[Histogram[F]]

    Permalink

  22. def noLabelsLinearBuckets[F[_]](cr: CollectorRegistry[F], name: Name, help: String, start: Double, factor: Double, count: Int)(implicit arg0: Sync[F]): F[Histogram[F]]

    Permalink

  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  26. def timed[E, F[_], A](h: Histogram[F], fa: F[A], unit: TimeUnit)(implicit arg0: Bracket[F, E], arg1: Clock[F]): F[A]

    Permalink

    Persist a timed value into this Histogram

    Persist a timed value into this Histogram

    h

    Histogram

    fa

    The action to time

    unit

    The unit of time to observe the timing in. Default Histogram buckets are optimized for SECONDS.

  27. def timedSeconds[E, F[_], A](h: Histogram[F], fa: F[A])(implicit arg0: Bracket[F, E], arg1: Clock[F]): F[A]

    Permalink

    Persist a timed value into this Histogram in unit Seconds.

    Persist a timed value into this Histogram in unit Seconds. This is exposed. since default buckets are in seconds it makes sense the general case will be to match the default buckets.

    h

    Histogram

    fa

    The action to time

  28. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped