Use ALIYUN::CMS::GroupMetricRule to create an alert rule for an application group - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

O recurso ALIYUN::CMS::GroupMetricRule cria uma regra de alerta para um grupo de aplicativos.

Sintaxe

{
  "Type": "ALIYUN::CMS::GroupMetricRule",
  "Properties": {
    "NoEffectiveInterval": String,
    "SilenceTime": Integer,
    "Category": String,
    "RuleId": String,
    "Dimensions": String,
    "Period": Integer,
    "EffectiveInterval": String,
    "Namespace": String,
    "GroupId": String,
    "MetricName": String,
    "Escalations": Map,
    "EmailSubject": String,
    "Webhook": String,
    "RuleName": String,
    "Interval": Integer,
    "NoDataPolicy": String,
    "ExtraDimensionJson": Map,
    "Options": String,
    "ContactGroups": List
  }
}

Propriedades

Parâmetro	Tipo	Obrigatório	Atualizações permitidas	Descrição	Restrições
Category	String	Sim	Não	Abreviação do nome do serviço Alibaba Cloud.	Valores válidos: ecs: Elastic Compute Service (ECS). rds: ApsaraDB RDS. ads: AnalyticDB for MySQL. slb: Server Load Balancer (SLB). vpc: Virtual Private Cloud (VPC). apigateway: API Gateway. cdn: Alibaba Cloud CDN (CDN). cs: Container Service for Kubernetes (ACK). dcdn: Dynamic Content Delivery Network (DCDN). ddos: Anti-DDoS Pro/Premium. eip: Elastic IP Address (EIP). elasticsearch: Elasticsearch. emr: E-MapReduce (EMR). ess: Auto Scaling. hbase: ApsaraDB for HBase. iot_edge: Link IoT Edge. k8s_pod: pod do ACK. kvstore_sharding: Tair (compatível com Redis OSS) com arquitetura de cluster. kvstore_splitrw: Tair (compatível com Redis OSS) com arquitetura de divisão de leitura e gravação. kvstore_standard: Tair (compatível com Redis OSS) com arquitetura padrão. memcache: ApsaraDB for Memcache (nova versão). SMQ: Simple Message Queue (anteriormente MNS). mongodb: instância de conjunto de réplicas do ApsaraDB for MongoDB. mongodb_cluster: instância autônoma do ApsaraDB for MongoDB. mongodb_sharding: instância de cluster fragmentado do ApsaraDB for MongoDB. mq_topic: tópico do Simple Message Queue (anteriormente MNS). ocs: ApsaraDB for Memcache (versão original). opensearch: OpenSearch. oss: Object Storage Service (OSS). polardb: PolarDB. petadata: HybridDB for MySQL. sharebandwidthpackages: Internet Shared Bandwidth. sls: Simple Log Service (SLS). vpn: VPN Gateway. Nota O CloudMonitor adiciona suporte a novos serviços continuamente. Portanto, esta lista pode não ser exaustiva.
Escalations	Map	Sim	Sim	Configurações de alerta.	Para obter mais informações, consulte Propriedades de Escalations.
GroupId	String	Sim	Sim	ID do grupo de aplicativos.	Nenhuma.
MetricName	String	Sim	Sim	Nome da métrica. Para obter mais informações, consulte DescribeMetricMetaList ou Principais métricas dos serviços Alibaba Cloud.	Nenhuma.
Namespace	String	Sim	Não	Namespace do serviço. Para obter mais informações, consulte DescribeMetricMetaList ou Principais métricas dos serviços Alibaba Cloud.	Nenhuma.
RuleId	String	Sim	Não	ID da regra de alerta.	Gere este ID para garantir que seja único.
RuleName	String	Sim	Sim	Nome da regra de alerta.	Nenhuma.
ContactGroups	List	Não	Sim	Grupos de contatos de alerta.	Especifique no máximo 200 contatos.
Dimensions	String	Não	Sim	Dimensões estendidas de recursos.	Por padrão, uma regra de alerta para um grupo de aplicativos se aplica a todas as instâncias desse grupo. Use este parâmetro para especificar dimensões adicionais de recursos. Por exemplo, para monitorar o uso de disco da partição raiz de todas as instâncias do grupo, defina este parâmetro como `[ {"dskName":"/"} ]`.
EffectiveInterval	String	Não	Sim	Período em que a regra de alerta está ativa.	Nenhuma.
EmailSubject	String	Não	Sim	Assunto do e-mail de notificação de alerta.	Nenhuma.
ExtraDimensionJson	Map	Não	Sim	Dimensões secundárias ou terciárias da regra de alerta.	Formato: coleção de pares chave-valor no formato `key:value`. Exemplo: `port:80`, `/dev/xvda:d-m5e6yphgzn3aprwu**`. Se a dimensão primária de uma regra de alerta for `{"instanceId":"i-m5e1qg6uo38rztr4"}`, uma dimensão secundária pode ser um disco em nuvem específico dessa instância, como `{"/dev/xvda":"d-m5e6yphgzn3aprwu**"}`.
Interval	Integer	Não	Sim	Intervalo de verificação da regra de alerta. O valor padrão é a frequência mínima de sondagem da métrica.	Unidade: segundos. Recomendamos definir este intervalo com o mesmo valor do período de relatório de dados. Se o intervalo de verificação for menor que o período de relatório, os alertas podem não ser acionados devido à insuficiência de dados.
NoDataPolicy	String	Não	Sim	Método para lidar com alertas quando não há dados de monitoramento disponíveis.	Valores válidos: `KEEP_LAST_STATE` (Padrão): Nenhuma ação é executada. `INSUFFICIENT_DATA`: Aciona um alerta indicando dados insuficientes. `OK`: Considera o status normal.
NoEffectiveInterval	String	Não	Sim	Período em que a regra de alerta está inativa.	Nenhuma.
Options	String	Não	Sim	Configurações avançadas.	Especifica configurações avançadas no formato JSON: `{"key1":"value1","key2":"value2"}`. Por exemplo, `{"NotSendOK":true}` impede que o CloudMonitor envie uma notificação quando um alerta for resolvido. Para a chave `NotSendOK`, `true` significa não enviar, e `false` (o padrão) significa enviar.
Period	Integer	Não	Sim	Período de agregação dos dados da métrica.	O valor deve ser 60 ou um múltiplo inteiro de 60. Unidade: segundos. Valor padrão: 300. Nota Para um período de 300 segundos, o sistema agrega dados brutos de uma janela de 5 minutos em um único ponto de dados para avaliação, com base no método estatístico especificado. Por exemplo, se os dados forem relatados a cada minuto, o sistema calcula a média dos cinco pontos de dados dentro do período.
SilenceTime	Integer	Não	Sim	Duração do tempo de silêncio. Se um alerta for acionado, nenhuma nova notificação será enviada até que o tempo de silêncio termine.	Unidade: segundos. Valor mínimo: 3600 (1 hora). Valor padrão: 86400 (1 dia).
Webhook	String	Não	Sim	URL do webhook para a qual o CloudMonitor envia uma notificação quando um alerta é acionado.	Nenhuma.

