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

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

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

Only the variables present in the detect condition are available in the alert body. For example, variable A in the following is not available in the alert body because it is only used in the TRIGGER_CONDITION and not in the detect 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')

注釈

If you change the alert condition after customizing the message, an icon on the Message preview tab appears.

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

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

Alert message variables 🔗

Detector and rule details 🔗

変数

説明

{{{detectorName}}}

ディテクターの名前

{{{ruleName}}}

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

{{ruleSeverity}}

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

{{{readableRule}}}

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

{{{runbookUrl}}}

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

{{{tip}}}

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

{{detectorId}}

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

{{detectorUrl}}

ディテクターのURL

Alert details 🔗

変数

説明
この変数には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は、アラートのトリガーと解除の両方で同じです。

Signal details 🔗

変数

説明

{{inputs.A.value}}

The value of the signal on plot line A. For the variable to be available in the alert body, it must be used in the detect condition.

{{inputs.B.value…}}

The value of other signals in the detector. For the variable to be available in the alert body, it must be used in the detect condition.

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

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

{{dimensions.dimensionName}}

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

{{dimensions.dimensionName2…}}

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

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

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

Organization details 🔗

変数

説明

{{organizationId}}

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

Helper functions 🔗

オプション

説明

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

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

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

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

Built-in alert rule variables 🔗

The following tables list the variables that are available to use when creating a custom message for the given built-in alert rule. You can’t use variables other than the ones that are listed.

Resource running out 🔗

変数

説明

{{inputs.hours_left.value}}

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

{{event_annotations.fire_forecast_ahead}}

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

{{event_annotations.clear_forecast_ahead}}

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

Outlier detection 🔗

変数

説明

{{inputs.promoted_population_stream.value}}

監視するシグナル

{{inputs.fire_bot.value}}

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

{{inputs.clear_bot.value}}

アラートの解除の閾値

{{inputs.fire_top.value}}

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

{{inputs.clear_top.value}}

アラートの解除の閾値

Sudden change 🔗

変数

説明

{{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}}

アラートの解除の閾値

Historical anomaly 🔗

変数

説明

{{event_annotations.current_window}}

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

{{inputs.summary.value}}

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

{{inputs.fire_bot.value}}

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

{{inputs.clear_bot.value}}

アラートの解除の閾値

{{inputs.fire_top.value}}

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

{{inputs.clear_top.value}}

アラートの解除の閾値

Example message 🔗

The following is an example of a default message that you can customize:

{{#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}}

This page was last updated on 2024年11月12日.