すべてのプロダクト
Search
ドキュメントセンター

Simple Log Service:元のアラートテンプレートの変数

最終更新日:Aug 29, 2024

このトピックでは、Simple Log Serviceの元のアラートテンプレートで使用できる変数について説明します。 このトピックでは、変数の参照に使用できるメソッドについても説明します。

参照方法

重要

変数のフルネームを使用して、変数を参照する必要があります。 参照先の変数が見つからないか無効な場合、Simple Log Serviceはその変数を空の文字列に置き換えます。 参照変数の値がオブジェクト型の場合、値はJSON文字列に変換されます。

アクションポリシーを設定する場合、アラートテンプレートを選択する必要があります。 アラートテンプレートは、アラート通知の内容と件名を指定します。 ContentパラメーターとSubjectパラメーターを設定するときに、${fieldName} 構文を使用してアラートテンプレートの変数を参照できます。 Simple Log Serviceがアラート通知を送信する前に、Simple Log Serviceは [コンテンツ] フィールドと [件名] フィールドで参照されている変数を実際の値に置き換えます。 たとえば、Simple Log Serviceは、${project} を、設定されたアラートルールが属するプロジェクトの名前に置き換えます。

利用可能な変数と参照の例

次の表に、使用可能な変数と変数の参照方法の例を示します。

変数

説明

データ型

値の例

参考例

aliuid

ユーザーが属する Alibaba Cloud アカウントの ID です。

String

117918664953 ****

アラートがトリガーされたプロジェクトは、${aliuid} Alibaba Cloudアカウントに属しています。

alert_instance_id

アラートがトリガーされたインスタンスのID。

String

ee16a8f435485f3f-5be6b81edc520-3d6 ****

アラートがトリガーされたインスタンスのIDは ${alert_instance_id} です。

project

アラートルールが属するプロジェクトです。

String

my-project

アラートは ${project} プロジェクトでトリガーされます。

alert_id

アラートルールの ID。 各アラートルールには、アラートルールが属するプロジェクト内で一意のIDが必要です。

String

0fdd88063a611aa114938f9371daeeb6-1671a52 ****

アラートルールのIDは ${alert_id} です。

alert_type

トリガーされるアラートのタイプ。

  • sls_alert: アラートは、Simple Log Serviceのアラートルールに基づいてトリガーされます。

  • sls_pub: アラートは、Simple Log Serviceではなくアラートシステムから取り込まれます。

String

sls_alert

アラートのタイプは ${alert_type} です。

alert_name

アラートルールの名前です。

String

new2

アラートルールの名前は ${alert_name} です。

next_eval_interval

次の評価アクティビティが開始されるまでの時間。

int

900

次の評価アクティビティは ${next_eval_interval} 秒で始まります。

alert_time

現在の評価アクティビティが開始される時刻。

int

1616744734

現在の評価アクティビティは ${alert_time} から始まります。

fire_time

アラートが初めてトリガーされた時刻。

int

1616059834

アラートは ${fire_time} で初めてトリガーされます。

status

アラートのステータス。

  • firing: アラートがトリガーされます。

  • resolved: アラートがクリアされました。

String

firing

アラートのステータスは ${status} です。

resolve_time

アラートが作成された時刻。

  • アラートが発火状態にある場合、この変数の値は0です。

  • アラートが解決済み状態の場合、この変数の値は特定の時点になります。

int

0

アラートは ${resolve_time} でクリアされます。

results

クエリのパラメーターと中間結果。 この変数の値は配列です。 この変数の値の詳細については、このトピックの「結果変数の説明」を参照してください。

array

[
{
"store_type": "log",
"region": "cn-hangzhou",
"project": "sls-alert-test",
"store": "test",
"query": "* | select count(1) as cnt",
"start_time": 1616741485,
"end_time": 1616745085,
"dashboard_id": "mydashboard",
"raw_results": [{"cnt": "4"}],
"raw_result_count": 1,
"truncated": false,
"role_arn": ""
}
]

