alert_policies

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

Overview

Name	alert_policies
Type	Resource
Id	google.monitoring.alert_policies

Fields

Name	Datatype	Description
name	string	Identifier. Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID][ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.
alertStrategy	object	Control over how the notification channels in notification_channels are notified when this alert fires.
combiner	string	How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED.
conditions	array	A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. If condition_time_series_query_language is present, it must be the only condition. If condition_monitoring_query_language is present, it must be the only condition.
creationRecord	object	Describes a change made to a configuration.
displayName	string	A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.The convention for the display_name of a PrometheusQueryLanguageCondition is "{rule group name}/{alert name}", where the {rule group name} and {alert name} should be taken from the corresponding Prometheus configuration file. This convention is not enforced. In any case the display_name is not a unique key of the AlertPolicy.
documentation	object	Documentation that is included in the notifications and incidents pertaining to this policy.
enabled	boolean	Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.
mutationRecord	object	Describes a change made to a configuration.
notificationChannels	array	Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
severity	string	Optional. The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications.
userLabels	object	User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.Note that Prometheus {alert name} is a valid Prometheus label names (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels), whereas Prometheus {rule group} is an unrestricted UTF-8 string. This means that they cannot be stored as-is in user labels, because they may contain characters that are not allowed in user-label values.
validity	object	The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

Methods

Name	Accessible by	Required Params	Description
projects_alert_policies_get	SELECT	alertPoliciesId, projectsId	Gets a single alerting policy.
projects_alert_policies_list	SELECT	projectsId	Lists the existing alerting policies for the workspace.
projects_alert_policies_create	INSERT	projectsId	Creates a new alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
projects_alert_policies_delete	DELETE	alertPoliciesId, projectsId	Deletes an alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
projects_alert_policies_patch	UPDATE	alertPoliciesId, projectsId	Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via updateMask. Returns the updated alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.

SELECT examples

Lists the existing alerting policies for the workspace.

SELECT
name,
alertStrategy,
combiner,
conditions,
creationRecord,
displayName,
documentation,
enabled,
mutationRecord,
notificationChannels,
severity,
userLabels,
validity
FROM google.monitoring.alert_policies
WHERE projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new alert_policies resource.

All Properties

/*+ create */
INSERT INTO google.monitoring.alert_policies (
projectsId,
name,
displayName,
documentation,
userLabels,
conditions,
combiner,
enabled,
validity,
notificationChannels,
creationRecord,
mutationRecord,
alertStrategy,
severity
)
SELECT 
'{{ projectsId }}',
'{{ name }}',
'{{ displayName }}',
'{{ documentation }}',
'{{ userLabels }}',
'{{ conditions }}',
'{{ combiner }}',
{{ enabled }},
'{{ validity }}',
'{{ notificationChannels }}',
'{{ creationRecord }}',
'{{ mutationRecord }}',
'{{ alertStrategy }}',
'{{ severity }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: documentation
      value:
        - name: content
          value: string
        - name: mimeType
          value: string
        - name: subject
          value: string
        - name: links
          value:
            - - name: displayName
                value: string
              - name: url
                value: string
    - name: userLabels
      value: object
    - name: conditions
      value:
        - - name: name
            value: string
          - name: displayName
            value: string
          - name: conditionThreshold
            value:
              - name: filter
                value: string
              - name: aggregations
                value:
                  - - name: alignmentPeriod
                      value: string
                    - name: perSeriesAligner
                      value: string
                    - name: crossSeriesReducer
                      value: string
                    - name: groupByFields
                      value:
                        - string
              - name: denominatorFilter
                value: string
              - name: denominatorAggregations
                value:
                  - - name: alignmentPeriod
                      value: string
                    - name: perSeriesAligner
                      value: string
                    - name: crossSeriesReducer
                      value: string
                    - name: groupByFields
                      value:
                        - string
              - name: forecastOptions
                value:
                  - name: forecastHorizon
                    value: string
              - name: comparison
                value: string
              - name: thresholdValue
                value: number
              - name: duration
                value: string
              - name: trigger
                value:
                  - name: count
                    value: integer
                  - name: percent
                    value: number
              - name: evaluationMissingData
                value: string
          - name: conditionAbsent
            value:
              - name: filter
                value: string
              - name: aggregations
                value:
                  - - name: alignmentPeriod
                      value: string
                    - name: perSeriesAligner
                      value: string
                    - name: crossSeriesReducer
                      value: string
                    - name: groupByFields
                      value:
                        - string
              - name: duration
                value: string
          - name: conditionMatchedLog
            value:
              - name: filter
                value: string
              - name: labelExtractors
                value: object
          - name: conditionMonitoringQueryLanguage
            value:
              - name: query
                value: string
              - name: duration
                value: string
              - name: evaluationMissingData
                value: string
          - name: conditionPrometheusQueryLanguage
            value:
              - name: query
                value: string
              - name: duration
                value: string
              - name: evaluationInterval
                value: string
              - name: labels
                value: object
              - name: ruleGroup
                value: string
              - name: alertRule
                value: string
    - name: combiner
      value: string
    - name: enabled
      value: boolean
    - name: validity
      value:
        - name: code
          value: integer
        - name: message
          value: string
        - name: details
          value:
            - object
    - name: notificationChannels
      value:
        - string
    - name: creationRecord
      value:
        - name: mutateTime
          value: string
        - name: mutatedBy
          value: string
    - name: alertStrategy
      value:
        - name: notificationRateLimit
          value:
            - name: period
              value: string
        - name: autoClose
          value: string
        - name: notificationChannelStrategy
          value:
            - - name: notificationChannelNames
                value:
                  - string
              - name: renotifyInterval
                value: string
    - name: severity
      value: string

UPDATE example

Updates a alert_policies resource.

/*+ update */
UPDATE google.monitoring.alert_policies
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
documentation = '{{ documentation }}',
userLabels = '{{ userLabels }}',
conditions = '{{ conditions }}',
combiner = '{{ combiner }}',
enabled = true|false,
validity = '{{ validity }}',
notificationChannels = '{{ notificationChannels }}',
creationRecord = '{{ creationRecord }}',
mutationRecord = '{{ mutationRecord }}',
alertStrategy = '{{ alertStrategy }}',
severity = '{{ severity }}'
WHERE 
alertPoliciesId = '{{ alertPoliciesId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified alert_policies resource.

/*+ delete */
DELETE FROM google.monitoring.alert_policies
WHERE alertPoliciesId = '{{ alertPoliciesId }}'
AND projectsId = '{{ projectsId }}';