MetricKeyMetaDataInfo

MetricKeyMetaDataInfo
Metric Key Meta Data Info

Metrics metadata information.

JSON Example
{
    "description": "string",
    "key": "string",
    "unit": "string",
    "aggregate_by_resource_ids": false,
    "query_time_features": {
        "aggregation": false,
        "filter_by_metric_value": false
    },
    "value_type": "string",
    "is_point_in_time": false,
    "is_time_series": false,
    "is_status_metric": false,
    "relationships": [
        {
            "related_resource_type": "string",
            "related_dimension": "string"
        }
    ],
    "introduced_in_version": "string",
    "deprecated_in_version": "string"
}
string
description
Optional

A description of the metric key.

string
key
Optional

Metric key identifier.

MetricsUnit
unit
Optional

Unit of the metric, for example, PERCENT, BYTES, SEC, BYTES_PER_SEC.

Possible values are : METRIC_COUNT, BITS_PER_SECOND, PERCENT, MILLISECONDS, SECONDS, PER_SECOND, BYTES, KILO_BYTES, KILO_BYTES_PER_SECOND, BYTES_PER_SECOND, KILO_BITS_PER_SECOND, GIGA_BYTES, MEGA_BYTES, NORMALIZED, STRING, SEC, MIN, DAYS, KB, MB, GB, MBPS, GHZ, RATIO, MICROSECONDS, HEALTH, HOURS, PACKETS_PER_SECOND, PACKETS, NANOSECONDS,
boolean
aggregate_by_resource_ids
Optional

Flag to indicate if this metric is aggregatable across all resource_ids using the metrics time-series API or point-in-time API. This flag is deprecated in SSP 5.1. Use the new flag aggregation under the query_time_features field instead.

QueryTimeFeatures
query_time_features
Optional

Query time features.

ValueType
value_type
Optional

Type for values of a metric.

Possible values are : DOUBLE, STRING,
boolean
is_point_in_time
Optional

Point-in-time metrics key flag. These keys can be queried using the /metrics/point-in-time/data API.

boolean
is_time_series
Optional

Time-series metrics key flag. These keys can be queried using the /metrics/data API.

boolean
is_status_metric
Optional

Status metrics key flag. Query this metric using point-in-time URL /metrics/point-in-time/data if only the latest status is of interest. Query using time-series URL /metrics/data if the interest is to see the transitions of this status in a given time interval.

array of MetricsMetadataInfoRelationship
relationships
Optional

Related type and dimensions.

string
introduced_in_version
Optional

Release version in which this metric was introduced.

string
deprecated_in_version
Optional

Release version in which this metric was deprecated.

Property Of