Push Endpoint

Created:2024-09-23 Last Modified:2024-09-23

This document was translated by ChatGPT

#1. Push Endpoint

Push endpoints are systems or services used to receive and process alerts. Currently, four push methods are supported: Email push, HTTP push, Kafka push, PCAP policy, and Syslog push.

The following sections introduce these five push methods in detail.

#1.1 Email Push

Sends alert events to a specified email address, allowing you to stay informed of alerts by checking your email.

Email Push

Email Push

  • Create a new Email push: Fill in the relevant information. Once successfully created, it can be used when creating an alert policy.
  • List
    • Associated alert policies: Click the number to jump to the Alert Policy page to view the alert policies using this push endpoint.
    • Edit: Supports editing the push endpoint.
    • Delete: Supports deleting the push endpoint.

#1.1.1 Create a New Email Push

Create a New Email Push

Create a New Email Push

  • Email: Enter the email address to which alerts will be pushed.
  • Push title: Optional, supports entering an email subject.
  • For other fields, please refer to the Create a New Kafka Push section.

#1.2 HTTP Push

HTTP push sends data to a specified URL address via the HTTP protocol.

HTTP Push

HTTP Push

  • For page button usage, please refer to the Email Push section.

#1.2.1 Create a New HTTP Push

Create a New HTTP Push

Create a New HTTP Push

  • Push method: Required. Supports POST, PUT, and PATCH methods, with POST as the default.
  • Push URL: Required. Protocol names are case-insensitive. Supports HTTP and HTTPS protocols, with HTTPS supporting one-way authentication.
    • Note: Supports Jinja template rendering, e.g., http://10.0.0.1/
  • Header: Enter HTTP key-value pairs.
  • For other fields, please refer to the Create a New Kafka Push section.

#1.3 Kafka Push

Kafka push supports sending alert events to Kafka.

  • For page button usage, please refer to the Email Push section.

#1.3.1 Create a New Kafka Push

Create a New Kafka Push

Create a New Kafka Push

  • Name: Required. Enter the name of the push endpoint.
  • Team: Required. Select the team that can use this push endpoint.
  • Broker address pool: Required. Input format [address]:[port]. Supports multiple entries separated by commas.
  • Topic: Required. The Kafka topic for pushing alerts. Supports 1–256 printable characters.
  • SASL: Optional. Authentication method. If Plain is selected, a username and password must be provided.
  • Push content: Supports Jinja template rendering. For default push content, please refer to the parameter description.
  • Configuration level: Select the alert event levels to receive. For alert event level descriptions, please refer to the Edit Alert Policy section.
    • By default, all alert levels except Info will be pushed.
  • Push cycle: Required. Within the push cycle, only one alert event will be pushed for the same monitored object under the same alert policy.
  • Push frequency: The maximum number of times an alert event for the same monitored object under the same alert policy can be pushed. Exceeding this limit will stop further pushes.

#1.4 PCAP Policy

Supports adding alert policies to PCAP policies for alert monitoring via PCAP.

Create a New PCAP Policy

Create a New PCAP Policy

  • For page button usage, please refer to the Email Push section.
  • Create a new PCAP policy
    • Associated PCAP policy: Required. Associates the PCAP policy with alert events. Alerts generated by monitoring can be downloaded in the associated PCAP policy.
  • Enable PCAP policy: Select the alert event levels to push. If an alert of the selected level is generated, it will be pushed to the associated PCAP policy, and the PCAP policy will be automatically enabled.
    • Note: By default, alerts of Critical, Error, and Warning levels will be pushed.
  • Disable PCAP policy: Select the alert event levels to push. If an alert of the selected level is generated, the associated PCAP policy will be automatically disabled.
    • Note: By default, Recovery alerts will be pushed.
  • For other fields, please refer to the Create a New Kafka Push section.

#1.5 Syslog Push

Syslog push sends alert information to a log server via the Syslog protocol. It can notify operations personnel in real time of potential system failures or security incidents, helping them take timely action.

  • For page button usage, please refer to the Email Push section.

#1.5.1 Create a New Syslog Push

Create a New Syslog Push

Create a New Syslog Push

  • Push destination: Required. Input format [forwarding protocol]://[log server address]:[port]
    • Note: Supported protocols are UDP and TCP, with UDP as the default. Supported ports are 1–65535, with 514 as the default.
  • For other fields, please refer to the Create a New Kafka Push section.