list-deployment-kpis¶

Description¶

Lists deployment KPIs.

Synopsis¶

  list-deployment-kpis
--deployment-crn <value>
--metrics-time-period <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--deployment-crn (string)

The deployment CRN

--metrics-time-period (string)

The metrics time period

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

metricCharts -> (array)

The metrics for the configured KPIs

item -> (object)

A metric chart

name -> (string)

The name of the metric

unitType -> (string)

The unit type of the metric

componentType -> (string)

The component type of the metric

metrics -> (object)

Chart data of metrics

averageValue -> (double)

The average value of the data

currentValue -> (double)

The most recent value in the list of data points

currentValueLabel -> (string)

The current value label

averageValueLabel -> (string)

The average value label

tooltipValueLabel -> (string)

The tooltip value label

datas -> (array)

The list of data points (in time-order) for the metric

item -> (object)

A metric value

timestamp -> (integer)

The timestamp of this data point

value -> (double)

The value of this data point

mirroredMetrics -> (object)

Chart data of metrics

averageValue -> (double)

The average value of the data

currentValue -> (double)

The most recent value in the list of data points

currentValueLabel -> (string)

The current value label

averageValueLabel -> (string)

The average value label

tooltipValueLabel -> (string)

The tooltip value label

datas -> (array)

The list of data points (in time-order) for the metric

item -> (object)

A metric value

timestamp -> (integer)

The timestamp of this data point

value -> (double)

The value of this data point

alert -> (object)

Thresholds associated with a metric

frequencyTolerance -> (object)

Frequency tolerance for a metric chart

unit -> (string)

The unit of time controlling how long a metric value can persist outside its boundaries before an alert is generated

value -> (double)

The amount of time, associated with the given unit, a metric value can persist outside its boundaries before an alert is generated

thresholdMoreThan -> (double)

The moreThan threshold for the alert

thresholdLessThan -> (double)

The lessThan threshold for the alert

componentName -> (string)

The scope component name that will exist for Processor, Process Group, and Connection metrics.

Form Factors¶

public