Oracle Cloud Infrastructureドキュメント

アラーム・メッセージ書式

モニタリングによって送信されたアラーム・メッセージに表示されるパラメータを参照します。パラメータの説明と値の例、動的変数、および書式設定されたメッセージのデフォルトの表示を確認します。

パラメータは、pretty JSONおよびraw形式の電子メール・メッセージに表示される順序でリストされます。

アラームメッセージのパラメータ

次の表では、アラーム・メッセージのパラメータについて説明し、値の例を示します。

アラーム

アラームパラメータ 説明と例の値
dedupekey

string

アラーム(グループ・メッセージ)またはアラーム内のメトリック・ストリームの一意の識別子(分割メッセージ)。

値の例: exampleuniqueid

使用上のコメント:

グループ化されたメッセージ(notificationType: Group notifications across metric streams)の場合は、dedupekeyを使用して、同じアラームに属するメッセージをグループ化します。

分割メッセージ(notificationType: Split messages per metric stream)の場合は、dedupekeyを使用して、同じアラームおよび同じメトリック・ストリームに属するメッセージをグループ化します。

同じメッセージの複数オカレンスを複製解除するには、dedupekeyとtimestampを一緒に使用します。
title

string

アラームの通知タイトル(アラームを作成および更新するためのコンソール・フォームの通知件名)。指定しない場合、アラームの表示名が使用されます。

ノート:サポートされているすべてのユース・ケースの最大長を尊重する動的変数を挿入します。最大値を超える動的変数は無効とみなされます。たとえば、titleで使用する動的変数について考えてみます。titleでサポートされているユース・ケースは、最大250文字の電子メール件名です。この場合、リソース名({{dimensions.<dimension-name>}})の動的変数は256文字であるため、最大値を超えているため無効です。

動的変数を使用した値の例: {{severity}} alarm triggered at {{timestamp}}

値の例(アラームの表示名): High CPU Utilization
body

string

アラームの構成済メッセージ本文(アラームを作成および更新するためのコンソール・フォームのアラーム本文)。指定されていない場合はNullです。

