gcp.monitoring.AlertPolicy
A description of the conditions under which some aspect of your system is considered to be “unhealthy” and the ways to notify people or services about this state.
To get more information about AlertPolicy, see:
- API documentation
- How-to Guides
Example Usage
Monitoring Alert Policy Basic
using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var alertPolicy = new Gcp.Monitoring.AlertPolicy("alertPolicy", new()
{
Combiner = "OR",
Conditions = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyConditionArgs
{
ConditionThreshold = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdArgs
{
Aggregations = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdAggregationArgs
{
AlignmentPeriod = "60s",
PerSeriesAligner = "ALIGN_RATE",
},
},
Comparison = "COMPARISON_GT",
Duration = "60s",
Filter = "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
},
DisplayName = "test condition",
},
},
DisplayName = "My Alert Policy",
UserLabels =
{
{ "foo", "bar" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/monitoring"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := monitoring.NewAlertPolicy(ctx, "alertPolicy", &monitoring.AlertPolicyArgs{
Combiner: pulumi.String("OR"),
Conditions: monitoring.AlertPolicyConditionArray{
&monitoring.AlertPolicyConditionArgs{
ConditionThreshold: &monitoring.AlertPolicyConditionConditionThresholdArgs{
Aggregations: monitoring.AlertPolicyConditionConditionThresholdAggregationArray{
&monitoring.AlertPolicyConditionConditionThresholdAggregationArgs{
AlignmentPeriod: pulumi.String("60s"),
PerSeriesAligner: pulumi.String("ALIGN_RATE"),
},
},
Comparison: pulumi.String("COMPARISON_GT"),
Duration: pulumi.String("60s"),
Filter: pulumi.String("metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\""),
},
DisplayName: pulumi.String("test condition"),
},
},
DisplayName: pulumi.String("My Alert Policy"),
UserLabels: pulumi.StringMap{
"foo": pulumi.String("bar"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.monitoring.AlertPolicy;
import com.pulumi.gcp.monitoring.AlertPolicyArgs;
import com.pulumi.gcp.monitoring.inputs.AlertPolicyConditionArgs;
import com.pulumi.gcp.monitoring.inputs.AlertPolicyConditionConditionThresholdArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var alertPolicy = new AlertPolicy("alertPolicy", AlertPolicyArgs.builder()
.combiner("OR")
.conditions(AlertPolicyConditionArgs.builder()
.conditionThreshold(AlertPolicyConditionConditionThresholdArgs.builder()
.aggregations(AlertPolicyConditionConditionThresholdAggregationArgs.builder()
.alignmentPeriod("60s")
.perSeriesAligner("ALIGN_RATE")
.build())
.comparison("COMPARISON_GT")
.duration("60s")
.filter("metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"")
.build())
.displayName("test condition")
.build())
.displayName("My Alert Policy")
.userLabels(Map.of("foo", "bar"))
.build());
}
}
import pulumi
import pulumi_gcp as gcp
alert_policy = gcp.monitoring.AlertPolicy("alertPolicy",
combiner="OR",
conditions=[gcp.monitoring.AlertPolicyConditionArgs(
condition_threshold=gcp.monitoring.AlertPolicyConditionConditionThresholdArgs(
aggregations=[gcp.monitoring.AlertPolicyConditionConditionThresholdAggregationArgs(
alignment_period="60s",
per_series_aligner="ALIGN_RATE",
)],
comparison="COMPARISON_GT",
duration="60s",
filter="metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
),
display_name="test condition",
)],
display_name="My Alert Policy",
user_labels={
"foo": "bar",
})
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const alertPolicy = new gcp.monitoring.AlertPolicy("alertPolicy", {
combiner: "OR",
conditions: [{
conditionThreshold: {
aggregations: [{
alignmentPeriod: "60s",
perSeriesAligner: "ALIGN_RATE",
}],
comparison: "COMPARISON_GT",
duration: "60s",
filter: "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
},
displayName: "test condition",
}],
displayName: "My Alert Policy",
userLabels: {
foo: "bar",
},
});
resources:
alertPolicy:
type: gcp:monitoring:AlertPolicy
properties:
combiner: OR
conditions:
- conditionThreshold:
aggregations:
- alignmentPeriod: 60s
perSeriesAligner: ALIGN_RATE
comparison: COMPARISON_GT
duration: 60s
filter: metric.type="compute.googleapis.com/instance/disk/write_bytes_count" AND resource.type="gce_instance"
displayName: test condition
displayName: My Alert Policy
userLabels:
foo: bar
Monitoring Alert Policy Evaluation Missing Data
using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var alertPolicy = new Gcp.Monitoring.AlertPolicy("alertPolicy", new()
{
Combiner = "OR",
Conditions = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyConditionArgs
{
ConditionThreshold = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdArgs
{
Aggregations = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdAggregationArgs
{
AlignmentPeriod = "60s",
PerSeriesAligner = "ALIGN_RATE",
},
},
Comparison = "COMPARISON_GT",
Duration = "60s",
EvaluationMissingData = "EVALUATION_MISSING_DATA_INACTIVE",
Filter = "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
},
DisplayName = "test condition",
},
},
DisplayName = "My Alert Policy",
UserLabels =
{
{ "foo", "bar" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/monitoring"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := monitoring.NewAlertPolicy(ctx, "alertPolicy", &monitoring.AlertPolicyArgs{
Combiner: pulumi.String("OR"),
Conditions: monitoring.AlertPolicyConditionArray{
&monitoring.AlertPolicyConditionArgs{
ConditionThreshold: &monitoring.AlertPolicyConditionConditionThresholdArgs{
Aggregations: monitoring.AlertPolicyConditionConditionThresholdAggregationArray{
&monitoring.AlertPolicyConditionConditionThresholdAggregationArgs{
AlignmentPeriod: pulumi.String("60s"),
PerSeriesAligner: pulumi.String("ALIGN_RATE"),
},
},
Comparison: pulumi.String("COMPARISON_GT"),
Duration: pulumi.String("60s"),
EvaluationMissingData: pulumi.String("EVALUATION_MISSING_DATA_INACTIVE"),
Filter: pulumi.String("metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\""),
},
DisplayName: pulumi.String("test condition"),
},
},
DisplayName: pulumi.String("My Alert Policy"),
UserLabels: pulumi.StringMap{
"foo": pulumi.String("bar"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.monitoring.AlertPolicy;
import com.pulumi.gcp.monitoring.AlertPolicyArgs;
import com.pulumi.gcp.monitoring.inputs.AlertPolicyConditionArgs;
import com.pulumi.gcp.monitoring.inputs.AlertPolicyConditionConditionThresholdArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var alertPolicy = new AlertPolicy("alertPolicy", AlertPolicyArgs.builder()
.combiner("OR")
.conditions(AlertPolicyConditionArgs.builder()
.conditionThreshold(AlertPolicyConditionConditionThresholdArgs.builder()
.aggregations(AlertPolicyConditionConditionThresholdAggregationArgs.builder()
.alignmentPeriod("60s")
.perSeriesAligner("ALIGN_RATE")
.build())
.comparison("COMPARISON_GT")
.duration("60s")
.evaluationMissingData("EVALUATION_MISSING_DATA_INACTIVE")
.filter("metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"")
.build())
.displayName("test condition")
.build())
.displayName("My Alert Policy")
.userLabels(Map.of("foo", "bar"))
.build());
}
}
import pulumi
import pulumi_gcp as gcp
alert_policy = gcp.monitoring.AlertPolicy("alertPolicy",
combiner="OR",
conditions=[gcp.monitoring.AlertPolicyConditionArgs(
condition_threshold=gcp.monitoring.AlertPolicyConditionConditionThresholdArgs(
aggregations=[gcp.monitoring.AlertPolicyConditionConditionThresholdAggregationArgs(
alignment_period="60s",
per_series_aligner="ALIGN_RATE",
)],
comparison="COMPARISON_GT",
duration="60s",
evaluation_missing_data="EVALUATION_MISSING_DATA_INACTIVE",
filter="metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
),
display_name="test condition",
)],
display_name="My Alert Policy",
user_labels={
"foo": "bar",
})
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const alertPolicy = new gcp.monitoring.AlertPolicy("alertPolicy", {
combiner: "OR",
conditions: [{
conditionThreshold: {
aggregations: [{
alignmentPeriod: "60s",
perSeriesAligner: "ALIGN_RATE",
}],
comparison: "COMPARISON_GT",
duration: "60s",
evaluationMissingData: "EVALUATION_MISSING_DATA_INACTIVE",
filter: "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
},
displayName: "test condition",
}],
displayName: "My Alert Policy",
userLabels: {
foo: "bar",
},
});
resources:
alertPolicy:
type: gcp:monitoring:AlertPolicy
properties:
combiner: OR
conditions:
- conditionThreshold:
aggregations:
- alignmentPeriod: 60s
perSeriesAligner: ALIGN_RATE
comparison: COMPARISON_GT
duration: 60s
evaluationMissingData: EVALUATION_MISSING_DATA_INACTIVE
filter: metric.type="compute.googleapis.com/instance/disk/write_bytes_count" AND resource.type="gce_instance"
displayName: test condition
displayName: My Alert Policy
userLabels:
foo: bar
Create AlertPolicy Resource
new AlertPolicy(name: string, args: AlertPolicyArgs, opts?: CustomResourceOptions);
@overload
def AlertPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
alert_strategy: Optional[AlertPolicyAlertStrategyArgs] = None,
combiner: Optional[str] = None,
conditions: Optional[Sequence[AlertPolicyConditionArgs]] = None,
display_name: Optional[str] = None,
documentation: Optional[AlertPolicyDocumentationArgs] = None,
enabled: Optional[bool] = None,
notification_channels: Optional[Sequence[str]] = None,
project: Optional[str] = None,
user_labels: Optional[Mapping[str, str]] = None)
@overload
def AlertPolicy(resource_name: str,
args: AlertPolicyArgs,
opts: Optional[ResourceOptions] = None)
func NewAlertPolicy(ctx *Context, name string, args AlertPolicyArgs, opts ...ResourceOption) (*AlertPolicy, error)
public AlertPolicy(string name, AlertPolicyArgs args, CustomResourceOptions? opts = null)
public AlertPolicy(String name, AlertPolicyArgs args)
public AlertPolicy(String name, AlertPolicyArgs args, CustomResourceOptions options)
type: gcp:monitoring:AlertPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AlertPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AlertPolicyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AlertPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AlertPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AlertPolicyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
AlertPolicy Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The AlertPolicy resource accepts the following input properties:
- Combiner string
How to combine the results of multiple conditions to determine if an incident should be opened. Possible values are
AND
,OR
, andAND_WITH_MATCHING_RESOURCE
.- Conditions
List<Alert
Policy Condition Args> 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. Structure is documented below.
- Display
Name 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.
- Alert
Strategy AlertPolicy Alert Strategy Args Control over how this alert policy's notification channels are notified. Structure is documented below.
- Documentation
Alert
Policy Documentation Args Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. Structure is documented below.
- Enabled bool
Whether or not the policy is enabled. The default is true.
- Notification
Channels List<string> 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 notificationChannels.list method. The syntax of the entries in this field is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- User
Labels Dictionary<string, string> This field is intended 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.
- Combiner string
How to combine the results of multiple conditions to determine if an incident should be opened. Possible values are
AND
,OR
, andAND_WITH_MATCHING_RESOURCE
.- Conditions
[]Alert
Policy Condition Args 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. Structure is documented below.
- Display
Name 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.
- Alert
Strategy AlertPolicy Alert Strategy Args Control over how this alert policy's notification channels are notified. Structure is documented below.
- Documentation
Alert
Policy Documentation Args Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. Structure is documented below.
- Enabled bool
Whether or not the policy is enabled. The default is true.
- Notification
Channels []string 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 notificationChannels.list method. The syntax of the entries in this field is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- User
Labels map[string]string This field is intended 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.
- combiner String
How to combine the results of multiple conditions to determine if an incident should be opened. Possible values are
AND
,OR
, andAND_WITH_MATCHING_RESOURCE
.- conditions
List<Alert
Policy Condition Args> 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. Structure is documented below.
- display
Name 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.
- alert
Strategy AlertPolicy Alert Strategy Args Control over how this alert policy's notification channels are notified. Structure is documented below.
- documentation
Alert
Policy Documentation Args Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. Structure is documented below.
- enabled Boolean
Whether or not the policy is enabled. The default is true.
- notification
Channels List<String> 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 notificationChannels.list method. The syntax of the entries in this field is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- user
Labels Map<String,String> This field is intended 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.
- combiner string
How to combine the results of multiple conditions to determine if an incident should be opened. Possible values are
AND
,OR
, andAND_WITH_MATCHING_RESOURCE
.- conditions
Alert
Policy Condition Args[] 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. Structure is documented below.
- display
Name 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.
- alert
Strategy AlertPolicy Alert Strategy Args Control over how this alert policy's notification channels are notified. Structure is documented below.
- documentation
Alert
Policy Documentation Args Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. Structure is documented below.
- enabled boolean
Whether or not the policy is enabled. The default is true.
- notification
Channels string[] 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 notificationChannels.list method. The syntax of the entries in this field is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- user
Labels {[key: string]: string} This field is intended 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.
- combiner str
How to combine the results of multiple conditions to determine if an incident should be opened. Possible values are
AND
,OR
, andAND_WITH_MATCHING_RESOURCE
.- conditions
Sequence[Alert
Policy Condition Args] 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. Structure is documented below.
- display_
name str 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.
- alert_
strategy AlertPolicy Alert Strategy Args Control over how this alert policy's notification channels are notified. Structure is documented below.
- documentation
Alert
Policy Documentation Args Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. Structure is documented below.
- enabled bool
Whether or not the policy is enabled. The default is true.
- notification_
channels Sequence[str] 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 notificationChannels.list method. The syntax of the entries in this field is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- user_
labels Mapping[str, str] This field is intended 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.
- combiner String
How to combine the results of multiple conditions to determine if an incident should be opened. Possible values are
AND
,OR
, andAND_WITH_MATCHING_RESOURCE
.- conditions List<Property Map>
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. Structure is documented below.
- display
Name 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.
- alert
Strategy Property Map Control over how this alert policy's notification channels are notified. Structure is documented below.
- documentation Property Map
Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. Structure is documented below.
- enabled Boolean
Whether or not the policy is enabled. The default is true.
- notification
Channels List<String> 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 notificationChannels.list method. The syntax of the entries in this field is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- user
Labels Map<String> This field is intended 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the AlertPolicy resource produces the following output properties:
- Creation
Records List<AlertPolicy Creation Record> A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored. Structure is documented below.
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
- Creation
Records []AlertPolicy Creation Record A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored. Structure is documented below.
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
- creation
Records List<AlertPolicy Creation Record> A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored. Structure is documented below.
- id String
The provider-assigned unique ID for this managed resource.
- name String
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
- creation
Records AlertPolicy Creation Record[] A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored. Structure is documented below.
- id string
The provider-assigned unique ID for this managed resource.
- name string
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
- creation_
records Sequence[AlertPolicy Creation Record] A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored. Structure is documented below.
- id str
The provider-assigned unique ID for this managed resource.
- name str
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
- creation
Records List<Property Map> A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored. Structure is documented below.
- id String
The provider-assigned unique ID for this managed resource.
- name String
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
Look up Existing AlertPolicy Resource
Get an existing AlertPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AlertPolicyState, opts?: CustomResourceOptions): AlertPolicy
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
alert_strategy: Optional[AlertPolicyAlertStrategyArgs] = None,
combiner: Optional[str] = None,
conditions: Optional[Sequence[AlertPolicyConditionArgs]] = None,
creation_records: Optional[Sequence[AlertPolicyCreationRecordArgs]] = None,
display_name: Optional[str] = None,
documentation: Optional[AlertPolicyDocumentationArgs] = None,
enabled: Optional[bool] = None,
name: Optional[str] = None,
notification_channels: Optional[Sequence[str]] = None,
project: Optional[str] = None,
user_labels: Optional[Mapping[str, str]] = None) -> AlertPolicy
func GetAlertPolicy(ctx *Context, name string, id IDInput, state *AlertPolicyState, opts ...ResourceOption) (*AlertPolicy, error)
public static AlertPolicy Get(string name, Input<string> id, AlertPolicyState? state, CustomResourceOptions? opts = null)
public static AlertPolicy get(String name, Output<String> id, AlertPolicyState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Alert
Strategy AlertPolicy Alert Strategy Args Control over how this alert policy's notification channels are notified. Structure is documented below.
- Combiner string
How to combine the results of multiple conditions to determine if an incident should be opened. Possible values are
AND
,OR
, andAND_WITH_MATCHING_RESOURCE
.- Conditions
List<Alert
Policy Condition Args> 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. Structure is documented below.
- Creation
Records List<AlertPolicy Creation Record Args> A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored. Structure is documented below.
- Display
Name 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.
- Documentation
Alert
Policy Documentation Args Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. Structure is documented below.
- Enabled bool
Whether or not the policy is enabled. The default is true.
- Name string
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
- Notification
Channels List<string> 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 notificationChannels.list method. The syntax of the entries in this field is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- User
Labels Dictionary<string, string> This field is intended 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.
- Alert
Strategy AlertPolicy Alert Strategy Args Control over how this alert policy's notification channels are notified. Structure is documented below.
- Combiner string
How to combine the results of multiple conditions to determine if an incident should be opened. Possible values are
AND
,OR
, andAND_WITH_MATCHING_RESOURCE
.- Conditions
[]Alert
Policy Condition Args 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. Structure is documented below.
- Creation
Records []AlertPolicy Creation Record Args A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored. Structure is documented below.
- Display
Name 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.
- Documentation
Alert
Policy Documentation Args Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. Structure is documented below.
- Enabled bool
Whether or not the policy is enabled. The default is true.
- Name string
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
- Notification
Channels []string 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 notificationChannels.list method. The syntax of the entries in this field is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- User
Labels map[string]string This field is intended 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.
- alert
Strategy AlertPolicy Alert Strategy Args Control over how this alert policy's notification channels are notified. Structure is documented below.
- combiner String
How to combine the results of multiple conditions to determine if an incident should be opened. Possible values are
AND
,OR
, andAND_WITH_MATCHING_RESOURCE
.- conditions
List<Alert
Policy Condition Args> 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. Structure is documented below.
- creation
Records List<AlertPolicy Creation Record Args> A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored. Structure is documented below.
- display
Name 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.
- documentation
Alert
Policy Documentation Args Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. Structure is documented below.
- enabled Boolean
Whether or not the policy is enabled. The default is true.
- name String
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
- notification
Channels List<String> 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 notificationChannels.list method. The syntax of the entries in this field is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- user
Labels Map<String,String> This field is intended 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.
- alert
Strategy AlertPolicy Alert Strategy Args Control over how this alert policy's notification channels are notified. Structure is documented below.
- combiner string
How to combine the results of multiple conditions to determine if an incident should be opened. Possible values are
AND
,OR
, andAND_WITH_MATCHING_RESOURCE
.- conditions
Alert
Policy Condition Args[] 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. Structure is documented below.
- creation
Records AlertPolicy Creation Record Args[] A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored. Structure is documented below.
- display
Name 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.
- documentation
Alert
Policy Documentation Args Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. Structure is documented below.
- enabled boolean
Whether or not the policy is enabled. The default is true.
- name string
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
- notification
Channels string[] 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 notificationChannels.list method. The syntax of the entries in this field is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- user
Labels {[key: string]: string} This field is intended 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.
- alert_
strategy AlertPolicy Alert Strategy Args Control over how this alert policy's notification channels are notified. Structure is documented below.
- combiner str
How to combine the results of multiple conditions to determine if an incident should be opened. Possible values are
AND
,OR
, andAND_WITH_MATCHING_RESOURCE
.- conditions
Sequence[Alert
Policy Condition Args] 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. Structure is documented below.
- creation_
records Sequence[AlertPolicy Creation Record Args] A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored. Structure is documented below.
- display_
name str 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.
- documentation
Alert
Policy Documentation Args Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. Structure is documented below.
- enabled bool
Whether or not the policy is enabled. The default is true.
- name str
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
- notification_
channels Sequence[str] 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 notificationChannels.list method. The syntax of the entries in this field is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- user_
labels Mapping[str, str] This field is intended 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.
- alert
Strategy Property Map Control over how this alert policy's notification channels are notified. Structure is documented below.
- combiner String
How to combine the results of multiple conditions to determine if an incident should be opened. Possible values are
AND
,OR
, andAND_WITH_MATCHING_RESOURCE
.- conditions List<Property Map>
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. Structure is documented below.
- creation
Records List<Property Map> A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored. Structure is documented below.
- display
Name 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.
- documentation Property Map
Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. Structure is documented below.
- enabled Boolean
Whether or not the policy is enabled. The default is true.
- name String
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
- notification
Channels List<String> 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 notificationChannels.list method. The syntax of the entries in this field is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- user
Labels Map<String> This field is intended 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.
Supporting Types
AlertPolicyAlertStrategy
- Auto
Close string If an alert policy that was active has no data for this long, any open incidents will close.
- Notification
Rate AlertLimit Policy Alert Strategy Notification Rate Limit Required for alert policies with a LogMatch condition. This limit is not implemented for alert policies that are not log-based. Structure is documented below.
- Auto
Close string If an alert policy that was active has no data for this long, any open incidents will close.
- Notification
Rate AlertLimit Policy Alert Strategy Notification Rate Limit Required for alert policies with a LogMatch condition. This limit is not implemented for alert policies that are not log-based. Structure is documented below.
- auto
Close String If an alert policy that was active has no data for this long, any open incidents will close.
- notification
Rate AlertLimit Policy Alert Strategy Notification Rate Limit Required for alert policies with a LogMatch condition. This limit is not implemented for alert policies that are not log-based. Structure is documented below.
- auto
Close string If an alert policy that was active has no data for this long, any open incidents will close.
- notification
Rate AlertLimit Policy Alert Strategy Notification Rate Limit Required for alert policies with a LogMatch condition. This limit is not implemented for alert policies that are not log-based. Structure is documented below.
- auto_
close str If an alert policy that was active has no data for this long, any open incidents will close.
- notification_
rate_ Alertlimit Policy Alert Strategy Notification Rate Limit Required for alert policies with a LogMatch condition. This limit is not implemented for alert policies that are not log-based. Structure is documented below.
- auto
Close String If an alert policy that was active has no data for this long, any open incidents will close.
- notification
Rate Property MapLimit Required for alert policies with a LogMatch condition. This limit is not implemented for alert policies that are not log-based. Structure is documented below.
AlertPolicyAlertStrategyNotificationRateLimit
- Period string
Not more than one notification per period.
- Period string
Not more than one notification per period.
- period String
Not more than one notification per period.
- period string
Not more than one notification per period.
- period str
Not more than one notification per period.
- period String
Not more than one notification per period.
AlertPolicyCondition
- Display
Name string A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the same policy.
- Condition
Absent AlertPolicy Condition Condition Absent A condition that checks that a time series continues to receive new data points. Structure is documented below.
- Condition
Matched AlertLog Policy Condition Condition Matched Log A condition that checks for log messages matching given constraints. If set, no other conditions can be present. Structure is documented below.
- Condition
Monitoring AlertQuery Language Policy Condition Condition Monitoring Query Language A Monitoring Query Language query that outputs a boolean stream Structure is documented below.
- Condition
Threshold AlertPolicy Condition Condition Threshold A condition that compares a time series against a threshold. Structure is documented below.
- Name string
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
- Display
Name string A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the same policy.
- Condition
Absent AlertPolicy Condition Condition Absent A condition that checks that a time series continues to receive new data points. Structure is documented below.
- Condition
Matched AlertLog Policy Condition Condition Matched Log A condition that checks for log messages matching given constraints. If set, no other conditions can be present. Structure is documented below.
- Condition
Monitoring AlertQuery Language Policy Condition Condition Monitoring Query Language A Monitoring Query Language query that outputs a boolean stream Structure is documented below.
- Condition
Threshold AlertPolicy Condition Condition Threshold A condition that compares a time series against a threshold. Structure is documented below.
- Name string
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
- display
Name String A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the same policy.
- condition
Absent AlertPolicy Condition Condition Absent A condition that checks that a time series continues to receive new data points. Structure is documented below.
- condition
Matched AlertLog Policy Condition Condition Matched Log A condition that checks for log messages matching given constraints. If set, no other conditions can be present. Structure is documented below.
- condition
Monitoring AlertQuery Language Policy Condition Condition Monitoring Query Language A Monitoring Query Language query that outputs a boolean stream Structure is documented below.
- condition
Threshold AlertPolicy Condition Condition Threshold A condition that compares a time series against a threshold. Structure is documented below.
- name String
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
- display
Name string A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the same policy.
- condition
Absent AlertPolicy Condition Condition Absent A condition that checks that a time series continues to receive new data points. Structure is documented below.
- condition
Matched AlertLog Policy Condition Condition Matched Log A condition that checks for log messages matching given constraints. If set, no other conditions can be present. Structure is documented below.
- condition
Monitoring AlertQuery Language Policy Condition Condition Monitoring Query Language A Monitoring Query Language query that outputs a boolean stream Structure is documented below.
- condition
Threshold AlertPolicy Condition Condition Threshold A condition that compares a time series against a threshold. Structure is documented below.
- name string
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
- display_
name str A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the same policy.
- condition_
absent AlertPolicy Condition Condition Absent A condition that checks that a time series continues to receive new data points. Structure is documented below.
- condition_
matched_ Alertlog Policy Condition Condition Matched Log A condition that checks for log messages matching given constraints. If set, no other conditions can be present. Structure is documented below.
- condition_
monitoring_ Alertquery_ language Policy Condition Condition Monitoring Query Language A Monitoring Query Language query that outputs a boolean stream Structure is documented below.
- condition_
threshold AlertPolicy Condition Condition Threshold A condition that compares a time series against a threshold. Structure is documented below.
- name str
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
- display
Name String A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the same policy.
- condition
Absent Property Map A condition that checks that a time series continues to receive new data points. Structure is documented below.
- condition
Matched Property MapLog A condition that checks for log messages matching given constraints. If set, no other conditions can be present. Structure is documented below.
- condition
Monitoring Property MapQuery Language A Monitoring Query Language query that outputs a boolean stream Structure is documented below.
- condition
Threshold Property Map A condition that compares a time series against a threshold. Structure is documented below.
- name String
(Output) The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.
AlertPolicyConditionConditionAbsent
- Duration string
The amount of time that a time series must fail to report new data to be considered failing. Currently, only values that are a multiple of a minute--e.g. 60s, 120s, or 300s --are supported.
- Aggregations
List<Alert
Policy Condition Condition Absent Aggregation> Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified. Structure is documented below.
- Filter string
A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- Trigger
Alert
Policy Condition Condition Absent Trigger The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations. Structure is documented below.
- Duration string
The amount of time that a time series must fail to report new data to be considered failing. Currently, only values that are a multiple of a minute--e.g. 60s, 120s, or 300s --are supported.
- Aggregations
[]Alert
Policy Condition Condition Absent Aggregation Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified. Structure is documented below.
- Filter string
A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- Trigger
Alert
Policy Condition Condition Absent Trigger The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations. Structure is documented below.
- duration String
The amount of time that a time series must fail to report new data to be considered failing. Currently, only values that are a multiple of a minute--e.g. 60s, 120s, or 300s --are supported.
- aggregations
List<Alert
Policy Condition Condition Absent Aggregation> Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified. Structure is documented below.
- filter String
A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- trigger
Alert
Policy Condition Condition Absent Trigger The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations. Structure is documented below.
- duration string
The amount of time that a time series must fail to report new data to be considered failing. Currently, only values that are a multiple of a minute--e.g. 60s, 120s, or 300s --are supported.
- aggregations
Alert
Policy Condition Condition Absent Aggregation[] Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified. Structure is documented below.
- filter string
A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- trigger
Alert
Policy Condition Condition Absent Trigger The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations. Structure is documented below.
- duration str
The amount of time that a time series must fail to report new data to be considered failing. Currently, only values that are a multiple of a minute--e.g. 60s, 120s, or 300s --are supported.
- aggregations
Sequence[Alert
Policy Condition Condition Absent Aggregation] Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified. Structure is documented below.
- filter str
A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- trigger
Alert
Policy Condition Condition Absent Trigger The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations. Structure is documented below.
- duration String
The amount of time that a time series must fail to report new data to be considered failing. Currently, only values that are a multiple of a minute--e.g. 60s, 120s, or 300s --are supported.
- aggregations List<Property Map>
Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified. Structure is documented below.
- filter String
A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- trigger Property Map
The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations. Structure is documented below.
AlertPolicyConditionConditionAbsentAggregation
- Alignment
Period string The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- Cross
Series stringReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- Group
By List<string>Fields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- Per
Series stringAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
- Alignment
Period string The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- Cross
Series stringReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- Group
By []stringFields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- Per
Series stringAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
- alignment
Period String The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- cross
Series StringReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- group
By List<String>Fields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- per
Series StringAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
- alignment
Period string The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- cross
Series stringReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- group
By string[]Fields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- per
Series stringAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
- alignment_
period str The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- cross_
series_ strreducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- group_
by_ Sequence[str]fields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- per_
series_ straligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
- alignment
Period String The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- cross
Series StringReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- group
By List<String>Fields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- per
Series StringAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
AlertPolicyConditionConditionAbsentTrigger
AlertPolicyConditionConditionMatchedLog
- Filter string
A logs-based filter.
- Label
Extractors Dictionary<string, string> A map from a label key to an extractor expression, which is used to extract the value for this label key. Each entry in this map is a specification for how data should be extracted from log entries that match filter. Each combination of extracted values is treated as a separate rule for the purposes of triggering notifications. Label keys and corresponding values can be used in notifications generated by this condition.
- Filter string
A logs-based filter.
- Label
Extractors map[string]string A map from a label key to an extractor expression, which is used to extract the value for this label key. Each entry in this map is a specification for how data should be extracted from log entries that match filter. Each combination of extracted values is treated as a separate rule for the purposes of triggering notifications. Label keys and corresponding values can be used in notifications generated by this condition.
- filter String
A logs-based filter.
- label
Extractors Map<String,String> A map from a label key to an extractor expression, which is used to extract the value for this label key. Each entry in this map is a specification for how data should be extracted from log entries that match filter. Each combination of extracted values is treated as a separate rule for the purposes of triggering notifications. Label keys and corresponding values can be used in notifications generated by this condition.
- filter string
A logs-based filter.
- label
Extractors {[key: string]: string} A map from a label key to an extractor expression, which is used to extract the value for this label key. Each entry in this map is a specification for how data should be extracted from log entries that match filter. Each combination of extracted values is treated as a separate rule for the purposes of triggering notifications. Label keys and corresponding values can be used in notifications generated by this condition.
- filter str
A logs-based filter.
- label_
extractors Mapping[str, str] A map from a label key to an extractor expression, which is used to extract the value for this label key. Each entry in this map is a specification for how data should be extracted from log entries that match filter. Each combination of extracted values is treated as a separate rule for the purposes of triggering notifications. Label keys and corresponding values can be used in notifications generated by this condition.
- filter String
A logs-based filter.
- label
Extractors Map<String> A map from a label key to an extractor expression, which is used to extract the value for this label key. Each entry in this map is a specification for how data should be extracted from log entries that match filter. Each combination of extracted values is treated as a separate rule for the purposes of triggering notifications. Label keys and corresponding values can be used in notifications generated by this condition.
AlertPolicyConditionConditionMonitoringQueryLanguage
- Duration string
The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.
- Query string
Monitoring Query Language query that outputs a boolean stream.
- Evaluation
Missing stringData A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. Possible values are
EVALUATION_MISSING_DATA_INACTIVE
,EVALUATION_MISSING_DATA_ACTIVE
, andEVALUATION_MISSING_DATA_NO_OP
.- Trigger
Alert
Policy Condition Condition Monitoring Query Language Trigger The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified. Structure is documented below.
- Duration string
The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.
- Query string
Monitoring Query Language query that outputs a boolean stream.
- Evaluation
Missing stringData A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. Possible values are
EVALUATION_MISSING_DATA_INACTIVE
,EVALUATION_MISSING_DATA_ACTIVE
, andEVALUATION_MISSING_DATA_NO_OP
.- Trigger
Alert
Policy Condition Condition Monitoring Query Language Trigger The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified. Structure is documented below.
- duration String
The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.
- query String
Monitoring Query Language query that outputs a boolean stream.
- evaluation
Missing StringData A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. Possible values are
EVALUATION_MISSING_DATA_INACTIVE
,EVALUATION_MISSING_DATA_ACTIVE
, andEVALUATION_MISSING_DATA_NO_OP
.- trigger
Alert
Policy Condition Condition Monitoring Query Language Trigger The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified. Structure is documented below.
- duration string
The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.
- query string
Monitoring Query Language query that outputs a boolean stream.
- evaluation
Missing stringData A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. Possible values are
EVALUATION_MISSING_DATA_INACTIVE
,EVALUATION_MISSING_DATA_ACTIVE
, andEVALUATION_MISSING_DATA_NO_OP
.- trigger
Alert
Policy Condition Condition Monitoring Query Language Trigger The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified. Structure is documented below.
- duration str
The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.
- query str
Monitoring Query Language query that outputs a boolean stream.
- evaluation_
missing_ strdata A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. Possible values are
EVALUATION_MISSING_DATA_INACTIVE
,EVALUATION_MISSING_DATA_ACTIVE
, andEVALUATION_MISSING_DATA_NO_OP
.- trigger
Alert
Policy Condition Condition Monitoring Query Language Trigger The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified. Structure is documented below.
- duration String
The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.
- query String
Monitoring Query Language query that outputs a boolean stream.
- evaluation
Missing StringData A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. Possible values are
EVALUATION_MISSING_DATA_INACTIVE
,EVALUATION_MISSING_DATA_ACTIVE
, andEVALUATION_MISSING_DATA_NO_OP
.- trigger Property Map
The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified. Structure is documented below.
AlertPolicyConditionConditionMonitoringQueryLanguageTrigger
AlertPolicyConditionConditionThreshold
- Comparison string
The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value). The comparison is applied on each time series, with the time series on the left-hand side and the threshold on the right-hand side. Only COMPARISON_LT and COMPARISON_GT are supported currently. Possible values are
COMPARISON_GT
,COMPARISON_GE
,COMPARISON_LT
,COMPARISON_LE
,COMPARISON_EQ
, andCOMPARISON_NE
.- Duration string
The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.
- Aggregations
List<Alert
Policy Condition Condition Threshold Aggregation> Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. Structure is documented below.
- Denominator
Aggregations List<AlertPolicy Condition Condition Threshold Denominator Aggregation> Specifies the alignment of data points in individual time series selected by denominatorFilter as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).When computing ratios, the aggregations and denominator_aggregations fields must use the same alignment period and produce time series that have the same periodicity and labels.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. Structure is documented below.
- Denominator
Filter string A filter that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold. If a denominator_filter is specified, the time series specified by the filter field will be used as the numerator.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- Evaluation
Missing stringData A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. Possible values are
EVALUATION_MISSING_DATA_INACTIVE
,EVALUATION_MISSING_DATA_ACTIVE
, andEVALUATION_MISSING_DATA_NO_OP
.- Filter string
A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- Threshold
Value double A value against which to compare the time series.
- Trigger
Alert
Policy Condition Condition Threshold Trigger The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified. Structure is documented below.
- Comparison string
The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value). The comparison is applied on each time series, with the time series on the left-hand side and the threshold on the right-hand side. Only COMPARISON_LT and COMPARISON_GT are supported currently. Possible values are
COMPARISON_GT
,COMPARISON_GE
,COMPARISON_LT
,COMPARISON_LE
,COMPARISON_EQ
, andCOMPARISON_NE
.- Duration string
The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.
- Aggregations
[]Alert
Policy Condition Condition Threshold Aggregation Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. Structure is documented below.
- Denominator
Aggregations []AlertPolicy Condition Condition Threshold Denominator Aggregation Specifies the alignment of data points in individual time series selected by denominatorFilter as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).When computing ratios, the aggregations and denominator_aggregations fields must use the same alignment period and produce time series that have the same periodicity and labels.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. Structure is documented below.
- Denominator
Filter string A filter that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold. If a denominator_filter is specified, the time series specified by the filter field will be used as the numerator.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- Evaluation
Missing stringData A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. Possible values are
EVALUATION_MISSING_DATA_INACTIVE
,EVALUATION_MISSING_DATA_ACTIVE
, andEVALUATION_MISSING_DATA_NO_OP
.- Filter string
A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- Threshold
Value float64 A value against which to compare the time series.
- Trigger
Alert
Policy Condition Condition Threshold Trigger The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified. Structure is documented below.
- comparison String
The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value). The comparison is applied on each time series, with the time series on the left-hand side and the threshold on the right-hand side. Only COMPARISON_LT and COMPARISON_GT are supported currently. Possible values are
COMPARISON_GT
,COMPARISON_GE
,COMPARISON_LT
,COMPARISON_LE
,COMPARISON_EQ
, andCOMPARISON_NE
.- duration String
The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.
- aggregations
List<Alert
Policy Condition Condition Threshold Aggregation> Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. Structure is documented below.
- denominator
Aggregations List<AlertPolicy Condition Condition Threshold Denominator Aggregation> Specifies the alignment of data points in individual time series selected by denominatorFilter as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).When computing ratios, the aggregations and denominator_aggregations fields must use the same alignment period and produce time series that have the same periodicity and labels.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. Structure is documented below.
- denominator
Filter String A filter that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold. If a denominator_filter is specified, the time series specified by the filter field will be used as the numerator.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- evaluation
Missing StringData A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. Possible values are
EVALUATION_MISSING_DATA_INACTIVE
,EVALUATION_MISSING_DATA_ACTIVE
, andEVALUATION_MISSING_DATA_NO_OP
.- filter String
A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- threshold
Value Double A value against which to compare the time series.
- trigger
Alert
Policy Condition Condition Threshold Trigger The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified. Structure is documented below.
- comparison string
The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value). The comparison is applied on each time series, with the time series on the left-hand side and the threshold on the right-hand side. Only COMPARISON_LT and COMPARISON_GT are supported currently. Possible values are
COMPARISON_GT
,COMPARISON_GE
,COMPARISON_LT
,COMPARISON_LE
,COMPARISON_EQ
, andCOMPARISON_NE
.- duration string
The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.
- aggregations
Alert
Policy Condition Condition Threshold Aggregation[] Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. Structure is documented below.
- denominator
Aggregations AlertPolicy Condition Condition Threshold Denominator Aggregation[] Specifies the alignment of data points in individual time series selected by denominatorFilter as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).When computing ratios, the aggregations and denominator_aggregations fields must use the same alignment period and produce time series that have the same periodicity and labels.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. Structure is documented below.
- denominator
Filter string A filter that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold. If a denominator_filter is specified, the time series specified by the filter field will be used as the numerator.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- evaluation
Missing stringData A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. Possible values are
EVALUATION_MISSING_DATA_INACTIVE
,EVALUATION_MISSING_DATA_ACTIVE
, andEVALUATION_MISSING_DATA_NO_OP
.- filter string
A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- threshold
Value number A value against which to compare the time series.
- trigger
Alert
Policy Condition Condition Threshold Trigger The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified. Structure is documented below.
- comparison str
The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value). The comparison is applied on each time series, with the time series on the left-hand side and the threshold on the right-hand side. Only COMPARISON_LT and COMPARISON_GT are supported currently. Possible values are
COMPARISON_GT
,COMPARISON_GE
,COMPARISON_LT
,COMPARISON_LE
,COMPARISON_EQ
, andCOMPARISON_NE
.- duration str
The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.
- aggregations
Sequence[Alert
Policy Condition Condition Threshold Aggregation] Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. Structure is documented below.
- denominator_
aggregations Sequence[AlertPolicy Condition Condition Threshold Denominator Aggregation] Specifies the alignment of data points in individual time series selected by denominatorFilter as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).When computing ratios, the aggregations and denominator_aggregations fields must use the same alignment period and produce time series that have the same periodicity and labels.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. Structure is documented below.
- denominator_
filter str A filter that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold. If a denominator_filter is specified, the time series specified by the filter field will be used as the numerator.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- evaluation_
missing_ strdata A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. Possible values are
EVALUATION_MISSING_DATA_INACTIVE
,EVALUATION_MISSING_DATA_ACTIVE
, andEVALUATION_MISSING_DATA_NO_OP
.- filter str
A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- threshold_
value float A value against which to compare the time series.
- trigger
Alert
Policy Condition Condition Threshold Trigger The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified. Structure is documented below.
- comparison String
The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value). The comparison is applied on each time series, with the time series on the left-hand side and the threshold on the right-hand side. Only COMPARISON_LT and COMPARISON_GT are supported currently. Possible values are
COMPARISON_GT
,COMPARISON_GE
,COMPARISON_LT
,COMPARISON_LE
,COMPARISON_EQ
, andCOMPARISON_NE
.- duration String
The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.
- aggregations List<Property Map>
Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. Structure is documented below.
- denominator
Aggregations List<Property Map> Specifies the alignment of data points in individual time series selected by denominatorFilter as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).When computing ratios, the aggregations and denominator_aggregations fields must use the same alignment period and produce time series that have the same periodicity and labels.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. Structure is documented below.
- denominator
Filter String A filter that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold. If a denominator_filter is specified, the time series specified by the filter field will be used as the numerator.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- evaluation
Missing StringData A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. Possible values are
EVALUATION_MISSING_DATA_INACTIVE
,EVALUATION_MISSING_DATA_ACTIVE
, andEVALUATION_MISSING_DATA_NO_OP
.- filter String
A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
- threshold
Value Number A value against which to compare the time series.
- trigger Property Map
The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified. Structure is documented below.
AlertPolicyConditionConditionThresholdAggregation
- Alignment
Period string The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- Cross
Series stringReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- Group
By List<string>Fields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- Per
Series stringAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
- Alignment
Period string The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- Cross
Series stringReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- Group
By []stringFields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- Per
Series stringAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
- alignment
Period String The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- cross
Series StringReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- group
By List<String>Fields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- per
Series StringAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
- alignment
Period string The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- cross
Series stringReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- group
By string[]Fields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- per
Series stringAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
- alignment_
period str The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- cross_
series_ strreducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- group_
by_ Sequence[str]fields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- per_
series_ straligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
- alignment
Period String The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- cross
Series StringReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- group
By List<String>Fields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- per
Series StringAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
AlertPolicyConditionConditionThresholdDenominatorAggregation
- Alignment
Period string The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- Cross
Series stringReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- Group
By List<string>Fields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- Per
Series stringAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
- Alignment
Period string The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- Cross
Series stringReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- Group
By []stringFields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- Per
Series stringAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
- alignment
Period String The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- cross
Series StringReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- group
By List<String>Fields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- per
Series StringAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
- alignment
Period string The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- cross
Series stringReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- group
By string[]Fields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- per
Series stringAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
- alignment_
period str The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- cross_
series_ strreducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- group_
by_ Sequence[str]fields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- per_
series_ straligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
- alignment
Period String The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
- cross
Series StringReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
REDUCE_NONE
,REDUCE_MEAN
,REDUCE_MIN
,REDUCE_MAX
,REDUCE_SUM
,REDUCE_STDDEV
,REDUCE_COUNT
,REDUCE_COUNT_TRUE
,REDUCE_COUNT_FALSE
,REDUCE_FRACTION_TRUE
,REDUCE_PERCENTILE_99
,REDUCE_PERCENTILE_95
,REDUCE_PERCENTILE_50
, andREDUCE_PERCENTILE_05
.- group
By List<String>Fields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- per
Series StringAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross- time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. Possible values are
ALIGN_NONE
,ALIGN_DELTA
,ALIGN_RATE
,ALIGN_INTERPOLATE
,ALIGN_NEXT_OLDER
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
,ALIGN_STDDEV
,ALIGN_COUNT_TRUE
,ALIGN_COUNT_FALSE
,ALIGN_FRACTION_TRUE
,ALIGN_PERCENTILE_99
,ALIGN_PERCENTILE_95
,ALIGN_PERCENTILE_50
,ALIGN_PERCENTILE_05
, andALIGN_PERCENT_CHANGE
.
AlertPolicyConditionConditionThresholdTrigger
AlertPolicyCreationRecord
- Mutate
Time string (Output) When the change occurred.
- Mutated
By string (Output) The email address of the user making the change.
- Mutate
Time string (Output) When the change occurred.
- Mutated
By string (Output) The email address of the user making the change.
- mutate
Time String (Output) When the change occurred.
- mutated
By String (Output) The email address of the user making the change.
- mutate
Time string (Output) When the change occurred.
- mutated
By string (Output) The email address of the user making the change.
- mutate_
time str (Output) When the change occurred.
- mutated_
by str (Output) The email address of the user making the change.
- mutate
Time String (Output) When the change occurred.
- mutated
By String (Output) The email address of the user making the change.
AlertPolicyDocumentation
- Content string
The text of the documentation, interpreted according to mimeType. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller.
- Mime
Type string The format of the content field. Presently, only the value "text/markdown" is supported.
- Content string
The text of the documentation, interpreted according to mimeType. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller.
- Mime
Type string The format of the content field. Presently, only the value "text/markdown" is supported.
- content String
The text of the documentation, interpreted according to mimeType. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller.
- mime
Type String The format of the content field. Presently, only the value "text/markdown" is supported.
- content string
The text of the documentation, interpreted according to mimeType. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller.
- mime
Type string The format of the content field. Presently, only the value "text/markdown" is supported.
- content str
The text of the documentation, interpreted according to mimeType. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller.
- mime_
type str The format of the content field. Presently, only the value "text/markdown" is supported.
- content String
The text of the documentation, interpreted according to mimeType. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller.
- mime
Type String The format of the content field. Presently, only the value "text/markdown" is supported.
Import
AlertPolicy can be imported using any of these accepted formats
$ pulumi import gcp:monitoring/alertPolicy:AlertPolicy default {{name}}
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-beta
Terraform Provider.