Class: Google::Cloud::Monitoring::V3::BasicSli

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

Overview

An SLI measuring performance on a well-known service type. Performance will be computed on the basis of pre-defined metrics. The type of the service_resource determines the metrics to use and the service_resource.labels and metric_labels are used to construct a monitoring filter to filter that metric down to just the data relevant to this service.

Defined Under Namespace

Classes: AvailabilityCriteria, LatencyCriteria

Instance Attribute Summary collapse

Instance Attribute Details

#availability ⇒ ::Google::Cloud::Monitoring::V3::BasicSli::AvailabilityCriteria

Returns Good service is defined to be the count of requests made to this service that return successfully.

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

Returns:

  • (::Google::Cloud::Monitoring::V3::BasicSli::AvailabilityCriteria) —

    Good service is defined to be the count of requests made to this service that return successfully.

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



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'proto_docs/google/monitoring/v3/service.rb', line 501

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

  # Future parameters for the availability SLI.
  class AvailabilityCriteria
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for a latency threshold SLI.
  # @!attribute [rw] threshold
  #   @return [::Google::Protobuf::Duration]
  #     Good service is defined to be the count of requests made to this service
  #     that return in no more than `threshold`.
  class LatencyCriteria
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#latency ⇒ ::Google::Cloud::Monitoring::V3::BasicSli::LatencyCriteria

Returns Good service is defined to be the count of requests made to this service that are fast enough with respect to latency.threshold.

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

Returns:

  • (::Google::Cloud::Monitoring::V3::BasicSli::LatencyCriteria) —

    Good service is defined to be the count of requests made to this service that are fast enough with respect to latency.threshold.

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



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'proto_docs/google/monitoring/v3/service.rb', line 501

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

  # Future parameters for the availability SLI.
  class AvailabilityCriteria
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for a latency threshold SLI.
  # @!attribute [rw] threshold
  #   @return [::Google::Protobuf::Duration]
  #     Good service is defined to be the count of requests made to this service
  #     that return in no more than `threshold`.
  class LatencyCriteria
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#location ⇒ ::Array<::String>

Returns OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error.

Returns:

  • (::Array<::String>) —

    OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error.



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'proto_docs/google/monitoring/v3/service.rb', line 501

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

  # Future parameters for the availability SLI.
  class AvailabilityCriteria
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for a latency threshold SLI.
  # @!attribute [rw] threshold
  #   @return [::Google::Protobuf::Duration]
  #     Good service is defined to be the count of requests made to this service
  #     that return in no more than `threshold`.
  class LatencyCriteria
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#method ⇒ ::Array<::String>

Returns OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error.

Returns:

  • (::Array<::String>) —

    OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error.



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'proto_docs/google/monitoring/v3/service.rb', line 501

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

  # Future parameters for the availability SLI.
  class AvailabilityCriteria
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for a latency threshold SLI.
  # @!attribute [rw] threshold
  #   @return [::Google::Protobuf::Duration]
  #     Good service is defined to be the count of requests made to this service
  #     that return in no more than `threshold`.
  class LatencyCriteria
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#version ⇒ ::Array<::String>

Returns OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error.

Returns:

  • (::Array<::String>) —

    OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error.



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'proto_docs/google/monitoring/v3/service.rb', line 501

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

  # Future parameters for the availability SLI.
  class AvailabilityCriteria
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for a latency threshold SLI.
  # @!attribute [rw] threshold
  #   @return [::Google::Protobuf::Duration]
  #     Good service is defined to be the count of requests made to this service
  #     that return in no more than `threshold`.
  class LatencyCriteria
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end