Type Members

1.  abstract class AbstractStatsReceiver extends StatsReceiver
2.  class BlacklistStatsReceiver extends StatsReceiverProxy

   A blacklisting StatsReceiver.

   A blacklisting StatsReceiver. If the name for a metric is found to be blacklisted, nothing is recorded.

3.  case class BucketAndCount(lowerLimit: Long, upperLimit: Long, count: Int) extends Product with Serializable

   Buckets consist of a lower limit and an upper limit.

   Buckets consist of a lower limit and an upper limit. In histograms, all values that fall inside these limits are counted as the same.

   The lower limit is inclusive and the upper limit is exclusive

   count

   number of data points which landed in that bucket.

4.  class CategorizingExceptionStatsHandler extends ExceptionStatsHandler

   Basic implementation of exception stat recording that allows exceptions to be categorised and optional rollup.

5.  trait CollisionTrackingStatsReceiver extends AnyRef

   A StatsReceiver that provides a linting rule to track metrics that have different underlying names, yet are exported under the same name.

6.  trait Counter extends AnyRef

   A writeable Counter.

   A writeable Counter. Only sums are kept of Counters. An example Counter is "number of requests served".

7.  trait DelegatingStatsReceiver extends AnyRef

   Should be mixed into StatsReceivers that delegate to other StatsReceivers.

8.  trait ExceptionStatsHandler extends AnyRef

   Exception Stats Recorder.

9.  trait Gauge extends AnyRef

   Exposes the value of a function.

   Exposes the value of a function. For example, one could add a gauge for a computed health metric.

10.  trait HistogramDetail extends AnyRef

    Details of a histogram's data points.

11.  class InMemoryStatsReceiver extends StatsReceiver with WithHistogramDetails

    An in-memory implementation of StatsReceiver, which is mostly used for testing.

    An in-memory implementation of StatsReceiver, which is mostly used for testing.

    Note that an InMemoryStatsReceiver does not conflate Seq("a", "b") and Seq("a/b") names no matter how they look when printed.

    val isr = new InMemoryStatsReceiver
    isr.counter("a", "b", "foo")
    isr.counter("a/b", "bar")
    
    isr.print(Console.out) // will print two lines "a/b/foo 0" and "a/b/bar 0"
    
    assert(isr.counters(Seq("a", "b", "foo") == 0)) // ok
    assert(isr.counters(Seq("a", "b", "bar") == 0)) // fail

12.  abstract class NameTranslatingStatsReceiver extends StatsReceiverProxy

    A StatsReceiver receiver proxy that translates all counter, stat, and gauge names according to a translate function.

13.  class NullStatsReceiver extends StatsReceiver

    A no-op StatsReceiver.

    A no-op StatsReceiver. Metrics are not recorded, making this receiver useful in unit tests and as defaults in situations where metrics are not strictly required.

14.  trait ReadableCounter extends Counter

    A variation of Counter that also supports reading of the current value via the apply method.

15.  trait ReadableStat extends Stat

    A variation of Stat that also supports reading of the current time series via the apply method.

16.  class RollupStatsReceiver extends StatsReceiverProxy

    A RollupStatsReceiver reports stats on multiple Counter/Stat/Gauge based on the sequence of names you pass.

    A RollupStatsReceiver reports stats on multiple Counter/Stat/Gauge based on the sequence of names you pass. e.g. counter("errors", "clientErrors", "java_net_ConnectException").incr() will actually increment those three counters: - "/errors" - "/errors/clientErrors" - "/errors/clientErrors/java_net_ConnectException"

17.  trait Stat extends AnyRef

    An append-only collection of time-series data.

    An append-only collection of time-series data. Example Stats are "queue depth" or "query width in a stream of requests".

    Utilities for timing synchronous execution and asynchronous execution are on the companion object (Stat.time(Stat) and Stat.timeFuture(Stat).

18.  trait StatsReceiver extends AnyRef

    An interface for recording metrics.

    An interface for recording metrics. Named Counters, Stats, and Gauges can be accessed through the corresponding methods of this class.

    Verbosity Levels

    Each metric created via a stats receiver has a verbosity level attached to it. Distinguishing verbosity levels for metrics is optional and is up to a concrete implementation. Doing this, however, helps to separate debug metrics (only helpful in troubleshooting) from their operationally-required counterparts (provide a corresponding degree of visibility into a healthy process) thus potentially reducing the observability cost.

    Metrics created w/o an explicitly specified Verbosity level, will use Verbosity.Default. Use VerbosityAdjustingStatsReceiver to adjust this behaviour.

    See also

    StatsReceivers for a Java-friendly API.

19.  trait StatsReceiverProxy extends StatsReceiver with DelegatingStatsReceiver

    A proxy StatsReceiver that delegates all calls to the self stats receiver.

20.  trait StatsReceiverWithCumulativeGauges extends StatsReceiver
21.  final class Verbosity extends AnyRef

    Represent a verbosity level for a given metric.

22.  class VerbosityAdjustingStatsReceiver extends StatsReceiverProxy

    A StatsReceiver that adjusts the passed Verbosity of an underlying stats receiver to a given defaultVerbosity.

23.  trait WithHistogramDetails extends AnyRef

    Allow StatsReceivers to provide snapshots of histogram counts.

    Allow StatsReceivers to provide snapshots of histogram counts. Implementations must expose a map where keys are the name of the stat and values are the contents of the histogram.