Class: Google::Cloud::Monitoring::V3::WindowsBasedSli

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

Overview

A WindowsBasedSli defines good_service as the count of time windows for which the provided service was of good quality. Criteria for determining if service was good are embedded in the window_criterion.

Defined Under Namespace

Classes: MetricRange, PerformanceThreshold

Instance Attribute Summary collapse

Instance Attribute Details

#good_bad_metric_filter ⇒ ::String

Returns A monitoring filter specifying a TimeSeries with ValueType = BOOL. The window is good if any true values appear in the window.

Note: The following fields are mutually exclusive: good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    A monitoring filter specifying a TimeSeries with ValueType = BOOL. The window is good if any true values appear in the window.

    Note: The following fields are mutually exclusive: good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.



635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'proto_docs/google/monitoring/v3/service.rb', line 635

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

  # A `PerformanceThreshold` is used when each window is good when that window
  # has a sufficiently high `performance`.
  # @!attribute [rw] performance
  #   @return [::Google::Cloud::Monitoring::V3::RequestBasedSli]
  #     `RequestBasedSli` to evaluate to judge window quality.
  #
  #     Note: The following fields are mutually exclusive: `performance`, `basic_sli_performance`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] basic_sli_performance
  #   @return [::Google::Cloud::Monitoring::V3::BasicSli]
  #     `BasicSli` to evaluate to judge window quality.
  #
  #     Note: The following fields are mutually exclusive: `basic_sli_performance`, `performance`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] threshold
  #   @return [::Float]
  #     If window `performance >= threshold`, the window is counted as good.
  class PerformanceThreshold
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A `MetricRange` is used when each window is good when the value x of a
  # single `TimeSeries` satisfies `range.min <= x <= range.max`. The provided
  # `TimeSeries` must have `ValueType = INT64` or `ValueType = DOUBLE` and
  # `MetricKind = GAUGE`.
  # @!attribute [rw] time_series
  #   @return [::String]
  #     A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
  #     specifying the `TimeSeries` to use for evaluating window quality.
  # @!attribute [rw] range
  #   @return [::Google::Cloud::Monitoring::V3::Range]
  #     Range of values considered "good." For a one-sided range, set one bound
  #     to an infinite value.
  class MetricRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#good_total_ratio_threshold ⇒ ::Google::Cloud::Monitoring::V3::WindowsBasedSli::PerformanceThreshold

Returns A window is good if its performance is high enough.

Note: The following fields are mutually exclusive: good_total_ratio_threshold, good_bad_metric_filter, metric_mean_in_range, metric_sum_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Monitoring::V3::WindowsBasedSli::PerformanceThreshold) —

    A window is good if its performance is high enough.

    Note: The following fields are mutually exclusive: good_total_ratio_threshold, good_bad_metric_filter, metric_mean_in_range, metric_sum_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.



635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'proto_docs/google/monitoring/v3/service.rb', line 635

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

  # A `PerformanceThreshold` is used when each window is good when that window
  # has a sufficiently high `performance`.
  # @!attribute [rw] performance
  #   @return [::Google::Cloud::Monitoring::V3::RequestBasedSli]
  #     `RequestBasedSli` to evaluate to judge window quality.
  #
  #     Note: The following fields are mutually exclusive: `performance`, `basic_sli_performance`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] basic_sli_performance
  #   @return [::Google::Cloud::Monitoring::V3::BasicSli]
  #     `BasicSli` to evaluate to judge window quality.
  #
  #     Note: The following fields are mutually exclusive: `basic_sli_performance`, `performance`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] threshold
  #   @return [::Float]
  #     If window `performance >= threshold`, the window is counted as good.
  class PerformanceThreshold
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A `MetricRange` is used when each window is good when the value x of a
  # single `TimeSeries` satisfies `range.min <= x <= range.max`. The provided
  # `TimeSeries` must have `ValueType = INT64` or `ValueType = DOUBLE` and
  # `MetricKind = GAUGE`.
  # @!attribute [rw] time_series
  #   @return [::String]
  #     A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
  #     specifying the `TimeSeries` to use for evaluating window quality.
  # @!attribute [rw] range
  #   @return [::Google::Cloud::Monitoring::V3::Range]
  #     Range of values considered "good." For a one-sided range, set one bound
  #     to an infinite value.
  class MetricRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#metric_mean_in_range ⇒ ::Google::Cloud::Monitoring::V3::WindowsBasedSli::MetricRange

Returns A window is good if the metric's value is in a good range, averaged across returned streams.

Note: The following fields are mutually exclusive: metric_mean_in_range, good_bad_metric_filter, good_total_ratio_threshold, metric_sum_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Monitoring::V3::WindowsBasedSli::MetricRange) —

    A window is good if the metric's value is in a good range, averaged across returned streams.

    Note: The following fields are mutually exclusive: metric_mean_in_range, good_bad_metric_filter, good_total_ratio_threshold, metric_sum_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.



