Metric

import type { Metric } from "https://googleapis.deno.dev/v1/spanner:v1.ts";

A message representing the actual monitoring data, values for each key bucket over time, of a metric.

interface Metric {

aggregation?: "AGGREGATION_UNSPECIFIED" | "MAX" | "SUM";

category?: LocalizedString;

derived?: DerivedMetric;

displayLabel?: LocalizedString;

hasNonzeroData?: boolean;

hotValue?: number;

indexedHotKeys?: {

[key: string]: IndexedHotKey;

};

indexedKeyRangeInfos?: {

[key: string]: IndexedKeyRangeInfos;

};

info?: LocalizedString;

matrix?: MetricMatrix;

unit?: LocalizedString;

visible?: boolean;

}

§Properties

aggregation?: "AGGREGATION_UNSPECIFIED" | "MAX" | "SUM"

[src]

The aggregation function used to aggregate each key bucket

category?: LocalizedString

[src]

The category of the metric, e.g. "Activity", "Alerts", "Reads", etc.

derived?: DerivedMetric

[src]

The references to numerator and denominator metrics for a derived metric.

displayLabel?: LocalizedString

[src]

The displayed label of the metric.

hasNonzeroData?: boolean

[src]

Whether the metric has any non-zero data.

hotValue?: number

[src]

The value that is considered hot for the metric. On a per metric basis hotness signals high utilization and something that might potentially be a cause for concern by the end user. hot_value is used to calibrate and scale visual color scales.

indexedHotKeys?: {

[key: string]: IndexedHotKey;

}

[src]

The (sparse) mapping from time index to an IndexedHotKey message, representing those time intervals for which there are hot keys.

indexedKeyRangeInfos?: {

[key: string]: IndexedKeyRangeInfos;

}

[src]

The (sparse) mapping from time interval index to an IndexedKeyRangeInfos message, representing those time intervals for which there are informational messages concerning key ranges.

info?: LocalizedString

[src]

Information about the metric.

matrix?: MetricMatrix

[src]

The data for the metric as a matrix.

unit?: LocalizedString

[src]

The unit of the metric.

visible?: boolean

[src]

Whether the metric is visible to the end user.