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

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

基本アラームの作成も参照してください。

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

ノート

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

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

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

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

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

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

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

動的変数の参照

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

    1. 「アラーム定義」リスト・ページで、操作するアラームを選択します。リスト・ページまたはアラームの確認に支援が必要な場合は、アラームのリストを参照してください。
    2. 「アクション」に移動して、「アラームの編集」を選択します。
    3. 「アラームの編集」ページで、動的変数を追加するフィールドを見つけます。
      • アラーム本文(bodyアラーム・メッセージ・パラメータ): アラーム・メッセージの本文内のフィールドとしてレンダリングされます。
      • アラーム・サマリー(alarmSummaryアラーム・メッセージ・パラメータ): アラーム・メッセージの本文内のフィールドとしてレンダリングされます。
      • 通知件名(titleアラーム・メッセージ・パラメータ): レンダリングはメッセージのタイプによって異なります。書式設定された電子メール・メッセージの場合、件名としてレンダリングされます。Slackメッセージの場合、タイトルとしてレンダリングされます。SMSメッセージの場合、メッセージの一部としてレンダリングされます。
        ノート

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

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

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

      動的変数の例:

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

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

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

    5. 「アラームの保存」を選択します。
  • 目的のフィールドで動的変数を使用するようにアラームを更新するには、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)を、動的変数を含む目的のテキストに設定します。