Use alert callbacks for system events (Recommended)

Background information

Cloud Monitor pushes alert notifications to your specified URL using POST requests over HTTP or HTTPS. Add the following IP addresses to your firewall's whitelist. After you receive an alert notification, you can further process it based on its content.

Procedure

1. Create a push channel.

   This example uses a webhook as the push channel.

   1. Log on to the Cloud Monitor console.

   2. In the left-side navigation pane, choose Event Center > Event Subscription.

   3. On the Event Subscription page, click the Push Channel tab.

   4. On the Push Channel tab, click Create Push Channel.

   5. In the Create Push Channel panel, enter a Channel Name, set Target Type to Webhook, Request Method to POST, and Data Format to JSON. In the Address field, enter the alert callback URL and use the default settings for the other parameters.

   6. Click OK.

2. Create a subscription policy.

   This example subscribes to the Instance:InstanceFailure.Reboot:Executing system event for an ECS instance and pushes notifications to the webhook.

   1. Click the Subscription Policy tab.

   2. On the Subscription Policy tab, click Create Subscription Policy.

   3. On the Create Subscription Policy page, configure the parameters.

      • Basic Information: Enter a name for the subscription policy.

      • Alert Subscription: Set Subscription Type to System Event. In the Subscription Scope section, set Product to ECS and Event Name to Instance:InstanceFailure.Reboot:Executing. Use the default settings for the other parameters. This subscribes to the Instance:InstanceFailure.Reboot:Executing system event for all ECS instances under your account.

        Note

        For more information about the system events that ECS supports, see ECS.

      • Merge and Denoise: Use the default settings.

      • Notification: Do not configure Notification Configuration. Use the default notification method for Custom Notification Method.

        Note

        Because no alert group is configured for the Notification Settings, there are no alert contacts, and you will not receive alert notifications.

      • Push and Integration: Select the push channel created in Step 1.

   4. Click Submit.

3. Debug the event subscription.

   1. On the Subscription Policy tab, click Debug Event Subscription.

   2. In the Create Event Debugging panel, set Product to ECS and Name to Instance:InstanceFailure.Reboot:Executing.

      The system automatically generates the debug content in JSON format.

   3. Click OK.

      The system displays an Operation successful message. Cloud Monitor then automatically sends a test alert notification to the webhook URL that you specified.

Results

When a system event triggers an alert, Cloud Monitor sends the alert information to the URL that you specified. Webhooks support POST and GET request methods. The following examples show the request content for each method:

• POST JSON

  Parameter name: body.

  Sample content:

  {
    "userInfo": {
      "aliyunId": "test",
      "userIdSec": "te***st",
      "aliyunIdSec": "test***test",
      "nickName": "test",
      "nickNameSec": "te***st",
      "userName": "test",
      "userId": "test",
      "userNameSec": "te***st"
    },
    "subscription": {
      "subscriptionUuid": "testid",
      "conditions": [
        {
          "field": "source",
          "op": "EQ",
          "value": "SYS_EVENT"
        },
        {
          "field": "product",
          "op": "IN",
          "value": "ECS,Redis,RDS,Config,tag"
        }
      ],
      "relation": "AND"
    },
    "batchId": "testbatchid",
    "alert": {
      "alertStatus": "TRIGGERED",
      "groupId": "",
      "source": "SYS_EVENT",
      "eventContentMap": {
        "extensions": {
          "agentVersion": "test-version",
          "region": "cn-hangzhou",
          "azone": "cn-hangzhou-i",
          "uptime": 23000
        },
        "vmName": "i-testhost",
        "impact": "Alert",
        "opsCode": "InstanceStatusChange",
        "bizEventId": "test-event-id"
      },
      "dedupId": "test-id",
      "eventName": "CloudAssistant:FirstHeartbeat",
      "arn": "acs:ecs:cn-hangzhou:testuser:instance/i-testhost",
      "timestamp": 1704780333000,
      "traceId": "testid",
      "severity": "INFO",
      "product": "ECS",
      "eventRawContent": "{}",
      "eventType": "Notification",
      "userId": "test",
      "meta": {
        "sysEventMeta": {
          "regionNameEn": "cn-hangzhou",
          "resourceId": "acs:ecs:cn-hangzhou:test:instance/i-testhost",
          "product": "ECS",
          "eventNameEn": "CloudAssistant:FirstHeartbeat",
          "instanceName": "i-testhost",
          "level": "INFO",
          "resource": "",
          "regionNameZh": "华东1(杭州)",
          "groupId": "",
          "serviceTypeEn": "ECS",
          "eventType": "Notification",
          "serviceTypeZh": "云服务器ECS",
          "regionId": "cn-hangzhou",
          "eventTime": "20240109T140533.642+0800",
          "name": "CloudAssistant:FirstHeartbeat",
          "id": "testid",
          "status": "Normal",
          "eventNameZh": "云助手首次心跳事件"
        }
      }
    },
    "severity": "INFO",
    "strategyName": "eventwebhook",
    "userId": "test",
    "time": 1704780333000
  }

