tencent cloud

Feedback

Alarm Policy

Last updated: 2023-08-04 09:55:16

    Overview

    This document describes how to create, modify, enable, disable, copy, and delete an alarm policy in the alarm module of iPaaS.

    You can use an alarm policy to set a threshold alarm for metrics such as number of execution failures for a launched integration app. In this way, you will promptly receive notifications and can then take measures accordingly when an exception occurs. An alarm policy consists of alarm name, alarm object, alarm condition, and alarm notification template.

    Basic Concepts

    Term Definition
    Alarm policy It consists of alarm name, description (optional), alarm condition, alarm object, and alarm notification template.
    Alarm name It is the name of an alarm policy.
    Description The alarm description is a simple definition of the purpose of the alarm policy.
    Alarm object It can be a launched integration app.
    Alarm condition An alarm condition is a semantic condition consisting of metric, judgment logic, judgment condition, statistical period, and number of consecutive monitoring periods.
    Notification template A notification template can be quickly reused for multiple alarm policies, making it suitable for alarm receipt in various use cases. For more information, see Creating notification template.

    Use Limits

    Feature Limit
    Alarm object Up to three items can be added.
    Alarm condition Up to four items can be added.

    Directions

    Creating an alarm policy

    1. Log in to the iPaaS console.
    2. On the left sidebar, select Ops center > Alarm settings > Alarm policies to enter the alarm policy settings page.
    3. Click Create and configure a new alarm policy as detailed below:
      Configuration Type Configuration Item Description
      Configure basic information Policy name Custom policy name.
      Description Custom policy description.
      Configure alarm rule Alarm object
      • Select an app name. The alarm policy will be bound to the selected app and all of the app’s flows.
      • Select one or more target regions. Only the integration app in the selected regions will be triggered when the trigger condition is met.
      Alarm condition
      • Alarm trigger condition: It is a semantic condition consisting of metric, judgment logic, judgment condition, statistical period, and number of consecutive periods. You can set an alarm threshold based on the trend shown in the chart.
        For example, if the metric is set to `Number/Total number of app triggers`, judgment logic to `>`, judgment condition to `10`, statistical period to `1` minute, and the number of consecutive periods to `Last 3 periods`,
        the number/total number of app triggers is collected once every minute, and if the number/total number of triggers of an app is greater than 10 for three consecutive times, an alarm will be triggered.
      • Alarm frequency: You can set a repeated notification policy for each alarm rule. In this way, an alarm notification will be sent at a specified frequency when an alarm is triggered.
        Frequency options: Once every 5 minutes, once every 15 minutes, once every 30 minutes, once every 12 hours, and other frequency options.
      Configure alarm notification Notification template You can create a custom alarm notification template. Each alarm policy can be associated with one template. For more information, see Notification Template.
    4. After configuring the above information, click Confirm.
    Note:

    For the metric description, see Monitoring Metric Description.

    Modifying an alarm policy

    1. Log in to the iPaaS console and go to the Alarm policies page.
    2. Click the name of the target alarm policy.
    3. On the Edit alarm policy page, directly modify the relevant information and click Confirm.

    Enabling/Disabling an alarm policy

    You can use the alarm toggle feature to enable or disable an alarm policy as needed. This allows you to disable unwanted alarm policies to get rid of redundant messages. You can also quickly enable the disabled alarm policy again when needed.

    1. Log in to the iPaaS console.
    2. Select Alarm settings on the left sidebar and click Alarm policies to enter the management page.
    3. Click the toggle in the Status column of the target policy to enable or disable alarms for the policy.

    Copying an alarm policy

    1. Log in to the iPaaS console and go to the Alarm policies page.
    2. Click Copy in the Operation column of the target alarm policy.
    3. Modify the information of the copied alarm policy on the redirected page and click Complete.

    Deleting an alarm policy

    1. Log in to the iPaaS console and go to the Alarm policies page.
    2. Click Delete in the Operation column of the target alarm policy and confirm the deletion in the pop-up window.
      Note:

      Only disabled policies can be deleted.

    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support