service_level_objectives

Creates, updates, deletes, gets or lists a service_level_objectives resource.

Overview

Name	service_level_objectives
Type	Resource
Id	google.monitoring.service_level_objectives

Fields

The following fields are returned by SELECT queries:

services_service_level_objectives_list

Name	Datatype	Description
name	string	Identifier. Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
calendarPeriod	string	A calendar period, semantically "since the start of the current ". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported. (CALENDAR_PERIOD_UNSPECIFIED, DAY, WEEK, FORTNIGHT, MONTH, QUARTER, HALF, YEAR)
displayName	string	Name used for UI elements listing this SLO.
goal	number (double)	The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.9999.
rollingPeriod	string (google-duration)	A rolling time period, semantically "in the past ". Must be an integer multiple of 1 day no larger than 30 days.
serviceLevelIndicator	object	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. (id: ServiceLevelIndicator)
userLabels	object	Labels which have been used to annotate the service-level objective. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.

services_service_level_objectives_get

Name	Datatype	Description
name	string	Identifier. Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
calendarPeriod	string	A calendar period, semantically "since the start of the current ". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported. (CALENDAR_PERIOD_UNSPECIFIED, DAY, WEEK, FORTNIGHT, MONTH, QUARTER, HALF, YEAR)
displayName	string	Name used for UI elements listing this SLO.
goal	number (double)	The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.9999.
rollingPeriod	string (google-duration)	A rolling time period, semantically "in the past ". Must be an integer multiple of 1 day no larger than 30 days.
serviceLevelIndicator	object	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. (id: ServiceLevelIndicator)
userLabels	object	Labels which have been used to annotate the service-level objective. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
services_service_level_objectives_list	select	parentType, parent	filter, pageSize, view, pageToken	List the ServiceLevelObjectives for the given Service.
services_service_level_objectives_get	select	name	view	Get a ServiceLevelObjective by name.
services_service_level_objectives_create	insert	parentType, parent	serviceLevelObjectiveId	Create a ServiceLevelObjective for the given Service.
services_service_level_objectives_patch	update	name	updateMask	Update the given ServiceLevelObjective.
services_service_level_objectives_delete	delete	name		Delete the given ServiceLevelObjective.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
name	string
parent	string
parentType	string
filter	string
pageSize	integer (int32)
pageToken	string
serviceLevelObjectiveId	string
updateMask	string (google-fieldmask)
view	string

SELECT examples

services_service_level_objectives_list

List the ServiceLevelObjectives for the given Service.

SELECT
name,
calendarPeriod,
displayName,
goal,
rollingPeriod,
serviceLevelIndicator,
userLabels
FROM google.monitoring.service_level_objectives
WHERE parentType = '{{ parentType }}' -- required
AND parent = '{{ parent }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND view = '{{ view }}'
AND pageToken = '{{ pageToken }}'
;

services_service_level_objectives_get

Get a ServiceLevelObjective by name.

SELECT
name,
calendarPeriod,
displayName,
goal,
rollingPeriod,
serviceLevelIndicator,
userLabels
FROM google.monitoring.service_level_objectives
WHERE name = '{{ name }}' -- required
AND view = '{{ view }}'
;

INSERT examples

services_service_level_objectives_create

Create a ServiceLevelObjective for the given Service.

INSERT INTO google.monitoring.service_level_objectives (
data__goal,
data__displayName,
data__rollingPeriod,
data__userLabels,
data__calendarPeriod,
data__name,
data__serviceLevelIndicator,
parentType,
parent,
serviceLevelObjectiveId
)
SELECT 
{{ goal }},
'{{ displayName }}',
'{{ rollingPeriod }}',
'{{ userLabels }}',
'{{ calendarPeriod }}',
'{{ name }}',
'{{ serviceLevelIndicator }}',
'{{ parentType }}',
'{{ parent }}',
'{{ serviceLevelObjectiveId }}'
RETURNING
name,
calendarPeriod,
displayName,
goal,
rollingPeriod,
serviceLevelIndicator,
userLabels
;

