Updated on 2024-09-06 GMT+08:00

Creating a Message Template

In AOM, you can create message templates to customize notifications. When a preset notification rule is triggered, notifications can be sent to specified personnel by email, SMS, Lark, WeCom, DingTalk, voice call, WeLink, HTTP, or HTTPS. If no message template is created, the default message template will be used.

Function Introduction

  • Message templates for emails, SMS, WeCom, DingTalk, Lark, voice calls, WeLink, HTTP, and HTTPS are supported.

    WeLink message templates are not yet generally available. If you need this function, submit a service ticket.

  • Message templates can be customized. For details, see 3.c.

Precautions

  • You can create a maximum of 100 metric/event or log message templates. If the number of message templates of a certain type reaches 100, delete unnecessary ones.
  • By default, six message templates are preset and cannot be deleted or edited. If there is no custom message template, notifications are sent based on a preset message template by default.

Creating a Message Template

  1. Log in to the AOM 2.0 console.
  2. In the navigation pane, choose Alarm Management > Alarm Action Rules.
  3. On the Message Templates tab page, click Create.

    Figure 1 Creating a message template
    1. Enter a template name, message template type, and description, and specify an enterprise project.
      Table 1 Parameter description

      Parameter

      Description

      Template Name

      Name of a message template. Enter up to 100 characters and do not start or end with an underscore (_) or hyphen (-). Only digits, letters, underscores, and hyphens are allowed.

      Description

      Description of the template. Enter up to 1024 characters.

      Message Template

      Type of the message template. Option: Metric/Event or Log.

      Enterprise Project

      Enterprise project.

      • If you have selected All for Enterprise Project on the global settings page, select one from the drop-down list here.
      • If you have already selected an enterprise project on the global settings page, this option will be dimmed and cannot be changed.
    2. Select a language (for example, English).
    3. Customize the template content (default fields are automatically filled in when a metric/event message template is created). There are templates for emails, WeCom, DingTalk, and SMS. For details about metric/event templates, see Table 2. For details about log templates, see Table 3.
      • In addition to the message fields in the default template, the message template also supports custom fields. You need to specify the fields when reporting event alarms. For details, see the alarm reporting structs in the following message template.
      • Custom fields support the JSONPath format. Example: $event.metadata.case1 or $event.metadata.case[0].
      • In the upper right corner of the Body area, click Add Variables to add required variables.
      • If you select Emails, you can click Preview to view the final effect. On the Preview page, change the message topic if necessary.
      Table 2 Variables in the default message template

      Variable

      Description

      Definition

      Alarm Name

      Name of the alarm rule that is triggered.

      ${event_name}

      Alarm ID

      ID of the alarm rule that is triggered.

      ${id}

      Action Rule

      Name of the alarm action rule that triggers notification.

      ${action_rule}

      Occurred

      Time when the alarm or event is triggered.

      ${starts_at}

      Event Severity

      Alarm or event severity. Options: Critical, Major, Minor, and Warning.

      ${event_severity}

      Alarm Info

      Detailed alarm information.

      ${alarm_info}

      Resource Identifier

      Resource for which the alarm or event is triggered.

      ${resources}

      Custom tag

      Extended tag.

      $event.metadata.key1

      Suggestion

      Suggestion about handing the alarm. For non-custom reporting, "NA" is displayed.

      ${alarm_fix_suggestion_zh}

      Custom annotation

      Extended annotation.

      $event.annotations.key2

      Table 3 Log message template parameters

      Parameter

      Description

      Check Rule

      Example

      Topic

      Message topic.

      Customize the topic name or use variables. (Max. 512 characters)

      Only email templates need a topic name.

      test

      Body

      Message content.

      Add variables:

      • Original rule name: ${event_name}
      • Alarm severity: ${event_severity}
      • Occurrence time: ${starts_at}
      • Occurrence region: ${region_name}
      • Huawei Cloud account: ${domain_name}
      • Alarm source: $event.metadata.resource_provider
      • Resource type: $event.metadata.resource_type
      • Resource ID: ${resources}
      • Alarm status: $event.annotations.alarm_status
      • Expression: $event.annotations.condition_expression
      • Current value: $event.annotations.current_value
      • Statistical period: $event.annotations.frequency
      • Rule name: $event.annotations.alarm_rule_alias
      • Keyword variables
        1. Query time: $event.annotations.results[0].time
        2. Query logs:

          $event.annotations.results[0].raw_results

        3. Query URL:

          $event.annotations.results[0].url

        4. Log group/stream name: $event.annotations.results[0].resource_id
          NOTE:

          Only the original name of the log group or stream created for the first time can be added.

      • SQL variables
        1. Log group/stream names of chart 0: $event.annotations.results[0].resource_id
          NOTE:

          Only the original name of the log group or stream created for the first time can be added.

        2. Query statement of chart 0: $event.annotations.results[0].sql
        3. Query time of chart 0: $event.annotations.results[0].time
        4. Query URL of chart 0: $event.annotations.results[0].url
        5. Query logs of chart 0: $event.annotations.results[0].raw_results

      ${event_name}

      ${event_severity}

      ${starts_at}

      ${region_name}

    4. Click Confirm. The message template is created.

More Operations

After creating a message template, you can perform the operations listed in Table 4.

Table 4 Related operations

Operation

Description

Editing a message template

Click Edit in the Operation column.

Copying a message template

Click Copy in the Operation column.

Deleting a message template

  • To delete a single message template, click Delete in the Operation column in the row that contains the template, and then click Yes on the displayed page.
  • To delete one or more message templates, select them, click Delete above the template list, and then click Yes on the displayed page.
    NOTE:

    Before deleting a message template, delete the alarm action rules bound to it.

Searching for a message template

Enter a template name in the search box in the upper right corner and click .