Class Scorecard (2.3.0)

Version 2.3.0

• 2.15.1 (latest)
• 2.15.0
• 2.14.1
• 2.13.0
• 2.12.3
• 2.11.1
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.4
• 2.6.1
• 2.5.1
• 2.4.1
• 2.3.0
• 2.2.4
• 2.1.0
• 2.0.0
• 1.0.2
• 0.1.2

Scorecard(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A widget showing the latest value of a metric, and how this value relates to one or more thresholds.

Attributes
Name	Description
time_series_query	google.cloud.monitoring_dashboard_v1.types.TimeSeriesQuery Required. Fields for querying time series data from the Stackdriver metrics API.
gauge_view	google.cloud.monitoring_dashboard_v1.types.Scorecard.GaugeView Will cause the scorecard to show a gauge chart.
spark_chart_view	google.cloud.monitoring_dashboard_v1.types.Scorecard.SparkChartView Will cause the scorecard to show a spark chart.
thresholds	Sequence[google.cloud.monitoring_dashboard_v1.types.Threshold] The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.) As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state.

Classes

GaugeView

GaugeView(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A gauge chart shows where the current value sits within a pre-defined range. The upper and lower bounds should define the possible range of values for the scorecard's query (inclusive).

SparkChartView

SparkChartView(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries.