colossus.metrics

Rate

trait Rate extends Collector

Metrics Collector which increments a value and resets after collection.

Linear Supertypes
Collector, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Rate
  2. Collector
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def address: MetricAddress

    The MetricAddress of this Collector.

    The MetricAddress of this Collector. Note, this will be relative to the containing MetricSystem's metricAddress.

    returns

    Definition Classes
    Collector

  2. abstract def count(tags: TagMap = TagMap.Empty): Long

    Returns the total number of ticks across all collection intervals to the rate for a set of tags

    Returns the total number of ticks across all collection intervals to the rate for a set of tags

    tags

    The tags for the count to get

  3. abstract def hit(tags: TagMap = TagMap.Empty, amount: Long = 1): Unit

    Increment value to this Rate for this specified TagMap A single Rate instance divides values amongst TagMaps, and tracks each one independently When they are collected and reported, all TagMaps will be reported under the same MetricAddress.

    Increment value to this Rate for this specified TagMap A single Rate instance divides values amongst TagMaps, and tracks each one independently When they are collected and reported, all TagMaps will be reported under the same MetricAddress.

    tags

    Tags to record with this value

    amount

    The value to increment the rate

  4. abstract def pruneEmpty: Boolean

    Instruct the collector to not report any values for tag combinations which were previously empty.

    Instruct the collector to not report any values for tag combinations which were previously empty.

    returns

  5. abstract def tick(interval: FiniteDuration): MetricMap

    TODO

    TODO

    interval
    returns

    Definition Classes
    Collector

  6. abstract def value(collectionInterval: FiniteDuration, tags: TagMap = TagMap.Empty): Long

    Returns the current number of hits to the rate since the last aggregation

    Returns the current number of hits to the rate since the last aggregation

    collectionInterval

    The collection interval to retrieve the value for. Collection intervals are configured per MetricSystem

    tags

    The tags for the value to get, defaults to an empty tagmap

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  18. def toString(): String

    Definition Classes
    AnyRef → Any

  19. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Collector

Inherited from AnyRef

Inherited from Any

Ungrouped