635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'proto_docs/google/monitoring/v3/service.rb', line 635

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

  # A `PerformanceThreshold` is used when each window is good when that window
  # has a sufficiently high `performance`.
  # @!attribute [rw] performance
  #   @return [::Google::Cloud::Monitoring::V3::RequestBasedSli]
  #     `RequestBasedSli` to evaluate to judge window quality.
  #
  #     Note: The following fields are mutually exclusive: `performance`, `basic_sli_performance`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] basic_sli_performance
  #   @return [::Google::Cloud::Monitoring::V3::BasicSli]
  #     `BasicSli` to evaluate to judge window quality.
  #
  #     Note: The following fields are mutually exclusive: `basic_sli_performance`, `performance`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] threshold
  #   @return [::Float]
  #     If window `performance >= threshold`, the window is counted as good.
  class PerformanceThreshold
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A `MetricRange` is used when each window is good when the value x of a
  # single `TimeSeries` satisfies `range.min <= x <= range.max`. The provided
  # `TimeSeries` must have `ValueType = INT64` or `ValueType = DOUBLE` and
  # `MetricKind = GAUGE`.
  # @!attribute [rw] time_series
  #   @return [::String]
  #     A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
  #     specifying the `TimeSeries` to use for evaluating window quality.
  # @!attribute [rw] range
  #   @return [::Google::Cloud::Monitoring::V3::Range]
  #     Range of values considered "good." For a one-sided range, set one bound
  #     to an infinite value.
  class MetricRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#metric_sum_in_range ⇒ ::Google::Cloud::Monitoring::V3::WindowsBasedSli::MetricRange

A window is good if the metric's value is in a good range, summed across returned streams.

Note: The following fields are mutually exclusive: metric_sum_in_range, good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Monitoring::V3::WindowsBasedSli::MetricRange) —

    A window is good if the metric's value is in a good range, summed across returned streams.

    Note: The following fields are mutually exclusive: metric_sum_in_range, good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.



635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'proto_docs/google/monitoring/v3/service.rb', line 635

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

  # A `PerformanceThreshold` is used when each window is good when that window
  # has a sufficiently high `performance`.
  # @!attribute [rw] performance
  #   @return [::Google::Cloud::Monitoring::V3::RequestBasedSli]
  #     `RequestBasedSli` to evaluate to judge window quality.
  #
  #     Note: The following fields are mutually exclusive: `performance`, `basic_sli_performance`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] basic_sli_performance
  #   @return [::Google::Cloud::Monitoring::V3::BasicSli]
  #     `BasicSli` to evaluate to judge window quality.
  #
  #     Note: The following fields are mutually exclusive: `basic_sli_performance`, `performance`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] threshold
  #   @return [::Float]
  #     If window `performance >= threshold`, the window is counted as good.
  class PerformanceThreshold
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A `MetricRange` is used when each window is good when the value x of a
  # single `TimeSeries` satisfies `range.min <= x <= range.max`. The provided
  # `TimeSeries` must have `ValueType = INT64` or `ValueType = DOUBLE` and
  # `MetricKind = GAUGE`.
  # @!attribute [rw] time_series
  #   @return [::String]
  #     A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
  #     specifying the `TimeSeries` to use for evaluating window quality.
  # @!attribute [rw] range
  #   @return [::Google::Cloud::Monitoring::V3::Range]
  #     Range of values considered "good." For a one-sided range, set one bound
  #     to an infinite value.
  class MetricRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#window_period ⇒ ::Google::Protobuf::Duration

Returns Duration over which window quality is evaluated. Must be an integer fraction of a day and at least 60s.

Returns:

  • (::Google::Protobuf::Duration) —

    Duration over which window quality is evaluated. Must be an integer fraction of a day and at least 60s.



635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'proto_docs/google/monitoring/v3/service.rb', line 635

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

  # A `PerformanceThreshold` is used when each window is good when that window
  # has a sufficiently high `performance`.
  # @!attribute [rw] performance
  #   @return [::Google::Cloud::Monitoring::V3::RequestBasedSli]
  #     `RequestBasedSli` to evaluate to judge window quality.
  #
  #     Note: The following fields are mutually exclusive: `performance`, `basic_sli_performance`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] basic_sli_performance
  #   @return [::Google::Cloud::Monitoring::V3::BasicSli]
  #     `BasicSli` to evaluate to judge window quality.
  #
  #     Note: The following fields are mutually exclusive: `basic_sli_performance`, `performance`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] threshold
  #   @return [::Float]
  #     If window `performance >= threshold`, the window is counted as good.
  class PerformanceThreshold
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A `MetricRange` is used when each window is good when the value x of a
  # single `TimeSeries` satisfies `range.min <= x <= range.max`. The provided
  # `TimeSeries` must have `ValueType = INT64` or `ValueType = DOUBLE` and
  # `MetricKind = GAUGE`.
  # @!attribute [rw] time_series
  #   @return [::String]
  #     A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
  #     specifying the `TimeSeries` to use for evaluating window quality.
  # @!attribute [rw] range
  #   @return [::Google::Cloud::Monitoring::V3::Range]
  #     Range of values considered "good." For a one-sided range, set one bound
  #     to an infinite value.
  class MetricRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end