Package io.pravega.shared.metrics

Enum ClientMetricKeys

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ClientMetricKeys>
    public enum ClientMetricKeys
extends java.lang.Enum<ClientMetricKeys>
    The various metrics that can be generated by the client.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CLIENT_APPEND_BLOCK_SIZE
      Metric to track the append block size for a given segment writer.
      CLIENT_APPEND_LATENCY
      Metric to track the amount of time in ms to perform an append to the Segment store.
      CLIENT_OUTSTANDING_APPEND_COUNT
      Metric to track the number of appends which have not been acknowledged by the segment store.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getMetricKey()  
      java.lang.String metric​(java.lang.String... tags)
      Create a metric string based on metric key and associated tags.
      static ClientMetricKeys valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ClientMetricKeys[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • CLIENT_APPEND_LATENCY

        public static final ClientMetricKeys CLIENT_APPEND_LATENCY
        Metric to track the amount of time in ms to perform an append to the Segment store.

      • CLIENT_APPEND_BLOCK_SIZE

        public static final ClientMetricKeys CLIENT_APPEND_BLOCK_SIZE
        Metric to track the append block size for a given segment writer.

      • CLIENT_OUTSTANDING_APPEND_COUNT

        public static final ClientMetricKeys CLIENT_OUTSTANDING_APPEND_COUNT
        Metric to track the number of appends which have not been acknowledged by the segment store.

    • Method Detail

      • values

        public static ClientMetricKeys[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ClientMetricKeys c : ClientMetricKeys.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ClientMetricKeys valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • metric

        public java.lang.String metric​(java.lang.String... tags)
        Create a metric string based on metric key and associated tags. If no tags are supplied the origninal metric key is returned.
        Parameters:
        tags - the tag(s) associated with the metric key.
        Returns:
        the metric.

      • getMetricKey

        public java.lang.String getMetricKey()