クエリは ${results[0].start_time} で初めて開始し、${results[0].end_time} で終了します。

説明

この例では、値0はチャートのシリアル番号です。

labels

アラートのラベル。

Map

{"env":"test"}

アラートのラベルは ${labels} です。

annotations

アラートの注釈。

Map

{"title": "Alert title","desc": "Alert description"}

アラートの注釈は ${annotations} です。

severity

アラートの重大度レベル。

  • 10: クリティカル

  • 8: 高い

  • 6: ミディアム

  • 4: 低い

  • 2: レポート

int

10

アラートの重大度は ${severity} です。

policy

構成するアラートポリシーまたはアクションポリシー。 この変数の値の詳細については、このトピックの「ポリシー変数の説明」を参照してください。

Map

{
    "alert_policy_id": "sls.test-alert",
    "action_policy_id": "sls.test-action",
    "use_default": false,
    "repeat_interval": "6m0s"
}

アラートポリシーのIDは ${policy.alert_policy_id} です。

region

アラートがトリガーされたリージョンのID。

String

cn-hangzhou

アラートは ${region} リージョンでトリガーされます。

drill_down_query

ドリルダウン分析に使用するクエリ文です。 カスタム警告テンプレートの場合、この変数の値は空です。 この変数は、Log Audit Service、Cost Manager、およびSLB Log Centerのアラートテンプレートで使用できます。

String

* | select count (1) as cnt

なし。

alert_url

アラートの URL です。

String

https://sls.console.aliyun.com/lognext/project/test-xxxx/alert/alert-1617164106-940166

アラートのURLは ${alert_url} です。

query_url

クエリで要求された最初のページのURL。

String

https://sls-stg.console.aliyun.com/lognext/project/test-xxx/logsearch/test-alert-access?encode=base64&endTime=1617175989&queryString=KiB8IHNlbGVjdCBjb3VudCgxKSBhcyBjbnQ%3D&queryTimeType=99&startTime=1617175089

クエリで要求された最初のページのURLは ${query_url} です。

alert_history_dashboard_url

アラート履歴統計ダッシュボードのURL。

String

https://sls.console.aliyun.com/lognext/project/test-xx/dashboard/internal-alert-analysis

アラート履歴統計ダッシュボードのURLは ${alert_history_dashboard_url} です。

条件

アラートルールのトリガー条件です。 Simple Log Serviceは、トリガー条件の変数をアラートをトリガーする値に置き換えます。 各値は括弧 ([]) で囲まれています。 この変数の値は、Count:Quantity式; Condition:Matching式形式です。

String

カウント:[5] > 3; 条件:[example.com]=='example.com'

アラートルールのトリガー条件は ${condition} です。

raw_condition

アラートルールの元のトリガー条件です。 トリガー条件の変数は保持されます。 この変数の値は、Count:Quantity式; Condition:Matching式形式です。

String

Count :__ count__ > 3; 条件: host=='example.com'

アラートルールの元のトリガー条件は ${raw_condition} です。

ダッシュボード

アラートルールに関連付けられているダッシュボードの名前。

String

mydashboard

アラートルールに関連付けられているダッシュボードの名前は ${dashboard} です。

dashboard_url

アラートルールに関連付けられているダッシュボードのURL。

String

https://sls.console.aliyun.com/next/project/myproject/dashboard/mydashboard

アラートルールに関連付けられているダッシュボードのURLは ${dashboard_url} です。

fire_結果

アラートがトリガーされたデータレコード。 データセットに対する操作に応じて、最大100のデータレコードを返すことができます。

array

[{
    "host":example.com",
    "host__1":"example.com",
    "pv":"836",
    "slbid":"slb-02",
    "status":"200"},{
    "host":"example.com",
    "host__1":"example.org",
    "pv":"836",
    "slbid":"slb-02",
    "status":"200"
},{
    "host":"example.com",
    "host__1":"example.com",
    "pv":"836",
    "slbid":"slb-02",
    "status":"200"
},{
    "host":"example.com",
    "host__1":"example.com",
    "pv":"836",
    "slbid":"slb-02",
    "status":"200"
},{
    "host":"example.com",
    "host__1":"example.com",
    "pv":"780",
    "slbid":"slb-01",
    "status":"200"
}]

