Class: Google::Apis::MonitoringV1::Scorecard

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/monitoring_v1/classes.rb,
generated/google/apis/monitoring_v1/representations.rb,
generated/google/apis/monitoring_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Scorecard

Returns a new instance of Scorecard.



763
764
765
 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 763

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#gauge_view ⇒ Google::Apis::MonitoringV1::GaugeView

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). Corresponds to the JSON property gaugeView

Returns:



729
730
731
 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 729

def gauge_view
  @gauge_view
end

#spark_chart_view ⇒ Google::Apis::MonitoringV1::SparkChartView

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. Corresponds to the JSON property sparkChartView

Returns:



736
737
738
 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 736

def spark_chart_view
  @spark_chart_view
end

#thresholds ⇒ Array<Google::Apis::MonitoringV1::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. Corresponds to the JSON property thresholds

Returns:



755
756
757
 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 755

def thresholds
  @thresholds
end

#time_series_query ⇒ Google::Apis::MonitoringV1::TimeSeriesQuery

TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API. Corresponds to the JSON property timeSeriesQuery

Returns:



761
762
763
 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 761

def time_series_query
  @time_series_query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



768
769
770
771
772
773
 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 768

def update!(**args)
  @gauge_view = args[:gauge_view] if args.key?(:gauge_view)
  @spark_chart_view = args[:spark_chart_view] if args.key?(:spark_chart_view)
  @thresholds = args[:thresholds] if args.key?(:thresholds)
  @time_series_query = args[:time_series_query] if args.key?(:time_series_query)
end