Skip to main content

Alerts

CubeAPM supports Alerts via HTTP API's.

Accessing Alert APIs​

The Alert Manager APIs are available on the Admin Port (default: 3199).

Example Endpoints:

  • http://<cubeapm-admin-host>:3199/api/alerts/api/v1/alerts

Supported HTTP APIs to Manages the Alerts​

API EndpointMethodDescription
/api/alerts/api/v1/rulesGET, POST, PUT, DELETEManage Alerts Rules.
/api/alerts/api/v1/receivergroupsGET, POST, PUT, DELETEManage receiver groups (Notification destinations).
/api/alerts/api/v1/mutegroupsGET, POST, PUT, DELETEManage mute schedules.

Authentication​

These APIs can be accessed programmatically using the Admin Port 3199.

Headers Required:

  • (Optional) Authorization: Bearer <ADMIN_TOKEN>
  • Content-Type: application/json
info

When http-token-admin is enabled in CubeAPM's config.properties, requests must include the corresponding token in the Authorization header when using curl to CREATE, UPDATE, or DELETE receiver groups or mute groups.

Key Concepts​

Alerts​

Alerts are the notifications themselves, sent when specific conditions are met.

  • Status: firing, pending, resolved.
  • Grouping: Custom labels provide context for which group the alert is associated with in the CubeAPM UI.
  • Inhibition: Active alerts can suppress new alerts with specific label sets.

Alert Rules​

Define the conditions under which alerts are generated.

  • Metrics Rules: Evaluate a PromQL/Metrics expression at regular intervals.
  • Log & Trace Rules: Evaluate log or trace patterns over time windows.
  • Grouping: Custom labels provide context to notifications. The special "group" label determines which group the alert is associated with in the CubeAPM UI.

Reffer Alert Rules for detailed information.

Receiver Groups​

Define where alerts are sent.

  • Supports multiple integration types: Slack, Email, PagerDuty, Webhook, MS Teams, Jira, OpsGenie, Google Chat.
  • A single group can contain multiple receivers.

Reffer Receiver Groups for detailed information.

Mute Groups​

Define when alerts are suppressed.

  • Allows scheduling mutes for specific time intervals.
  • Useful for maintenance windows, holidays, or off-hours.

Reffer Mute Groups for detailed information.