class MetricBuilder extends Metadata
A builder class used to configure settings and metadata for metrics prior to instantiating them. Calling any of the three build methods (counter, gauge, or histogram) will cause the metric to be instantiated in the underlying StatsReceiver.
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- MetricBuilder
- Metadata
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def canEqual(other: Any): Boolean
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val description: String
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(other: Any): Boolean
- Definition Classes
- MetricBuilder → AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- MetricBuilder → AnyRef → Any
- val histogramFormat: HistogramFormat
- val identity: Identity
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val isStandard: Boolean
- val keyIndicator: Boolean
- val metricType: MetricType
- val metricUsageHints: Set[MetricUsageHint]
- def name: Seq[String]
The hierarchical name of the metric
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val percentiles: IndexedSeq[Double]
- val processPath: Option[String]
- val relativeName: Seq[String]
- val role: SourceRole
- val sourceClass: Option[String]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toMetricBuilder: Option[MetricBuilder]
Extract the MetricBuilder from Metadata
Extract the MetricBuilder from Metadata
Will return
Noneif it'sNoMetadata- Definition Classes
- Metadata
- def toString(): String
- Definition Classes
- MetricBuilder → AnyRef → Any
- val units: MetricUnit
- val verbosity: Verbosity
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withCounterishGauge: MetricBuilder
- def withDescription(desc: String): MetricBuilder
- def withHistogramFormat(histogramFormat: HistogramFormat): MetricBuilder
- def withIdentifier(processPath: Option[String]): MetricBuilder
- def withKeyIndicator(isKeyIndicator: Boolean = true): MetricBuilder
- def withMetricUsageHints(hints: Set[MetricUsageHint]): MetricBuilder
- def withName(name: String*): MetricBuilder
- Annotations
- @varargs()
- def withPercentiles(percentiles: Double*): MetricBuilder
- Annotations
- @varargs()
- def withRelativeName(relativeName: String*): MetricBuilder
- Annotations
- @varargs()
- def withRole(role: SourceRole): MetricBuilder
- def withSourceClass(sourceClass: Option[String]): MetricBuilder
- def withUnits(units: MetricUnit): MetricBuilder
- def withVerbosity(verbosity: Verbosity): MetricBuilder