Sintaxe de Escalations

"Escalations": {
  "Critical": Map,
  "Info": Map,
  "Warn": Map
}

Propriedades de Escalations

Parâmetro	Tipo	Obrigatório	Atualizações permitidas	Descrição	Restrições
Critical	Map	Não	Sim	Configurações para alertas de nível Critical.	Para obter mais informações, consulte Propriedades de Critical.
Info	Map	Não	Sim	Configurações para alertas de nível Info.	Para obter mais informações, consulte Propriedades de Info.
Warn	Map	Não	Sim	Configurações para alertas de nível Warn.	Para obter mais informações, consulte Propriedades de Warn.

Sintaxe de Critical

"Critical": {
  "ComparisonOperator": String,
  "Times": Integer,
  "Statistics": String,
  "Threshold": Integer
}

Propriedades de Critical

Parâmetro	Tipo	Obrigatório	Atualizações permitidas	Descrição	Restrições
ComparisonOperator	String	Sim	Sim	Operador para comparar o valor da métrica com o limiar.	Valores válidos: `GreaterThanOrEqualToThreshold`: maior ou igual ao limiar. `GreaterThanThreshold`: maior que o limiar. `LessThanOrEqualToThreshold`: menor ou igual ao limiar. `LessThanThreshold`: menor que o limiar. `NotEqualToThreshold`: diferente do limiar. `GreaterThanYesterday`: maior que o valor da métrica no mesmo horário ontem. `LessThanYesterday`: menor que o valor da métrica no mesmo horário ontem. `GreaterThanLastWeek`: maior que o valor da métrica no mesmo horário na semana anterior. `LessThanLastWeek`: menor que o valor da métrica no mesmo horário na semana anterior. `GreaterThanLastPeriod`: maior que o valor da métrica no ciclo de monitoramento anterior. `LessThanLastPeriod`: menor que o valor da métrica no ciclo de monitoramento anterior.
Statistics	String	Sim	Sim	Método estatístico.	Para valores válidos do método estatístico para cada severidade, consulte DescribeSystemEventMetaList.
Times	Integer	Sim	Sim	Número de vezes consecutivas que o valor da métrica deve atender à condição de alerta para acionar um alerta.	Nenhuma.
Threshold	Integer	Sim	Sim	Limiar de alerta.	Nenhuma.

