# Package com.h3c.sdn.metric

Fundamental classes for the SDN core controller metering framework, including the classes for various metric types that may be obtained from the framework.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  MetricFilter | A filter, based on `MetricDescriptor`, that is used (among other purposes) to determine whether or not a `TimeStampedMetric` should be reported.
  MetricRegistryListener | Listeners for events from the registry.
  TimeStampedMetric | Methods for a Coda Hale `Metric` with associated time stamp management.

- Class Summary
  Class | Description
  --- | ---
  CounterDataPoint | Class for a time stamped counter data point.
  CounterDataPointList | A list of `CounterDataPoint` objects.
  CounterDescriptor | Counter descriptor object, which specifies numerous properties that shape the processing and handling of a `TimeStampedCounter` object.
  CounterDescriptor.CounterDescriptorBuilder | Counter descriptor builder object, which requires that only arguments that are mandatory for the construction of a `CounterDescriptor` be specified during its own construction.
  CounterMetricValue | Counter metric value object, a data carrier which contains common metric value attributes being retrieved from the metric updates persisted and summarized.
  CounterMetricValue.Builder<T extends CounterMetricValue.Builder<T>> | Builder (mutable) used to create a new value instances.
  DataPoint | Abstract base class for time stamped data points.
  DataPointList<T extends DataPoint> | A list of `DataPoint` objects.
  GaugeDataPoint | Class for a time stamped gauge data point.
  GaugeDataPointList | A list of `GaugeDataPoint` objects.
  GaugeDescriptor | Gauge descriptor object, which specifies numerous properties that shape the processing and handling of a `TimeStampedGauge` object.
  GaugeDescriptor.GaugeDescriptorBuilder | Gauge descriptor builder object, which requires that only arguments that are mandatory for the construction of a `GaugeDescriptor` be specified during its own construction.
  GaugeMetricValue | Gauge metric value object, a data carrier which contains common metric value attributes being retrieved from the metric updates persisted and summarized.
  GaugeMetricValue.Builder<T extends GaugeMetricValue.Builder<T>> | Builder (mutable) used to create a new value instances.
  HistogramDataPoint | Class for a time stamped histogram data point.
  HistogramDataPointList | A list of `HistogramDataPoint` objects.
  HistogramDescriptor | Histogram descriptor object, which specifies numerous properties that shape the processing and handling of a `TimeStampedHistogram` object.
  HistogramDescriptor.HistogramDescriptorBuilder | Histogram descriptor builder object, which requires that only arguments that are mandatory for the construction of a `HistogramDescriptor` be specified during its own construction.
  HistogramMetricValue | Histogram metric value object, a data carrier which contains common metric value attributes plus additional histogram specific ones being retrieved from the metric updates persisted and summarized.
  HistogramMetricValue.Builder<T extends HistogramMetricValue.Builder<T>> | Builder (mutable) used to create a new value instances.
  MeterDataPoint | Class for a time stamped meter data point.
  MeterDataPointList | A list of `MeterDataPoint` objects.
  MeterDescriptor | Meter descriptor object, which specifies numerous properties that shape the processing and handling of a `TimeStampedMeter` object.
  MeterDescriptor.MeterDescriptorBuilder | Meter descriptor builder object, which requires that only arguments that are mandatory for the construction of a `MeterDescriptor` be specified during its own construction.
  MeterMetricValue | Meter metric value object, a data carrier which contains common metric value attributes being retrieved from the metric updates persisted and summarized.
  MeterMetricValue.Builder<T extends MeterMetricValue.Builder<T>> | Builder (mutable) used to create a new value instances.
  MetricDescriptor | Metric descriptor object, which specifies numerous properties that shape the processing and handling of a `TimeStampedMetric` object.
  MetricDescriptor.MetricDescriptorBuilder<T extends MetricDescriptor> | Metric descriptor builder object, which requires that only arguments that are mandatory for the construction of a `MetricDescriptor` be specified during its own construction.
  MetricRegistry | A registry of `TimeStampedMetric` instances.
  MetricRegistry.PersistTimes | Utility class that holds two time stamps that should correspond to a single metric.
  MetricUpdate | Metric update object, a data carrier which contains different properties that holds the metric values to be updated by the corresponding `TimeStampedMetric` object specified by the metric identifier.
  MetricValue | Metric value object, a data carrier which contains common metric value attributes being retrieved from the metric updates persisted and summarized.
  MetricValue.Builder<T extends MetricValue.Builder<T>> | Builder (mutable) used to create a new value instances.
  RatioGaugeDataPoint | Class for a time stamped ratio gauge data point.
  RatioGaugeDataPointList | A list of `RatioGaugeDataPoint` objects.
  RatioGaugeDescriptor | Ratio gauge descriptor object, which specifies numerous properties that shape the processing and handling of a `TimeStampedRatioGauge` object.
  RatioGaugeDescriptor.RatioGaugeDescriptorBuilder | Ratio gauge descriptor builder object, which requires that only arguments that are mandatory for the construction of a `RatioGaugeDescriptor` be specified during its own construction.
  RatioGaugeMetricValue | Ratio gauge metric value object, a data carrier which contains common metric value attributes being retrieved from the metric updates persisted and summarized.
  RatioGaugeMetricValue.Builder<T extends RatioGaugeMetricValue.Builder<T>> | Builder (mutable) used to create a new value instances.
  RollingCounterDataPoint | Class for a time stamped rolling counter data point.
  RollingCounterDataPointList | A list of `RollingCounterDataPoint` objects.
  RollingCounterDescriptor | Rolling counter descriptor object, which specifies numerous properties that shape the processing and handling of a `TimeStampedRollingCounter` object.
  RollingCounterDescriptor.RollingCounterDescriptorBuilder | Counter descriptor builder object, which requires that only arguments that are mandatory for the construction of a `RollingCounterDescriptor` be specified during its own construction.
  RollingCounterMetricValue | Rolling counter metric value object, a data carrier which contains common metric value attributes being retrieved from the metric updates persisted and summarized.
  RollingCounterMetricValue.Builder<T extends RollingCounterMetricValue.Builder<T>> | Builder (mutable) used to create a new value instances.
  TimerDataPoint | Class for a time stamped timer data point.
  TimerDataPointList | A list of `TimerDataPoint` objects.
  TimerDescriptor | Timer descriptor object, which specifies numerous properties that shape the processing and handling of a `TimeStampedTimer` object.
  TimerDescriptor.TimerDescriptorBuilder | Timer descriptor builder object, which requires that only arguments that are mandatory for the construction of a `TimerDescriptor` be specified during its own construction.
  TimerMetricValue | Meter metric value object, a data carrier which contains common metric value attributes being retrieved from the metric updates persisted and summarized.
  TimerMetricValue.Builder<T extends TimerMetricValue.Builder<T>> | Builder (mutable) used to create a new value instances.
  TimeStampedCounter | Extension of Coda Hale `Counter` class that provides an association of the `Counter` value with time stamps.
  TimeStampedGauge | Implementation of Coda Hale `Gauge` interface that provides an association of the `Gauge` value with time stamps.
  TimeStampedHistogram | Extension of Coda Hale `Histogram` class that provides an association of sliding time window `Histogram` values with time stamps.
  TimeStampedMeter | Extension of Coda Hale `Meter` class that provides an association of the `Meter` value with time stamps.
  TimeStampedMetricDescriptor | Container object that pairs a `MetricDescriptor` with a time stamp.
  TimeStampedRatioGauge | Extension of Coda Hale `RatioGauge` class that provides an association of the `RatioGauge` value with time stamps.
  TimeStampedRollingCounter | A rolling (asymptotically increasing) counter metric whose value is computed as a delta between 64-bit counter snapshots over a period of time.
  TimeStampedTimer | Extension of Coda Hale `Timer` class that provides an association of sliding time window `Timer` values with time stamps.
  TimeStampManager | Utility for tracking time stamps.
  UidMetricDescriptor | Container object that pairs a `MetricDescriptor` with a metric identifier.

- Enum Summary
  Enum | Description
  --- | ---
  CounterDataPoint.CounterIndices | Indices used for storing `CounterDataPoint` contents in a file.
  DataPoint.Indices | Indices used for storing `DataPoint` contents in a file.
  GaugeDataPoint.GaugeIndices | Indices used for storing `GaugeDataPoint` contents in a file.
  HistogramDataPoint.HistogramIndices | Indices used for storing `HistogramDataPoint` contents in a file.
  MeterDataPoint.MeterIndices | Indices used for storing `MeterDataPoint` contents in a file.
  MetricDescriptor.SummaryIntervalMinutes | The set of permitted values for the interval that can elapse between summarizations of a `TimeStampedMetric` value.
  MetricDescriptor.Type | The set of permitted values for `TimeStampedMetric` types.
  RatioGaugeDataPoint.RatioGaugeIndices | Indices used for storing `RatioGaugeDataPoint` contents in a file.
  RollingCounterDataPoint.RollingCounterIndices | Indices used for storing `RollingCounterDataPoint` contents in a file.
  TimerDataPoint.TimerIndices | Indices used for storing `TimerDataPoint` contents in a file.

## Package com.h3c.sdn.metric Description

Fundamental classes for the SDN core controller metering framework, including the classes for various metric types that may be obtained from the framework.

Copyright © 2014. All Rights Reserved.