ALIYUN::CMS::ResourceMetricRule digunakan untuk membuat aturan peringatan yang dipicu berdasarkan ambang batas suatu metrik dari sebuah resource.
Sintaks
{
"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
}
}Properti
Property | Type | Required | Editable | Description | Constraint |
ContactGroups | List | Yes | Yes | kelompok kontak peringatan. | CloudMonitor mengirimkan pemberitahuan peringatan ke kontak peringatan yang termasuk dalam kelompok kontak peringatan tersebut. Catatan Satu kelompok kontak peringatan dapat berisi satu atau lebih kontak peringatan. Untuk informasi selengkapnya tentang cara membuat kontak peringatan dan kelompok kontak peringatan, lihat PutContact dan PutContactGroup. |
Escalations | Map | No | Yes | Detail peringatan. | Untuk informasi selengkapnya, lihat properti Escalations. |
MetricName | String | Yes | Yes | Nama metrik. | Untuk informasi selengkapnya tentang cara menanyakan nama metrik, lihat Lampiran 1: Metrik layanan cloud. Catatan Jika Anda membuat aturan peringatan Prometheus untuk Pemantauan Cloud Hibrida, Anda harus mengatur properti ini ke nama namespace. Untuk informasi selengkapnya tentang cara menanyakan nama namespace, lihat DescribeHybridMonitorNamespaceList. |
Namespace | String | Yes | Yes | Namespace layanan cloud. | Untuk informasi selengkapnya tentang cara menanyakan namespace layanan cloud, lihat Lampiran 1: Metrik layanan cloud. Catatan Anda harus mengatur properti ini ke acs_prometheus saat membuat aturan peringatan Prometheus untuk Pemantauan Cloud Hibrida. |
Resources | List | Yes | Yes | Informasi mengenai resource. | Contoh: |
CompositeExpression | Map | No | Yes | Kondisi pemicu untuk beberapa metrik. | Untuk informasi selengkapnya, lihat properti CompositeExpression. Catatan Kondisi pemicu untuk satu metrik dan beberapa metrik bersifat saling eksklusif. Anda tidak dapat menentukan kondisi pemicu untuk satu metrik dan beberapa metrik dalam satu permintaan. |
DeletionForce | Boolean | No | Yes | Menentukan apakah aturan peringatan dihapus secara paksa. | Nilai yang valid:
|
EffectiveInterval | String | No | Yes | Periode waktu ketika aturan peringatan berlaku. | Contoh: 00:00-23:59. |
EmailSubject | String | No | Yes | Subjek email pemberitahuan peringatan. | Tidak ada. |
Interval | Integer | No | Yes | Interval pemicuan peringatan berdasarkan aturan peringatan. | Unit: detik. Catatan Untuk informasi selengkapnya tentang cara menanyakan periode statistik metrik, lihat Lampiran 1: Metrik layanan cloud. |
Labels | List | No | Yes | Informasi mengenai tag. | Untuk informasi selengkapnya, lihat properti Labels. |
NoDataPolicy | String | No | Yes | Metode yang digunakan untuk menangani peringatan ketika tidak ditemukan data pemantauan. | Nilai yang valid:
|
NoEffectiveInterval | String | No | Yes | Periode waktu ketika aturan peringatan tidak berlaku. | Contoh: 00:00-23:59. |
Period | Integer | No | Yes | Periode statistik metrik. | Unit: detik. Nilai default adalah interval pengumpulan data pemantauan metrik tersebut. Catatan Untuk informasi selengkapnya tentang cara menanyakan periode statistik metrik, lihat Lampiran 1: Metrik layanan cloud. |
Prometheus | Map | No | Yes | Informasi mengenai aturan peringatan Prometheus. | Untuk informasi selengkapnya, lihat properti Prometheus. Catatan Anda harus menentukan properti ini saat membuat aturan peringatan Prometheus untuk Pemantauan Cloud Hibrida. |
RuleId | String | No | No | ID aturan peringatan. | Anda dapat menentukan ID baru atau ID aturan peringatan yang sudah ada. Untuk informasi selengkapnya tentang cara menanyakan ID aturan peringatan, lihat DescribeMetricRuleList. Catatan Jika Anda menentukan ID baru, aturan peringatan berbasis ambang batas akan dibuat. |
RuleName | String | No | Yes | Nama aturan peringatan. | Anda dapat menentukan nama baru atau nama aturan peringatan yang sudah ada di CloudMonitor. Untuk informasi selengkapnya tentang cara menanyakan nama aturan peringatan, lihat DescribeMetricRuleList. Catatan Jika Anda menentukan nama baru, aturan peringatan berbasis ambang batas akan dibuat. |
SilenceTime | Integer | No | Yes | periode bisu selama pemberitahuan peringatan baru tidak dikirim meskipun kondisi pemicu terpenuhi. | Unit: detik. Nilai default: 86400. Catatan Jika peringatan belum terselesaikan setelah periode bisu berakhir, CloudMonitor akan mengirim ulang pemberitahuan peringatan. |
Webhook | String | No | Yes | URL callback tempat permintaan POST dikirim ketika peringatan dipicu berdasarkan aturan peringatan. | Tidak ada. |
Sintaks Prometheus
"Prometheus": {
"Annotations": List,
"PromQL": String,
"Times": Integer,
"Level": String
}Properti Prometheus
Property | Type | Required | Editable | Description | Constraint |
Level | String | Yes | Yes | Tingkat peringatan. | Nilai yang valid:
|
PromQL | String | Yes | Yes | Pernyataan kueri PromQL. | Tidak ada. |
Times | Integer | Yes | Yes | Jumlah pemicuan berturut-turut. Jika jumlah kali nilai metrik memenuhi kondisi pemicu mencapai nilai properti ini, CloudMonitor akan mengirimkan pemberitahuan peringatan. | Tidak ada. |
Annotations | List | No | Yes | Anotasi aturan peringatan Prometheus. Saat peringatan Prometheus dipicu, sistem akan merender kunci dan nilai anotasi tersebut. | Untuk informasi selengkapnya, lihat properti Annotations. Catatan Properti ini memiliki efek yang sama dengan properti Annotation dalam properti Prometheus. |
Sintaks Annotations
"Annotations": [
{
"Value": String,
"Key": String
}
]Properti Annotations
Property | Type | Required | Editable | Description | Constraint |
Key | String | No | Yes | Kunci anotasi. | Tidak ada. |
Value | String | No | Yes | Nilai anotasi. | Tidak ada. |
Sintaks Labels
"Labels": [
{
"Value": String,
"Key": String
}
]Properti Labels
Property | Type | Required | Editable | Description | Constraint |
Key | String | Yes | Yes | kunci tag. | Tidak ada. |
Value | String | No | Yes | nilai tag. | Tidak ada. |
Sintaks Escalations
"Escalations": {
"Critical": Map,
"Info": Map,
"Warn": Map
}Properti Escalations
Property | Type | Required | Editable | Description | Constraint |
Critical | Map | No | Yes | Detail peringatan tingkat Critical. | Untuk informasi selengkapnya, lihat properti Critical. |
Info | Map | No | Yes | Detail peringatan tingkat Info. | Untuk informasi selengkapnya, lihat properti Info. |
Warn | Map | No | Yes | Detail peringatan tingkat Warn. | Untuk informasi selengkapnya, lihat properti Warn. |
Sintaks Critical
"Critical": {
"ComparisonOperator": String,
"Times": Integer,
"Statistics": String,
"Threshold": String
}Properti Kritis
Property | Type | Required | Editable | Description | Constraint |
ComparisonOperator | String | Yes | Yes | Operator yang digunakan untuk membandingkan nilai metrik dengan ambang batas untuk peringatan tingkat Critical. | Nilai yang valid:
Catatan Anda harus mengonfigurasi minimal satu tingkat peringatan dari Critical, Warn, atau Info serta menentukan properti Statistics, ComparisonOperator, Threshold, dan Times untuk tingkat peringatan tersebut. |
Statistics | String | Yes | Yes | Metode statistik untuk peringatan tingkat Critical. | Nilai yang valid:
Catatan Anda harus mengonfigurasi minimal satu tingkat peringatan dari Critical, Warn, atau Info serta menentukan properti Statistics, ComparisonOperator, Threshold, dan Times untuk tingkat peringatan tersebut. |
Threshold | String | Yes | Yes | ambang batas peringatan untuk tingkat Critical. | Catatan Anda harus mengonfigurasi minimal satu tingkat peringatan dari Critical, Warn, atau Info serta menentukan properti Statistics, ComparisonOperator, Threshold, dan Times untuk tingkat peringatan tersebut. |
Times | Integer | Yes | Yes | Jumlah kali berturut-turut nilai metrik harus memenuhi kondisi pemicu sebelum peringatan tingkat Critical dipicu. | Catatan Anda harus mengonfigurasi minimal satu tingkat peringatan dari Critical, Warn, atau Info serta menentukan properti Statistics, ComparisonOperator, Threshold, dan Times untuk tingkat peringatan tersebut. |
Sintaks Info
"Info": {
"ComparisonOperator": String,
"Times": Integer,
"Statistics": String,
"Threshold": String
}Properti Info
Property | Type | Required | Editable | Description | Constraint |
ComparisonOperator | String | Yes | Yes | Operator yang digunakan untuk membandingkan nilai metrik dengan ambang batas untuk peringatan tingkat Info. | Nilai yang valid:
Catatan Anda harus mengonfigurasi minimal satu tingkat peringatan dari Critical, Warn, atau Info serta menentukan properti Statistics, ComparisonOperator, Threshold, dan Times untuk tingkat peringatan tersebut. |
Statistics | String | Yes | Yes | Metode statistik untuk peringatan tingkat Info. | Nilai yang valid:
Catatan Anda harus mengonfigurasi minimal satu tingkat peringatan dari Critical, Warn, atau Info serta menentukan properti Statistics, ComparisonOperator, Threshold, dan Times untuk tingkat peringatan tersebut. |
Threshold | String | Yes | Yes | ambang batas peringatan untuk tingkat Info. | Catatan Anda harus mengonfigurasi minimal satu tingkat peringatan dari Critical, Warn, atau Info serta menentukan properti Statistics, ComparisonOperator, Threshold, dan Times untuk tingkat peringatan tersebut. |
Times | Integer | Yes | Yes | Jumlah kali berturut-turut nilai metrik harus memenuhi kondisi pemicu sebelum peringatan tingkat Info dipicu. | Catatan Anda harus mengonfigurasi minimal satu tingkat peringatan dari Critical, Warn, atau Info serta menentukan properti Statistics, ComparisonOperator, Threshold, dan Times untuk tingkat peringatan tersebut. |
Sintaks Warn
"Warn": {
"ComparisonOperator": String,
"Times": Integer,
"Statistics": String,
"Threshold": String
}Properti Warn
Property | Type | Required | Editable | Description | Constraint |
ComparisonOperator | String | Yes | Yes | Operator yang digunakan untuk membandingkan nilai metrik dengan ambang batas untuk peringatan tingkat Warn. | Nilai yang valid:
Catatan Anda harus mengonfigurasi minimal satu tingkat peringatan dari Critical, Warn, atau Info serta menentukan properti Statistics, ComparisonOperator, Threshold, dan Times untuk tingkat peringatan tersebut. |
Statistics | String | Yes | Yes | Metode statistik untuk peringatan tingkat Warn. | Nilai yang valid:
Catatan Anda harus mengonfigurasi minimal satu tingkat peringatan dari Critical, Warn, atau Info serta menentukan properti Statistics, ComparisonOperator, Threshold, dan Times untuk tingkat peringatan tersebut. |
Threshold | String | Yes | Yes | ambang batas peringatan untuk tingkat Warn. | Catatan Anda harus mengonfigurasi minimal satu tingkat peringatan dari Critical, Warn, atau Info serta menentukan properti Statistics, ComparisonOperator, Threshold, dan Times untuk tingkat peringatan tersebut. |
Times | Integer | Yes | Yes | Jumlah kali berturut-turut nilai metrik harus memenuhi kondisi pemicu sebelum peringatan tingkat Warn dipicu. | Catatan Anda harus mengonfigurasi minimal satu tingkat peringatan dari Critical, Warn, atau Info serta menentukan properti Statistics, ComparisonOperator, Threshold, dan Times untuk tingkat peringatan tersebut. |
Sintaks CompositeExpression
"CompositeExpression": {
"Times": Integer,
"ExpressionRaw": String,
"ExpressionListJoin": String,
"Level": String,
"ExpressionList": List
}Properti CompositeExpression
Property | Type | Required | Editable | Description | Constraint |
Level | String | Yes | Yes | Tingkat peringatan. | Nilai yang valid:
|
Times | Integer | Yes | Yes | Jumlah pemicuan berturut-turut. Jika jumlah kali nilai metrik memenuhi kondisi pemicu mencapai nilai properti ini, CloudMonitor akan mengirimkan pemberitahuan peringatan. | Tidak ada. |
ExpressionList | List | No | Yes | Kondisi pemicu yang dibuat dalam mode standar. | Untuk informasi selengkapnya, lihat properti ExpressionList. |
ExpressionListJoin | String | No | Yes | Hubungan antara kondisi pemicu untuk beberapa metrik. | Nilai yang valid:
|
ExpressionRaw | String | No | Yes | Kondisi pemicu yang dibuat menggunakan ekspresi. | Anda dapat menggunakan ekspresi untuk membuat kondisi pemicu dalam skenario berikut:
|
Sintaks ExpressionList
"ExpressionList": [
{
"MetricName": String,
"ComparisonOperator": String,
"Period": Integer,
"Id": String,
"ExpressionRaw": String,
"Statistics": String,
"Threshold": String
}
]Properti ExpressionList
Property | Type | Required | Editable | Description | Constraint |
ComparisonOperator | String | Yes | Yes | Operator yang digunakan untuk membandingkan nilai metrik dengan ambang batas. | Nilai yang valid:
|
MetricName | String | Yes | Yes | Nama metrik layanan cloud. | Tidak ada. |
Period | Integer | Yes | Yes | periode agregasi metrik. | Unit: detik. |
Statistics | String | Yes | Yes | Metode statistik metrik. | Nilai yang valid:
Catatan $ adalah awalan metrik. Untuk informasi selengkapnya tentang layanan cloud yang didukung oleh CloudMonitor, lihat Lampiran 1: Metrik layanan cloud. |
Threshold | String | Yes | Yes | ambang batas peringatan. | Tidak ada. |
Id | String | No | No | ID kondisi peringatan. | Tidak ada. |
ExpressionRaw | String | No | No | Ekspresi kustom yang mendefinisikan kondisi peringatan. | Gunakan untuk skenario lanjutan, seperti:
|
Nilai kembalian
Fn::GetAtt
RuleId: ID aturan peringatan.
RuleName: nama aturan peringatan.
Contoh
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
ContactGroups:
Type: Json
Description: |-
Kelompok kontak peringatan yang menerima pemberitahuan peringatan.
Catatan: Satu kelompok kontak peringatan dapat berisi satu atau lebih kontak peringatan. Untuk membuat kontak peringatan dan kelompok kontak peringatan, lihat PutContact dan PutContactGroup.
MinLength: 1
Namespace:
Type: String
Description: |-
Namespace layanan cloud.
Untuk menemukan namespace layanan cloud, lihat Lampiran 1: Metrik.
Catatan: Jika Anda membuat aturan peringatan Prometheus untuk Pemantauan Cloud Hibrida, Anda harus mengatur parameter ini ke acs_prometheus.
MetricName:
Type: String
Description: |-
Nama metrik.
Untuk menemukan nama metrik, lihat Lampiran 1: Metrik.
Catatan: Untuk aturan peringatan Prometheus dalam Pemantauan Cloud Hibrida, parameter ini harus diatur ke nama namespace target. Untuk mendapatkan daftar nama namespace, panggil operasi DescribeHybridMonitorNamespaceList.
Escalations:
Type: Json
Description: Anda harus menentukan minimal satu tingkat peringatan: Critical, Warn, atau Info.
MinLength: 1
Resources:
Type: Json
Description: |-
Resource yang diterapkan aturan peringatan.
Contoh: [{"instanceId":"i-uf6j91r34rnwawoo****"}] dan [{"userId":"100931896542****"}].
Untuk dimensi yang didukung dalam menanyakan resource, lihat Lampiran 1: Metrik.
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 aturan peringatan.
Value:
Fn::GetAtt:
- ResourceMetricRule
- RuleId
RuleName:
Description: Nama aturan peringatan.
Value:
Fn::GetAtt:
- ResourceMetricRule
- RuleName
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"ContactGroups": {
"Type": "Json",
"Description": "Kelompok kontak peringatan yang menerima pemberitahuan peringatan.\nCatatan: Satu kelompok kontak peringatan dapat berisi satu atau lebih kontak peringatan. Untuk membuat kontak peringatan dan kelompok kontak peringatan, lihat PutContact dan PutContactGroup.",
"MinLength": 1
},
"Namespace": {
"Type": "String",
"Description": "Namespace layanan cloud.\nUntuk menemukan namespace layanan cloud, lihat Lampiran 1: Metrik.\nCatatan: Jika Anda membuat aturan peringatan Prometheus untuk Pemantauan Cloud Hibrida, Anda harus mengatur parameter ini ke acs_prometheus."
},
"MetricName": {
"Type": "String",
"Description": "Nama metrik.\nUntuk menemukan nama metrik, lihat Lampiran 1: Metrik.\nCatatan: Untuk aturan peringatan Prometheus dalam Pemantauan Cloud Hibrida, parameter ini harus diatur ke nama namespace target. Untuk mendapatkan daftar nama namespace, panggil operasi DescribeHybridMonitorNamespaceList."
},
"Escalations": {
"Type": "Json",
"Description": "Anda harus menentukan minimal satu tingkat peringatan: Critical, Warn, atau Info.",
"MinLength": 1
},
"Resources": {
"Type": "Json",
"Description": "Resource yang diterapkan aturan peringatan.\nContoh: [{\"instanceId\":\"i-uf6j91r34rnwawoo****\"}] dan [{\"userId\":\"100931896542****\"}].\nUntuk dimensi yang didukung dalam menanyakan resource, lihat Lampiran 1: Metrik.",
"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 aturan peringatan.",
"Value": {
"Fn::GetAtt": [
"ResourceMetricRule",
"RuleId"
]
}
},
"RuleName": {
"Description": "Nama aturan peringatan.",
"Value": {
"Fn::GetAtt": [
"ResourceMetricRule",
"RuleName"
]
}
}
}
}