GroupMetricRuleProps

Properties for defining a GroupMetricRule.

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

Initializer

import { GroupMetricRuleProps } from '@alicloud/ros-cdk-cms'
const groupMetricRuleProps: GroupMetricRuleProps = { ... }

Properties

category^Required

public readonly category: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property category: The abbreviation of the service name.

Valid values: ECS (including Alibaba Cloud and non-Alibaba Cloud hosts) RDS (ApsaraDB for RDS) ADS (AnalyticDB) SLB (Server Load Balancer) VPC (Virtual Private Cloud) APIGATEWAY (API Gateway) CDN CS (Container Service for Swarm) DCDN (Dynamic Route for CDN) DDoS (distributed denial of service) EIP (Elastic IP) ELASTICSEARCH (Elasticsearch) EMR (E-MapReduce) ESS (Auto Scaling) HBASE (ApsaraDB for HBase) IOT_EDGE (IoT Edge) K8S_POD (k8s pod) KVSTORE_SHARDING (ApsaraDB for Redis cluster version) KVSTORE_SPLITRW (ApsaraDB for Redis read\/write splitting version) KVSTORE_STANDARD (ApsaraDB for Redis standard version) MEMCACHE (ApsaraDB for Memcache) MNS (Message Service) MONGODB (ApsaraDB for MongoDB replica set instances) MONGODB_CLUSTER (ApsaraDB for MongoDB cluster version) MONGODB_SHARDING (ApsaraDB for MongoDB sharded clusters) MQ_TOPIC (Message Service topic) OCS (original version of ApsaraDB for Memcache) OPENSEARCH (Open Search) OSS (Object Storage Service) POLARDB (ApsaraDB for POLARDB) PETADATA (HybridDB for MySQL) SCDN (Secure Content Delivery Network) SHAREBANDWIDTHPACKAGES (shared bandwidth package) SLS (Log Service) VPN (VPN Gateway)

escalations^Required

public readonly escalations: IResolvable | EscalationsProperty;

• Type: @alicloud/ros-cdk-core.IResolvable | EscalationsProperty

Property escalations: undefined.

groupId^Required

public readonly groupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property groupId: The ID of application group.

metricName^Required

public readonly metricName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property metricName: The name of the metric.

For more information, call DescribeMetricMetaList or see Preset metrics reference.

namespace^Required

public readonly namespace: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property namespace: The data namespace of the service.

For more information, call DescribeMetricMetaList or see Preset metrics reference.

ruleId^Required

public readonly ruleId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property ruleId: The ID of the alert rule.

The IDs of alert rules are generated by callers to ensure uniqueness.

ruleName^Required

public readonly ruleName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property ruleName: The name of the alert rule.

contactGroups^Optional

public readonly contactGroups: IResolvable | string | IResolvable[];

• Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property contactGroups: The alert contact groups.

dimensions^Optional

public readonly dimensions: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property dimensions: The dimensions that specify the resources to be monitored.

The value is a collection of key-value pairs. Format: key:value. For example, {"userId":"120886317861**"} and {"instanceId":"i-2ze2d6j5uhg20x47**"}.

effectiveInterval^Optional

public readonly effectiveInterval: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property effectiveInterval: The period when the alert rule is effective.

emailSubject^Optional

public readonly emailSubject: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property emailSubject: The subject of the alert notification email.

extraDimensionJson^Optional

public readonly extraDimensionJson: IResolvable | {[ key: string ]: any};

• Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

Property extraDimensionJson: The secondary or tertiary dimensions of the alert rule in the application group.

Format: a collection of key:value pairs, for example, port:80 or \/dev\/xvda:d-m5e6yphgzn3aprwu****.

When the first-level dimension of the alert rule is {"instanceId":"i-m5e1qg6uo38rztr4****"}, its secondary dimension is the disk {"\/dev\/xvda":"d-m5e6yphgzn3aprwu****"}.

interval^Optional

public readonly interval: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

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

Unit: seconds.

Set the alert detection interval to the same value as the data reporting interval. If the alert detection interval is shorter than the data reporting interval, alerts may not be triggered due to insufficient data.

noDataPolicy^Optional

public readonly noDataPolicy: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property noDataPolicy: The handling method when there is no monitoring data.

Valid values: - KEEP_LAST_STATE (default): No action is taken. - INSUFFICIENT_DATA: Alert content is "No Data". - OK: Normal.

noEffectiveInterval^Optional

public readonly noEffectiveInterval: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property noEffectiveInterval: The period when the alert rule is ineffective.

options^Optional

public readonly options: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property options: The advanced settings.

Format: {"key1":"value1","key2":"value2"}, for example, {"NotSendOK":true}, indicating whether to send alert recovery notifications. The key is NotSendOK, and the value is true (do not send) or false (send by default).

period^Optional

public readonly period: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property period: The statistical period of the metric.

The value of Period must be an integral multiple of 60. Unit: seconds. Default value: 300.

silenceTime^Optional

public readonly silenceTime: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

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

Unit: second. Default value: 86400. Minimum value: 60.

webhook^Optional

public readonly webhook: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property webhook: The callback URL to which alert notifications are sent.

Enter a URL that is accessible over the Internet. CloudMonitor sends alert notifications to the URL using POST requests. Only the HTTP protocol is supported.