Oracle Cloud Infrastructureドキュメント

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

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

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

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

次の表に、アラームメッセージのパラメータと、値の例を示します。

アラーム

アラームパラメータ 説明および例の値
dedupekey

文字列

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

値の例: exampleuniqueid

使用に関するコメント:

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

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

同じメッセージが複数回出現する場合は、dedupekeyとtimestampを一緒に使用します。
title

文字列

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

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

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

文字列

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

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

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

文字列

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

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

値の例: OK_TO_FIRING
severity

文字列

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

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

長い

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

値の例: 1684337663852
timestamp

文字列

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

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

オブジェクトの配列

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

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

int

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

値の例: 1.5

アラーム・メタデータ

アラームパラメータ 説明および例の値
id

文字列

アラームOCID。

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

文字列

アラームの状態。

有効な値: OK、FIRING
severity

文字列

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

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

文字列

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

値の例: oci_computeagent
query

文字列

アラームの構成済問合せまたは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

文字列

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

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

文字列

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

動的変数を使用した値の例: {{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

文字列

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

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

動的変数

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

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

ヒント

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

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

アラーム

アラームパラメータ 動的変数*
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>は、ディメンションの名前です。たとえば、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
  • 電子メール(書式設定済): メトリック違反しきい値の数
  • Slack: しきい値に違反するメトリック・ストリームの数
  • SMS: デフォルトでは省略されています
dimensions
metricValues
alarmUrl
alarmSummary
  • 電子メール(書式設定済): アラーム・サマリー(メッセージの下部にあるボタン)
  • Slack: デフォルトでは省略されています
  • SMS: デフォルトでは省略されています
notificationType デフォルトで省略