アラートは、${fire_results} のデータレコードに対してトリガーされます。

fire_results_count

アラートがトリガーされたデータレコードの総数。 この変数の値は100より大きくてもよい。 たとえば、データセットに対してCROSS JOIN操作を実行すると、Simple Log Serviceが100を超えるデータレコードのアラートをトリガーする場合があります。

int

3

アラートは、合計 ${fire_results_count} のデータレコードに対してトリガーされます。

fire_results_as_kv

アラートがトリガーされるデータレコードの詳細。 データセットに対する操作に応じて、最大100のデータレコードを返すことができます。 この変数の値は、[key1:value1,key2:value2] 形式です。

array

[hos t:example.com、pv:836、ステータス: 200][hos t:example.com、pv:780、ステータス: 200]

アラートは、次のデータレコード ${fire_results_as_kv} に対してトリガーされます。

ポリシー変数の説明

policy変数で参照できる変数を次の表に示します。

変数

説明

データ型

alert_policy_id

アラートルールで構成するアラートポリシーのID。

String

sls.test-alert

action_policy_id

アラートルールで設定したアクションポリシーのID。 この変数は、アラートポリシーを動的アクションポリシーに関連付ける場合にのみ使用できます。

String

sls.test-action

repeat_interval

Simple Log Serviceが繰り返しアラートを送信する時間間隔。 この変数は、アラートポリシーをアクションポリシーに関連付ける場合にのみ使用できます。

String

4h

結果変数の説明

results変数で参照できる変数を次の表に示します。

変数

説明

データ型

role_arn

使用するリソースのAlibaba Cloudリソース名 (ARN) 。

String

acs:ram::1117918664953 ****:role/aliyunslsalertmonitorrole

store_type

使用するデータの種類。 有効な値:

  • log: ログデータ

  • metric:時系列データ

  • meta: リソースデータ

String

log

region

宛先Logstoreまたは宛先Metricstoreが存在するリージョン。

store_type変数の値がmetaの場合、region変数は空です。

String

cn-hangzhou

project

宛先Logstoreまたは宛先Metricstoreが属するプロジェクト。

store_type変数の値がmetaの場合、project変数は空です。

String

sls.test-alert

ストア

宛先Logstoreまたは宛先Metricstoreの名前。

String

test-logstore

query

実行するクエリ文。The query statement that you want to execute.

String

error | select count(1) as cnt

start_time

クエリの開始時刻。

store_type変数の値がmetaの場合、start_time変数は空です。

int

2006-01-02 15:04:05

start_time_ts

クエリの開始時刻。 この値は UNIX タイムスタンプです。

store_type変数の値がmetaの場合、start_time_ts変数は空です。

int

1616741485

end_time

クエリの終了時刻。

store_type変数の値がmetaの場合、end_time_ts変数は空です。

int

2006-01-02 15:04:05

end_time_ts

クエリの終了時刻。 この値は UNIX タイムスタンプです。

store_type変数の値がmetaの場合、end_time_ts変数は空です。

int

1616745085

dashboard_id

クエリに関連付けられているダッシュボードの ID。

String

mydashboard

raw_results

クエリに応答して返される結果。 この変数の値は配列です。 最大100のデータレコードが返されます。

array

[{
    "host":"example.com",
    "slbid":"slb-02",
    "status":"200"
},{
    "host":"example.com",
    "slbid":"slb-01",
    "status":"200"
},{
    "host":"example.com",
    "slbid":"slb-02",
    "status":"306"
},{
    "host":"example.com",
    "slbid":"slb-02",
    "status":"200"
},{
    "host":"example.com",
    "slbid":"slb-01",
    "status":"200"
},{
    "host":"example.com",
    "slbid":"slb-02",
    "status":"200"
}]