Class: Google::Cloud::Monitoring::Dashboard::V1::Scorecard

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/monitoring/dashboard/v1/scorecard.rb

Overview

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

Defined Under Namespace

Classes: GaugeView, SparkChartView

Instance Attribute Summary collapse

Instance Attribute Details

#blank_view ⇒ ::Google::Protobuf::Empty

Returns 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.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/monitoring/dashboard/v1/scorecard.rb', line 81

class Scorecard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] lower_bound
  #   @return [::Float]
  #     The lower bound for this gauge chart. The value of the chart should
  #     always be greater than or equal to this.
  # @!attribute [rw] upper_bound
  #   @return [::Float]
  #     The upper bound for this gauge chart. The value of the chart should
  #     always be less than or equal to this.
  class GaugeView
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] spark_chart_type
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::SparkChartType]
  #     Required. The type of sparkchart to show in this chartView.
  # @!attribute [rw] min_alignment_period
  #   @return [::Google::Protobuf::Duration]
  #     The lower bound on data point frequency in the chart implemented by
  #     specifying the minimum alignment period to use in a time series query.
  #     For example, if the data is published once every 10 minutes it would not
  #     make sense to fetch and align data at one minute intervals. This field is
  #     optional and exists only as a hint.
  class SparkChartView
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#gauge_view ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Scorecard::GaugeView

Returns Will cause the scorecard to show a gauge chart.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/monitoring/dashboard/v1/scorecard.rb', line 81

class Scorecard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] lower_bound
  #   @return [::Float]
  #     The lower bound for this gauge chart. The value of the chart should
  #     always be greater than or equal to this.
  # @!attribute [rw] upper_bound
  #   @return [::Float]
  #     The upper bound for this gauge chart. The value of the chart should
  #     always be less than or equal to this.
  class GaugeView
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] spark_chart_type
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::SparkChartType]
  #     Required. The type of sparkchart to show in this chartView.
  # @!attribute [rw] min_alignment_period
  #   @return [::Google::Protobuf::Duration]
  #     The lower bound on data point frequency in the chart implemented by
  #     specifying the minimum alignment period to use in a time series query.
  #     For example, if the data is published once every 10 minutes it would not
  #     make sense to fetch and align data at one minute intervals. This field is
  #     optional and exists only as a hint.
  class SparkChartView
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#spark_chart_view ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Scorecard::SparkChartView

Returns Will cause the scorecard to show a spark chart.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/monitoring/dashboard/v1/scorecard.rb', line 81

class Scorecard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] lower_bound
  #   @return [::Float]
  #     The lower bound for this gauge chart. The value of the chart should
  #     always be greater than or equal to this.
  # @!attribute [rw] upper_bound
  #   @return [::Float]
  #     The upper bound for this gauge chart. The value of the chart should
  #     always be less than or equal to this.
  class GaugeView
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] spark_chart_type
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::SparkChartType]
  #     Required. The type of sparkchart to show in this chartView.
  # @!attribute [rw] min_alignment_period
  #   @return [::Google::Protobuf::Duration]
  #     The lower bound on data point frequency in the chart implemented by
  #     specifying the minimum alignment period to use in a time series query.
  #     For example, if the data is published once every 10 minutes it would not
  #     make sense to fetch and align data at one minute intervals. This field is
  #     optional and exists only as a hint.
  class SparkChartView
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#thresholds ⇒ ::Array<::Google::Cloud::Monitoring::Dashboard::V1::Threshold>

Returns 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.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/monitoring/dashboard/v1/scorecard.rb', line 81

class Scorecard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] lower_bound
  #   @return [::Float]
  #     The lower bound for this gauge chart. The value of the chart should
  #     always be greater than or equal to this.
  # @!attribute [rw] upper_bound
  #   @return [::Float]
  #     The upper bound for this gauge chart. The value of the chart should
  #     always be less than or equal to this.
  class GaugeView
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] spark_chart_type
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::SparkChartType]
  #     Required. The type of sparkchart to show in this chartView.
  # @!attribute [rw] min_alignment_period
  #   @return [::Google::Protobuf::Duration]
  #     The lower bound on data point frequency in the chart implemented by
  #     specifying the minimum alignment period to use in a time series query.
  #     For example, if the data is published once every 10 minutes it would not
  #     make sense to fetch and align data at one minute intervals. This field is
  #     optional and exists only as a hint.
  class SparkChartView
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#time_series_query ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery

Returns Required. Fields for querying time series data from the Stackdriver metrics API.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/monitoring/dashboard/v1/scorecard.rb', line 81

class Scorecard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] lower_bound
  #   @return [::Float]
  #     The lower bound for this gauge chart. The value of the chart should
  #     always be greater than or equal to this.
  # @!attribute [rw] upper_bound
  #   @return [::Float]
  #     The upper bound for this gauge chart. The value of the chart should
  #     always be less than or equal to this.
  class GaugeView
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] spark_chart_type
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::SparkChartType]
  #     Required. The type of sparkchart to show in this chartView.
  # @!attribute [rw] min_alignment_period
  #   @return [::Google::Protobuf::Duration]
  #     The lower bound on data point frequency in the chart implemented by
  #     specifying the minimum alignment period to use in a time series query.
  #     For example, if the data is published once every 10 minutes it would not
  #     make sense to fetch and align data at one minute intervals. This field is
  #     optional and exists only as a hint.
  class SparkChartView
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end