Summary

Type Members

final class Quantile extends AnyRef

The percentile and tolerated error to be observed
The percentile and tolerated error to be observed
There is a safe constructor, and a macro constructor which can statically verify these values if they are known at compile time.
Quantile.quantile(0.5, 0.05) - 50th percentile (= median) with 5% tolerated error
Quantile.quantile(0.9, 0.01) - 90th percentile with 1% tolerated error
Quantile.quantile(0.99, 0.001) - 99th percentile with 0.1% tolerated error
final class UnlabelledSummary[F[_], A] extends AnyRef

Generic Unlabeled Summary
Generic Unlabeled Summary
Apply a label to be able to measure events.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object Quantile
object Unsafe
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val defaultAgeBuckets: Int
val defaultMaxAgeSeconds: Long
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def labelled[F[_], A, N <: Nat](cr: CollectorRegistry[F], name: String, help: String, labels: Sized[IndexedSeq[String], N], f: (A) ⇒ Sized[IndexedSeq[String], N], quantiles: Quantile*)(implicit arg0: Sync[F], arg1: Clock[F]): F[UnlabelledSummary[F, A]]

Default Constructor for a labelled Summary.
Default Constructor for a labelled Summary.
maxAgeSeconds is set to defaultMaxAgeSeconds which is 10 minutes.
ageBuckets is the number of buckets for the sliding time window, set to defaultAgeBuckets which is 5.
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 UnlabelledSummary in order to be measureable or recorded.
cr
CollectorRegistry this Summary will be registred with
name
The name of the Summary.
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.
quantiles
The measurements to track for specifically over the sliding time window.
def labelledQuantiles[F[_], A, N <: Nat](cr: CollectorRegistry[F], name: String, help: String, maxAgeSeconds: Long, ageBuckets: Int, labels: Sized[IndexedSeq[String], N], f: (A) ⇒ Sized[IndexedSeq[String], N], quantiles: Quantile*)(implicit arg0: Sync[F], arg1: Clock[F]): F[UnlabelledSummary[F, A]]

Constructor for a labelled Summary.
Constructor for a labelled Summary.
maxAgeSeconds is set to defaultMaxAgeSeconds which is 10 minutes.
ageBuckets is the number of buckets for the sliding time window, set to defaultAgeBuckets which is 5.
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 UnlabelledSummary in order to be measureable or recorded.
cr
CollectorRegistry this Summary will be registred with
name
The name of the Summary.
help
The help string of the metric
maxAgeSeconds
Set the duration of the time window is, i.e. how long observations are kept before they are discarded.
ageBuckets
Set the number of buckets used to implement the sliding time window. If your time window is 10 minutes, and you have ageBuckets=5, buckets will be switched every 2 minutes. The value is a trade-off between resources (memory and cpu for maintaining the bucket) and how smooth the time window is moved.
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.
quantiles
The measurements to track for specifically over the sliding time window.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def noLabels[F[_]](cr: CollectorRegistry[F], name: String, help: String, quantiles: Quantile*)(implicit arg0: Sync[F], arg1: Clock[F]): F[Summary[F]]

Default Constructor for a Summary with no labels.
Default Constructor for a Summary with no labels.
maxAgeSeconds is set to defaultMaxAgeSeconds which is 10 minutes.
ageBuckets is the number of buckets for the sliding time window, set to defaultAgeBuckets which is 5.
If you want to exert control, use the full constructor noLabelsQuantiles
cr
CollectorRegistry this Summary will be registered with
name
The name of the Summary
help
The help string of the metric
quantiles
The measurements to track for specifically over the sliding time window.
def noLabelsQuantiles[F[_]](cr: CollectorRegistry[F], name: String, help: String, maxAgeSeconds: Long, ageBuckets: Int, quantiles: Quantile*)(implicit arg0: Sync[F], arg1: Clock[F]): F[Summary[F]]

Constructor for a Summary with no labels.
Constructor for a Summary with no labels.
maxAgeSeconds is set to defaultMaxAgeSeconds which is 10 minutes.
ageBuckets is the number of buckets for the sliding time window, set to defaultAgeBuckets which is 5.
If you want to exert control, use the full constructor noLabelsQuantiles
cr
CollectorRegistry this Summary will be registered with
name
The name of the Summary
help
The help string of the metric
maxAgeSeconds
Set the duration of the time window is, i.e. how long observations are kept before they are discarded.
ageBuckets
Set the number of buckets used to implement the sliding time window. If your time window is 10 minutes, and you have ageBuckets=5, buckets will be switched every 2 minutes. The value is a trade-off between resources (memory and cpu for maintaining the bucket) and how smooth the time window is moved.
quantiles
The measurements to track for specifically over the sliding time window.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: class Summary | package epimetheus

object Summary

Type Members

final class Quantile extends AnyRef

final class UnlabelledSummary[F[_], A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Quantile

object Unsafe

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val defaultAgeBuckets: Int

val defaultMaxAgeSeconds: Long

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def labelled[F[_], A, N <: Nat](cr: CollectorRegistry[F], name: String, help: String, labels: Sized[IndexedSeq[String], N], f: (A) ⇒ Sized[IndexedSeq[String], N], quantiles: Quantile*)(implicit arg0: Sync[F], arg1: Clock[F]): F[UnlabelledSummary[F, A]]

final def ne(arg0: AnyRef): Boolean

def noLabels[F[_]](cr: CollectorRegistry[F], name: String, help: String, quantiles: Quantile*)(implicit arg0: Sync[F], arg1: Clock[F]): F[Summary[F]]

def noLabelsQuantiles[F[_]](cr: CollectorRegistry[F], name: String, help: String, maxAgeSeconds: Long, ageBuckets: Int, quantiles: Quantile*)(implicit arg0: Sync[F], arg1: Clock[F]): F[Summary[F]]

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped