c

com.twitter.finagle.stats

MetricBuilder

class MetricBuilder extends AnyRef

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. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MetricBuilder(keyIndicator: Boolean = false, description: String = "No description provided", units: MetricUnit = Unspecified, role: SourceRole = NoRoleSpecified, verbosity: Verbosity = Verbosity.Default, sourceClass: Option[String] = None, name: Seq[String] = Seq(), processPath: Option[String] = None, percentiles: IndexedSeq[Double] = IndexedSeq(), statsReceiver: StatsReceiver)

    keyIndicator

    indicates whether this metric is crucial to this service (ie, an SLO metric)

    description

    human-readable description of a metric's significance

    units

    the unit associated with the metrics value (milliseconds, megabytes, requests, etc)

    role

    whether the service is playing the part of client or server regarding this metric

    verbosity

    see StatsReceiver for details

    sourceClass

    the name of the class which generated this metric (ie, com.twitter.finagle.StatsFilter)

    name

    the relative metric name which will be appended to the scope of the StatsReceiver prior to long term storage

    processPath

    a universal coordinate for the resource

    percentiles

    used to indicate buckets for histograms, to be set by the StatsReceiver

    statsReceiver

    used for the actual metric creation, set by the StatsReceiver when creating a MetricBuilder

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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. def counter(name: String*): Counter

    Produce a counter as described by the builder inside the underlying StatsReceiver.

    Produce a counter as described by the builder inside the underlying StatsReceiver.

    returns

    the counter created.

  8. val description: String
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(other: Any): Boolean
    Definition Classes
    MetricBuilder → AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def gauge(name: String*)(f: ⇒ Float): Gauge

    Produce a gauge as described by the builder inside the underlying StatsReceiver.

    Produce a gauge as described by the builder inside the underlying StatsReceiver.

    returns

    the gauge created.

  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    MetricBuilder → AnyRef → Any
  15. def histogram(name: String*): Stat

    Produce a histogram as described by the builder inside the underlying StatsReceiver.

    Produce a histogram as described by the builder inside the underlying StatsReceiver.

    returns

    the histogram created.

  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val keyIndicator: Boolean
  18. val 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 role: SourceRole
  25. val sourceClass: Option[String]
  26. val statsReceiver: StatsReceiver
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    MetricBuilder → AnyRef → Any
  29. val units: MetricUnit
  30. val verbosity: Verbosity
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  34. def withDescription(desc: String): MetricBuilder
  35. def withIdentifier(processPath: Option[String]): MetricBuilder
  36. def withKeyIndicator(isKeyIndicator: Boolean = true): MetricBuilder
  37. def withName(name: Seq[String]): MetricBuilder
  38. def withPercentiles(percentiles: IndexedSeq[Double]): MetricBuilder
  39. def withRole(role: SourceRole): MetricBuilder
  40. def withSourceClass(sourceClass: Option[String]): MetricBuilder
  41. def withUnits(units: MetricUnit): MetricBuilder
  42. def withVerbosity(verbosity: Verbosity): MetricBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped