object MetricBuilder

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MetricBuilder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class Identity(hierarchicalName: Seq[String], dimensionalName: Seq[String], labels: Map[String, String] = Map.empty, identityType: IdentityType = IdentityType.NonDeterminate) extends Product with Serializable

    Experimental way to represent both hierarchical and dimensional identity information.

    Experimental way to represent both hierarchical and dimensional identity information.

    Note

    this type is expected to undergo some churn as dimensional metric support matures.

  2. sealed abstract class IdentityType extends AnyRef

    Representation of how an Identitys name is defined

  3. sealed trait MetricType extends AnyRef

    Indicate the Metric type, CounterType will create a Counter, GaugeType will create a standard Gauge, and HistogramType will create a Stat.

    Indicate the Metric type, CounterType will create a Counter, GaugeType will create a standard Gauge, and HistogramType will create a Stat.

    Note

    CounterishGaugeType will also create a Gauge, but specifically one that models a Counter.

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. val DimensionalNameScopeSeparator: String
  5. val NoDescription: String
  6. def apply(keyIndicator: Boolean = false, description: String = NoDescription, units: MetricUnit = Unspecified, role: SourceRole = SourceRole.NoRoleSpecified, verbosity: Verbosity = Verbosity.Default, sourceClass: Option[String] = None, name: Seq[String] = Seq.empty, relativeName: Seq[String] = Seq.empty, processPath: Option[String] = None, histogramFormat: HistogramFormat = HistogramFormat.Default, percentiles: IndexedSeq[Double] = EmptyPercentiles, isStandard: Boolean = false, metricType: MetricType): MetricBuilder

    Construct a MethodBuilder.

    Construct a MethodBuilder.

    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 full metric name

    relativeName

    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

    isStandard

    whether the metric should the standard path separator or defer to the metrics store for the separator

    metricType

    the type of the metric being constructed

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. val forCounter: MetricBuilder

    Construct a new MetricBuilder that will build counters.

    Construct a new MetricBuilder that will build counters. The result is the same as calling newBuilder(CounterType).

  13. val forGauge: MetricBuilder

    Construct a new MetricBuilder that will build gauges.

    Construct a new MetricBuilder that will build gauges. The result is the same as calling newBuilder(GaugeType).

  14. val forStat: MetricBuilder

    Construct a new MetricBuilder that will build stats (histograms).

    Construct a new MetricBuilder that will build stats (histograms). The result is the same as calling newBuilder(HistogramType).

  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def newBuilder(metricType: MetricType): MetricBuilder

    Construct a new MetricBuilder

    Construct a new MetricBuilder

    Simpler method for constructing a MetricBuilder. This API is a little more friendly for java users as they can bootstrap a MetricBuilder and then proceed to use with .with API's rather than being forced to use the mega apply method.

    metricType

    the type of the metric being constructed.

  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. case object CounterType extends MetricType with Product with Serializable
  28. case object CounterishGaugeType extends MetricType with Product with Serializable
  29. case object GaugeType extends MetricType with Product with Serializable
  30. case object HistogramType extends MetricType with Product with Serializable
  31. object IdentityType
  32. case object UnlatchedCounter extends MetricType with Product with Serializable

    Counter type that will be always unlatched

Inherited from AnyRef

Inherited from Any

Ungrouped