Sintaxe de Info

"Info": {
  "ComparisonOperator": String,
  "Times": Integer,
  "Statistics": String,
  "Threshold": Integer
}

Propriedades de Info

Parâmetro	Tipo	Obrigatório	Atualizações permitidas	Descrição	Restrições
ComparisonOperator	String	Sim	Sim	Operador para comparar o valor da métrica com o limiar.	Valores válidos: `GreaterThanOrEqualToThreshold`: maior ou igual ao limiar. `GreaterThanThreshold`: maior que o limiar. `LessThanOrEqualToThreshold`: menor ou igual ao limiar. `LessThanThreshold`: menor que o limiar. `NotEqualToThreshold`: diferente do limiar. `GreaterThanYesterday`: maior que o valor da métrica no mesmo horário ontem. `LessThanYesterday`: menor que o valor da métrica no mesmo horário ontem. `GreaterThanLastWeek`: maior que o valor da métrica no mesmo horário na semana anterior. `LessThanLastWeek`: menor que o valor da métrica no mesmo horário na semana anterior. `GreaterThanLastPeriod`: maior que o valor da métrica no ciclo de monitoramento anterior. `LessThanLastPeriod`: menor que o valor da métrica no ciclo de monitoramento anterior.
Statistics	String	Sim	Sim	Método estatístico.	Para valores válidos do método estatístico para cada severidade, consulte DescribeSystemEventMetaList.
Threshold	Integer	Sim	Sim	Limiar de alerta.	Nenhuma.
Times	Integer	Sim	Sim	Número de vezes consecutivas que o valor da métrica deve atender à condição de alerta para acionar um alerta.	Nenhuma.

Sintaxe de Warn

"Warn": {
  "ComparisonOperator": String,
  "Times": Integer,
  "Statistics": String,
  "Threshold": Integer
}

Propriedades de Warn

Parâmetro	Tipo	Obrigatório	Atualizações permitidas	Descrição	Restrições
ComparisonOperator	String	Sim	Sim	Operador para comparar o valor da métrica com o limiar.	Valores válidos: `GreaterThanOrEqualToThreshold`: maior ou igual ao limiar. `GreaterThanThreshold`: maior que o limiar. `LessThanOrEqualToThreshold`: menor ou igual ao limiar. `LessThanThreshold`: menor que o limiar. `NotEqualToThreshold`: diferente do limiar. `GreaterThanYesterday`: maior que o valor da métrica no mesmo horário ontem. `LessThanYesterday`: menor que o valor da métrica no mesmo horário ontem. `GreaterThanLastWeek`: maior que o valor da métrica no mesmo horário na semana anterior. `LessThanLastWeek`: menor que o valor da métrica no mesmo horário na semana anterior. `GreaterThanLastPeriod`: maior que o valor da métrica no ciclo de monitoramento anterior. `LessThanLastPeriod`: menor que o valor da métrica no ciclo de monitoramento anterior.
Statistics	String	Sim	Sim	Método estatístico.	Para valores válidos do método estatístico para cada severidade, consulte DescribeSystemEventMetaList.
Threshold	Integer	Sim	Sim	Limiar de alerta.	Nenhuma.
Times	Integer	Sim	Sim	Número de vezes consecutivas que o valor da métrica deve atender à condição de alerta para acionar um alerta.	Nenhuma.