Manifest

# Description fields are for documentation purposes
- name: service_level_objectives
props:
  - name: parentType
    value: "{{ parentType }}"
    description: Required parameter for the service_level_objectives resource.
  - name: parent
    value: "{{ parent }}"
    description: Required parameter for the service_level_objectives resource.
  - name: goal
    value: {{ goal }}
    description: |
      The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.9999.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Name used for UI elements listing this SLO.
  - name: rollingPeriod
    value: "{{ rollingPeriod }}"
    description: |
      A rolling time period, semantically "in the past ". Must be an integer multiple of 1 day no larger than 30 days.
  - name: userLabels
    value: "{{ userLabels }}"
    description: |
      Labels which have been used to annotate the service-level objective. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.
  - name: calendarPeriod
    value: "{{ calendarPeriod }}"
    description: |
      A calendar period, semantically "since the start of the current ". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported.
    valid_values: ['CALENDAR_PERIOD_UNSPECIFIED', 'DAY', 'WEEK', 'FORTNIGHT', 'MONTH', 'QUARTER', 'HALF', 'YEAR']
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
  - name: serviceLevelIndicator
    description: |
      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.
    value:
      basicSli:
        availability: "{{ availability }}"
        location:
          - "{{ location }}"
        latency:
          threshold: "{{ threshold }}"
        method:
          - "{{ method }}"
        version:
          - "{{ version }}"
      requestBased:
        goodTotalRatio:
          totalServiceFilter: "{{ totalServiceFilter }}"
          badServiceFilter: "{{ badServiceFilter }}"
          goodServiceFilter: "{{ goodServiceFilter }}"
        distributionCut:
          distributionFilter: "{{ distributionFilter }}"
          range:
            min: {{ min }}
            max: {{ max }}
      windowsBased:
        windowPeriod: "{{ windowPeriod }}"
        metricMeanInRange:
          range:
            min: {{ min }}
            max: {{ max }}
          timeSeries: "{{ timeSeries }}"
        metricSumInRange:
          range:
            min: {{ min }}
            max: {{ max }}
          timeSeries: "{{ timeSeries }}"
        goodTotalRatioThreshold:
          basicSliPerformance:
            availability: "{{ availability }}"
            location:
              - "{{ location }}"
            latency:
              threshold: "{{ threshold }}"
            method:
              - "{{ method }}"
            version:
              - "{{ version }}"
          threshold: {{ threshold }}
          performance:
            goodTotalRatio:
              totalServiceFilter: "{{ totalServiceFilter }}"
              badServiceFilter: "{{ badServiceFilter }}"
              goodServiceFilter: "{{ goodServiceFilter }}"
            distributionCut:
              distributionFilter: "{{ distributionFilter }}"
              range: "{{ range }}"
        goodBadMetricFilter: "{{ goodBadMetricFilter }}"
  - name: serviceLevelObjectiveId
    value: "{{ serviceLevelObjectiveId }}"

UPDATE examples

services_service_level_objectives_patch

Update the given ServiceLevelObjective.

UPDATE google.monitoring.service_level_objectives
SET 
data__goal = {{ goal }},
data__displayName = '{{ displayName }}',
data__rollingPeriod = '{{ rollingPeriod }}',
data__userLabels = '{{ userLabels }}',
data__calendarPeriod = '{{ calendarPeriod }}',
data__name = '{{ name }}',
data__serviceLevelIndicator = '{{ serviceLevelIndicator }}'
WHERE 
name = '{{ name }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
calendarPeriod,
displayName,
goal,
rollingPeriod,
serviceLevelIndicator,
userLabels;

DELETE examples

services_service_level_objectives_delete

Delete the given ServiceLevelObjective.

DELETE FROM google.monitoring.service_level_objectives
WHERE name = '{{ name }}' --required
;