Netdata · Schema

Netdata Alert

A Netdata health alert/alarm instance

MonitoringObservabilityInfrastructureMetricsAlertsReal-TimeAPMDevOps

Properties

Name	Type	Description
id	integer	Unique alert identifier
name	string	Alert name as defined in health configuration
chart	string	Chart the alert applies to
family	string	Chart family
status	string	Current alert status
value	numbernull	Current metric value
units	string	Value units
info	string	Human-readable description
summary	string	Short summary
last_status_change	integer	Unix timestamp of last status change
last_updated	integer	Unix timestamp of last evaluation
node_id	string	ID of the node owning this alert
hostname	string	Hostname of the monitored node

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/netdata/main/json-schema/netdata-alert-schema.json",
  "title": "Netdata Alert",
  "description": "A Netdata health alert/alarm instance",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique alert identifier"
    },
    "name": {
      "type": "string",
      "description": "Alert name as defined in health configuration"
    },
    "chart": {
      "type": "string",
      "description": "Chart the alert applies to"
    },
    "family": {
      "type": "string",
      "description": "Chart family"
    },
    "status": {
      "type": "string",
      "enum": [
        "UNDEFINED",
        "UNINITIALIZED",
        "CLEAR",
        "WARNING",
        "CRITICAL",
        "REMOVED"
      ],
      "description": "Current alert status"
    },
    "value": {
      "type": [
        "number",
        "null"
      ],
      "description": "Current metric value"
    },
    "units": {
      "type": "string",
      "description": "Value units"
    },
    "info": {
      "type": "string",
      "description": "Human-readable description"
    },
    "summary": {
      "type": "string",
      "description": "Short summary"
    },
    "last_status_change": {
      "type": "integer",
      "description": "Unix timestamp of last status change"
    },
    "last_updated": {
      "type": "integer",
      "description": "Unix timestamp of last evaluation"
    },
    "node_id": {
      "type": "string",
      "description": "ID of the node owning this alert"
    },
    "hostname": {
      "type": "string",
      "description": "Hostname of the monitored node"
    }
  },
  "required": [
    "id",
    "name",
    "chart",
    "status"
  ]
}