Class: Google::Cloud::Monitoring::V3::ServiceLevelObjective

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

Overview

A Service-Level Objective (SLO) describes a level of desired good service. It consists of a service-level indicator (SLI), a performance goal, and a period over which the objective is to be evaluated against that goal. The SLO can use SLIs defined in a number of different manners. Typical SLOs might include "99% of requests in each rolling week have latency below 200 milliseconds" or "99.5% of requests in each calendar month return successfully."

Defined Under Namespace

Modules: View

Instance Attribute Summary collapse

Instance Attribute Details

#calendar_period ⇒ ::Google::Type::CalendarPeriod

Returns A calendar period, semantically "since the start of the current <calendar_period>". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported.

Returns:

  • (::Google::Type::CalendarPeriod) —

    A calendar period, semantically "since the start of the current <calendar_period>". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported.



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/monitoring/v3/service.rb', line 205

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

  # `ServiceLevelObjective.View` determines what form of
  # `ServiceLevelObjective` is returned from `GetServiceLevelObjective`,
  # `ListServiceLevelObjectives`, and `ListServiceLevelObjectiveVersions` RPCs.
  module View
    # Same as FULL.
    VIEW_UNSPECIFIED = 0

    # Return the embedded `ServiceLevelIndicator` in the form in which it was
    # defined. If it was defined using a `BasicSli`, return that `BasicSli`.
    FULL = 2

    # For `ServiceLevelIndicator`s using `BasicSli` articulation, instead
    # return the `ServiceLevelIndicator` with its mode of computation fully
    # spelled out as a `RequestBasedSli`. For `ServiceLevelIndicator`s using
    # `RequestBasedSli` or `WindowsBasedSli`, return the
    # `ServiceLevelIndicator` as it was provided.
    EXPLICIT = 1
  end
end

#display_name ⇒ ::String

Returns Name used for UI elements listing this SLO.

Returns:

  • (::String) —

    Name used for UI elements listing this SLO.



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/monitoring/v3/service.rb', line 205

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

  # `ServiceLevelObjective.View` determines what form of
  # `ServiceLevelObjective` is returned from `GetServiceLevelObjective`,
  # `ListServiceLevelObjectives`, and `ListServiceLevelObjectiveVersions` RPCs.
  module View
    # Same as FULL.
    VIEW_UNSPECIFIED = 0

    # Return the embedded `ServiceLevelIndicator` in the form in which it was
    # defined. If it was defined using a `BasicSli`, return that `BasicSli`.
    FULL = 2

    # For `ServiceLevelIndicator`s using `BasicSli` articulation, instead
    # return the `ServiceLevelIndicator` with its mode of computation fully
    # spelled out as a `RequestBasedSli`. For `ServiceLevelIndicator`s using
    # `RequestBasedSli` or `WindowsBasedSli`, return the
    # `ServiceLevelIndicator` as it was provided.
    EXPLICIT = 1
  end
end

#goal ⇒ ::Float

Returns The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999.

Returns:

  • (::Float) —

    The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999.



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/monitoring/v3/service.rb', line 205

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

  # `ServiceLevelObjective.View` determines what form of
  # `ServiceLevelObjective` is returned from `GetServiceLevelObjective`,
  # `ListServiceLevelObjectives`, and `ListServiceLevelObjectiveVersions` RPCs.
  module View
    # Same as FULL.
    VIEW_UNSPECIFIED = 0

    # Return the embedded `ServiceLevelIndicator` in the form in which it was
    # defined. If it was defined using a `BasicSli`, return that `BasicSli`.
    FULL = 2

    # For `ServiceLevelIndicator`s using `BasicSli` articulation, instead
    # return the `ServiceLevelIndicator` with its mode of computation fully
    # spelled out as a `RequestBasedSli`. For `ServiceLevelIndicator`s using
    # `RequestBasedSli` or `WindowsBasedSli`, return the
    # `ServiceLevelIndicator` as it was provided.
    EXPLICIT = 1
  end
end

#name ⇒ ::String

Returns Resource name for this ServiceLevelObjective. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME].

Returns:

  • (::String) —

    Resource name for this ServiceLevelObjective. The format is:

    projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/monitoring/v3/service.rb', line 205

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

  # `ServiceLevelObjective.View` determines what form of
  # `ServiceLevelObjective` is returned from `GetServiceLevelObjective`,
  # `ListServiceLevelObjectives`, and `ListServiceLevelObjectiveVersions` RPCs.
  module View
    # Same as FULL.
    VIEW_UNSPECIFIED = 0

    # Return the embedded `ServiceLevelIndicator` in the form in which it was
    # defined. If it was defined using a `BasicSli`, return that `BasicSli`.
    FULL = 2

    # For `ServiceLevelIndicator`s using `BasicSli` articulation, instead
    # return the `ServiceLevelIndicator` with its mode of computation fully
    # spelled out as a `RequestBasedSli`. For `ServiceLevelIndicator`s using
    # `RequestBasedSli` or `WindowsBasedSli`, return the
    # `ServiceLevelIndicator` as it was provided.
    EXPLICIT = 1
  end
end

#rolling_period ⇒ ::Google::Protobuf::Duration

Returns A rolling time period, semantically "in the past <rolling_period>". Must be an integer multiple of 1 day no larger than 30 days.

Returns:

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

    A rolling time period, semantically "in the past <rolling_period>". Must be an integer multiple of 1 day no larger than 30 days.



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/monitoring/v3/service.rb', line 205

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

  # `ServiceLevelObjective.View` determines what form of
  # `ServiceLevelObjective` is returned from `GetServiceLevelObjective`,
  # `ListServiceLevelObjectives`, and `ListServiceLevelObjectiveVersions` RPCs.
  module View
    # Same as FULL.
    VIEW_UNSPECIFIED = 0

    # Return the embedded `ServiceLevelIndicator` in the form in which it was
    # defined. If it was defined using a `BasicSli`, return that `BasicSli`.
    FULL = 2

    # For `ServiceLevelIndicator`s using `BasicSli` articulation, instead
    # return the `ServiceLevelIndicator` with its mode of computation fully
    # spelled out as a `RequestBasedSli`. For `ServiceLevelIndicator`s using
    # `RequestBasedSli` or `WindowsBasedSli`, return the
    # `ServiceLevelIndicator` as it was provided.
    EXPLICIT = 1
  end
end

#service_level_indicator ⇒ ::Google::Cloud::Monitoring::V3::ServiceLevelIndicator

Returns The definition of good service, used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality.

Returns:



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/monitoring/v3/service.rb', line 205

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

  # `ServiceLevelObjective.View` determines what form of
  # `ServiceLevelObjective` is returned from `GetServiceLevelObjective`,
  # `ListServiceLevelObjectives`, and `ListServiceLevelObjectiveVersions` RPCs.
  module View
    # Same as FULL.
    VIEW_UNSPECIFIED = 0

    # Return the embedded `ServiceLevelIndicator` in the form in which it was
    # defined. If it was defined using a `BasicSli`, return that `BasicSli`.
    FULL = 2

    # For `ServiceLevelIndicator`s using `BasicSli` articulation, instead
    # return the `ServiceLevelIndicator` with its mode of computation fully
    # spelled out as a `RequestBasedSli`. For `ServiceLevelIndicator`s using
    # `RequestBasedSli` or `WindowsBasedSli`, return the
    # `ServiceLevelIndicator` as it was provided.
    EXPLICIT = 1
  end
end