Valores de retorno

Fn::GetAtt

RuleId: ID da regra de alerta.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Category:
    Type: String
    Description: |-
      The abbreviation of the Alibaba Cloud service name. Valid values:
      ecs: Elastic Compute Service (ECS)
      rds: ApsaraDB RDS
      ads: AnalyticDB for MySQL
      slb: Server Load Balancer (SLB)
      vpc: Virtual Private Cloud (VPC)
      apigateway: API Gateway
      cdn: Alibaba Cloud CDN (CDN)
      cs: Container Service for Kubernetes (ACK)
      dcdn: Dynamic Content Delivery Network (DCDN)
      ddos: Anti-DDoS Pro/Premium
      eip: Elastic IP Address (EIP)
      elasticsearch: Elasticsearch
      emr: E-MapReduce (EMR)
      ess: Auto Scaling
      hbase: ApsaraDB for HBase
      iot_edge: Link IoT Edge
      k8s_pod: ACK pod
      kvstore_sharding: Tair (Redis OSS-compatible) of the cluster architecture
      kvstore_splitrw: Tair (Redis OSS-compatible) of the read/write splitting architecture
      kvstore_standard: Tair (Redis OSS-compatible) of the standard architecture
      memcache: ApsaraDB for Memcache (new version)
      mongodb: ApsaraDB for MongoDB replica set instance
      mongodb_cluster: ApsaraDB for MongoDB standalone instance
      mongodb_sharding: ApsaraDB for MongoDB sharded cluster instance
      mq_topic: Simple Message Queue (SMQ) topic
      ocs: ApsaraDB for Memcache (original version)
      opensearch: OpenSearch
      oss: Object Storage Service (OSS)
      polardb: PolarDB
      petadata: HybridDB for MySQL
      sharebandwidthpackages: Internet Shared Bandwidth
      sls: Simple Log Service (SLS)
      smq: Simple Message Queue (SMQ)
      vpn: VPN Gateway
    Default: ecs
  RuleId:
    Type: String
    Description: The ID of the alert rule. This ID must be generated by the caller to ensure its uniqueness.
    Default: uuid_aad57415dswer23124sfsg9***
  Namespace:
    Type: String
    Description: |-
      The data namespace of the service. For more information, call DescribeMetricMetaList
      or see Major metrics of Alibaba Cloud services.
    Default: acs_ecs_dashboard
  GroupId:
    Type: String
    Description: The ID of the application group.
    Default: 6102***
  MetricName:
    Type: String
    Description: The name of the metric. For more information, call DescribeMetricMetaList or see Major metrics of Alibaba Cloud services.
    Default: cpu_cores
  Escalations:
    Type: Json
    Description: The alert settings.
    Default:
      Critical:
        ComparisonOperator: GreaterThanOrEqualToThreshold
        Times: 3
        Statistics: Value
        Threshold: '100'
  RuleName:
    Type: String
    Description: The name of the alert rule.
    Default: mytest
Resources:
  GroupMetricRule:
    Type: ALIYUN::CMS::GroupMetricRule
    Properties:
      Category:
        Ref: Category
      RuleId:
        Ref: RuleId
      Namespace:
        Ref: Namespace
      GroupId:
        Ref: GroupId
      MetricName:
        Ref: MetricName
      Escalations:
        Ref: Escalations
      RuleName:
        Ref: RuleName
