Application Real-Time Monitoring Service:Integrate a custom alert source with ARMS

Quick start: minimal payload

Send the smallest possible payload to verify connectivity:

curl -k -H "Content-Type: application/json" -d '{
  "alertname": "test-alert",
  "severity": "P2",
  "message": "Test alert from custom source"
}' "https://alerts.aliyuncs.com/api/v1/integrations/custom/<your-api-key>"

Replace <your-api-key> with the API key copied in the previous step.

Full payload example

The following curl command sends a complete alert event for a scenario where TCP packet errors occur on a server. The payload includes nested metadata and equipment arrays:

curl -k -H "Content-Type: application/json" -d '{
  "trigger-type": "network",
  "trigger-location": "cn-hangzhou",
  "trigger-severity": "MAX",
  "trigger-policy": "package errors > 5%",
  "trigger-event": "inbound tcp package errors is 20%",
  "trigger-check": "tcp package error percentage",
  "trigger-value": "20",
  "trigger-time": "1629702922000",
  "metadata": [
    {
      "agent": "SERVER",
      "ip": "141.219.XX.XX",
      "fqdn": "websrv1.damenport.org",
      "microServiceId": "ms-login-2251",
      "accountId": "1504000433993",
      "service": "login-0"
    },
    {
      "agent": "CONTAINER",
      "ip": "172.1.XX.XX",
      "fqdn": "websrv2.damenport.org",
      "microServiceId": "ms-login-2252",
      "accountId": "129930302939",
      "service": "login-1"
    }
  ],
  "equipments": [
    {
      "equipmentId": "112"
    },
    {
      "equipmentId": "113"
    }
  ]
}' "https://alerts.aliyuncs.com/api/v1/integrations/custom/<your-api-key>"

The following table describes the key fields in this payload:

Replace the following placeholder with your actual value:

Send test data

1. On the Integration Details page, in the Event Mapping section, click Send Test Data.

2. In the Send Test Data dialog box, paste the JSON payload from your alert source and click Send.

   • If the message Uploaded. No events are generated. Configure mappings based on the original data. appears, the fields are not yet mapped. The raw data appears in the left pane for reference when configuring mappings.

   • If the message Uploaded. appears, the event was successfully reported. View it on the Alert Event History page. For more information, see View historical alert events.

   

3. In the Send Test Data dialog box, click Disable.

Configure batch processing (optional)

If your alert data contains an array node (such as metadata), you can process all elements in the array as a batch.

1. In the left pane of the Event Mapping section, click a data record to view its details.

2. In the right pane, under Select Root Node, select Use Batch Processing, then choose the array node to use as the root node.

How batch processing affects field mapping:

• Batch enabled (e.g., metadata as root node): All $.metadata[*].service values are iteratively mapped to the target ARMS field.

• Batch disabled: Only a specific element (e.g., $.metadata[0].service or $.metadata[1].service) maps to the target field.

Configure alert recovery events (optional)

To automatically clear alerts when a recovery event arrives, select Configure Alert Recovery Events and define field conditions.

When ARMS receives an event matching your conditions, it finds and clears the corresponding alerts. The condition field must be equivalent to alert severity in the event. The $.severity field cannot be used.

For example, the condition {$.eventType = "resolved"} clears all alerts in the integration where the eventType field equals resolved.

Map source fields to ARMS alert fields

In the Map Source Fields to Target Fields section, map each source field to an ARMS alert field.

The following table describes the ARMS alert fields:

Mapping methods

Click the Map icon next to a field to switch between these mapping methods:

• Direct: Maps one source field directly to one ARMS field.

• Series: Concatenates multiple source fields with a delimiter (special characters only) into one value, then maps it to an ARMS field. For example, joining $.trigger-type and $.trigger-policy with an underscore (_) produces network_package errors > 5%, which maps to alertname.

• Condition: Maps a source field based on a condition. For example:

  • If $.metadata[*].agent equals CONTAINER, map $.metadata[*].microServiceId to the ARMS service field.

  • If $.metadata[*].agent equals SERVER, map $.metadata[*].service to the ARMS service field.

• Mapping table: Converts source values to ARMS values through a lookup table. Used only for the severity field.