Updated on 2023-11-29 GMT+08:00

Message Templates

A message template defines the format of alarm notification messages sent to subscribers. LTS provides built-in keywords_template and sql_template. Subscribers can select templates based on protocols. If the template of a specified protocol does not exist, the built-in template is used to send messages to subscribers of that protocol. When using a message template to send alarm notification messages, the system automatically replaces the template variables with the content in the alarm rule.

Creating a Message Template

  1. On the LTS console, choose Alarms > Message Templates.

    There are two built-in message templates. If no message content is configured in your selected template, LTS uses a built-in template instead.
    • keywords_template: keyword alarm template
    • sql_template: SQL alarm template

  2. Click Create. On the Create Message Template page, set the required parameters.

    Table 1 Message template parameters

    Parameter

    Description

    Verification Rule

    Example

    Template Name

    Message template name.

    Include digits, letters, underscores (_), and hyphens (-). Do not start or end with an underscore or hyphen. (Max. 100 characters)

    LTS-test

    Description

    Description of the template.

    Include digits, letters, and underscores (_). Do not start or end with an underscore. (Max. 1024 characters)

    -

    Message Header

    Default message header to be added in messages.

    • English
    • "Dear user,"

    Notification method

    Notification method.

    • Email
    • SMS
    • HTTP/HTTPS

    -

    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 Variable

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

        $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 log stream created for the first time can be added. The modified log group or log stream name cannot be added.

      5. Query custom field: $event.annotations.results[0].fields.xxx
        NOTE:

        xxx indicates a structured or built-in field (such as hostIP and hostName) in raw logs.

    • 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 log stream created for the first time can be added. The modified log group or log stream name cannot 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 log of chart 0: $event.annotations.results[0].raw_results

    Copy from Existing

    • keywords_template
    • sql_template
    • Custom templates (created with variables)

    ${event_name}

    ${event_severity}

    ${starts_at}

    ${region_name}

    • Create a message template.
      Figure 1 Creating a message template
    • Copy from an existing template.
      Figure 2 Copying a message template
    • The email content supports HTML tags and message preview.
    • Templates such as WeCom and DingTalk support markdown syntax and message preview.
    • You can create up to 100 message templates for AOM and LTS. If there are already 100 templates, delete unnecessary templates before creating a new one.

  3. When the configuration is complete, click OK.

Modifying a Message Template

  1. In the message template list, click in the row that contains the target template, and modify the template according to Table 1. The template name cannot be modified.

    Built-in message templates cannot be modified.

  2. Click OK.

Copying a Message Template

  1. In the message template list, click in the row that contains the target template, and set a new template name.
  2. Click OK.

Deleting a Message Template

Deleting a Single Message Template

  1. In the message template list, click in the Operation column of the target template.

    Built-in message templates cannot be deleted.

  2. Click OK.

Deleting Multiple Message Templates

  1. In the message template list, select the templates to be deleted and click Delete above the list.
  2. Click OK.