Package com.attivio.platform.perfmon.model

Enum Metric.Type

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Metric.Type>
    Enclosing class:
    Metric
    public static enum Metric.Type
extends java.lang.Enum<Metric.Type>
    The type of a metric indicates what if any special processing needs to be done in the performance server. for example, dps is computed by taking the document counts and dividing it over a time period.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      COMBINEDTREND
      Combined trends are the same as TREND except that multiple sources for metric instances will be accumulated during the sample period instead of only choosing a single source for the instance.
      CONSTANT
      A metric whose value does not change
      COUNT
      Represents a changing value that does not need additional processing, ie #docs in the index, percent of CPU used.
      LASTVALUE
      Only the last value for this metric is kept.
      STATUS
      Generally speaking a status metric is meant to convey some state about the system as opposed to a performance count.
      TREND
      Represents a value that is always going up so the rate of change is interesting as opposed to the count: qps, dps.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Metric.Type fromInt​(int i)  
      int getVal()  
      static Metric.Type valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Metric.Type[] 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

      • COUNT

        public static final Metric.Type COUNT
        Represents a changing value that does not need additional processing, ie #docs in the index, percent of CPU used.

      • TREND

        public static final Metric.Type TREND
        Represents a value that is always going up so the rate of change is interesting as opposed to the count: qps, dps. 'trend' indicates that the aie node will provide the count and the performance server will calculate the 'X per second' values dynamically.

      • STATUS

        public static final Metric.Type STATUS
        Generally speaking a status metric is meant to convey some state about the system as opposed to a performance count. For example, the index might be committing/replicating/etc. the metadata for the metric should define how to interpret the status. The numeric value for the metric data will be used to show state change and the metric metadata should make clear what the state is for end user consumption. (ie state 1 = foo, state 2 = bar)

      • CONSTANT

        public static final Metric.Type CONSTANT
        A metric whose value does not change

      • LASTVALUE

        public static final Metric.Type LASTVALUE
        Only the last value for this metric is kept.

      • COMBINEDTREND

        public static final Metric.Type COMBINEDTREND
        Combined trends are the same as TREND except that multiple sources for metric instances will be accumulated during the sample period instead of only choosing a single source for the instance.

    • Method Detail

      • values

        public static Metric.Type[] 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 (Metric.Type c : Metric.Type.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Metric.Type 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

      • fromInt

        public static Metric.Type fromInt​(int i)

      • getVal

        public int getVal()