Enum Class MetricCategory

java.lang.Object
java.lang.Enum<MetricCategory>
io.nosqlbench.nb.api.engine.metrics.instruments.MetricCategory
All Implemented Interfaces:
Serializable, Comparable<MetricCategory>, Constable
public enum MetricCategory extends Enum<MetricCategory>

  • 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
    Accuracy
    When the result returned by an operation is scrutinized for some degree of accuracy on a sliding scale, this category applies.
    Analysis
    Some metrics help provide insight into analysis methods and progress.
    Config
    Metrics which mirror configuration data, either static or dynamic during the lifetime of an activity, session, or container.
    Core
    Metrics which are essential to understanding the behavior of any activity
    Driver
    When drivers are used to augment the metrics views, such as with the CQL client, these metrics can be folded into metrics feeds.
    Errors
    Measurements of error rates, exception counts, and any other failure modes which can be counted or otherwise quantified
    Internals
    Metrics which are used to ascertain the validity of client behavior, such as the CPU load or other potentially contending effects.
    Payload
    Metrics which describe payload properties, such as result size or similar
    Progress
    Some metrics are provided only to inform the user of relative or absolute progress, in terms of cycles remaining or similar
    User
    Sometimes users provide their own metrics instrumentation.
    Verification
    Verification logic is used to assert the validity or some property of results returned by individual operations.

  • Method Summary

    Modifier and Type
    Method
    Description
    static MetricCategory
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static MetricCategory[]
    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

    • Core

      public static final MetricCategory Core
      Metrics which are essential to understanding the behavior of any activity

    • Progress

      public static final MetricCategory Progress
      Some metrics are provided only to inform the user of relative or absolute progress, in terms of cycles remaining or similar

    • Config

      public static final MetricCategory Config
      Metrics which mirror configuration data, either static or dynamic during the lifetime of an activity, session, or container. These are shared because they may need to be known for further understanding or evaluation. For example, the target rate puts the achieved rate in context, and having them both together in downstream metrics view makes computation simple and direct.

    • Internals

      public static final MetricCategory Internals
      Metrics which are used to ascertain the validity of client behavior, such as the CPU load or other potentially contending effects. This is important because test results can be invalidated when the composed system 
      client <-> infrastructure <-> target system
      relies too heavily on the testing apparatus. When the testing apparatus is under any degree of measurable stress, the ability to drive the target system to its capacity is compromised, as well as the client's ability to approximate real-time measurements due to task scheduling delays.

    • Driver

      public static final MetricCategory Driver
      When drivers are used to augment the metrics views, such as with the CQL client, these metrics can be folded into metrics feeds. However, they are not part of the core NB metrics. Such auxiliary metric need to be identified separately.

    • Errors

      public static final MetricCategory Errors
      Measurements of error rates, exception counts, and any other failure modes which can be counted or otherwise quantified

    • Verification

      public static final MetricCategory Verification
      Verification logic is used to assert the validity or some property of results returned by individual operations. Verification is meant to indicate whether a result was valid or invalid, with no room for interpretation in between.

    • Payload

      public static final MetricCategory Payload
      Metrics which describe payload properties, such as result size or similar

    • User

      public static final MetricCategory User
      Sometimes users provide their own metrics instrumentation. These may or may not have descriptions provided.

    • Analysis

      public static final MetricCategory Analysis
      Some metrics help provide insight into analysis methods and progress. This can include parameters for an optimizers configuration, parameters from a single frame of simulation, achieved results in the form of a value function, or similar.

    • Accuracy

      public static final MetricCategory Accuracy
      When the result returned by an operation is scrutinized for some degree of accuracy on a sliding scale, this category applies. This is distinct from Verification in that verification implies a pass/fail scenario, whereas accuracy measures are on a sliding scale where interpretation is often more subjective.

  • Method Details

    • values

      public static MetricCategory[] 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 MetricCategory 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