動的変数を使用した値の例: {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

値の例(テキスト): Follow runbook at http://example.com/runbooks
type

string

通知メッセージを送信する理由。

有効な値: メッセージ・タイプを参照してください。

値の例: OK_TO_FIRING
severity

string

リストされているアラームの最も高い重大度レベル。

有効な値: CRITICAL、ERROR、WARNINGおよびINFO
timestampEpochMillis

long

評価タイムスタンプ(エポック時間からのミリ秒)。

値の例: 1684337663852
timestamp

string

評価タイムスタンプ(ISO-8601形式)。

値の例: 2023-05-17T15:34:23.852Z
alarmMetaData

オブジェクトの配列

この通知メッセージに関連するアラームのリスト。

値の例については、次の表の「アラーム・メタデータ」の子パラメータを参照してください。
version

int

アラーム・メッセージ形式のバージョン。

値の例: 1.5

アラーム・メタデータ

アラームパラメータ 説明と例の値
id

string

アラームOCID。

値の例: ocid1.alarm.oc1..exampleuniqueID
status

string

アラームの状態。

有効な値: OK、FIRING
severity

string

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

有効な値: CRITICAL、ERROR、WARNING、INFO
namespace

string

メトリック・ネームスペース。

値の例: oci_computeagent
query

string

アラームの構成済問合せまたはMQL式。

値の例: CpuUtilization[1m].mean() > 90
totalMetricsFiring

int

この通知メッセージで表されるメトリック・ストリーム数。

値の例: 3
dimensions

オブジェクトの配列

各メトリック・ストリームを識別するディメンション・キー/値ペアのリスト。このリストは、100個のエントリに制限されています。

値の例:

{ "instancePoolId": "Default", "resourceDisplayname": "oke-0", "faultDomain": "FAULT-DOMAIN-1", "resourceId": "ocid1.instance.oc1.iad.exampleid", "availabilityDomain": "sOZD:US-ASHBURN-AD-2", "imageId": "ocid1.image.oc1.iad.exampleid", "region": "us-ashburn-1", "shape": "VM.Standard.E3.Flex" }, { "instancePoolId": "Default", "resourceDisplayname": "oke-2", "faultDomain": "FAULT-DOMAIN-3", "resourceId": "ocid1.instance.oc1.iad.exampleid", "availabilityDomain": "sOZD:US-ASHBURN-AD-1", "imageId": "ocid1.image.oc1.iad.exampleid", "region": "us-ashburn-1", "shape": "VM.Standard.E3.Flex" }, { "instancePoolId": "Default", "resourceDisplayname": "oke-1", "faultDomain": "FAULT-DOMAIN-2", "resourceId": "ocid1.instance.oc1.iad.exampleid", "availabilityDomain": "sOZD:US-ASHBURN-AD-3", "imageId": "ocid1.image.oc1.iad.exampleid", "region": "us-ashburn-1", "shape": "VM.Standard.E3.Flex" }
metricValues

オブジェクトの配列

ディメンションのキーと値のペアのメトリック値のリスト(メトリック・ストリーム)。このリストは、100個のエントリに制限されています。

値の例:

[{"CpuUtilization[1m].mean()":"92"},{"CpuUtilization[1m].mean()":"95"},{"CpuUtilization[1m].mean()":"93"}]
alarmUrl

string

コンソールのアラーム詳細ページにリンクします。

値の例: https://cloud.oracle.com/monitoring/alarms/ocid1.alarm.oc1.iad.exampleuniqueid?region=us-ashburn-1
alarmSummary

string

アラームの構成済アラーム・サマリー(アラームを作成および更新するためのコンソール・フォームのアラーム・サマリー)。構成されていない場合は、状態を要約するシステム生成のメッセージが使用されます。

動的変数を使用した値の例: {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

システム生成メッセージ(アラーム・サマリーが構成されていない場合に使用)の内容は、notificationTypeによって異なります。

  • Grouped messages across metric streamsの場合:

    Alarm <alarm-name> is in a <alarm-state> state; because <number-of-metric-streams> metrics meet the trigger rule: "mql-expression", with a trigger delay of <number-of-minutes>

    例:

    Alarm High CPU Utilization is in a FIRING state; because 4 metrics meet the trigger rule: CpuUtilization[1m].mean() >90, with a trigger delay of 1 minute

  • Split messages per metric streamの場合、次のようになります。

    Alarm <alarm-name> is in a <alarm-state> state; because the resources with dimensions listed below meet the trigger rule: "mql-expression", with a trigger delay of <number-of-minutes>
notificationType

string

通知のタイプ(グループ化または分割)。

有効な値: Grouped messages across metric streamsまたはSplit messages per metric stream

ダイナミック変数

次の表に、各パラメータで使用可能な動的変数を示します。

示された動的変数を使用して、アラーム・メッセージでパラメータの値をレンダリングします。

ヒント

HTMLエスケープは、プライマリ(短い)動的変数に対して発生します。たとえば、プライマリ動的変数{{title}}をtitleパラメータ値alarm for successRate < 0.99に使用すると、<文字は&lt;としてレンダリングされます。

HTMLエスケープを無効にするには、セカンダリ(より長い)動的変数を使用します。たとえば、セカンダリ動的変数{{{title}}}をtitleパラメータ値alarm for successRate < 0.99に使用すると、<文字が保持されます。

アラーム

アラームパラメータ 動的変数*
dedupekey
  • {{dedupekey}}
  • {{{dedupekey}}}
title
  • {{title}}
  • {{{title}}}
body (なし)
type
  • {{type}}
  • {{{type}}}
severity

次の表の「アラーム・メタデータ」の子パラメータseverityを参照してください。
timestampEpochMillis
  • {{timestampEpochMillis}}
  • {{{timestampEpochMillis}}}
timestamp
  • {{timestamp}}
  • {{{timestamp}}}
alarmMetaData

次の表の「アラーム・メタデータ」の子パラメータを参照してください。
version
  • {{version}}
  • {{{version}}}

*プライマリ(短い)動的変数はHTMLエスケープを実行します。セカンダリ(より長い)動的変数は、入力文字を保持します。

アラーム・メタデータ

アラームパラメータ 動的変数*
id
  • {{id}}
  • {{{id}}}
status
  • {{status}}
  • {{{status}}}
severity
  • {{severity}}
  • {{{severity}}}
namespace
  • {{namespace}}
  • {{{namespace}}}
query
  • {{query}}
  • {{{query}}}
totalMetricsFiring
  • {{totalMetricsFiring}}
  • {{{totalMetricsFiring}}}
dimensions
  • {{dimensions.<dimension-name>}}
  • {{{dimensions.<dimension-name>}}}

<dimension-name>は、ディメンションの名前です。

ディメンション名は、アラーム・メッセージでレンダリングされる動的変数に対して有効である必要があります。

動的変数は、最初の戻り値をレンダリングします。つまり、複数の個別値が返される場合は、最初の値がレンダリング用に選択されます。

例1: targetディメンションからの複数の個別値

  • {{dimensions.target}}
  • {{{dimensions.target}}}

値: target1、target2

関連RAWメッセージ・コンテンツ:

"target": "target1"
…
"target": "target2"

この例では、最初の戻り値target1がレンダリング用に選択されています。

例2: faultdomainディメンションの単一値

  • {{dimensions.faultdomain}}
  • {{{dimensions.faultdomain}}}

値: FAULT-DOMAIN-3

関連RAWメッセージ・コンテンツ:

"faultdomain":"FAULT-DOMAIN-3"
metricValues
  • {{metricValues}}
  • {{{metricValues}}}

値の例:

[{CpuUtilization[1m].mean():92,disUtil[1m].mean():95}]

関連RAWメッセージ・コンテンツ:

metricValues:[{CpuUtilization[1m].mean():92,disUtil[1m].mean():95}]
alarmUrl
  • {{alarmUrl}}
  • {{{alarmUrl}}}
alarmSummary
  • {{alarmSummary}}
  • {{{alarmSummary}}}
notificationType
  • {{notificationType}}
  • {{{notificationType}}}

*プライマリ(短い)動的変数はHTMLエスケープを実行します。セカンダリ(より長い)動的変数は、入力文字を保持します。

デフォルトのフォーマット済メッセージの外観

次の表に、フォーマットされたアラーム・メッセージの各アラーム・メッセージ・パラメータのデフォルト表示を示します。

アラーム

アラームパラメータ デフォルトのフォーマットされたメッセージの外観
dedupekey
title
body
type
severity デフォルトでは省略されます。
timestampEpochMillis デフォルトでは省略されます。
timestamp
alarmMetaData

次の表の「アラーム・メタデータ」の子パラメータを参照してください。
version デフォルトでは省略されます。

アラーム・メタデータ

アラームパラメータ デフォルトのフォーマットされたメッセージの外観
id
status
severity
namespace デフォルトでは省略されます。
query
totalMetricsFiring
dimensions
metricValues
alarmUrl
alarmSummary
notificationType デフォルトでは省略されます。