Docs » Splunk Observability Cloudのアラートとディテクターの概要 » アラートメッセージ変数の参照情報

アラートメッセージ変数の参照情報 🔗

以下の表は、カスタムメッセージの作成時に使用できる変数とヘルパー関数を説明したものです。変数の値がエスケープ処理されないように、指定された場所では三重の波括弧を使用します。

アラート本文で使用できるのは、検出条件に存在する変数だけです。例えば、以下の変数Aは、TRIGGER_CONDITION のみで使用されており、検出条件では使用されていないため、アラート本文では使用できません。

A = data('metric').publish('A')
B = data('test').publish('B')
TRIGGER_CONDITION = when(A > 100)

detect(TRIGGER_CONDITION and when(B < 500)).publish('Alert notification')

注釈

メッセージをカスタマイズした後にアラート条件を変更すると、「メッセージのプレビュー」タブにアイコンが表示されます。

この画像はメッセージタブのアイコンです。

これは、これまで使用していた変数が新しく選択した条件には適用されなくなる可能性があるため、メッセージを見直すことを促すためのものです。このアイコンは「メッセージのプレビュー」タブから離れると消えます。

アラートメッセージの変数 🔗

ディテクターとルールの詳細 🔗

変数

説明

{{{detectorName}}}

ディテクターの名前

{{{ruleName}}}

アラートをトリガーしたルールの名前

{{ruleSeverity}}

ルールの重大度： Critical、Major、Minor、Warning または Info

{{{readableRule}}}

このルールの分かりやすい説明。例：「metric.name.hereの値が100を超える」。

{{{runbookUrl}}}

このアラートがトリガーされたときに表示するページのURL

{{{tip}}}

実行するコマンドラインなど、最初に取るべき行動を提案するプレーンテキスト

{{detectorId}}

ディテクターのID。これを使用して、プログラムでこのディテクターを参照できます。

{{detectorUrl}}

ディテクターのURL

アラートの詳細 🔗

変数

説明
この変数には2つのバリエーションがあります：

  • {{timestamp}}

  • {{dateTimeFormat timestamp format=」short」}}

  • {timestamp}}は、このアラートのUTCタイムスタンプを以下のフォーマットで提供します： Wed, 8 Mar 2023 22:11:32 GMT

  • {{dateTimeFormat timestamp format=」short」}}は、このアラートのUTCタイムスタンプをUNIX時間で提供します： 1678313492000

注：アラートがトリガーまたは解除されると、常にUTCでタイムスタンプが生成されます。しかし、アラートのプレビューメッセージでは、このタイムスタンプは、ご利用のUIのタイムゾーンで表示されます。これはGMTと異なる可能性があります。

{{anomalyState}}

アラートの状態（OKまたはANOMALOUS）

{{anomalous}}

ブール値：「true」の場合はアラートがトリガーされたことを示します。

{{normal}}

ブール値：「true」の場合はアラートが解除されたことを示します。

{{imageUrl}}

通知メッセージに表示されるプレビュー画像のURL

{{incidentId}}

インシデントのID。インシデントIDは、アラートのトリガーと解除の両方で同じです。

シグナルの詳細 🔗

変数

説明

{{inputs.A.value}}

プロットラインAのシグナルの値。この変数をアラート本文で利用できるようにするには、この変数を検出条件で使用する必要があります。

{{inputs.B.value…}}

ディテクター内のその他のシグナルの値。この変数をアラート本文で使用できるようにするには、この変数を検出条件で使用する必要があります。

{{{dimensions}}}
監視するシグナルの全ディメンションのリスト（次の形式で）：

{sf_metric=metricName, dimensionNameA=valueA, dimensionNameB=valueB, …}

{{dimensions.dimensionName}}

監視するシグナルのディメンション（」dimensionName」）の値

{{dimensions.dimensionName2…}}

監視するシグナルのその他のディメンションの値

{{dimensions.[dimension.name.3…]}}

監視するシグナルのその他のディメンションの値。ディメンション名にドット（.）が含まれているときは、変数を機能させるために角括弧（[]）で囲む必要があります。

組織の詳細 🔗

変数

説明

{{organizationId}}

組織ID。この組織をプログラムで参照するために使用できます。

ヘルパー関数 🔗

オプション

説明

{{#if}} {{else}} {{/if}}
条件関数。例：

{{#if anomalous}}Alert triggered at {{timestamp}} {{else}} Alert cleared at {{timestamp}} {{/if}}

{{#notEmpty dimensions}} {{/notEmpty}}
シグナルに関連するディメンションがある場合、例：

{{#notEmpty dimensions}} Signal details: {{{dimensions}}} {{/notEmpty}}

内蔵アラートルールの変数 🔗

以下の表は、特定の内蔵アラートルールのカスタムメッセージを作成する際に使用できる変数の一覧です。リストにある変数以外は使用できません。

リソースの枯渇 🔗

変数

説明

{{inputs.hours_left.value}}

EmptyまたはCapacityに達するまでの残り時間数

{{event_annotations.fire_forecast_ahead}}

アラートのトリガーの閾値（単位：時間）

{{event_annotations.clear_forecast_ahead}}

アラートの解除の閾値（単位：時間）

外れ値検出 🔗

変数

説明

{{inputs.promoted_population_stream.value}}

監視するシグナル

{{inputs.fire_bot.value}}

値が閾値より低い場合のアラートのトリガーの閾値

{{inputs.clear_bot.value}}

アラートの解除の閾値

{{inputs.fire_top.value}}

値が閾値より高い場合のアラートのトリガーの閾値

{{inputs.clear_top.value}}

アラートの解除の閾値

急激な変化 🔗

変数

説明

{{event_annotations.current_window}}

異常値を検査するウィンドウ

{{inputs.recent_min.value}}

現在のウィンドウの最小値

{{inputs.recent_max.value}}

現在のウィンドウの最大値

{{inputs.f_bot.value}}

値が閾値より低い場合のアラートのトリガーの閾値

{{inputs.c_bot.value}}

アラートの解除の閾値

{{inputs.f_top.value}}

値が閾値より高い場合のアラートのトリガーの閾値

{{inputs.c_top.value}}

アラートの解除の閾値

履歴的異常 🔗

変数

説明

{{event_annotations.current_window}}

異常値を検査するウィンドウ

{{inputs.summary.value}}

現在のウィンドウの平均値

{{inputs.fire_bot.value}}

値が閾値より低い場合のアラートのトリガーの閾値

{{inputs.clear_bot.value}}

アラートの解除の閾値

{{inputs.fire_top.value}}

値が閾値より高い場合のアラートのトリガーの閾値

{{inputs.clear_top.value}}

アラートの解除の閾値

メッセージの例 🔗

以下は、カスタマイズ可能なデフォルトメッセージの例です：

{{#if anomalous}}
   Rule "{{ruleName}}" in detector "{{detectorName}}" triggered at {{timestamp}}.
{{else}}
   Rule "{{ruleName}}" in detector "{{detectorName}}" cleared at {{timestamp}}.
{{/if}}

{{#if anomalous}}
Triggering condition: {{{readableRule}}}
{{/if}}

{{#if anomalous}}Signal value: {{inputs.A.value}}
{{else}}Current signal value: {{inputs.A.value}}
{{/if}}

{{#notEmpty dimensions}}
Signal details:
{{{dimensions}}}
{{/notEmpty}}

{{#if anomalous}}
{{#if runbookUrl}}Runbook: {{{runbookUrl}}}{{/if}}
{{#if tip}}Tip: {{{tip}}}{{/if}}
{{/if}}

このページは 2024年11月12日 に最終更新されました。