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

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 canEqual(other: Any): Boolean
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. val description: String
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(other: Any): Boolean
    Definition Classes
    MetricBuilder → AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    MetricBuilder → AnyRef → Any
  13. val identity: Identity
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. val isStandard: Boolean
  16. val keyIndicator: Boolean
  17. val metricType: MetricType
  18. def name: Seq[String]
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. val percentiles: IndexedSeq[Double]
  23. val processPath: Option[String]
  24. val relativeName: Seq[String]
  25. val role: SourceRole
  26. val sourceClass: Option[String]
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toMetricBuilder: Option[MetricBuilder]

    Extract the MetricBuilder from Metadata

    Extract the MetricBuilder from Metadata

    Will return None if it's NoMetadata

    Definition Classes
    Metadata
  29. def toString(): String
    Definition Classes
    MetricBuilder → AnyRef → Any
  30. val units: MetricUnit
  31. val verbosity: Verbosity
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  35. def withCounterishGauge: MetricBuilder
  36. def withDescription(desc: String): MetricBuilder
  37. def withIdentifier(processPath: Option[String]): MetricBuilder
  38. def withKeyIndicator(isKeyIndicator: Boolean = true): MetricBuilder
  39. def withName(name: String*): MetricBuilder
    Annotations
    @varargs()
  40. def withPercentiles(percentiles: Double*): MetricBuilder
    Annotations
    @varargs()
  41. def withRelativeName(relativeName: String*): MetricBuilder
    Annotations
    @varargs()
  42. def withRole(role: SourceRole): MetricBuilder
  43. def withSourceClass(sourceClass: Option[String]): MetricBuilder
  44. def withUnits(units: MetricUnit): MetricBuilder
  45. def withVerbosity(verbosity: Verbosity): MetricBuilder

Deprecated Value Members

  1. val statsReceiver: StatsReceiver
    Annotations
    @deprecated
    Deprecated

    (Since version 2022-03-28) Being removed to make MetricBuilder strictly a metric definition.

Inherited from Metadata

Inherited from AnyRef

Inherited from Any

Ungrouped