Docs Home
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
gcp.monitoring.AlertPolicy
Explore with Pulumi AI
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
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const alertPolicy = new gcp.monitoring.AlertPolicy("alert_policy", {
displayName: "My Alert Policy",
combiner: "OR",
conditions: [{
displayName: "test condition",
conditionThreshold: {
filter: "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
duration: "60s",
comparison: "COMPARISON_GT",
aggregations: [{
alignmentPeriod: "60s",
perSeriesAligner: "ALIGN_RATE",
}],
},
}],
userLabels: {
foo: "bar",
},
});
import pulumi
import pulumi_gcp as gcp
alert_policy = gcp.monitoring.AlertPolicy("alert_policy",
display_name="My Alert Policy",
combiner="OR",
conditions=[{
"display_name": "test condition",
"condition_threshold": {
"filter": "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
"duration": "60s",
"comparison": "COMPARISON_GT",
"aggregations": [{
"alignment_period": "60s",
"per_series_aligner": "ALIGN_RATE",
}],
},
}],
user_labels={
"foo": "bar",
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/monitoring"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := monitoring.NewAlertPolicy(ctx, "alert_policy", &monitoring.AlertPolicyArgs{
DisplayName: pulumi.String("My Alert Policy"),
Combiner: pulumi.String("OR"),
Conditions: monitoring.AlertPolicyConditionArray{
&monitoring.AlertPolicyConditionArgs{
DisplayName: pulumi.String("test condition"),
ConditionThreshold: &monitoring.AlertPolicyConditionConditionThresholdArgs{
Filter: pulumi.String("metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\""),
Duration: pulumi.String("60s"),
Comparison: pulumi.String("COMPARISON_GT"),
Aggregations: monitoring.AlertPolicyConditionConditionThresholdAggregationArray{
&monitoring.AlertPolicyConditionConditionThresholdAggregationArgs{
AlignmentPeriod: pulumi.String("60s"),
PerSeriesAligner: pulumi.String("ALIGN_RATE"),
},
},
},
},
},
UserLabels: pulumi.StringMap{
"foo": pulumi.String("bar"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var alertPolicy = new Gcp.Monitoring.AlertPolicy("alert_policy", new()
{
DisplayName = "My Alert Policy",
Combiner = "OR",
Conditions = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyConditionArgs
{
DisplayName = "test condition",
ConditionThreshold = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdArgs
{
Filter = "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
Duration = "60s",
Comparison = "COMPARISON_GT",
Aggregations = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdAggregationArgs
{
AlignmentPeriod = "60s",
PerSeriesAligner = "ALIGN_RATE",
},
},
},
},
},
UserLabels =
{
{ "foo", "bar" },
},
});
});
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()
.displayName("My Alert Policy")
.combiner("OR")
.conditions(AlertPolicyConditionArgs.builder()
.displayName("test condition")
.conditionThreshold(AlertPolicyConditionConditionThresholdArgs.builder()
.filter("metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"")
.duration("60s")
.comparison("COMPARISON_GT")
.aggregations(AlertPolicyConditionConditionThresholdAggregationArgs.builder()
.alignmentPeriod("60s")
.perSeriesAligner("ALIGN_RATE")
.build())
.build())
.build())
.userLabels(Map.of("foo", "bar"))
.build());
}
}
resources:
alertPolicy:
type: gcp:monitoring:AlertPolicy
name: alert_policy
properties:
displayName: My Alert Policy
combiner: OR
conditions:
- displayName: test condition
conditionThreshold:
filter: metric.type="compute.googleapis.com/instance/disk/write_bytes_count" AND resource.type="gce_instance"
duration: 60s
comparison: COMPARISON_GT
aggregations:
- alignmentPeriod: 60s
perSeriesAligner: ALIGN_RATE
userLabels:
foo: bar
Monitoring Alert Policy Evaluation Missing Data
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const alertPolicy = new gcp.monitoring.AlertPolicy("alert_policy", {
displayName: "My Alert Policy",
combiner: "OR",
conditions: [{
displayName: "test condition",
conditionThreshold: {
filter: "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
duration: "60s",
comparison: "COMPARISON_GT",
aggregations: [{
alignmentPeriod: "60s",
perSeriesAligner: "ALIGN_RATE",
}],
evaluationMissingData: "EVALUATION_MISSING_DATA_INACTIVE",
},
}],
userLabels: {
foo: "bar",
},
});
import pulumi
import pulumi_gcp as gcp
alert_policy = gcp.monitoring.AlertPolicy("alert_policy",
display_name="My Alert Policy",
combiner="OR",
conditions=[{
"display_name": "test condition",
"condition_threshold": {
"filter": "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
"duration": "60s",
"comparison": "COMPARISON_GT",
"aggregations": [{
"alignment_period": "60s",
"per_series_aligner": "ALIGN_RATE",
}],
"evaluation_missing_data": "EVALUATION_MISSING_DATA_INACTIVE",
},
}],
user_labels={
"foo": "bar",
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/monitoring"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := monitoring.NewAlertPolicy(ctx, "alert_policy", &monitoring.AlertPolicyArgs{
DisplayName: pulumi.String("My Alert Policy"),
Combiner: pulumi.String("OR"),
Conditions: monitoring.AlertPolicyConditionArray{
&monitoring.AlertPolicyConditionArgs{
DisplayName: pulumi.String("test condition"),
ConditionThreshold: &monitoring.AlertPolicyConditionConditionThresholdArgs{
Filter: pulumi.String("metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\""),
Duration: pulumi.String("60s"),
Comparison: pulumi.String("COMPARISON_GT"),
Aggregations: monitoring.AlertPolicyConditionConditionThresholdAggregationArray{
&monitoring.AlertPolicyConditionConditionThresholdAggregationArgs{
AlignmentPeriod: pulumi.String("60s"),
PerSeriesAligner: pulumi.String("ALIGN_RATE"),
},
},
EvaluationMissingData: pulumi.String("EVALUATION_MISSING_DATA_INACTIVE"),
},
},
},
UserLabels: pulumi.StringMap{
"foo": pulumi.String("bar"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var alertPolicy = new Gcp.Monitoring.AlertPolicy("alert_policy", new()
{
DisplayName = "My Alert Policy",
Combiner = "OR",
Conditions = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyConditionArgs
{
DisplayName = "test condition",
ConditionThreshold = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdArgs
{
Filter = "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
Duration = "60s",
Comparison = "COMPARISON_GT",
Aggregations = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdAggregationArgs
{
AlignmentPeriod = "60s",
PerSeriesAligner = "ALIGN_RATE",
},
},
EvaluationMissingData = "EVALUATION_MISSING_DATA_INACTIVE",
},
},
},
UserLabels =
{
{ "foo", "bar" },
},
});
});
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()
.displayName("My Alert Policy")
.combiner("OR")
.conditions(AlertPolicyConditionArgs.builder()
.displayName("test condition")
.conditionThreshold(AlertPolicyConditionConditionThresholdArgs.builder()
.filter("metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"")
.duration("60s")
.comparison("COMPARISON_GT")
.aggregations(AlertPolicyConditionConditionThresholdAggregationArgs.builder()
.alignmentPeriod("60s")
.perSeriesAligner("ALIGN_RATE")
.build())
.evaluationMissingData("EVALUATION_MISSING_DATA_INACTIVE")
.build())
.build())
.userLabels(Map.of("foo", "bar"))
.build());
}
}
resources:
alertPolicy:
type: gcp:monitoring:AlertPolicy
name: alert_policy
properties:
displayName: My Alert Policy
combiner: OR
conditions:
- displayName: test condition
conditionThreshold:
filter: metric.type="compute.googleapis.com/instance/disk/write_bytes_count" AND resource.type="gce_instance"
duration: 60s
comparison: COMPARISON_GT
aggregations:
- alignmentPeriod: 60s
perSeriesAligner: ALIGN_RATE
evaluationMissingData: EVALUATION_MISSING_DATA_INACTIVE
userLabels:
foo: bar
Monitoring Alert Policy Forecast Options
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const alertPolicy = new gcp.monitoring.AlertPolicy("alert_policy", {
displayName: "My Alert Policy",
combiner: "OR",
conditions: [{
displayName: "test condition",
conditionThreshold: {
filter: "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
duration: "60s",
forecastOptions: {
forecastHorizon: "3600s",
},
comparison: "COMPARISON_GT",
aggregations: [{
alignmentPeriod: "60s",
perSeriesAligner: "ALIGN_RATE",
}],
},
}],
userLabels: {
foo: "bar",
},
});
import pulumi
import pulumi_gcp as gcp
alert_policy = gcp.monitoring.AlertPolicy("alert_policy",
display_name="My Alert Policy",
combiner="OR",
conditions=[{
"display_name": "test condition",
"condition_threshold": {
"filter": "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
"duration": "60s",
"forecast_options": {
"forecast_horizon": "3600s",
},
"comparison": "COMPARISON_GT",
"aggregations": [{
"alignment_period": "60s",
"per_series_aligner": "ALIGN_RATE",
}],
},
}],
user_labels={
"foo": "bar",
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/monitoring"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := monitoring.NewAlertPolicy(ctx, "alert_policy", &monitoring.AlertPolicyArgs{
DisplayName: pulumi.String("My Alert Policy"),
Combiner: pulumi.String("OR"),
Conditions: monitoring.AlertPolicyConditionArray{
&monitoring.AlertPolicyConditionArgs{
DisplayName: pulumi.String("test condition"),
ConditionThreshold: &monitoring.AlertPolicyConditionConditionThresholdArgs{
Filter: pulumi.String("metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\""),
Duration: pulumi.String("60s"),
ForecastOptions: &monitoring.AlertPolicyConditionConditionThresholdForecastOptionsArgs{
ForecastHorizon: pulumi.String("3600s"),
},
Comparison: pulumi.String("COMPARISON_GT"),
Aggregations: monitoring.AlertPolicyConditionConditionThresholdAggregationArray{
&monitoring.AlertPolicyConditionConditionThresholdAggregationArgs{
AlignmentPeriod: pulumi.String("60s"),
PerSeriesAligner: pulumi.String("ALIGN_RATE"),
},
},
},
},
},
UserLabels: pulumi.StringMap{
"foo": pulumi.String("bar"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var alertPolicy = new Gcp.Monitoring.AlertPolicy("alert_policy", new()
{
DisplayName = "My Alert Policy",
Combiner = "OR",
Conditions = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyConditionArgs
{
DisplayName = "test condition",
ConditionThreshold = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdArgs
{
Filter = "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
Duration = "60s",
ForecastOptions = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdForecastOptionsArgs
{
ForecastHorizon = "3600s",
},
Comparison = "COMPARISON_GT",
Aggregations = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdAggregationArgs
{
AlignmentPeriod = "60s",
PerSeriesAligner = "ALIGN_RATE",
},
},
},
},
},
UserLabels =
{
{ "foo", "bar" },
},
});
});
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 com.pulumi.gcp.monitoring.inputs.AlertPolicyConditionConditionThresholdForecastOptionsArgs;
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()
.displayName("My Alert Policy")
.combiner("OR")
.conditions(AlertPolicyConditionArgs.builder()
.displayName("test condition")
.conditionThreshold(AlertPolicyConditionConditionThresholdArgs.builder()
.filter("metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"")
.duration("60s")
.forecastOptions(AlertPolicyConditionConditionThresholdForecastOptionsArgs.builder()
.forecastHorizon("3600s")
.build())
.comparison("COMPARISON_GT")
.aggregations(AlertPolicyConditionConditionThresholdAggregationArgs.builder()
.alignmentPeriod("60s")
.perSeriesAligner("ALIGN_RATE")
.build())
.build())
.build())
.userLabels(Map.of("foo", "bar"))
.build());
}
}
resources:
alertPolicy:
type: gcp:monitoring:AlertPolicy
name: alert_policy
properties:
displayName: My Alert Policy
combiner: OR
conditions:
- displayName: test condition
conditionThreshold:
filter: metric.type="compute.googleapis.com/instance/disk/write_bytes_count" AND resource.type="gce_instance"
duration: 60s
forecastOptions:
forecastHorizon: 3600s
comparison: COMPARISON_GT
aggregations:
- alignmentPeriod: 60s
perSeriesAligner: ALIGN_RATE
userLabels:
foo: bar
Monitoring Alert Policy Promql Condition
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const alertPolicy = new gcp.monitoring.AlertPolicy("alert_policy", {
displayName: "My Alert Policy",
combiner: "OR",
conditions: [{
displayName: "test condition",
conditionPrometheusQueryLanguage: {
query: "compute_googleapis_com:instance_cpu_usage_time > 0",
duration: "60s",
evaluationInterval: "60s",
alertRule: "AlwaysOn",
ruleGroup: "a test",
},
}],
alertStrategy: {
autoClose: "1800s",
},
});
import pulumi
import pulumi_gcp as gcp
alert_policy = gcp.monitoring.AlertPolicy("alert_policy",
display_name="My Alert Policy",
combiner="OR",
conditions=[{
"display_name": "test condition",
"condition_prometheus_query_language": {
"query": "compute_googleapis_com:instance_cpu_usage_time > 0",
"duration": "60s",
"evaluation_interval": "60s",
"alert_rule": "AlwaysOn",
"rule_group": "a test",
},
}],
alert_strategy={
"auto_close": "1800s",
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/monitoring"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := monitoring.NewAlertPolicy(ctx, "alert_policy", &monitoring.AlertPolicyArgs{
DisplayName: pulumi.String("My Alert Policy"),
Combiner: pulumi.String("OR"),
Conditions: monitoring.AlertPolicyConditionArray{
&monitoring.AlertPolicyConditionArgs{
DisplayName: pulumi.String("test condition"),
ConditionPrometheusQueryLanguage: &monitoring.AlertPolicyConditionConditionPrometheusQueryLanguageArgs{
Query: pulumi.String("compute_googleapis_com:instance_cpu_usage_time > 0"),
Duration: pulumi.String("60s"),
EvaluationInterval: pulumi.String("60s"),
AlertRule: pulumi.String("AlwaysOn"),
RuleGroup: pulumi.String("a test"),
},
},
},
AlertStrategy: &monitoring.AlertPolicyAlertStrategyArgs{
AutoClose: pulumi.String("1800s"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var alertPolicy = new Gcp.Monitoring.AlertPolicy("alert_policy", new()
{
DisplayName = "My Alert Policy",
Combiner = "OR",
Conditions = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyConditionArgs
{
DisplayName = "test condition",
ConditionPrometheusQueryLanguage = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionPrometheusQueryLanguageArgs
{
Query = "compute_googleapis_com:instance_cpu_usage_time > 0",
Duration = "60s",
EvaluationInterval = "60s",
AlertRule = "AlwaysOn",
RuleGroup = "a test",
},
},
},
AlertStrategy = new Gcp.Monitoring.Inputs.AlertPolicyAlertStrategyArgs
{
AutoClose = "1800s",
},
});
});
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.AlertPolicyConditionConditionPrometheusQueryLanguageArgs;
import com.pulumi.gcp.monitoring.inputs.AlertPolicyAlertStrategyArgs;
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()
.displayName("My Alert Policy")
.combiner("OR")
.conditions(AlertPolicyConditionArgs.builder()
.displayName("test condition")
.conditionPrometheusQueryLanguage(AlertPolicyConditionConditionPrometheusQueryLanguageArgs.builder()
.query("compute_googleapis_com:instance_cpu_usage_time > 0")
.duration("60s")
.evaluationInterval("60s")
.alertRule("AlwaysOn")
.ruleGroup("a test")
.build())
.build())
.alertStrategy(AlertPolicyAlertStrategyArgs.builder()
.autoClose("1800s")
.build())
.build());
}
}
resources:
alertPolicy:
type: gcp:monitoring:AlertPolicy
name: alert_policy
properties:
displayName: My Alert Policy
combiner: OR
conditions:
- displayName: test condition
conditionPrometheusQueryLanguage:
query: compute_googleapis_com:instance_cpu_usage_time > 0
duration: 60s
evaluationInterval: 60s
alertRule: AlwaysOn
ruleGroup: a test
alertStrategy:
autoClose: 1800s
Create AlertPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AlertPolicy(name: string, args: AlertPolicyArgs, opts?: CustomResourceOptions);@overload
def AlertPolicy(resource_name: str,
args: AlertPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AlertPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
combiner: Optional[str] = None,
conditions: Optional[Sequence[AlertPolicyConditionArgs]] = None,
display_name: Optional[str] = None,
alert_strategy: Optional[AlertPolicyAlertStrategyArgs] = None,
documentation: Optional[AlertPolicyDocumentationArgs] = None,
enabled: Optional[bool] = None,
notification_channels: Optional[Sequence[str]] = None,
project: Optional[str] = None,
severity: Optional[str] = None,
user_labels: Optional[Mapping[str, str]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var alertPolicyResource = new Gcp.Monitoring.AlertPolicy("alertPolicyResource", new()
{
Combiner = "string",
Conditions = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyConditionArgs
{
DisplayName = "string",
ConditionAbsent = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionAbsentArgs
{
Duration = "string",
Aggregations = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionAbsentAggregationArgs
{
AlignmentPeriod = "string",
CrossSeriesReducer = "string",
GroupByFields = new[]
{
"string",
},
PerSeriesAligner = "string",
},
},
Filter = "string",
Trigger = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionAbsentTriggerArgs
{
Count = 0,
Percent = 0,
},
},
ConditionMatchedLog = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionMatchedLogArgs
{
Filter = "string",
LabelExtractors =
{
{ "string", "string" },
},
},
ConditionMonitoringQueryLanguage = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionMonitoringQueryLanguageArgs
{
Duration = "string",
Query = "string",
EvaluationMissingData = "string",
Trigger = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionMonitoringQueryLanguageTriggerArgs
{
Count = 0,
Percent = 0,
},
},
ConditionPrometheusQueryLanguage = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionPrometheusQueryLanguageArgs
{
Query = "string",
AlertRule = "string",
Duration = "string",
EvaluationInterval = "string",
Labels =
{
{ "string", "string" },
},
RuleGroup = "string",
},
ConditionThreshold = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdArgs
{
Comparison = "string",
Duration = "string",
Aggregations = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdAggregationArgs
{
AlignmentPeriod = "string",
CrossSeriesReducer = "string",
GroupByFields = new[]
{
"string",
},
PerSeriesAligner = "string",
},
},
DenominatorAggregations = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdDenominatorAggregationArgs
{
AlignmentPeriod = "string",
CrossSeriesReducer = "string",
GroupByFields = new[]
{
"string",
},
PerSeriesAligner = "string",
},
},
DenominatorFilter = "string",
EvaluationMissingData = "string",
Filter = "string",
ForecastOptions = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdForecastOptionsArgs
{
ForecastHorizon = "string",
},
ThresholdValue = 0,
Trigger = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdTriggerArgs
{
Count = 0,
Percent = 0,
},
},
Name = "string",
},
},
DisplayName = "string",
AlertStrategy = new Gcp.Monitoring.Inputs.AlertPolicyAlertStrategyArgs
{
AutoClose = "string",
NotificationChannelStrategies = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyAlertStrategyNotificationChannelStrategyArgs
{
NotificationChannelNames = new[]
{
"string",
},
RenotifyInterval = "string",
},
},
NotificationPrompts = new[]
{
"string",
},
NotificationRateLimit = new Gcp.Monitoring.Inputs.AlertPolicyAlertStrategyNotificationRateLimitArgs
{
Period = "string",
},
},
Documentation = new Gcp.Monitoring.Inputs.AlertPolicyDocumentationArgs
{
Content = "string",
Links = new[]
{
new Gcp.Monitoring.Inputs.AlertPolicyDocumentationLinkArgs
{
DisplayName = "string",
Url = "string",
},
},
MimeType = "string",
Subject = "string",
},
Enabled = false,
NotificationChannels = new[]
{
"string",
},
Project = "string",
Severity = "string",
UserLabels =
{
{ "string", "string" },
},
});
example, err := monitoring.NewAlertPolicy(ctx, "alertPolicyResource", &monitoring.AlertPolicyArgs{
Combiner: pulumi.String("string"),
Conditions: monitoring.AlertPolicyConditionArray{
&monitoring.AlertPolicyConditionArgs{
DisplayName: pulumi.String("string"),
ConditionAbsent: &monitoring.AlertPolicyConditionConditionAbsentArgs{
Duration: pulumi.String("string"),
Aggregations: monitoring.AlertPolicyConditionConditionAbsentAggregationArray{
&monitoring.AlertPolicyConditionConditionAbsentAggregationArgs{
AlignmentPeriod: pulumi.String("string"),
CrossSeriesReducer: pulumi.String("string"),
GroupByFields: pulumi.StringArray{
pulumi.String("string"),
},
PerSeriesAligner: pulumi.String("string"),
},
},
Filter: pulumi.String("string"),
Trigger: &monitoring.AlertPolicyConditionConditionAbsentTriggerArgs{
Count: pulumi.Int(0),
Percent: pulumi.Float64(0),
},
},
ConditionMatchedLog: &monitoring.AlertPolicyConditionConditionMatchedLogArgs{
Filter: pulumi.String("string"),
LabelExtractors: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
ConditionMonitoringQueryLanguage: &monitoring.AlertPolicyConditionConditionMonitoringQueryLanguageArgs{
Duration: pulumi.String("string"),
Query: pulumi.String("string"),
EvaluationMissingData: pulumi.String("string"),
Trigger: &monitoring.AlertPolicyConditionConditionMonitoringQueryLanguageTriggerArgs{
Count: pulumi.Int(0),
Percent: pulumi.Float64(0),
},
},
ConditionPrometheusQueryLanguage: &monitoring.AlertPolicyConditionConditionPrometheusQueryLanguageArgs{
Query: pulumi.String("string"),
AlertRule: pulumi.String("string"),
Duration: pulumi.String("string"),
EvaluationInterval: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
RuleGroup: pulumi.String("string"),
},
ConditionThreshold: &monitoring.AlertPolicyConditionConditionThresholdArgs{
Comparison: pulumi.String("string"),
Duration: pulumi.String("string"),
Aggregations: monitoring.AlertPolicyConditionConditionThresholdAggregationArray{
&monitoring.AlertPolicyConditionConditionThresholdAggregationArgs{
AlignmentPeriod: pulumi.String("string"),
CrossSeriesReducer: pulumi.String("string"),
GroupByFields: pulumi.StringArray{
pulumi.String("string"),
},
PerSeriesAligner: pulumi.String("string"),
},
},
DenominatorAggregations: monitoring.AlertPolicyConditionConditionThresholdDenominatorAggregationArray{
&monitoring.AlertPolicyConditionConditionThresholdDenominatorAggregationArgs{
AlignmentPeriod: pulumi.String("string"),
CrossSeriesReducer: pulumi.String("string"),
GroupByFields: pulumi.StringArray{
pulumi.String("string"),
},
PerSeriesAligner: pulumi.String("string"),
},
},
DenominatorFilter: pulumi.String("string"),
EvaluationMissingData: pulumi.String("string"),
Filter: pulumi.String("string"),
ForecastOptions: &monitoring.AlertPolicyConditionConditionThresholdForecastOptionsArgs{
ForecastHorizon: pulumi.String("string"),
},
ThresholdValue: pulumi.Float64(0),
Trigger: &monitoring.AlertPolicyConditionConditionThresholdTriggerArgs{
Count: pulumi.Int(0),
Percent: pulumi.Float64(0),
},
},
Name: pulumi.String("string"),
},
},
DisplayName: pulumi.String("string"),
AlertStrategy: &monitoring.AlertPolicyAlertStrategyArgs{
AutoClose: pulumi.String("string"),
NotificationChannelStrategies: monitoring.AlertPolicyAlertStrategyNotificationChannelStrategyArray{
&monitoring.AlertPolicyAlertStrategyNotificationChannelStrategyArgs{
NotificationChannelNames: pulumi.StringArray{
pulumi.String("string"),
},
RenotifyInterval: pulumi.String("string"),
},
},
NotificationPrompts: pulumi.StringArray{
pulumi.String("string"),
},
NotificationRateLimit: &monitoring.AlertPolicyAlertStrategyNotificationRateLimitArgs{
Period: pulumi.String("string"),
},
},
Documentation: &monitoring.AlertPolicyDocumentationArgs{
Content: pulumi.String("string"),
Links: monitoring.AlertPolicyDocumentationLinkArray{
&monitoring.AlertPolicyDocumentationLinkArgs{
DisplayName: pulumi.String("string"),
Url: pulumi.String("string"),
},
},
MimeType: pulumi.String("string"),
Subject: pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
NotificationChannels: pulumi.StringArray{
pulumi.String("string"),
},
Project: pulumi.String("string"),
Severity: pulumi.String("string"),
UserLabels: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var alertPolicyResource = new AlertPolicy("alertPolicyResource", AlertPolicyArgs.builder()
.combiner("string")
.conditions(AlertPolicyConditionArgs.builder()
.displayName("string")
.conditionAbsent(AlertPolicyConditionConditionAbsentArgs.builder()
.duration("string")
.aggregations(AlertPolicyConditionConditionAbsentAggregationArgs.builder()
.alignmentPeriod("string")
.crossSeriesReducer("string")
.groupByFields("string")
.perSeriesAligner("string")
.build())
.filter("string")
.trigger(AlertPolicyConditionConditionAbsentTriggerArgs.builder()
.count(0)
.percent(0)
.build())
.build())
.conditionMatchedLog(AlertPolicyConditionConditionMatchedLogArgs.builder()
.filter("string")
.labelExtractors(Map.of("string", "string"))
.build())
.conditionMonitoringQueryLanguage(AlertPolicyConditionConditionMonitoringQueryLanguageArgs.builder()
.duration("string")
.query("string")
.evaluationMissingData("string")
.trigger(AlertPolicyConditionConditionMonitoringQueryLanguageTriggerArgs.builder()
.count(0)
.percent(0)
.build())
.build())
.conditionPrometheusQueryLanguage(AlertPolicyConditionConditionPrometheusQueryLanguageArgs.builder()
.query("string")
.alertRule("string")
.duration("string")
.evaluationInterval("string")
.labels(Map.of("string", "string"))
.ruleGroup("string")
.build())
.conditionThreshold(AlertPolicyConditionConditionThresholdArgs.builder()
.comparison("string")
.duration("string")
.aggregations(AlertPolicyConditionConditionThresholdAggregationArgs.builder()
.alignmentPeriod("string")
.crossSeriesReducer("string")
.groupByFields("string")
.perSeriesAligner("string")
.build())
.denominatorAggregations(AlertPolicyConditionConditionThresholdDenominatorAggregationArgs.builder()
.alignmentPeriod("string")
.crossSeriesReducer("string")
.groupByFields("string")
.perSeriesAligner("string")
.build())
.denominatorFilter("string")
.evaluationMissingData("string")
.filter("string")
.forecastOptions(AlertPolicyConditionConditionThresholdForecastOptionsArgs.builder()
.forecastHorizon("string")
.build())
.thresholdValue(0)
.trigger(AlertPolicyConditionConditionThresholdTriggerArgs.builder()
.count(0)
.percent(0)
.build())
.build())
.name("string")
.build())
.displayName("string")
.alertStrategy(AlertPolicyAlertStrategyArgs.builder()
.autoClose("string")
.notificationChannelStrategies(AlertPolicyAlertStrategyNotificationChannelStrategyArgs.builder()
.notificationChannelNames("string")
.renotifyInterval("string")
.build())
.notificationPrompts("string")
.notificationRateLimit(AlertPolicyAlertStrategyNotificationRateLimitArgs.builder()
.period("string")
.build())
.build())
.documentation(AlertPolicyDocumentationArgs.builder()
.content("string")
.links(AlertPolicyDocumentationLinkArgs.builder()
.displayName("string")
.url("string")
.build())
.mimeType("string")
.subject("string")
.build())
.enabled(false)
.notificationChannels("string")
.project("string")
.severity("string")
.userLabels(Map.of("string", "string"))
.build());
alert_policy_resource = gcp.monitoring.AlertPolicy("alertPolicyResource",
combiner="string",
conditions=[{
"display_name": "string",
"condition_absent": {
"duration": "string",
"aggregations": [{
"alignment_period": "string",
"cross_series_reducer": "string",
"group_by_fields": ["string"],
"per_series_aligner": "string",
}],
"filter": "string",
"trigger": {
"count": 0,
"percent": 0,
},
},
"condition_matched_log": {
"filter": "string",
"label_extractors": {
"string": "string",
},
},
"condition_monitoring_query_language": {
"duration": "string",
"query": "string",
"evaluation_missing_data": "string",
"trigger": {
"count": 0,
"percent": 0,
},
},
"condition_prometheus_query_language": {
"query": "string",
"alert_rule": "string",
"duration": "string",
"evaluation_interval": "string",
"labels": {
"string": "string",
},
"rule_group": "string",
},
"condition_threshold": {
"comparison": "string",
"duration": "string",
"aggregations": [{
"alignment_period": "string",
"cross_series_reducer": "string",
"group_by_fields": ["string"],
"per_series_aligner": "string",
}],
"denominator_aggregations": [{
"alignment_period": "string",
"cross_series_reducer": "string",
"group_by_fields": ["string"],
"per_series_aligner": "string",
}],
"denominator_filter": "string",
"evaluation_missing_data": "string",
"filter": "string",
"forecast_options": {
"forecast_horizon": "string",
},
"threshold_value": 0,
"trigger": {
"count": 0,
"percent": 0,
},
},
"name": "string",
}],
display_name="string",
alert_strategy={
"auto_close": "string",
"notification_channel_strategies": [{
"notification_channel_names": ["string"],
"renotify_interval": "string",
}],
"notification_prompts": ["string"],
"notification_rate_limit": {
"period": "string",
},
},
documentation={
"content": "string",
"links": [{
"display_name": "string",
"url": "string",
}],
"mime_type": "string",
"subject": "string",
},
enabled=False,
notification_channels=["string"],
project="string",
severity="string",
user_labels={
"string": "string",
})
const alertPolicyResource = new gcp.monitoring.AlertPolicy("alertPolicyResource", {
combiner: "string",
conditions: [{
displayName: "string",
conditionAbsent: {
duration: "string",
aggregations: [{
alignmentPeriod: "string",
crossSeriesReducer: "string",
groupByFields: ["string"],
perSeriesAligner: "string",
}],
filter: "string",
trigger: {
count: 0,
percent: 0,
},
},
conditionMatchedLog: {
filter: "string",
labelExtractors: {
string: "string",
},
},
conditionMonitoringQueryLanguage: {
duration: "string",
query: "string",
evaluationMissingData: "string",
trigger: {
count: 0,
percent: 0,
},
},
conditionPrometheusQueryLanguage: {
query: "string",
alertRule: "string",
duration: "string",
evaluationInterval: "string",
labels: {
string: "string",
},
ruleGroup: "string",
},
conditionThreshold: {
comparison: "string",
duration: "string",
aggregations: [{
alignmentPeriod: "string",
crossSeriesReducer: "string",
groupByFields: ["string"],
perSeriesAligner: "string",
}],
denominatorAggregations: [{
alignmentPeriod: "string",
crossSeriesReducer: "string",
groupByFields: ["string"],
perSeriesAligner: "string",
}],
denominatorFilter: "string",
evaluationMissingData: "string",
filter: "string",
forecastOptions: {
forecastHorizon: "string",
},
thresholdValue: 0,
trigger: {
count: 0,
percent: 0,
},
},
name: "string",
}],
displayName: "string",
alertStrategy: {
autoClose: "string",
notificationChannelStrategies: [{
notificationChannelNames: ["string"],
renotifyInterval: "string",
}],
notificationPrompts: ["string"],
notificationRateLimit: {
period: "string",
},
},
documentation: {
content: "string",
links: [{
displayName: "string",
url: "string",
}],
mimeType: "string",
subject: "string",
},
enabled: false,
notificationChannels: ["string"],
project: "string",
severity: "string",
userLabels: {
string: "string",
},
});
type: gcp:monitoring:AlertPolicy
properties:
alertStrategy:
autoClose: string
notificationChannelStrategies:
- notificationChannelNames:
- string
renotifyInterval: string
notificationPrompts:
- string
notificationRateLimit:
period: string
combiner: string
conditions:
- conditionAbsent:
aggregations:
- alignmentPeriod: string
crossSeriesReducer: string
groupByFields:
- string
perSeriesAligner: string
duration: string
filter: string
trigger:
count: 0
percent: 0
conditionMatchedLog:
filter: string
labelExtractors:
string: string
conditionMonitoringQueryLanguage:
duration: string
evaluationMissingData: string
query: string
trigger:
count: 0
percent: 0
conditionPrometheusQueryLanguage:
alertRule: string
duration: string
evaluationInterval: string
labels:
string: string
query: string
ruleGroup: string
conditionThreshold:
aggregations:
- alignmentPeriod: string
crossSeriesReducer: string
groupByFields:
- string
perSeriesAligner: string
comparison: string
denominatorAggregations:
- alignmentPeriod: string
crossSeriesReducer: string
groupByFields:
- string
perSeriesAligner: string
denominatorFilter: string
duration: string
evaluationMissingData: string
filter: string
forecastOptions:
forecastHorizon: string
thresholdValue: 0
trigger:
count: 0
percent: 0
displayName: string
name: string
displayName: string
documentation:
content: string
links:
- displayName: string
url: string
mimeType: string
subject: string
enabled: false
notificationChannels:
- string
project: string
severity: string
userLabels:
string: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
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,AND_WITH_MATCHING_RESOURCE. - Conditions
List<Alert
Policy Condition> - 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 - Control over how this alert policy's notification channels are notified.
- Documentation
Alert
Policy Documentation - 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.
- 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
- Severity string
- The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications. Possible values: ["CRITICAL", "ERROR", "WARNING"]
- 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,AND_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.
- 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.
- 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
- Severity string
- The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications. Possible values: ["CRITICAL", "ERROR", "WARNING"]
- 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,AND_WITH_MATCHING_RESOURCE. - conditions
List<Alert
Policy Condition> - 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 - Control over how this alert policy's notification channels are notified.
- documentation
Alert
Policy Documentation - 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.
- 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
- severity String
- The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications. Possible values: ["CRITICAL", "ERROR", "WARNING"]
- 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,AND_WITH_MATCHING_RESOURCE. - conditions
Alert
Policy Condition[] - 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 - Control over how this alert policy's notification channels are notified.
- documentation
Alert
Policy Documentation - 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.
- 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
- severity string
- The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications. Possible values: ["CRITICAL", "ERROR", "WARNING"]
- 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,AND_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.
- 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.
- 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
- severity str
- The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications. Possible values: ["CRITICAL", "ERROR", "WARNING"]
- 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,AND_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.
- 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.
- 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
- severity String
- The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications. Possible values: ["CRITICAL", "ERROR", "WARNING"]
- 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
- The unique resource name for this policy. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
- 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
- The unique resource name for this policy. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
- 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
- The unique resource name for this policy. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
- 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
- The unique resource name for this policy. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
- 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
- The unique resource name for this policy. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
- 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
- The unique resource name for this policy. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
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,
severity: Optional[str] = None,
user_labels: Optional[Mapping[str, str]] = None) -> AlertPolicyfunc 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 - Control over how this alert policy's notification channels are notified.
- Combiner string
- How to combine the results of multiple conditions to
determine if an incident should be opened.
Possible values are:
AND,OR,AND_WITH_MATCHING_RESOURCE. - Conditions
List<Alert
Policy Condition> - 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> - 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 - 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.
- Enabled bool
- Whether or not the policy is enabled. The default is true.
- Name string
- The unique resource name for this policy. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
- 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
- Severity string
- The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications. Possible values: ["CRITICAL", "ERROR", "WARNING"]
- 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.
- Combiner string
- How to combine the results of multiple conditions to
determine if an incident should be opened.
Possible values are:
AND,OR,AND_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.
- Enabled bool
- Whether or not the policy is enabled. The default is true.
- Name string
- The unique resource name for this policy. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
- 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
- Severity string
- The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications. Possible values: ["CRITICAL", "ERROR", "WARNING"]
- 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 - Control over how this alert policy's notification channels are notified.
- combiner String
- How to combine the results of multiple conditions to
determine if an incident should be opened.
Possible values are:
AND,OR,AND_WITH_MATCHING_RESOURCE. - conditions
List<Alert
Policy Condition> - 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> - 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 - 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.
- enabled Boolean
- Whether or not the policy is enabled. The default is true.
- name String
- The unique resource name for this policy. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
- 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
- severity String
- The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications. Possible values: ["CRITICAL", "ERROR", "WARNING"]
- 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 - Control over how this alert policy's notification channels are notified.
- combiner string
- How to combine the results of multiple conditions to
determine if an incident should be opened.
Possible values are:
AND,OR,AND_WITH_MATCHING_RESOURCE. - conditions
Alert
Policy Condition[] - 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[] - 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 - 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.
- enabled boolean
- Whether or not the policy is enabled. The default is true.
- name string
- The unique resource name for this policy. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
- 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
- severity string
- The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications. Possible values: ["CRITICAL", "ERROR", "WARNING"]
- 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.
- combiner str
- How to combine the results of multiple conditions to
determine if an incident should be opened.
Possible values are:
AND,OR,AND_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.
- enabled bool
- Whether or not the policy is enabled. The default is true.
- name str
- The unique resource name for this policy. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
- 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
- severity str
- The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications. Possible values: ["CRITICAL", "ERROR", "WARNING"]
- 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.
- combiner String
- How to combine the results of multiple conditions to
determine if an incident should be opened.
Possible values are:
AND,OR,AND_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.
- enabled Boolean
- Whether or not the policy is enabled. The default is true.
- name String
- The unique resource name for this policy. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
- 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
- severity String
- The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications. Possible values: ["CRITICAL", "ERROR", "WARNING"]
- 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, AlertPolicyAlertStrategyArgs
- Auto
Close string - If an alert policy that was active has no data for this long, any open incidents will close.
- Notification
Channel List<AlertStrategies Policy Alert Strategy Notification Channel Strategy> - Control over how the notification channels in
notification_channelsare notified when this alert fires, on a per-channel basis. Structure is documented below. - Notification
Prompts List<string> - Control when notifications will be sent out.
Each value may be one of:
NOTIFICATION_PROMPT_UNSPECIFIED,OPENED,CLOSED. - 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
Channel []AlertStrategies Policy Alert Strategy Notification Channel Strategy - Control over how the notification channels in
notification_channelsare notified when this alert fires, on a per-channel basis. Structure is documented below. - Notification
Prompts []string - Control when notifications will be sent out.
Each value may be one of:
NOTIFICATION_PROMPT_UNSPECIFIED,OPENED,CLOSED. - 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
Channel List<AlertStrategies Policy Alert Strategy Notification Channel Strategy> - Control over how the notification channels in
notification_channelsare notified when this alert fires, on a per-channel basis. Structure is documented below. - notification
Prompts List<String> - Control when notifications will be sent out.
Each value may be one of:
NOTIFICATION_PROMPT_UNSPECIFIED,OPENED,CLOSED. - 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
Channel AlertStrategies Policy Alert Strategy Notification Channel Strategy[] - Control over how the notification channels in
notification_channelsare notified when this alert fires, on a per-channel basis. Structure is documented below. - notification
Prompts string[] - Control when notifications will be sent out.
Each value may be one of:
NOTIFICATION_PROMPT_UNSPECIFIED,OPENED,CLOSED. - 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_
channel_ Sequence[Alertstrategies Policy Alert Strategy Notification Channel Strategy] - Control over how the notification channels in
notification_channelsare notified when this alert fires, on a per-channel basis. Structure is documented below. - notification_
prompts Sequence[str] - Control when notifications will be sent out.
Each value may be one of:
NOTIFICATION_PROMPT_UNSPECIFIED,OPENED,CLOSED. - 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
Channel List<Property Map>Strategies - Control over how the notification channels in
notification_channelsare notified when this alert fires, on a per-channel basis. Structure is documented below. - notification
Prompts List<String> - Control when notifications will be sent out.
Each value may be one of:
NOTIFICATION_PROMPT_UNSPECIFIED,OPENED,CLOSED. - 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.
AlertPolicyAlertStrategyNotificationChannelStrategy, AlertPolicyAlertStrategyNotificationChannelStrategyArgs
- Notification
Channel List<string>Names - The notification channels that these settings apply to. Each of these
correspond to the name field in one of the NotificationChannel objects
referenced in the notification_channels field of this AlertPolicy. The format is
projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] - Renotify
Interval string - The frequency at which to send reminder notifications for open incidents.
- Notification
Channel []stringNames - The notification channels that these settings apply to. Each of these
correspond to the name field in one of the NotificationChannel objects
referenced in the notification_channels field of this AlertPolicy. The format is
projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] - Renotify
Interval string - The frequency at which to send reminder notifications for open incidents.
- notification
Channel List<String>Names - The notification channels that these settings apply to. Each of these
correspond to the name field in one of the NotificationChannel objects
referenced in the notification_channels field of this AlertPolicy. The format is
projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] - renotify
Interval String - The frequency at which to send reminder notifications for open incidents.
- notification
Channel string[]Names - The notification channels that these settings apply to. Each of these
correspond to the name field in one of the NotificationChannel objects
referenced in the notification_channels field of this AlertPolicy. The format is
projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] - renotify
Interval string - The frequency at which to send reminder notifications for open incidents.
- notification_
channel_ Sequence[str]names - The notification channels that these settings apply to. Each of these
correspond to the name field in one of the NotificationChannel objects
referenced in the notification_channels field of this AlertPolicy. The format is
projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] - renotify_
interval str - The frequency at which to send reminder notifications for open incidents.
- notification
Channel List<String>Names - The notification channels that these settings apply to. Each of these
correspond to the name field in one of the NotificationChannel objects
referenced in the notification_channels field of this AlertPolicy. The format is
projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] - renotify
Interval String - The frequency at which to send reminder notifications for open incidents.
AlertPolicyAlertStrategyNotificationRateLimit, AlertPolicyAlertStrategyNotificationRateLimitArgs
- Period string
- Not more than one notification per period. A duration in seconds with up to nine fractional digits, terminated by 's'. Example "60.5s".
- Period string
- Not more than one notification per period. A duration in seconds with up to nine fractional digits, terminated by 's'. Example "60.5s".
- period String
- Not more than one notification per period. A duration in seconds with up to nine fractional digits, terminated by 's'. Example "60.5s".
- period string
- Not more than one notification per period. A duration in seconds with up to nine fractional digits, terminated by 's'. Example "60.5s".
- period str
- Not more than one notification per period. A duration in seconds with up to nine fractional digits, terminated by 's'. Example "60.5s".
- period String
- Not more than one notification per period. A duration in seconds with up to nine fractional digits, terminated by 's'. Example "60.5s".
AlertPolicyCondition, AlertPolicyConditionArgs
- 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
Prometheus AlertQuery Language Policy Condition Condition Prometheus Query Language - A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL). The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group. 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
Prometheus AlertQuery Language Policy Condition Condition Prometheus Query Language - A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL). The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group. 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
Prometheus AlertQuery Language Policy Condition Condition Prometheus Query Language - A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL). The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group. 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
Prometheus AlertQuery Language Policy Condition Condition Prometheus Query Language - A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL). The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group. 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_
prometheus_ Alertquery_ language Policy Condition Condition Prometheus Query Language - A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL). The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group. 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
Prometheus Property MapQuery Language - A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL). The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group. 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, AlertPolicyConditionConditionAbsentArgs
- 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, AlertPolicyConditionConditionAbsentAggregationArgs
- 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,REDUCE_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,ALIGN_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,REDUCE_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,ALIGN_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,REDUCE_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,ALIGN_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,REDUCE_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,ALIGN_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,REDUCE_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,ALIGN_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,REDUCE_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,ALIGN_PERCENT_CHANGE.
AlertPolicyConditionConditionAbsentTrigger, AlertPolicyConditionConditionAbsentTriggerArgs
AlertPolicyConditionConditionMatchedLog, AlertPolicyConditionConditionMatchedLogArgs
- 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, AlertPolicyConditionConditionMonitoringQueryLanguageArgs
- 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,EVALUATION_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,EVALUATION_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,EVALUATION_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,EVALUATION_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,EVALUATION_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,EVALUATION_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, AlertPolicyConditionConditionMonitoringQueryLanguageTriggerArgs
AlertPolicyConditionConditionPrometheusQueryLanguage, AlertPolicyConditionConditionPrometheusQueryLanguageArgs
- Query string
- The PromQL expression to evaluate. Every evaluation cycle this expression is evaluated at the current time, and all resultant time series become pending/firing alerts. This field must not be empty.
- Alert
Rule string - The alerting rule name of this alert in the corresponding Prometheus
configuration file.
Some external tools may require this field to be populated correctly
in order to refer to the original Prometheus configuration file.
The rule group name and the alert name are necessary to update the
relevant AlertPolicies in case the definition of the rule group changes
in the future.
This field is optional. If this field is not empty, then it must be a
valid Prometheus label name.
- Duration string
- Alerts are considered firing once their PromQL expression evaluated to be "true" for this long. Alerts whose PromQL expression was not evaluated to be "true" for long enough are considered pending. The default value is zero. Must be zero or positive.
- Evaluation
Interval string - How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. The default value is 30 seconds. If this PrometheusQueryLanguageCondition was generated from a Prometheus alerting rule, then this value should be taken from the enclosing rule group.
- Labels Dictionary<string, string>
- Labels to add to or overwrite in the PromQL query result. Label names must be valid. Label values can be templatized by using variables. The only available variable names are the names of the labels in the PromQL result, including "name" and "value". "labels" may be empty. This field is intended to be used for organizing and identifying the AlertPolicy
- Rule
Group string - The rule group name of this alert in the corresponding Prometheus configuration file. Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future. This field is optional.
- Query string
- The PromQL expression to evaluate. Every evaluation cycle this expression is evaluated at the current time, and all resultant time series become pending/firing alerts. This field must not be empty.
- Alert
Rule string - The alerting rule name of this alert in the corresponding Prometheus
configuration file.
Some external tools may require this field to be populated correctly
in order to refer to the original Prometheus configuration file.
The rule group name and the alert name are necessary to update the
relevant AlertPolicies in case the definition of the rule group changes
in the future.
This field is optional. If this field is not empty, then it must be a
valid Prometheus label name.
- Duration string
- Alerts are considered firing once their PromQL expression evaluated to be "true" for this long. Alerts whose PromQL expression was not evaluated to be "true" for long enough are considered pending. The default value is zero. Must be zero or positive.
- Evaluation
Interval string - How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. The default value is 30 seconds. If this PrometheusQueryLanguageCondition was generated from a Prometheus alerting rule, then this value should be taken from the enclosing rule group.
- Labels map[string]string
- Labels to add to or overwrite in the PromQL query result. Label names must be valid. Label values can be templatized by using variables. The only available variable names are the names of the labels in the PromQL result, including "name" and "value". "labels" may be empty. This field is intended to be used for organizing and identifying the AlertPolicy
- Rule
Group string - The rule group name of this alert in the corresponding Prometheus configuration file. Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future. This field is optional.
- query String
- The PromQL expression to evaluate. Every evaluation cycle this expression is evaluated at the current time, and all resultant time series become pending/firing alerts. This field must not be empty.
- alert
Rule String - The alerting rule name of this alert in the corresponding Prometheus
configuration file.
Some external tools may require this field to be populated correctly
in order to refer to the original Prometheus configuration file.
The rule group name and the alert name are necessary to update the
relevant AlertPolicies in case the definition of the rule group changes
in the future.
This field is optional. If this field is not empty, then it must be a
valid Prometheus label name.
- duration String
- Alerts are considered firing once their PromQL expression evaluated to be "true" for this long. Alerts whose PromQL expression was not evaluated to be "true" for long enough are considered pending. The default value is zero. Must be zero or positive.
- evaluation
Interval String - How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. The default value is 30 seconds. If this PrometheusQueryLanguageCondition was generated from a Prometheus alerting rule, then this value should be taken from the enclosing rule group.
- labels Map<String,String>
- Labels to add to or overwrite in the PromQL query result. Label names must be valid. Label values can be templatized by using variables. The only available variable names are the names of the labels in the PromQL result, including "name" and "value". "labels" may be empty. This field is intended to be used for organizing and identifying the AlertPolicy
- rule
Group String - The rule group name of this alert in the corresponding Prometheus configuration file. Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future. This field is optional.
- query string
- The PromQL expression to evaluate. Every evaluation cycle this expression is evaluated at the current time, and all resultant time series become pending/firing alerts. This field must not be empty.
- alert
Rule string - The alerting rule name of this alert in the corresponding Prometheus
configuration file.
Some external tools may require this field to be populated correctly
in order to refer to the original Prometheus configuration file.
The rule group name and the alert name are necessary to update the
relevant AlertPolicies in case the definition of the rule group changes
in the future.
This field is optional. If this field is not empty, then it must be a
valid Prometheus label name.
- duration string
- Alerts are considered firing once their PromQL expression evaluated to be "true" for this long. Alerts whose PromQL expression was not evaluated to be "true" for long enough are considered pending. The default value is zero. Must be zero or positive.
- evaluation
Interval string - How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. The default value is 30 seconds. If this PrometheusQueryLanguageCondition was generated from a Prometheus alerting rule, then this value should be taken from the enclosing rule group.
- labels {[key: string]: string}
- Labels to add to or overwrite in the PromQL query result. Label names must be valid. Label values can be templatized by using variables. The only available variable names are the names of the labels in the PromQL result, including "name" and "value". "labels" may be empty. This field is intended to be used for organizing and identifying the AlertPolicy
- rule
Group string - The rule group name of this alert in the corresponding Prometheus configuration file. Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future. This field is optional.
- query str
- The PromQL expression to evaluate. Every evaluation cycle this expression is evaluated at the current time, and all resultant time series become pending/firing alerts. This field must not be empty.
- alert_
rule str - The alerting rule name of this alert in the corresponding Prometheus
configuration file.
Some external tools may require this field to be populated correctly
in order to refer to the original Prometheus configuration file.
The rule group name and the alert name are necessary to update the
relevant AlertPolicies in case the definition of the rule group changes
in the future.
This field is optional. If this field is not empty, then it must be a
valid Prometheus label name.
- duration str
- Alerts are considered firing once their PromQL expression evaluated to be "true" for this long. Alerts whose PromQL expression was not evaluated to be "true" for long enough are considered pending. The default value is zero. Must be zero or positive.
- evaluation_
interval str - How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. The default value is 30 seconds. If this PrometheusQueryLanguageCondition was generated from a Prometheus alerting rule, then this value should be taken from the enclosing rule group.
- labels Mapping[str, str]
- Labels to add to or overwrite in the PromQL query result. Label names must be valid. Label values can be templatized by using variables. The only available variable names are the names of the labels in the PromQL result, including "name" and "value". "labels" may be empty. This field is intended to be used for organizing and identifying the AlertPolicy
- rule_
group str - The rule group name of this alert in the corresponding Prometheus configuration file. Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future. This field is optional.
- query String
- The PromQL expression to evaluate. Every evaluation cycle this expression is evaluated at the current time, and all resultant time series become pending/firing alerts. This field must not be empty.
- alert
Rule String - The alerting rule name of this alert in the corresponding Prometheus
configuration file.
Some external tools may require this field to be populated correctly
in order to refer to the original Prometheus configuration file.
The rule group name and the alert name are necessary to update the
relevant AlertPolicies in case the definition of the rule group changes
in the future.
This field is optional. If this field is not empty, then it must be a
valid Prometheus label name.
- duration String
- Alerts are considered firing once their PromQL expression evaluated to be "true" for this long. Alerts whose PromQL expression was not evaluated to be "true" for long enough are considered pending. The default value is zero. Must be zero or positive.
- evaluation
Interval String - How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. The default value is 30 seconds. If this PrometheusQueryLanguageCondition was generated from a Prometheus alerting rule, then this value should be taken from the enclosing rule group.
- labels Map<String>
- Labels to add to or overwrite in the PromQL query result. Label names must be valid. Label values can be templatized by using variables. The only available variable names are the names of the labels in the PromQL result, including "name" and "value". "labels" may be empty. This field is intended to be used for organizing and identifying the AlertPolicy
- rule
Group String - The rule group name of this alert in the corresponding Prometheus configuration file. Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future. This field is optional.
AlertPolicyConditionConditionThreshold, AlertPolicyConditionConditionThresholdArgs
- 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,COMPARISON_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,EVALUATION_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.
- Forecast
Options AlertPolicy Condition Condition Threshold Forecast Options - When this field is present, the
MetricThresholdcondition forecasts whether the time series is predicted to violate the threshold within theforecastHorizon. When this field is not set, theMetricThresholdtests the current value of the timeseries against the threshold. Structure is documented below. - 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,COMPARISON_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,EVALUATION_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.
- Forecast
Options AlertPolicy Condition Condition Threshold Forecast Options - When this field is present, the
MetricThresholdcondition forecasts whether the time series is predicted to violate the threshold within theforecastHorizon. When this field is not set, theMetricThresholdtests the current value of the timeseries against the threshold. Structure is documented below. - 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,COMPARISON_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,EVALUATION_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.
- forecast
Options AlertPolicy Condition Condition Threshold Forecast Options - When this field is present, the
MetricThresholdcondition forecasts whether the time series is predicted to violate the threshold within theforecastHorizon. When this field is not set, theMetricThresholdtests the current value of the timeseries against the threshold. Structure is documented below. - 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,COMPARISON_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,EVALUATION_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.
- forecast
Options AlertPolicy Condition Condition Threshold Forecast Options - When this field is present, the
MetricThresholdcondition forecasts whether the time series is predicted to violate the threshold within theforecastHorizon. When this field is not set, theMetricThresholdtests the current value of the timeseries against the threshold. Structure is documented below. - 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,COMPARISON_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,EVALUATION_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.
- forecast_
options AlertPolicy Condition Condition Threshold Forecast Options - When this field is present, the
MetricThresholdcondition forecasts whether the time series is predicted to violate the threshold within theforecastHorizon. When this field is not set, theMetricThresholdtests the current value of the timeseries against the threshold. Structure is documented below. - 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,COMPARISON_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,EVALUATION_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.
- forecast
Options Property Map - When this field is present, the
MetricThresholdcondition forecasts whether the time series is predicted to violate the threshold within theforecastHorizon. When this field is not set, theMetricThresholdtests the current value of the timeseries against the threshold. Structure is documented below. - 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, AlertPolicyConditionConditionThresholdAggregationArgs
- 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,REDUCE_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,ALIGN_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,REDUCE_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,ALIGN_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,REDUCE_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,ALIGN_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,REDUCE_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,ALIGN_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,REDUCE_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,ALIGN_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,REDUCE_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,ALIGN_PERCENT_CHANGE.
AlertPolicyConditionConditionThresholdDenominatorAggregation, AlertPolicyConditionConditionThresholdDenominatorAggregationArgs
- 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,REDUCE_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,ALIGN_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,REDUCE_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,ALIGN_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,REDUCE_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,ALIGN_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,REDUCE_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,ALIGN_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,REDUCE_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,ALIGN_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,REDUCE_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,ALIGN_PERCENT_CHANGE.
AlertPolicyConditionConditionThresholdForecastOptions, AlertPolicyConditionConditionThresholdForecastOptionsArgs
- Forecast
Horizon string - The length of time into the future to forecast
whether a timeseries will violate the threshold.
If the predicted value is found to violate the
threshold, and the violation is observed in all
forecasts made for the Configured
duration, then the timeseries is considered to be failing.
- Forecast
Horizon string - The length of time into the future to forecast
whether a timeseries will violate the threshold.
If the predicted value is found to violate the
threshold, and the violation is observed in all
forecasts made for the Configured
duration, then the timeseries is considered to be failing.
- forecast
Horizon String - The length of time into the future to forecast
whether a timeseries will violate the threshold.
If the predicted value is found to violate the
threshold, and the violation is observed in all
forecasts made for the Configured
duration, then the timeseries is considered to be failing.
- forecast
Horizon string - The length of time into the future to forecast
whether a timeseries will violate the threshold.
If the predicted value is found to violate the
threshold, and the violation is observed in all
forecasts made for the Configured
duration, then the timeseries is considered to be failing.
- forecast_
horizon str - The length of time into the future to forecast
whether a timeseries will violate the threshold.
If the predicted value is found to violate the
threshold, and the violation is observed in all
forecasts made for the Configured
duration, then the timeseries is considered to be failing.
- forecast
Horizon String - The length of time into the future to forecast
whether a timeseries will violate the threshold.
If the predicted value is found to violate the
threshold, and the violation is observed in all
forecasts made for the Configured
duration, then the timeseries is considered to be failing.
AlertPolicyConditionConditionThresholdTrigger, AlertPolicyConditionConditionThresholdTriggerArgs
AlertPolicyCreationRecord, AlertPolicyCreationRecordArgs
- 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, AlertPolicyDocumentationArgs
- 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.
- Links
List<Alert
Policy Documentation Link> - Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries. Structure is documented below.
- Mime
Type string - The format of the content field. Presently, only the value "text/markdown" is supported.
- Subject string
- The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary.
- 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.
- Links
[]Alert
Policy Documentation Link - Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries. Structure is documented below.
- Mime
Type string - The format of the content field. Presently, only the value "text/markdown" is supported.
- Subject string
- The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary.
- 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.
- links
List<Alert
Policy Documentation Link> - Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries. Structure is documented below.
- mime
Type String - The format of the content field. Presently, only the value "text/markdown" is supported.
- subject String
- The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary.
- 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.
- links
Alert
Policy Documentation Link[] - Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries. Structure is documented below.
- mime
Type string - The format of the content field. Presently, only the value "text/markdown" is supported.
- subject string
- The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary.
- 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.
- links
Sequence[Alert
Policy Documentation Link] - Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries. Structure is documented below.
- mime_
type str - The format of the content field. Presently, only the value "text/markdown" is supported.
- subject str
- The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary.
- 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.
- links List<Property Map>
- Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries. Structure is documented below.
- mime
Type String - The format of the content field. Presently, only the value "text/markdown" is supported.
- subject String
- The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary.
AlertPolicyDocumentationLink, AlertPolicyDocumentationLinkArgs
- Display
Name string - A short display name for the link. The display name must not be empty or exceed 63 characters. Example: "playbook".
- Url string
- The url of a webpage. A url can be templatized by using variables in the path or the query parameters. The total length of a URL should not exceed 2083 characters before and after variable expansion. Example: "https://my_domain.com/playbook?name=${resource.name}".
- Display
Name string - A short display name for the link. The display name must not be empty or exceed 63 characters. Example: "playbook".
- Url string
- The url of a webpage. A url can be templatized by using variables in the path or the query parameters. The total length of a URL should not exceed 2083 characters before and after variable expansion. Example: "https://my_domain.com/playbook?name=${resource.name}".
- display
Name String - A short display name for the link. The display name must not be empty or exceed 63 characters. Example: "playbook".
- url String
- The url of a webpage. A url can be templatized by using variables in the path or the query parameters. The total length of a URL should not exceed 2083 characters before and after variable expansion. Example: "https://my_domain.com/playbook?name=${resource.name}".
- display
Name string - A short display name for the link. The display name must not be empty or exceed 63 characters. Example: "playbook".
- url string
- The url of a webpage. A url can be templatized by using variables in the path or the query parameters. The total length of a URL should not exceed 2083 characters before and after variable expansion. Example: "https://my_domain.com/playbook?name=${resource.name}".
- display_
name str - A short display name for the link. The display name must not be empty or exceed 63 characters. Example: "playbook".
- url str
- The url of a webpage. A url can be templatized by using variables in the path or the query parameters. The total length of a URL should not exceed 2083 characters before and after variable expansion. Example: "https://my_domain.com/playbook?name=${resource.name}".
- display
Name String - A short display name for the link. The display name must not be empty or exceed 63 characters. Example: "playbook".
- url String
- The url of a webpage. A url can be templatized by using variables in the path or the query parameters. The total length of a URL should not exceed 2083 characters before and after variable expansion. Example: "https://my_domain.com/playbook?name=${resource.name}".
Import
AlertPolicy can be imported using any of these accepted formats:
{{project}}/{{name}}{{project}} {{name}}{{name}}
When using the pulumi import command, AlertPolicy can be imported using one of the formats above. For example:
$ pulumi import gcp:monitoring/alertPolicy:AlertPolicy default {{project}}/{{name}}
$ pulumi import gcp:monitoring/alertPolicy:AlertPolicy default "{{project}} {{name}}"
$ pulumi import gcp:monitoring/alertPolicy:AlertPolicy default {{name}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.