• GET JSON

  Parameter name: data.

  Sample content:

  {
    "userInfo": {
      "aliyunId": "test",
      "userIdSec": "te***st",
      "aliyunIdSec": "test***test",
      "nickName": "test",
      "nickNameSec": "te***st",
      "userName": "test",
      "userId": "test",
      "userNameSec": "te***st"
    },
    "subscription": {
      "subscriptionUuid": "testid",
      "conditions": [
        {
          "field": "source",
          "op": "EQ",
          "value": "SYS_EVENT"
        },
        {
          "field": "product",
          "op": "IN",
          "value": "ECS,Redis,RDS,Config,tag"
        }
      ],
      "relation": "AND"
    },
    "batchId": "testbatchid",
    "alert": {
      "alertStatus": "TRIGGERED",
      "groupId": "",
      "source": "SYS_EVENT",
      "eventContentMap": {
        "extensions": {
          "agentVersion": "test-version",
          "region": "cn-hangzhou",
          "azone": "cn-hangzhou-i",
          "uptime": 23000
        },
        "vmName": "i-testhost",
        "impact": "Alert",
        "opsCode": "InstanceStatusChange",
        "bizEventId": "test-event-id"
      },
      "dedupId": "test-id",
      "eventName": "CloudAssistant:FirstHeartbeat",
      "arn": "acs:ecs:cn-hangzhou:testuser:instance/i-testhost",
      "timestamp": 1704780333000,
      "traceId": "testid",
      "severity": "INFO",
      "product": "ECS",
      "eventRawContent": "{}",
      "eventType": "Notification",
      "userId": "test",
      "meta": {
        "sysEventMeta": {
          "regionNameEn": "cn-hangzhou",
          "resourceId": "acs:ecs:cn-hangzhou:test:instance/i-testhost",
          "product": "ECS",
          "eventNameEn": "CloudAssistant:FirstHeartbeat",
          "instanceName": "i-testhost",
          "level": "INFO",
          "resource": "",
          "regionNameZh": "华东1(杭州)",
          "groupId": "",
          "serviceTypeEn": "ECS",
          "eventType": "Notification",
          "serviceTypeZh": "云服务器ECS",
          "regionId": "cn-hangzhou",
          "eventTime": "20240109T140533.642+0800",
          "name": "CloudAssistant:FirstHeartbeat",
          "id": "testid",
          "status": "Normal",
          "eventNameZh": "云助手首次心跳事件"
        }
      }
    },
    "severity": "INFO",
    "strategyName": "eventwebhook",
    "userId": "test",
    "time": 1704780333000
  }

• POST FORM and GET FORM

  Parameter	Value
  userInfo	{ "aliyunId": "test", "userIdSec": "te***st", "aliyunIdSec": "test***test", "nickName": "test", "nickNameSec": "te***st", "userName": "test", "userId": "test", "userNameSec": "te***st" }
  subscription	{ "subscriptionUuid": "testid", "conditions": [ { "field": "source", "op": "EQ", "value": "SYS_EVENT" }, { "field": "product", "op": "IN", "value": "ECS,Redis,RDS,Config,tag" } ], "relation": "AND" }
  alert	{ "alertStatus": "TRIGGERED", "groupId": "", "source": "SYS_EVENT", "eventContentMap": { "extensions": { "agentVersion": "test-version", "region": "cn-hangzhou", "azone": "cn-hangzhou-i", "uptime": 23000 }, "vmName": "i-testhost", "impact": "Alert", "opsCode": "InstanceStatusChange", "bizEventId": "test-event-id" }, "dedupId": "test-id", "eventName": "CloudAssistant:FirstHeartbeat", "arn": "acs:ecs:cn-hangzhou:testuser:instance/i-testhost", "timestamp": 1704780333000, "traceId": "testid", "severity": "INFO", "product": "ECS", "eventRawContent": "{}", "eventType": "Notification", "userId": "test", "meta": { "sysEventMeta": { "regionNameEn": "cn-hangzhou", "resourceId": "acs:ecs:cn-hangzhou:test:instance/i-testhost", "product": "ECS", "eventNameEn": "CloudAssistant:FirstHeartbeat", "instanceName": "i-testhost", "level": "INFO", "resource": "", "regionNameZh": "华东1(杭州)", "groupId": "", "serviceTypeEn": "ECS", "eventType": "Notification", "serviceTypeZh": "云服务器ECS", "regionId": "cn-hangzhou", "eventTime": "20240109T140533.642+0800", "name": "CloudAssistant:FirstHeartbeat", "id": "testid", "status": "Normal", "eventNameZh": "云助手首次心跳事件" } } }
  severity	INFO
  strategyName	eventwebhook
  userId	test
  time	1704780333000

Field descriptions

Related documents

• Use alert callbacks for threshold-based alerts

• Receive alert notifications by using PagerDuty