Package com.pushtechnology.diffusion.client.features.control

Enum Class Metrics.MetricType

java.lang.Object
java.lang.Enum<Metrics.MetricType>
com.pushtechnology.diffusion.client.features.control.Metrics.MetricType
All Implemented Interfaces:
Serializable, Comparable<Metrics.MetricType>, Constable
Enclosing interface:
Metrics
public static enum Metrics.MetricType extends Enum<Metrics.MetricType>
Enumeration defining the metric types available. These match the types defined in the OpenMetrics specification.
Since:
6.10

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    COUNTER
    Counters measure discrete events.
    GAUGE
    Gauges are current measurements, such as bytes of memory currently used or the number of items in a queue.
    GAUGE_HISTOGRAM
    GaugeHistograms measure current distributions.
    HISTOGRAM
    Histograms measure distributions of discrete events.
    INFO
    Info metrics are used to expose textual information which SHOULD NOT change during process lifetime.
    STATE_SET
    StateSets represent a series of related boolean values, also called a bitset.
    SUMMARY
    Like Histograms, Summaries measure distributions of discrete events and MAY be used when Histograms are too expensive and/or an average event size is sufficient.
    UNKNOWN
    An unknown metric type.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Metrics.MetricType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static Metrics.MetricType[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • COUNTER

      public static final Metrics.MetricType COUNTER
      Counters measure discrete events. Common examples are the number of HTTP requests received, CPU seconds spent, or bytes sent. Counters are always monotonic, and are typically used to count events.

    • GAUGE

      public static final Metrics.MetricType GAUGE
      Gauges are current measurements, such as bytes of memory currently used or the number of items in a queue.

    • INFO

      public static final Metrics.MetricType INFO
      Info metrics are used to expose textual information which SHOULD NOT change during process lifetime. Common examples are an application's version, revision control commit, and the version of a compiler.

    • HISTOGRAM

      public static final Metrics.MetricType HISTOGRAM
      Histograms measure distributions of discrete events. Common examples are the latency of HTTP requests, function runtimes, or I/O request sizes.

    • GAUGE_HISTOGRAM

      public static final Metrics.MetricType GAUGE_HISTOGRAM
      GaugeHistograms measure current distributions. Common examples are how long items have been waiting in a queue, or size of the requests in a queue.

    • STATE_SET

      public static final Metrics.MetricType STATE_SET
      StateSets represent a series of related boolean values, also called a bitset.

    • SUMMARY

      public static final Metrics.MetricType SUMMARY
      Like Histograms, Summaries measure distributions of discrete events and MAY be used when Histograms are too expensive and/or an average event size is sufficient.

    • UNKNOWN

      public static final Metrics.MetricType UNKNOWN
      An unknown metric type.

  • Method Details

    • values

      public static Metrics.MetricType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Metrics.MetricType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null