アラームメッセージでの動的変数の使用

モニタリングでアラームを更新して、メッセージにアラーム・メッセージ・パラメータの値を含めます。

動的変数のレンダリング方法

関連付けられた動的変数をサポートされたフィールドに挿入すると、アラーム・メッセージ・パラメータの値がアラーム・メッセージにレンダリングされます。たとえば、アラーム本体として次のように入力します。

{{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

アラーム・メッセージの次のイメージでは、アラーム本文(Body)は次のようにレンダリングされます: 2023-08-15T19:51:00Zの[CpuUtilization[1m].mean():92]が原因でしきい値が違反したためにトリガーされたCRITICALアラーム。

フォーマットされた電子メール メッセージでレンダリングされる動的変数の例。

動的変数は、body要素を含む通知に表示されます。

  • 動的変数に対してデータが使用可能な場合は、変数が解決され、データがその場所に表示されます。前述のアラーム・メッセージの例では、動的変数{{metricValues}}のかわりに[CpuUtilization[1m].mean():92]が表示されています。
  • 動的変数に使用可能なデータがない場合、その変数は未解決になり、コード化されて表示されます。たとえば、動的変数{{metricValues}}に使用可能なメトリック値がない場合(アラームがOK状態の場合など)、動的変数{{metricValues}}がアラーム・メッセージに表示されます。
  • SMSメッセージには本文要素がないため、動的変数は解決されません。

動的変数の検索

パラメータの動的変数を検索するには、動的変数を参照してください。

    1. ナビゲーション・メニューを開き、「監視および管理」をクリックします。「モニタリング」で、「アラーム定義」をクリックします。
    2. 目的のアラームの名前をクリックします。
    3. 「アラーム詳細」ページで、「アクション」をクリックし、「アラームの編集」を選択します。
    4. 「アラームの編集」ページで、動的変数を追加するフィールドを見つけます。
      • アラーム本体(bodyアラーム・メッセージ・パラメータ): アラーム・メッセージの本体内のフィールドとしてレンダリングされます。
      • アラーム・サマリー(alarmSummaryアラーム・メッセージ・パラメータ): アラーム・メッセージの本文内のフィールドとしてレンダリングされます。
      • 通知サブジェクト(titleアラーム・メッセージ・パラメータ): レンダリングはメッセージのタイプによって異なります。書式設定されたEメール・メッセージの場合、件名としてレンダリングされます。Slackメッセージの場合、タイトルとしてレンダリングされます。SMSメッセージの場合、メッセージの一部としてレンダリングされます。

      書式設定されたメッセージでのこれらのアラーム・メッセージ・パラメータのデフォルトの外観の詳細は、アラーム・メッセージの書式を参照してください。

    5. 必要なアラーム・メッセージ・パラメータの動的変数を挿入します。

      動的変数の例:

      {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

      パラメータの動的変数を検索するには、動的変数を参照してください。

      アラーム・パラメータにより長い動的変数を使用して、HTMLエスケープを無効にできます。たとえば、HTMLエスケープが無効になっているアラーム・メッセージでqueryパラメータの値をレンダリングするには、動的変数{{{query}}}を入力します。

    6. 「アラームの保存」をクリックします。
  • 必要なフィールドで動的変数を使用するようにアラームを更新するには、oci monitoring alarm updateコマンドおよび必須パラメータを使用します:

    oci monitoring alarm update --alarm-summary <text-including-dynamic-variables> --body <text-including-dynamic-variables> --notification-title <text-including-dynamic-variables> [...]

    改行あり:

    oci monitoring alarm update 
    --alarm-summary <text-including-dynamic-variables> 
    --body <text-including-dynamic-variables> 
    --notification-title <text-including-dynamic-variables> [...]

    CLIコマンドのパラメータおよび値の完全なリストは、モニタリングのコマンドライン・リファレンスを参照してください。

  • UpdateAlarm操作を実行して、必要なメッセージ形式オプションを使用するようにアラームを更新します。

    UpdateAlarmDetailsの詳細を定義する場合は、必要なフィールド(alarmSummarybodyまたはnotificationTitle)を、動的変数を含む必要なテキストに設定します。