Outputs:
  RuleId:
    Description: The ID of the alert rule.
    Value:
      Fn::GetAtt:
        - GroupMetricRule
        - RuleId

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Category": {
      "Type": "String",
      "Description": "The abbreviation of the Alibaba Cloud service name. Valid values:\necs: Elastic Compute Service (ECS)\nrds: ApsaraDB RDS\nads: AnalyticDB for MySQL\nslb: Server Load Balancer (SLB)\nvpc: Virtual Private Cloud (VPC)\napigateway: API Gateway\ncdn: Alibaba Cloud CDN (CDN)\ncs: Container Service for Kubernetes (ACK)\ndcdn: Dynamic Content Delivery Network (DCDN)\nddos: Anti-DDoS Pro/Premium\neip: Elastic IP Address (EIP)\nelasticsearch: Elasticsearch\nemr: E-MapReduce (EMR)\ness: Auto Scaling\nhbase: ApsaraDB for HBase\niot_edge: Link IoT Edge\nk8s_pod: ACK pod\nkvstore_sharding: Tair (Redis OSS-compatible) of the cluster architecture\nkvstore_splitrw: Tair (Redis OSS-compatible) of the read/write splitting architecture\nkvstore_standard: Tair (Redis OSS-compatible) of the standard architecture\nmemcache: ApsaraDB for Memcache (new version)\nmongodb: ApsaraDB for MongoDB replica set instance\nmongodb_cluster: ApsaraDB for MongoDB standalone instance\nmongodb_sharding: ApsaraDB for MongoDB sharded cluster instance\nmq_topic: Simple Message Queue (SMQ) topic\nocs: ApsaraDB for Memcache (original version)\nopensearch: OpenSearch\noss: Object Storage Service (OSS)\npolardb: PolarDB\npetadata: HybridDB for MySQL\nsharebandwidthpackages: Internet Shared Bandwidth\nsls: Simple Log Service (SLS)\nSMQ: Simple Message Queue (SMQ)\nvpn: VPN Gateway",
      "Default": "ecs"
    },
    "RuleId": {
      "Type": "String",
      "Description": "The ID of the alert rule. This ID must be generated by the caller to ensure its uniqueness.",
      "Default": "uuid_aad57415dswer23124sfsg9***"
    },
    "Namespace": {
      "Type": "String",
      "Description": "The data namespace of the service. For more information, call DescribeMetricMetaList or see Major metrics of Alibaba Cloud services.",
      "Default": "acs_ecs_dashboard"
    },
    "GroupId": {
      "Type": "String",
      "Description": "The ID of the application group.",
      "Default": "6102***"
    },
    "MetricName": {
      "Type": "String",
      "Description": "The name of the metric. For more information, call DescribeMetricMetaList or see Major metrics of Alibaba Cloud services.",
      "Default": "cpu_cores"
    },
    "Escalations": {
      "Type": "Json",
      "Description": "The alert settings.",
      "Default": {
        "Critical": {
          "ComparisonOperator": "GreaterThanOrEqualToThreshold",
          "Times": 3,
          "Statistics": "Value",
          "Threshold": "100"
        }
      }
    },
    "RuleName": {
      "Type": "String",
      "Description": "The name of the alert rule.",
      "Default": "mytest"
    }
  },
  "Resources": {
    "GroupMetricRule": {
      "Type": "ALIYUN::CMS::GroupMetricRule",
      "Properties": {
        "Category": {
          "Ref": "Category"
        },
        "RuleId": {
          "Ref": "RuleId"
        },
        "Namespace": {
          "Ref": "Namespace"
        },
        "GroupId": {
          "Ref": "GroupId"
        },
        "MetricName": {
          "Ref": "MetricName"
        },
        "Escalations": {
          "Ref": "Escalations"
        },
        "RuleName": {
          "Ref": "RuleName"
        }
      }
    }
  },
  "Outputs": {
    "RuleId": {
      "Description": "The ID of the alert rule.",
      "Value": {
        "Fn::GetAtt": [
          "GroupMetricRule",
          "RuleId"
        ]
      }
    }
  }
}