Cloud Monitoring Dashboards V1 API - Class Google::Cloud::Monitoring::Dashboard::V1::Scorecard (v0.16.0)

Reference documentation and code samples for the Cloud Monitoring Dashboards V1 API class Google::Cloud::Monitoring::Dashboard::V1::Scorecard.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#blank_view

def blank_view() -> ::Google::Protobuf::Empty
Returns
  • (::Google::Protobuf::Empty) — Will cause the Scorecard to show only the value, with no indicator to its value relative to its thresholds.

#blank_view=

def blank_view=(value) -> ::Google::Protobuf::Empty
Parameter
  • value (::Google::Protobuf::Empty) — Will cause the Scorecard to show only the value, with no indicator to its value relative to its thresholds.
Returns
  • (::Google::Protobuf::Empty) — Will cause the Scorecard to show only the value, with no indicator to its value relative to its thresholds.

#gauge_view

def gauge_view() -> ::Google::Cloud::Monitoring::Dashboard::V1::Scorecard::GaugeView
Returns

#gauge_view=

def gauge_view=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::Scorecard::GaugeView
Parameter
Returns

#spark_chart_view

def spark_chart_view() -> ::Google::Cloud::Monitoring::Dashboard::V1::Scorecard::SparkChartView
Returns

#spark_chart_view=

def spark_chart_view=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::Scorecard::SparkChartView
Parameter
Returns

#thresholds

def thresholds() -> ::Array<::Google::Cloud::Monitoring::Dashboard::V1::Threshold>
Returns
  • (::Array<::Google::Cloud::Monitoring::Dashboard::V1::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.

#thresholds=

def thresholds=(value) -> ::Array<::Google::Cloud::Monitoring::Dashboard::V1::Threshold>
Parameter
  • value (::Array<::Google::Cloud::Monitoring::Dashboard::V1::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.

Returns
  • (::Array<::Google::Cloud::Monitoring::Dashboard::V1::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.

#time_series_query

def time_series_query() -> ::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery
Returns

#time_series_query=

def time_series_query=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery
Parameter
Returns