Interface Metric

All Known Implementing Classes:
MetricJson
public interface Metric
A time-series metric returned by the Equinix Fabric Metrics API. Each metric describes a named measurement (for example bandwidth usage) for a particular asset over a series of time-bucketed datapoints.

Metrics supersede the deprecated per-asset /stats statistics endpoints and are retrieved via fabric.metrics().search(...) or the per-asset convenience methods fabric.connections().getMetrics(...) and fabric.ports().getMetrics(...).

Author:
ianjones
See Also:

  • Method Details

    • getType

      String getType()

      The Equinix supported metric type.

    • getName

      String getName()

      The metric name (for example equinix.fabric.connection.bandwidth_tx.usage).

    • getUnit

      String getUnit()

      The unit the metric values are expressed in.

    • getInterval

      String getInterval()

      The metric interval, set automatically based on the search range.

    • getResource

      MetricResource getResource()

      The asset (resource) the metric was collected for.

    • getSummary

      String getSummary()

      A human-readable summary of the metric.

    • getDatapoints

      List<MetricDatapoint> getDatapoints()

      The time-bucketed datapoints making up this metric.

      Returns:
      a List of MetricDatapoint objects.