ResourceMetricRuleProps

Properties for defining a ResourceMetricRule.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cms-resourcemetricrule

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkcms"
&alicloudroscdkcms.ResourceMetricRuleProps {
    ContactGroups: interface{},
    MetricName: interface{},
    Namespace: interface{},
    Resources: interface{},
    CompositeExpression: interface{},
    DeletionForce: interface{},
    EffectiveInterval: interface{},
    EmailSubject: interface{},
    Escalations: interface{},
    Interval: interface{},
    Labels: interface{},
    NoDataPolicy: interface{},
    NoEffectiveInterval: interface{},
    Period: interface{},
    Prometheus: interface{},
    RuleId: interface{},
    RuleName: interface{},
    SilenceTime: interface{},
    Webhook: interface{},
}

Properties

ContactGroups^Required

ContactGroups interface{}

• Type: interface{}

Property contactGroups: The alert contact group.

The alert notifications are sent to the contacts that belong to the alert contact group. Note: An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see PutContact and PutContactGroup.

MetricName^Required

MetricName interface{}

• Type: interface{}

Property metricName: The name of the metric.

For information about how to query the name of a metric, see Appendix 1: Metrics. Note: If you create a Prometheus alert rule for Hybrid Cloud Monitoring, you must set this parameter to the name of the namespace. For information about how to obtain the name of a namespace, see DescribeHybridMonitorNamespaceList.

Namespace^Required

Namespace interface{}

• Type: interface{}

Property namespace: The namespace of the cloud service.

For information about how to query the namespace of a cloud service, Appendix 1: Metrics. Note: If you create a Prometheus alert rule for Hybrid Cloud Monitoring, you must set this parameter to acs_prometheus.

Resources^Required

Resources interface{}

• Type: interface{}

Property resources: The information about the resource.

Examples: [{"instanceId":"i-uf6j91r34rnwawoo*"}] and [{"userId":"100931896542*"}]. For information about the supported dimensions that are used to query resources, see Appendix 1: Metrics.

CompositeExpression^Optional

CompositeExpression interface{}

• Type: interface{}

Property compositeExpression: The alert conditions for multiple metrics.

The settings for a single metric and multiple metrics are mutually exclusive. You cannot configure both.

DeletionForce^Optional

DeletionForce interface{}

• Type: interface{}

Property deletionForce: Whether to delete rule even if it is not created by ROS.

Default is false

EffectiveInterval^Optional

EffectiveInterval interface{}

• Type: interface{}

Property effectiveInterval: The time period during which the alert rule is effective.

EmailSubject^Optional

EmailSubject interface{}

• Type: interface{}

Property emailSubject: The subject of the alert notification email.

Escalations^Optional

Escalations interface{}

• Type: interface{}

Property escalations: You must select at least one of the Critical, Warn, and Info alert levels.

Interval^Optional

Interval interface{}

• Type: interface{}

Property interval: The interval at which the alert is triggered.

Unit: seconds. Note: For information about how to query the statistical period of a metric, see Appendix 1: Metrics.

Labels^Optional

Labels interface{}

• Type: interface{}

Property labels: Labels to add to a triggered alert.

These labels appear in the alert notification.

This feature is equivalent to the label feature in Prometheus alerting.

NoDataPolicy^Optional

NoDataPolicy interface{}

• Type: interface{}

Property noDataPolicy: The processing method of alerts when no monitoring data is found.

Valid values:

• KEEP_LAST_STATE (default value): No operation is performed.
• INSUFFICIENT_DATA: An alert whose content is "Insufficient data" is triggered.
• OK: The status is considered normal.

NoEffectiveInterval^Optional

NoEffectiveInterval interface{}

• Type: interface{}

Property noEffectiveInterval: The time period during which the alert rule is ineffective.

Period^Optional

Period interface{}

• Type: interface{}

Property period: The statistical period of the metric.

Unit: seconds. The default value is the interval at which the monitoring data of the metric is collected. Note: For information about how to query the statistical period of a metric, see Appendix 1: Metrics.

Prometheus^Optional

Prometheus interface{}

• Type: interface{}

Property prometheus: The configurations for a Prometheus alert rule.

You need to configure this parameter only when you create a Prometheus alert rule for CloudMonitor for Enterprise.

RuleId^Optional

RuleId interface{}

• Type: interface{}

Property ruleId: The ID of the alert rule.

If not specified, ROS will generate one. You can specify a new ID or the ID of an existing alert rule. For information about how to query the ID of an alert rule, see DescribeMetricRuleList. Note: If you specify a new ID, a threshold-triggered alert rule is created.

RuleName^Optional

RuleName interface{}

• Type: interface{}

Property ruleName: The name of the alert rule.

If not specified and the rule is created by ROS, default to RuleId. You can specify a new name or the name of an existing alert rule. For information about how to query the name of an alert rule, see DescribeMetricRuleList. Note: If you specify a new name, a threshold-triggered alert rule is created.

SilenceTime^Optional

SilenceTime interface{}

• Type: interface{}

Property silenceTime: The mute period during which new alerts are not sent even if the trigger conditions are met.

Unit: seconds. Default value: 86400. Note: If an alert is not cleared within the mute period, a new alert notification is sent when the mute period ends.

Webhook^Optional

Webhook interface{}

• Type: interface{}

Property webhook: The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.