リソースメトリックのアラートルールを作成する - Resource Orchestration Service

ALIYUN::CMS::ResourceMetricRule は、リソースのメトリックに対してしきい値ベースのアラートルールを作成するために使用されます。

構文

{
  "Type": "ALIYUN::CMS::ResourceMetricRule",
  "Properties": {
    "NoEffectiveInterval": String,
    "ContactGroups": List,
    "SilenceTime": Integer,
    "RuleId": String,
    "Period": Integer,
    "Prometheus": Map,
    "Labels": List,
    "EffectiveInterval": String,
    "NoDataPolicy": String,
    "Namespace": String,
    "MetricName": String,
    "DeletionForce": Boolean,
    "Escalations": Map,
    "EmailSubject": String,
    "CompositeExpression": Map,
    "Webhook": String,
    "Resources": List,
    "RuleName": String,
    "Interval": Integer
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ContactGroups	List	はい	はい	アラートグループ。	CloudMonitor は、アラートグループに属するアラート連絡先にアラート通知を送信します。説明アラートグループには、1 つ以上のアラート連絡先を含めることができます。アラート連絡先とアラートグループの作成方法の詳細については、「PutContact」および「PutContactGroup」をご参照ください。
Escalations	Map	いいえ	はい	アラートの詳細。	詳細については、「Escalations のプロパティ」をご参照ください。
MetricName	String	はい	はい	メトリック名。	メトリック名のクエリ方法の詳細については、「付録 1：メトリック」をご参照ください。説明ハイブリッドクラウド監視用に Prometheus アラートルールを作成する場合は、このプロパティを名前空間名に設定する必要があります。名前空間名のクエリ方法の詳細については、「DescribeHybridMonitorNamespaceList」をご参照ください。
Namespace	String	はい	はい	クラウドサービスの名前空間。	クラウドサービスの名前空間のクエリ方法の詳細については、「付録 1：メトリック」をご参照ください。説明ハイブリッドクラウド監視用に Prometheus アラートルールを作成する場合は、このプロパティを acs_prometheus に設定する必要があります。
Resources	List	はい	はい	リソースに関する情報。	例：`[{"instanceId":"i-uf6j91r34rnwawoo**"}]` および `[{"userId":"100931896542**"}]`。サポートされているリソースディメンションについては、「クラウドサービスのメトリック」をご参照ください。
CompositeExpression	Map	いいえ	はい	複数メトリックのトリガー条件。	詳細については、「CompositeExpression のプロパティ」をご参照ください。説明単一メトリックと複数メトリックのトリガー条件は相互排他的です。リクエストで単一メトリックと複数メトリックのトリガー条件を同時に指定することはできません。
DeletionForce	ブール値	いいえ	はい	アラートルールを強制的に削除するかどうかを指定します。	有効値： true false
EffectiveInterval	String	いいえ	はい	アラートルールが有効な期間。	例：00:00-23:59。
EmailSubject	String	いいえ	はい	アラート通知メールの件名。	なし。
Interval	Integer	いいえ	はい	アラートルールに基づいてアラートがトリガーされる間隔。	単位：秒。説明メトリックの統計期間のクエリ方法の詳細については、「付録 1：メトリック」をご参照ください。
Labels	List	いいえ	はい	タグに関する情報。	詳細については、「Labels のプロパティ」をご参照ください。
NoDataPolicy	String	いいえ	はい	モニタリングデータが見つからない場合にアラートを処理するメソッド。	有効値： KEEP_LAST_STATE (デフォルト)：操作を実行しません。 INSUFFICIENT_DATA：「データ不足」という内容のアラートをトリガーします。 OK：ステータスを正常と見なします。
NoEffectiveInterval	String	いいえ	はい	アラートルールが無効な期間。	例：00:00-23:59。
Period	Integer	いいえ	はい	メトリックの統計期間。	単位：秒。デフォルト値は、メトリックのモニタリングデータが収集される間隔です。説明メトリックの統計期間のクエリ方法の詳細については、「付録 1：メトリック」をご参照ください。
Prometheus	Map	いいえ	はい	Prometheus アラートルールに関する情報。	詳細については、「Prometheus のプロパティ」をご参照ください。説明ハイブリッドクラウド監視用に Prometheus アラートルールを作成する場合は、このプロパティを指定する必要があります。
RuleId	String	いいえ	いいえ	アラートルールの ID。	新しい ID または既存のアラートルールの ID を指定できます。アラートルールの ID のクエリ方法の詳細については、「DescribeMetricRuleList」をご参照ください。説明新しい ID を指定すると、しきい値ベースのアラートルールが作成されます。
RuleName	String	いいえ	はい	アラートルールの名前。	CloudMonitor で新しい名前または既存のアラートルールの名前を指定できます。アラートルールの名前のクエリ方法の詳細については、「DescribeMetricRuleList」をご参照ください。説明新しい名前を指定すると、しきい値ベースのアラートルールが作成されます。
SilenceTime	Integer	いいえ	はい	トリガー条件が満たされても、新しいアラート通知が送信されないミュート期間。	単位：秒。デフォルト値：86400。説明ミュート期間が終了してもアラートがクリアされない場合、CloudMonitor はアラート通知を再送信します。
Webhook	String	いいえ	はい	アラートルールに基づいてアラートがトリガーされたときに POST リクエストが送信されるコールバック URL。	なし。

Prometheus の構文

"Prometheus": {
  "Annotations": List,
  "PromQL": String,
  "Times": Integer,
  "Level": String
}

Prometheus のプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Level	String	はい	はい	アラートレベル。	有効値： Critical Warn Info
PromQL	String	はい	はい	PromQL クエリ文。	なし。
Times	Integer	はい	はい	連続してトリガーする回数。メトリック値がトリガー条件を満たす回数がこのプロパティの値に達した場合、CloudMonitor はアラート通知を送信します。	なし。
Annotations	List	いいえ	はい	Prometheus アラートルールのアノテーション。Prometheus アラートがトリガーされると、システムはアノテーションのキーと値をレンダリングします。	詳細については、「Annotations のプロパティ」をご参照ください。説明このプロパティは、Prometheus プロパティの Annotation プロパティと同じ効果があります。

Annotations の構文

"Annotations": [
  {
    "Value": String,
    "Key": String
  }
]

Annotations のプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Key	String	いいえ	はい	アノテーションのキー。	なし。
Value	String	いいえ	はい	アノテーションの値。	なし。

Labels の構文

"Labels": [
  {
    "Value": String,
    "Key": String
  }
]

Labels のプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Key	String	はい	はい	タグキー。	なし。
Value	String	いいえ	はい	タグ値。	なし。

Escalations の構文

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

Escalations のプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Critical	Map	いいえ	はい	Critical レベルのアラートの詳細。	詳細については、「Critical のプロパティ」をご参照ください。
Info	Map	いいえ	はい	Info レベルのアラートの詳細。	詳細については、「Info のプロパティ」をご参照ください。
Warn	Map	いいえ	はい	Warn レベルのアラートの詳細。	詳細については、「Warn のプロパティ」をご参照ください。

重要な構文

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

Critical のプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ComparisonOperator	String	はい	はい	Critical レベルのアラートに対して、メトリック値としきい値を比較するために使用される演算子。	有効値： GreaterThanOrEqualToThreshold：しきい値以上 GreaterThanThreshold：しきい値より大きい LessThanOrEqualToThreshold：しきい値以下 LessThanThreshold：しきい値より小さい NotEqualToThreshold：しきい値と等しくない GreaterThanYesterday：昨日の同時刻のメトリック値より大きい LessThanYesterday：昨日の同時刻のメトリック値より小さい GreaterThanLastWeek：先週の同時刻のメトリック値より大きい LessThanLastWeek：先週の同時刻のメトリック値より小さい GreaterThanLastPeriod：前のモニタリングサイクルのメトリック値より大きい LessThanLastPeriod：前のモニタリングサイクルのメトリック値より小さい説明 Critical、Warn、Info のうち少なくとも 1 つのアラートレベルを設定し、そのアラートレベルに対して Statistics、ComparisonOperator、Threshold、Times プロパティを指定する必要があります。
Statistics	String	はい	はい	Critical レベルのアラートの統計メソッド。	有効値： Maximum：最大値 Minimum：最小値 Average：平均値 Availability：可用性レート説明 Critical、Warn、Info のうち少なくとも 1 つのアラートレベルを設定し、そのアラートレベルに対して Statistics、ComparisonOperator、Threshold、Times プロパティを指定する必要があります。
Threshold	String	はい	はい	Critical レベルのアラートのしきい値。	説明 Critical、Warn、Info のうち少なくとも 1 つのアラートレベルを設定し、そのアラートレベルに対して Statistics、ComparisonOperator、Threshold、Times プロパティを指定する必要があります。
Times	Integer	はい	はい	Critical レベルのアラートがトリガーされるまでに、メトリック値がトリガー条件を満たす必要がある連続回数。	説明 Critical、Warn、Info のうち少なくとも 1 つのアラートレベルを設定し、そのアラートレベルに対して Statistics、ComparisonOperator、Threshold、Times プロパティを指定する必要があります。

Info の構文

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

Info のプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ComparisonOperator	String	はい	はい	Info レベルのアラートに対して、メトリック値としきい値を比較するために使用される演算子。	有効値： GreaterThanOrEqualToThreshold：しきい値以上 GreaterThanThreshold：しきい値より大きい LessThanOrEqualToThreshold：しきい値以下 LessThanThreshold：しきい値より小さい NotEqualToThreshold：しきい値と等しくない GreaterThanYesterday：昨日の同時刻のメトリック値より大きい LessThanYesterday：昨日の同時刻のメトリック値より小さい GreaterThanLastWeek：先週の同時刻のメトリック値より大きい LessThanLastWeek：先週の同時刻のメトリック値より小さい GreaterThanLastPeriod：前のモニタリングサイクルのメトリック値より大きい LessThanLastPeriod：前のモニタリングサイクルのメトリック値より小さい説明 Critical、Warn、Info のうち少なくとも 1 つのアラートレベルを設定し、そのアラートレベルに対して Statistics、ComparisonOperator、Threshold、Times プロパティを指定する必要があります。
Statistics	String	はい	はい	Info レベルのアラートの統計メソッド。	有効値： Maximum：最大値 Minimum：最小値 Average：平均値 Availability：可用性レート説明 Critical、Warn、Info のうち少なくとも 1 つのアラートレベルを設定し、そのアラートレベルに対して Statistics、ComparisonOperator、Threshold、Times プロパティを指定する必要があります。
Threshold	String	はい	はい	Info レベルのアラートのしきい値。	説明 Critical、Warn、Info のうち少なくとも 1 つのアラートレベルを設定し、そのアラートレベルに対して Statistics、ComparisonOperator、Threshold、Times プロパティを指定する必要があります。
Times	Integer	はい	はい	Info レベルのアラートがトリガーされるまでに、メトリック値がトリガー条件を満たす必要がある連続回数。	説明 Critical、Warn、Info のうち少なくとも 1 つのアラートレベルを設定し、そのアラートレベルに対して Statistics、ComparisonOperator、Threshold、Times プロパティを指定する必要があります。

Warn の構文

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

Warn のプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ComparisonOperator	String	はい	はい	Warn レベルのアラートに対して、メトリック値としきい値を比較するために使用される演算子。	有効値： GreaterThanOrEqualToThreshold：しきい値以上 GreaterThanThreshold：しきい値より大きい LessThanOrEqualToThreshold：しきい値以下 LessThanThreshold：しきい値より小さい NotEqualToThreshold：しきい値と等しくない GreaterThanYesterday：昨日の同時刻のメトリック値より大きい LessThanYesterday：昨日の同時刻のメトリック値より小さい GreaterThanLastWeek：先週の同時刻のメトリック値より大きい LessThanLastWeek：先週の同時刻のメトリック値より小さい GreaterThanLastPeriod：前のモニタリングサイクルのメトリック値より大きい LessThanLastPeriod：前のモニタリングサイクルのメトリック値より小さい説明 Critical、Warn、Info のうち少なくとも 1 つのアラートレベルを設定し、そのアラートレベルに対して Statistics、ComparisonOperator、Threshold、Times プロパティを指定する必要があります。
Statistics	String	はい	はい	Warn レベルのアラートの統計メソッド。	有効値： Maximum：最大値 Minimum：最小値 Average：平均値 Availability：可用性レート説明 Critical、Warn、Info のうち少なくとも 1 つのアラートレベルを設定し、そのアラートレベルに対して Statistics、ComparisonOperator、Threshold、Times プロパティを指定する必要があります。
Threshold	String	はい	はい	Warn レベルのアラートのしきい値。	説明 Critical、Warn、Info のうち少なくとも 1 つのアラートレベルを設定し、そのアラートレベルに対して Statistics、ComparisonOperator、Threshold、Times プロパティを指定する必要があります。
Times	Integer	はい	はい	Warn レベルのアラートがトリガーされるまでに、メトリック値がトリガー条件を満たす必要がある連続回数。	説明 Critical、Warn、Info のうち少なくとも 1 つのアラートレベルを設定し、そのアラートレベルに対して Statistics、ComparisonOperator、Threshold、Times プロパティを指定する必要があります。

CompositeExpression の構文

"CompositeExpression": {
  "Times": Integer,
  "ExpressionRaw": String,
  "ExpressionListJoin": String,
  "Level": String,
  "ExpressionList": List
}

CompositeExpression のプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Level	String	はい	はい	アラートレベル。	有効値： Critical Warn Info
Times	Integer	はい	はい	連続してトリガーする回数。メトリック値がトリガー条件を満たす回数がこのプロパティの値に達した場合、CloudMonitor はアラート通知を送信します。	なし。
ExpressionList	List	いいえ	はい	標準モードで作成されたトリガー条件。	詳細については、「ExpressionList のプロパティ」をご参照ください。
ExpressionListJoin	String	いいえ	はい	複数メトリックのトリガー条件間の関係。	有効値： &&：すべてのメトリックがトリガー条件を満たした場合にのみアラートがトリガーされます。 \|\|：いずれかのメトリックがトリガー条件を満たした場合にアラートがトリガーされます。
ExpressionRaw	String	いいえ	はい	式を使用して作成されたトリガー条件。	次のシナリオで式を使用してトリガー条件を作成できます：特定のリソースのアラートブラックリストを設定できます。たとえば、式 `$instanceId != 'i-io8kfvcpp7x5**' && $Average > 50` は、インスタンス `i-io8kfvcpp7x5` の `Average` 値が 50 を超えても、アラートがトリガーされないことを意味します。ルール内の特定のインスタンスに特別なアラートのしきい値を設定します。例：`$Average > ($instanceId == 'i-io8kfvcpp7x5'? 80: 50)`。この式は、インスタンス i-`io8kfvcpp7x5**` の Average 値が 80 を超えた場合にのみアラートがトリガーされることを意味します。他のインスタンスについては、Average 値が 50 を超えるとアラートがトリガーされます。ルール内でしきい値を超えるインスタンスの数を制限します。たとえば、`count($Average > 20) > 3` は、Average 値が 20 を超えるインスタンスの数が 3 を超えた場合にのみアラートがトリガーされることを示します。

ExpressionList の構文

"ExpressionList": [
  {
    "MetricName": String,
    "ComparisonOperator": String,
    "Period": Integer,
    "Id": String,
    "ExpressionRaw": String,
    "Statistics": String,
    "Threshold": String
  }
]

ExpressionList のプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ComparisonOperator	String	はい	はい	メトリック値としきい値を比較するために使用される演算子。	有効値： GreaterThanOrEqualToThreshold：しきい値以上 GreaterThanThreshold：しきい値より大きい LessThanOrEqualToThreshold：しきい値以下 LessThanThreshold：しきい値より小さい NotEqualToThreshold：しきい値と等しくない GreaterThanYesterday：昨日の同時刻のメトリック値より大きい LessThanYesterday：昨日の同時刻のメトリック値より小さい GreaterThanLastWeek：先週の同時刻のメトリック値より大きい LessThanLastWeek：先週の同時刻のメトリック値より小さい GreaterThanLastPeriod：前のモニタリングサイクルのメトリック値より大きい LessThanLastPeriod：前のモニタリングサイクルのメトリック値より小さい
MetricName	String	はい	はい	クラウドサービスのメトリック名。	なし。
Period	Integer	はい	はい	メトリックの集計期間。	単位：秒。
Statistics	String	はい	はい	メトリックの統計メソッド。	有効値： $Maximum：最大値。 $Minimum：最小値。 $Average：平均値。 $Availability：可用性レート。ほとんどの場合、可用性レートはサイトモニタリングに使用されます。説明 $ はメトリックのプレフィックスです。CloudMonitor でサポートされているクラウドサービスの詳細については、「付録 1：メトリック」をご参照ください。
Threshold	String	はい	はい	アラートのしきい値。	なし。
Id	String	いいえ	いいえ	アラート条件の ID。	なし。
ExpressionRaw	String	いいえ	いいえ	アラート条件を定義するカスタム式。	次のような高度なシナリオで使用します：特定のリソースのアラート除外リストを設定できます。たとえば、式 $instanceId != 'i-io8kfvcpp7x5**' ``&&`` $Average > 50 は、インスタンス `i-io8kfvcpp7x5` の `Average` 値が 50 を超えても、アラートルールでアラートがトリガーされないことを意味します。ルール内の特定のインスタンスに特別なアラートのしきい値を設定します。例：`$Average > ($instanceId == 'i-io8kfvcpp7x5'? 80: 50)`。この式は、インスタンス `i-io8kfvcpp7x5**` の `Average` 値が 80 を超えた場合にのみアラートがトリガーされることを示します。他のインスタンスについては、`Average` 値が 50 を超えるとアラートがトリガーされます。ルール内でしきい値を超えるインスタンスの数を制限します。たとえば、`count($Average > 20) > 3` は、`Average` 値が 20 を超えるインスタンスが 3 つを超えた場合にのみアラートがトリガーされることを意味します。

戻り値

Fn::GetAtt

RuleId：アラートルールの ID。
RuleName：アラートルールの名前。

例

YAML


ROSTemplateFormatVersion: '2015-09-01'
Parameters:
 ContactGroups:
 Type: Json
 Description: |-
 アラート通知を受信するアラートグループ。
 注：アラートグループには、1 つ以上のアラート連絡先を含めることができます。アラート連絡先とアラートグループを作成するには、PutContact と PutContactGroup をご参照ください。
 MinLength: 1
 Namespace:
 Type: String
 Description: |-
 クラウドサービスの名前空間。
 クラウドサービスの名前空間を見つけるには、「付録 1：メトリック」をご参照ください。
 注：ハイブリッドクラウド監視用に Prometheus アラートルールを作成する場合は、このパラメーターを acs_prometheus に設定する必要があります。
 MetricName:
 Type: String
 Description: |-
 メトリックの名前。
 メトリックの名前を見つけるには、「付録 1：メトリック」をご参照ください。
 注：ハイブリッドクラウド監視の Prometheus アラートルールでは、このパラメーターをターゲット名前空間の名前に設定する必要があります。名前空間名のリストを見つけるには、DescribeHybridMonitorNamespaceList 操作を呼び出します。
 Escalations:
 Type: Json
 Description: 少なくとも 1 つのアラートレベル (Critical、Warn、または Info) を指定する必要があります。
 MinLength: 1
 Resources:
 Type: Json
 Description: |-
 アラートルールが適用されるリソース。
 例：[{"instanceId":"i-uf6j91r34rnwawoo****"}] および [{"userId":"100931896542****"}]。
 リソースをクエリするためのサポートされているディメンションについては、「付録 1：メトリック」をご参照ください。
 MinLength: 1
Resources:
 ResourceMetricRule:
 Type: ALIYUN::CMS::ResourceMetricRule
 Properties:
 ContactGroups:
 Ref: ContactGroups
 Namespace:
 Ref: Namespace
 MetricName:
 Ref: MetricName
 Resources:
 Ref: Resources
 Escalations:
 Ref: Escalations
Outputs:
 RuleId:
 Description: アラートルールの ID。
 Value:
 Fn::GetAtt:
 - ResourceMetricRule
 - RuleId
 RuleName:
 Description: アラートルールの名前。
 Value:
 Fn::GetAtt:
 - ResourceMetricRule
 - RuleName

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ContactGroups": {
      "Type": "Json",
      "Description": "アラート通知を受信するアラートグループ。\n注：アラートグループには、1 つ以上のアラート連絡先を含めることができます。アラート連絡先とアラートグループを作成するには、PutContact と PutContactGroup をご参照ください。",
      "MinLength": 1
    },
    "Namespace": {
      "Type": "String",
      "Description": "クラウドサービスの名前空間。\nクラウドサービスの名前空間を見つけるには、「付録 1：メトリック」をご参照ください。\n注：ハイブリッドクラウド監視用に Prometheus アラートルールを作成する場合は、このパラメーターを acs_prometheus に設定する必要があります。"
    },
    "MetricName": {
      "Type": "String",
      "Description": "メトリックの名前。\nメトリックの名前を見つけるには、「付録 1：メトリック」をご参照ください。\n注：ハイブリッドクラウド監視の Prometheus アラートルールでは、このパラメーターをターゲット名前空間の名前に設定する必要があります。名前空間名のリストを見つけるには、DescribeHybridMonitorNamespaceList 操作を呼び出します。"
    },
    "Escalations": {
      "Type": "Json",
      "Description": "少なくとも 1 つのアラートレベル (Critical、Warn、または Info) を指定する必要があります。",
      "MinLength": 1
    },
    "Resources": {
      "Type": "Json",
      "Description": "アラートルールが適用されるリソース。\n例：[{\"instanceId\":\"i-uf6j91r34rnwawoo****\"}] および [{\"userId\":\"100931896542****\"}]。\nリソースをクエリするためのサポートされているディメンションについては、「付録 1：メトリック」をご参照ください。",
      "MinLength": 1
    }
  },
  "Resources": {
    "ResourceMetricRule": {
      "Type": "ALIYUN::CMS::ResourceMetricRule",
      "Properties": {
        "ContactGroups": {
          "Ref": "ContactGroups"
        },
        "Namespace": {
          "Ref": "Namespace"
        },
        "MetricName": {
          "Ref": "MetricName"
        },
        "Resources": {
          "Ref": "Resources"
        },
        "Escalations": {
          "Ref": "Escalations"
        }
      }
    }
  },
  "Outputs": {
    "RuleId": {
      "Description": "アラートルールの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ResourceMetricRule",
          "RuleId"
        ]
      }
    },
    "RuleName": {
      "Description": "アラートルールの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ResourceMetricRule",
          "RuleName"
        ]
      }
    }
  }
}