このトピックでは、アラートルールのデータ構造について説明します。
アラート
フィールド | タイプ | 必須 | 説明 |
name | String | はい | アラートルールの ID。 ID はルールの URL に表示されます。 |
displayName | String | はい | アラートルールの名前。名前はアラートリストに表示されます。 |
status | String | いいえ | アラートルールのステータス。有効な値:
|
type | String | はい | 値を Alert に設定します。 |
description | String | いいえ | 互換性フィールド。値を空の文字列に設定します。 |
schedule | スケジュール | はい | チェック頻度に関連する設定。詳細については、「スケジュール」をご参照ください。 |
configuration | 構成 | はい | アラートルールの詳細設定。詳細については、「構成」をご参照ください。 |
スケジュール
フィールド | タイプ | 必須 | 説明 |
type | String | はい | チェック頻度のタイプ。Log Service は、指定した頻度に基づいてクエリと分析結果をチェックします。有効な値:
|
interval | String | いいえ | 固定間隔。例:5m、1h。 type を FixedRate に設定する場合は、interval を構成する必要があります。 |
cronExpression | String | いいえ | Cron 式。分単位で正確な間隔を指定できます。Cron 式は 24 時間制に基づいています。たとえば、 type を Cron に設定する場合は、cronExpression を構成する必要があります。 |
dayOfWeek | Integer | いいえ | 曜日。有効な値:0 ~ 6(日曜日~土曜日)。 type を Weekly に設定する場合は、dayOfWeek を構成する必要があります。 |
hour | Integer | いいえ | 時間。有効な値:0 ~ 23(1 日の各時間を指定)。 type を Weekly または Daily に設定する場合は、hour を構成する必要があります。 |
runImmediately | ブール値 | いいえ | ルール作成後すぐにアラートルールを実行するかどうかを指定します。 |
構成
フィールド | タイプ | 必須 | 説明 |
version | String | はい | 値を 2.0 に設定します。 |
type | String | はい | 値を default に設定します。 |
dashboard | String | いいえ | アラート履歴ダッシュボード。推奨値:internal-alert-analysis。 |
queryList | AlertQuery | はい | クエリ文のリスト。 |
groupConfiguration | GroupConfiguration | はい | グループ評価の設定。詳細については、「GroupConfiguration」をご参照ください。 |
joinConfigurations | []JoinConfiguration | いいえ | 集合演算の設定。詳細については、「JoinConfiguration」をご参照ください。
|
severityConfigurations | []SeverityConfiguration | はい | トリガー条件。少なくとも 1 つのトリガー条件を指定する必要があります。詳細については、「SeverityConfigurations」をご参照ください。 |
labels | []Tag | いいえ | ラベル。詳細については、「タグ」をご参照ください。 |
annotations | []Tag | いいえ | 注釈。詳細については、「タグ」をご参照ください。 |
autoAnnotation | ブール値 | はい | システムが注釈を自動的に追加することを許可するかどうかを指定します。
|
sendResolved | ブール値 | いいえ | アラートがクリアされたときに回復アラートをトリガーするかどうかを指定します。
|
threshold | Integer | はい | アラートがトリガーされるしきい値。指定されたトリガー条件が満たされた連続回数が指定されたしきい値に達すると、アラートがトリガーされます。指定されたトリガー条件が満たされていない回数はカウントされません。 |
noDataFire | ブール値 | いいえ | データがないという条件が満たされたときにアラートをトリガーするかどうかを指定します。
|
noDataSeverity | Integer | いいえ | データがないという条件が満たされたときにトリガーされるアラートの重大度レベル。詳細については、「アラートの重大度」をご参照ください。 |
policyConfiguration | PolicyConfiguration | はい | アラートポリシーの設定。詳細については、「PolicyConfiguration」をご参照ください。 |
tags | []String | いいえ | カスタムアラート ルールのタイプ。 説明 このフィールドは、Log Service SDK for Java V0.6.74 以降でサポートされています。 |
AlertQuery
フィールド | タイプ | 必須 | 説明 |
storeType | String | はい | クエリのデータソースのタイプ。有効な値:
|
region | String | はい | クエリが実行されるプロジェクトのリージョン。
|
project | String | はい | クエリが実行されるプロジェクト。
|
store | String | はい | クエリが実行されるログストア、メトリックストア、またはリソースデータ。
|
roleArn | String | いいえ | データにアクセスするために必要な RAM ロールの Alibaba Cloud Resource Name (ARN)。詳細については、「プロジェクトをまたぐデータ監視の承認を構成する」をご参照ください。 |
query | String | はい | クエリ文。
|
timeSpanType | String | いいえ | 時間のタイプ。詳細については、「クエリ文の時間範囲」をご参照ください。 storeType を log または metric に設定する場合は、timeSpanType を構成する必要があります。 |
start | String | いいえ | 開始時刻。 storeType を log または metric に設定する場合は、start を構成する必要があります。 |
end | String | いいえ | 終了時刻。 storeType を log または metric に設定する場合は、end を構成する必要があります。 |
powerSqlMode | String | いいえ | 専用 SQL を有効にするかどうかを指定します。有効な値:
|
GroupConfiguration
フィールド | タイプ | 必須 | 説明 |
type | String | はい | グループ評価のタイプ。有効な値:
|
fields | []String | いいえ | クエリと分析結果をグループ化する基準となるフィールド。 type を custom に設定する場合は、fields を構成する必要があります。 |
JoinConfiguration
フィールド | タイプ | 必須 | 説明 |
type | String | はい | 集合演算のタイプ。有効な値:
|
condition | String | いいえ | type を inner_join、left_join、right_join、full_join、left_exclude、または right_exclude に設定する場合は、condition を構成する必要があります。例: |
SeverityConfiguration
フィールド | タイプ | 必須 | 説明 |
重大度 | 整数 | はい | アラートの重大度レベル。詳細については、「アラートの重大度」をご参照ください。 |
評価条件 | 条件設定 | いいえ | トリガー条件。詳細については、「評価式の指定」をご参照ください。 |
evalCondition.condition | 文字列 | はい | データの照合に使用する式です。
|
evalCondition.countCondition | 文字列 | はい | データエントリの件数と照合するために使用される式。
|
タグ
フィールド | タイプ | 必須 | 説明 |
キー | String | はい | フィールドの名前。 |
値 | String | はい | フィールドの値。 |
PolicyConfiguration
フィールド | タイプ | 必須 | 説明 |
alertPolicyId | 文字列 | はい | アラートポリシーの ID です。
|
actionPolicyId | 文字列 | はい | アクションポリシーの ID です。 詳細モードで、アラートポリシーが動的アクションポリシーを使用しない場合は、actionPolicyId を空の文字列に設定します。 |
repeatInterval | 文字列 | はい | 繰り返し間隔です。例:5m、1h。 |
useDefault | ブール値 | はい | 互換性フィールドです。値を false に設定します。 |
参照データ
アラートの重大度
アラートの重大度 | 説明 |
クリティカル | 10 |
高 | 8 |
中 | 6 |
低 | 4 |
レポート | 2 |
クエリ文の時間範囲
timeSpanType | start | end | 説明 |
カスタム | -15m | absolute | 時間枠タイプの 15 分の期間。 |
カスタム | -100s | -20s | 前の 100 秒から前の 20 秒までの相対タイプの期間。 |
カスタム | -60s | now | 相対タイプの 60 秒の期間。 |
カスタム | -120m | 空の文字列 | 相対タイプの 120 分の期間。 |
相対 | -100s | -20s | 前の 100 秒から前の 20 秒までの相対タイプの期間。 |
相対 | -60s | now | 相対タイプの 60 秒の期間。 |
相対 | -120m | 空の文字列 | 相対タイプの 120 分の期間。 |
切り捨て | -15m | 任意 | 時間枠タイプの 15 分の期間。 |
今日 | 任意 | 任意 | 現在の日の 00:00 から現在の時刻までの期間。 |
昨日 | 任意 | 任意 | 前の日の 00:00 から現在の日の 00:00 までの期間。 |