{ "description": "Alert is the Schema for the Alerts API.\n\nNote that this is only for the latest version of the Alerts API. If your account has been created before March 2025, make sure that your account has been migrated before using advanced features of alerts.\n\n**Added in v0.4.0**", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "type": "object" }, "spec": { "description": "AlertSpec defines the desired state of a Coralogix Alert. For more info check - https://coralogix.com/docs/getting-started-with-coralogix-alerts/.", "properties": { "alertType": { "description": "Type of alert.", "properties": { "flow": { "description": "Flow alerts chaining multiple alerts together.", "properties": { "enforceSuppression": { "default": false, "type": "boolean" }, "stages": { "items": { "description": "Stages to go through.", "properties": { "flowStagesType": { "description": "Type of stage.", "properties": { "groups": { "items": { "description": "Flow stage grouping.", "properties": { "alertDefs": { "description": "Alerts to group.", "items": { "description": "Alert references.", "properties": { "alertRef": { "description": "Reference for an alert, backend or Kubernetes resource", "properties": { "backendRef": { "description": "Coralogix id reference.", "properties": { "id": { "description": "Alert ID.", "type": "string" }, "name": { "description": "Name of the alert.", "type": "string" } }, "type": "object", "x-kubernetes-validations": [ { "message": "One of id or name is required", "rule": "has(self.id) != has(self.name)" } ], "additionalProperties": false }, "resourceRef": { "description": "Kubernetes resource reference.", "properties": { "name": { "description": "Name of the resource.", "type": "string" }, "namespace": { "description": "Kubernetes namespace.", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false } }, "type": "object", "x-kubernetes-validations": [ { "message": "Exactly one of backendRef or resourceRef must be set", "rule": "has(self.backendRef) != has(self.resourceRef)" } ], "additionalProperties": false }, "not": { "default": false, "description": "Inversion.", "type": "boolean" } }, "required": [ "alertRef", "not" ], "type": "object", "additionalProperties": false }, "type": "array" }, "alertsOp": { "description": "Operation for the alert.", "enum": [ "and", "or" ], "type": "string" }, "nextOp": { "description": "Link to the next alert.", "enum": [ "and", "or" ], "type": "string" } }, "required": [ "alertDefs", "alertsOp", "nextOp" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "required": [ "groups" ], "type": "object", "additionalProperties": false }, "timeframeMs": { "format": "int64", "type": "integer" }, "timeframeType": { "description": "Type of timeframe.", "enum": [ "unspecified", "upTo" ], "type": "string" } }, "required": [ "flowStagesType", "timeframeMs", "timeframeType" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "required": [ "enforceSuppression", "stages" ], "type": "object", "additionalProperties": false }, "logsAnomaly": { "description": "Anomaly alerts for logs.", "properties": { "anomalyAlertSettings": { "description": "Settings for anomaly alerts.", "properties": { "percentageOfDeviation": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "The percentage of deviation from the baseline for triggering the alert.", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true } }, "required": [ "percentageOfDeviation" ], "type": "object", "additionalProperties": false }, "evaluationDelayMs": { "description": "Evaluation delay in milliseconds.", "format": "int32", "type": "integer" }, "logsFilter": { "description": "Filter to filter the logs with.", "properties": { "simpleFilter": { "description": "Simple lucene filter.", "properties": { "labelFilters": { "description": "Filter for labels.", "properties": { "applicationName": { "description": "Application name to filter for.", "items": { "description": "Label filter specifications", "properties": { "operation": { "default": "is", "description": "Operation to apply.", "enum": [ "is", "includes", "endsWith", "startsWith" ], "type": "string" }, "value": { "description": "The value", "minLength": 0, "type": "string" } }, "required": [ "operation", "value" ], "type": "object", "additionalProperties": false }, "type": "array" }, "severity": { "description": "Severity to filter for.", "items": { "description": "How severe a log is.", "enum": [ "debug", "info", "warning", "error", "critical", "verbose" ], "type": "string" }, "type": "array" }, "subsystemName": { "description": "Subsystem name to filter for.", "items": { "description": "Label filter specifications", "properties": { "operation": { "default": "is", "description": "Operation to apply.", "enum": [ "is", "includes", "endsWith", "startsWith" ], "type": "string" }, "value": { "description": "The value", "minLength": 0, "type": "string" } }, "required": [ "operation", "value" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "luceneQuery": { "description": "The query.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "notificationPayloadFilter": { "description": "Filter for the notification payload.", "items": { "type": "string" }, "type": "array" }, "rules": { "description": "Rules that match the alert to the data.", "items": { "description": "The rule to match the alert's conditions.", "properties": { "condition": { "description": "Condition to match to.", "properties": { "conditionType": { "default": "moreThanUsual", "description": "Condition type.", "enum": [ "moreThanUsual" ], "type": "string" }, "minimumThreshold": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "default": 0, "description": "Minimum value", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "timeWindow": { "description": "Time window to evaluate.", "properties": { "specificValue": { "description": "Logs time window type", "enum": [ "5m", "10m", "15m", "20m", "30m", "1h", "2h", "4h", "6h", "12h", "24h", "36h" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "minimumThreshold", "timeWindow" ], "type": "object", "additionalProperties": false } }, "required": [ "condition" ], "type": "object", "additionalProperties": false }, "minItems": 1, "type": "array" } }, "required": [ "rules" ], "type": "object", "additionalProperties": false }, "logsImmediate": { "description": "Immediate alerts for logs.", "properties": { "logsFilter": { "description": "Filter to filter the logs with.", "properties": { "simpleFilter": { "description": "Simple lucene filter.", "properties": { "labelFilters": { "description": "Filter for labels.", "properties": { "applicationName": { "description": "Application name to filter for.", "items": { "description": "Label filter specifications", "properties": { "operation": { "default": "is", "description": "Operation to apply.", "enum": [ "is", "includes", "endsWith", "startsWith" ], "type": "string" }, "value": { "description": "The value", "minLength": 0, "type": "string" } }, "required": [ "operation", "value" ], "type": "object", "additionalProperties": false }, "type": "array" }, "severity": { "description": "Severity to filter for.", "items": { "description": "How severe a log is.", "enum": [ "debug", "info", "warning", "error", "critical", "verbose" ], "type": "string" }, "type": "array" }, "subsystemName": { "description": "Subsystem name to filter for.", "items": { "description": "Label filter specifications", "properties": { "operation": { "default": "is", "description": "Operation to apply.", "enum": [ "is", "includes", "endsWith", "startsWith" ], "type": "string" }, "value": { "description": "The value", "minLength": 0, "type": "string" } }, "required": [ "operation", "value" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "luceneQuery": { "description": "The query.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "notificationPayloadFilter": { "description": "Filter for the notification payload.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "logsNewValue": { "description": "Alerts when a new log value appears.", "properties": { "logsFilter": { "description": "Filter to filter the logs with.", "properties": { "simpleFilter": { "description": "Simple lucene filter.", "properties": { "labelFilters": { "description": "Filter for labels.", "properties": { "applicationName": { "description": "Application name to filter for.", "items": { "description": "Label filter specifications", "properties": { "operation": { "default": "is", "description": "Operation to apply.", "enum": [ "is", "includes", "endsWith", "startsWith" ], "type": "string" }, "value": { "description": "The value", "minLength": 0, "type": "string" } }, "required": [ "operation", "value" ], "type": "object", "additionalProperties": false }, "type": "array" }, "severity": { "description": "Severity to filter for.", "items": { "description": "How severe a log is.", "enum": [ "debug", "info", "warning", "error", "critical", "verbose" ], "type": "string" }, "type": "array" }, "subsystemName": { "description": "Subsystem name to filter for.", "items": { "description": "Label filter specifications", "properties": { "operation": { "default": "is", "description": "Operation to apply.", "enum": [ "is", "includes", "endsWith", "startsWith" ], "type": "string" }, "value": { "description": "The value", "minLength": 0, "type": "string" } }, "required": [ "operation", "value" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "luceneQuery": { "description": "The query.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "notificationPayloadFilter": { "description": "Filter for the notification payload.", "items": { "type": "string" }, "type": "array" }, "rules": { "description": "Rules that match the alert to the data.", "items": { "description": "The rule to match the alert's conditions.", "properties": { "condition": { "description": "Condition to match to", "properties": { "keypathToTrack": { "description": "Where to look", "type": "string" }, "timeWindow": { "description": "Which time window.", "properties": { "specificValue": { "description": "Time windows.", "enum": [ "12h", "24h", "48h", "72h", "1w", "1mo", "2mo", "3mo" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "keypathToTrack", "timeWindow" ], "type": "object", "additionalProperties": false } }, "required": [ "condition" ], "type": "object", "additionalProperties": false }, "minItems": 1, "type": "array" } }, "required": [ "logsFilter", "rules" ], "type": "object", "additionalProperties": false }, "logsRatioThreshold": { "description": "Alerts for when a log exceeds a defined ratio.", "properties": { "denominator": { "description": "A filter for logs.", "properties": { "simpleFilter": { "description": "Simple lucene filter.", "properties": { "labelFilters": { "description": "Filter for labels.", "properties": { "applicationName": { "description": "Application name to filter for.", "items": { "description": "Label filter specifications", "properties": { "operation": { "default": "is", "description": "Operation to apply.", "enum": [ "is", "includes", "endsWith", "startsWith" ], "type": "string" }, "value": { "description": "The value", "minLength": 0, "type": "string" } }, "required": [ "operation", "value" ], "type": "object", "additionalProperties": false }, "type": "array" }, "severity": { "description": "Severity to filter for.", "items": { "description": "How severe a log is.", "enum": [ "debug", "info", "warning", "error", "critical", "verbose" ], "type": "string" }, "type": "array" }, "subsystemName": { "description": "Subsystem name to filter for.", "items": { "description": "Label filter specifications", "properties": { "operation": { "default": "is", "description": "Operation to apply.", "enum": [ "is", "includes", "endsWith", "startsWith" ], "type": "string" }, "value": { "description": "The value", "minLength": 0, "type": "string" } }, "required": [ "operation", "value" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "luceneQuery": { "description": "The query.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "denominatorAlias": { "type": "string" }, "evaluationDelayMs": { "description": "Evaluation delay in milliseconds.", "format": "int32", "type": "integer" }, "groupByFor": { "description": "Which side of the ratio the group-by keys are applied to.", "enum": [ "both", "numeratorOnly", "denominatorOnly" ], "type": "string" }, "ignoreInfinity": { "default": false, "description": "Ignore infinity on the threshold value.", "type": "boolean" }, "notificationPayloadFilter": { "description": "Filter for the notification payload.", "items": { "type": "string" }, "type": "array" }, "numerator": { "description": "A filter for logs.", "properties": { "simpleFilter": { "description": "Simple lucene filter.", "properties": { "labelFilters": { "description": "Filter for labels.", "properties": { "applicationName": { "description": "Application name to filter for.", "items": { "description": "Label filter specifications", "properties": { "operation": { "default": "is", "description": "Operation to apply.", "enum": [ "is", "includes", "endsWith", "startsWith" ], "type": "string" }, "value": { "description": "The value", "minLength": 0, "type": "string" } }, "required": [ "operation", "value" ], "type": "object", "additionalProperties": false }, "type": "array" }, "severity": { "description": "Severity to filter for.", "items": { "description": "How severe a log is.", "enum": [ "debug", "info", "warning", "error", "critical", "verbose" ], "type": "string" }, "type": "array" }, "subsystemName": { "description": "Subsystem name to filter for.", "items": { "description": "Label filter specifications", "properties": { "operation": { "default": "is", "description": "Operation to apply.", "enum": [ "is", "includes", "endsWith", "startsWith" ], "type": "string" }, "value": { "description": "The value", "minLength": 0, "type": "string" } }, "required": [ "operation", "value" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "luceneQuery": { "description": "The query.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "numeratorAlias": { "type": "string" }, "rules": { "description": "Rules that match the alert to the data.", "items": { "description": "The rule to match the alert's conditions.", "properties": { "condition": { "description": "Condition to match", "properties": { "conditionType": { "description": "Condition to evaluate with.", "enum": [ "moreThan", "lessThan" ], "type": "string" }, "threshold": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Threshold to pass.", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "timeWindow": { "description": "Time window to evaluate.", "properties": { "specificValue": { "description": "Time window type.", "enum": [ "5m", "10m", "15m", "30m", "1h", "2h", "4h", "6h", "12h", "24h", "36h" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "conditionType", "threshold", "timeWindow" ], "type": "object", "additionalProperties": false }, "override": { "description": "Override alert properties", "properties": { "priority": { "description": "Priority to override it", "enum": [ "p1", "p2", "p3", "p4", "p5" ], "type": "string" } }, "required": [ "priority" ], "type": "object", "additionalProperties": false } }, "required": [ "condition" ], "type": "object", "additionalProperties": false }, "minItems": 1, "type": "array" }, "undetectedValuesManagement": { "description": "How to work with undetected values.", "properties": { "autoRetireTimeframe": { "default": "never", "description": "Automatically retire the alerts after this time.", "enum": [ "never", "5m", "10m", "1h", "2h", "6h", "12h", "24h" ], "type": "string" }, "triggerUndetectedValues": { "default": false, "description": "Deactivate triggering the alert on undetected values.", "type": "boolean" } }, "required": [ "autoRetireTimeframe", "triggerUndetectedValues" ], "type": "object", "additionalProperties": false } }, "required": [ "denominator", "denominatorAlias", "numerator", "numeratorAlias", "rules" ], "type": "object", "x-kubernetes-validations": [ { "message": "undetectedValuesManagement requires at least one rule with a lessThan condition", "rule": "!has(self.undetectedValuesManagement) || self.rules.exists(r, r.condition.conditionType == 'lessThan')" } ], "additionalProperties": false }, "logsThreshold": { "description": "Alerts for when a log crosses a threshold.", "properties": { "evaluationDelayMs": { "description": "Evaluation delay in milliseconds.", "format": "int32", "type": "integer" }, "logsFilter": { "description": "Filter to filter the logs with.", "properties": { "simpleFilter": { "description": "Simple lucene filter.", "properties": { "labelFilters": { "description": "Filter for labels.", "properties": { "applicationName": { "description": "Application name to filter for.", "items": { "description": "Label filter specifications", "properties": { "operation": { "default": "is", "description": "Operation to apply.", "enum": [ "is", "includes", "endsWith", "startsWith" ], "type": "string" }, "value": { "description": "The value", "minLength": 0, "type": "string" } }, "required": [ "operation", "value" ], "type": "object", "additionalProperties": false }, "type": "array" }, "severity": { "description": "Severity to filter for.", "items": { "description": "How severe a log is.", "enum": [ "debug", "info", "warning", "error", "critical", "verbose" ], "type": "string" }, "type": "array" }, "subsystemName": { "description": "Subsystem name to filter for.", "items": { "description": "Label filter specifications", "properties": { "operation": { "default": "is", "description": "Operation to apply.", "enum": [ "is", "includes", "endsWith", "startsWith" ], "type": "string" }, "value": { "description": "The value", "minLength": 0, "type": "string" } }, "required": [ "operation", "value" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "luceneQuery": { "description": "The query.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "noDataPolicy": { "description": "Policy for handling missing data.", "properties": { "autoRetireSeconds": { "description": "The timeframe in seconds for auto retiring values that were detected as no-data.\nMust be a multiple of 60 seconds.", "format": "int32", "type": "integer" }, "state": { "description": "State to use when no data is present.", "enum": [ "ok", "alerting", "keepLast", "noData" ], "type": "string" } }, "required": [ "state" ], "type": "object", "additionalProperties": false }, "notificationPayloadFilter": { "description": "Filter for the notification payload.", "items": { "type": "string" }, "type": "array" }, "rules": { "description": "Rules that match the alert to the data.", "items": { "description": "The rule to match the alert's conditions.", "properties": { "condition": { "description": "Condition to match", "properties": { "logsThresholdConditionType": { "description": "Condition type.", "enum": [ "moreThan", "lessThan" ], "type": "string" }, "threshold": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Threshold to match to.", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "timeWindow": { "description": "Time window in which the condition is checked.", "properties": { "specificValue": { "description": "Logs time window type", "enum": [ "5m", "10m", "15m", "20m", "30m", "1h", "2h", "4h", "6h", "12h", "24h", "36h" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "logsThresholdConditionType", "threshold", "timeWindow" ], "type": "object", "additionalProperties": false }, "override": { "description": "Alert overrides.", "properties": { "priority": { "description": "Priority to override it", "enum": [ "p1", "p2", "p3", "p4", "p5" ], "type": "string" } }, "required": [ "priority" ], "type": "object", "additionalProperties": false } }, "required": [ "condition" ], "type": "object", "additionalProperties": false }, "minItems": 1, "type": "array" }, "undetectedValuesManagement": { "description": "How to work with undetected values.", "properties": { "autoRetireTimeframe": { "default": "never", "description": "Automatically retire the alerts after this time.", "enum": [ "never", "5m", "10m", "1h", "2h", "6h", "12h", "24h" ], "type": "string" }, "triggerUndetectedValues": { "default": false, "description": "Deactivate triggering the alert on undetected values.", "type": "boolean" } }, "required": [ "autoRetireTimeframe", "triggerUndetectedValues" ], "type": "object", "additionalProperties": false } }, "required": [ "rules" ], "type": "object", "additionalProperties": false }, "logsTimeRelativeThreshold": { "description": "Alerts are sent when the number of logs matching a filter is more than or less than a threshold over a specific time window.", "properties": { "evaluationDelayMs": { "description": "Evaluation delay in milliseconds.", "format": "int32", "type": "integer" }, "ignoreInfinity": { "default": false, "description": "Ignore infinity on the threshold value.", "type": "boolean" }, "logsFilter": { "description": "A filter for logs.", "properties": { "simpleFilter": { "description": "Simple lucene filter.", "properties": { "labelFilters": { "description": "Filter for labels.", "properties": { "applicationName": { "description": "Application name to filter for.", "items": { "description": "Label filter specifications", "properties": { "operation": { "default": "is", "description": "Operation to apply.", "enum": [ "is", "includes", "endsWith", "startsWith" ], "type": "string" }, "value": { "description": "The value", "minLength": 0, "type": "string" } }, "required": [ "operation", "value" ], "type": "object", "additionalProperties": false }, "type": "array" }, "severity": { "description": "Severity to filter for.", "items": { "description": "How severe a log is.", "enum": [ "debug", "info", "warning", "error", "critical", "verbose" ], "type": "string" }, "type": "array" }, "subsystemName": { "description": "Subsystem name to filter for.", "items": { "description": "Label filter specifications", "properties": { "operation": { "default": "is", "description": "Operation to apply.", "enum": [ "is", "includes", "endsWith", "startsWith" ], "type": "string" }, "value": { "description": "The value", "minLength": 0, "type": "string" } }, "required": [ "operation", "value" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "luceneQuery": { "description": "The query.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "notificationPayloadFilter": { "description": "Filter for the notification payload.", "items": { "type": "string" }, "type": "array" }, "rules": { "description": "Rules that match the alert to the data.", "items": { "description": "The rule to match the alert's conditions.", "properties": { "condition": { "description": "The condition to match to.", "properties": { "comparedTo": { "description": "Comparison window.", "enum": [ "previousHour", "sameHourYesterday", "sameHourLastWeek", "yesterday", "sameDayLastWeek", "sameDayLastMonth" ], "type": "string" }, "conditionType": { "description": "How to compare.", "enum": [ "moreThan", "lessThan" ], "type": "string" }, "threshold": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Threshold to match.", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true } }, "required": [ "comparedTo", "conditionType", "threshold" ], "type": "object", "additionalProperties": false }, "override": { "description": "Override alert properties", "properties": { "priority": { "description": "Priority to override it", "enum": [ "p1", "p2", "p3", "p4", "p5" ], "type": "string" } }, "required": [ "priority" ], "type": "object", "additionalProperties": false } }, "required": [ "condition" ], "type": "object", "additionalProperties": false }, "minItems": 1, "type": "array" }, "undetectedValuesManagement": { "description": "How to work with undetected values.", "properties": { "autoRetireTimeframe": { "default": "never", "description": "Automatically retire the alerts after this time.", "enum": [ "never", "5m", "10m", "1h", "2h", "6h", "12h", "24h" ], "type": "string" }, "triggerUndetectedValues": { "default": false, "description": "Deactivate triggering the alert on undetected values.", "type": "boolean" } }, "required": [ "autoRetireTimeframe", "triggerUndetectedValues" ], "type": "object", "additionalProperties": false } }, "required": [ "ignoreInfinity", "logsFilter", "rules" ], "type": "object", "additionalProperties": false }, "logsUniqueCount": { "description": "Alerts for unique count changes.", "properties": { "logsFilter": { "description": "Filter to filter the logs with.", "properties": { "simpleFilter": { "description": "Simple lucene filter.", "properties": { "labelFilters": { "description": "Filter for labels.", "properties": { "applicationName": { "description": "Application name to filter for.", "items": { "description": "Label filter specifications", "properties": { "operation": { "default": "is", "description": "Operation to apply.", "enum": [ "is", "includes", "endsWith", "startsWith" ], "type": "string" }, "value": { "description": "The value", "minLength": 0, "type": "string" } }, "required": [ "operation", "value" ], "type": "object", "additionalProperties": false }, "type": "array" }, "severity": { "description": "Severity to filter for.", "items": { "description": "How severe a log is.", "enum": [ "debug", "info", "warning", "error", "critical", "verbose" ], "type": "string" }, "type": "array" }, "subsystemName": { "description": "Subsystem name to filter for.", "items": { "description": "Label filter specifications", "properties": { "operation": { "default": "is", "description": "Operation to apply.", "enum": [ "is", "includes", "endsWith", "startsWith" ], "type": "string" }, "value": { "description": "The value", "minLength": 0, "type": "string" } }, "required": [ "operation", "value" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "luceneQuery": { "description": "The query.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "maxUniqueCountPerGroupByKey": { "format": "int64", "type": "integer" }, "notificationPayloadFilter": { "description": "Filter for the notification payload.", "items": { "type": "string" }, "type": "array" }, "rules": { "description": "Rules that match the alert to the data.", "items": { "description": "The rule to match the alert's conditions.", "properties": { "condition": { "description": "Condition to match to.", "properties": { "threshold": { "description": "Threshold to cross", "format": "int64", "type": "integer" }, "timeWindow": { "description": "Time window to evaluate.", "properties": { "specificValue": { "description": "Time windows for Logs Unique Count", "enum": [ "1m", "5m", "10m", "15m", "20m", "30m", "1h", "2h", "4h", "6h", "12h", "24h", "36h" ], "type": "string" } }, "required": [ "specificValue" ], "type": "object", "additionalProperties": false } }, "required": [ "threshold", "timeWindow" ], "type": "object", "additionalProperties": false } }, "required": [ "condition" ], "type": "object", "additionalProperties": false }, "minItems": 1, "type": "array" }, "uniqueCountKeypath": { "type": "string" } }, "required": [ "logsFilter", "rules", "uniqueCountKeypath" ], "type": "object", "additionalProperties": false }, "metricAnomaly": { "description": "Anomaly alerts for metrics.", "properties": { "anomalyAlertSettings": { "description": "Settings for anomaly alerts.", "properties": { "percentageOfDeviation": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "The percentage of deviation from the baseline for triggering the alert.", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true } }, "required": [ "percentageOfDeviation" ], "type": "object", "additionalProperties": false }, "evaluationDelayMs": { "description": "Evaluation delay in milliseconds.", "format": "int32", "type": "integer" }, "metricFilter": { "description": "PromQL filter for metrics", "properties": { "promql": { "description": "PromQL query: https://coralogix.com/academy/mastering-metrics-in-coralogix/promql-fundamentals/", "type": "string" } }, "type": "object", "additionalProperties": false }, "rules": { "description": "Rules that match the alert to the data.", "items": { "description": "The rule to match the alert's conditions.", "properties": { "condition": { "description": "Condition to match to.", "properties": { "conditionType": { "description": "Condition type.", "enum": [ "moreThanUsual", "lessThanUsual" ], "type": "string" }, "forOverPct": { "description": "Percentage for the threshold", "format": "int64", "maximum": 100, "type": "integer" }, "minNonNullValuesPct": { "description": "Replace with a number", "format": "int64", "maximum": 100, "type": "integer" }, "ofTheLast": { "description": "Time window to match within", "properties": { "specificValue": { "description": "Time window type.", "enum": [ "1m", "5m", "10m", "15m", "20m", "30m", "1h", "2h", "4h", "6h", "12h", "24h", "36h" ], "type": "string" } }, "required": [ "specificValue" ], "type": "object", "additionalProperties": false }, "threshold": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Threshold to clear.", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true } }, "required": [ "conditionType", "forOverPct", "minNonNullValuesPct", "ofTheLast", "threshold" ], "type": "object", "additionalProperties": false } }, "required": [ "condition" ], "type": "object", "additionalProperties": false }, "minItems": 1, "type": "array" } }, "required": [ "metricFilter", "rules" ], "type": "object", "additionalProperties": false }, "metricThreshold": { "description": "Alerts for when a metric crosses a threshold.", "properties": { "evaluationDelayMs": { "description": "Evaluation delay in milliseconds.", "format": "int32", "type": "integer" }, "metricFilter": { "description": "Filter for metrics", "properties": { "promql": { "description": "PromQL query: https://coralogix.com/academy/mastering-metrics-in-coralogix/promql-fundamentals/", "type": "string" } }, "type": "object", "additionalProperties": false }, "missingValues": { "description": "Missing values strategies.", "properties": { "minNonNullValuesPct": { "description": "Replace with a number", "format": "int64", "maximum": 100, "type": "integer" }, "replaceWithZero": { "default": false, "description": "Replace missing values with 0s", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "noDataPolicy": { "description": "Policy for handling missing data.", "properties": { "autoRetireSeconds": { "description": "The timeframe in seconds for auto retiring values that were detected as no-data.\nMust be a multiple of 60 seconds.", "format": "int32", "type": "integer" }, "state": { "description": "State to use when no data is present.", "enum": [ "ok", "alerting", "keepLast", "noData" ], "type": "string" } }, "required": [ "state" ], "type": "object", "additionalProperties": false }, "rules": { "description": "Rules that match the alert to the data.", "items": { "description": "Rules that match the alert to the data.", "properties": { "condition": { "description": "Conditions to match for the rule.", "properties": { "conditionType": { "description": "ConditionType type.", "enum": [ "moreThan", "lessThan", "moreThanOrEquals", "lessThanOrEquals" ], "type": "string" }, "forOverPct": { "format": "int32", "maximum": 100, "type": "integer" }, "ofTheLast": { "description": "Time window type.", "properties": { "dynamicDuration": { "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "specificValue": { "description": "Time window type.", "enum": [ "1m", "5m", "10m", "15m", "20m", "30m", "1h", "2h", "4h", "6h", "12h", "24h", "36h" ], "type": "string" } }, "type": "object", "x-kubernetes-validations": [ { "message": "Exactly one of specificValue or dynamicDuration is required", "rule": "has(self.specificValue) != has(self.dynamicDuration)" } ], "additionalProperties": false }, "threshold": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true } }, "required": [ "conditionType", "forOverPct", "ofTheLast", "threshold" ], "type": "object", "additionalProperties": false }, "override": { "description": "Alert property overrides", "properties": { "priority": { "description": "Priority to override it", "enum": [ "p1", "p2", "p3", "p4", "p5" ], "type": "string" } }, "required": [ "priority" ], "type": "object", "additionalProperties": false } }, "required": [ "condition" ], "type": "object", "additionalProperties": false }, "minItems": 1, "type": "array" }, "undetectedValuesManagement": { "description": "How to work with undetected values.", "properties": { "autoRetireTimeframe": { "default": "never", "description": "Automatically retire the alerts after this time.", "enum": [ "never", "5m", "10m", "1h", "2h", "6h", "12h", "24h" ], "type": "string" }, "triggerUndetectedValues": { "default": false, "description": "Deactivate triggering the alert on undetected values.", "type": "boolean" } }, "required": [ "autoRetireTimeframe", "triggerUndetectedValues" ], "type": "object", "additionalProperties": false } }, "required": [ "metricFilter", "missingValues", "rules" ], "type": "object", "additionalProperties": false }, "sloThreshold": { "description": "Alerts for SLO thresholds.", "properties": { "burnRate": { "properties": { "rules": { "items": { "properties": { "condition": { "description": "Condition to match", "properties": { "threshold": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true } }, "required": [ "threshold" ], "type": "object", "additionalProperties": false }, "override": { "description": "Alert overrides.", "properties": { "priority": { "description": "Priority to override it", "enum": [ "p1", "p2", "p3", "p4", "p5" ], "type": "string" } }, "required": [ "priority" ], "type": "object", "additionalProperties": false } }, "required": [ "condition" ], "type": "object", "additionalProperties": false }, "type": "array" }, "type": { "properties": { "dual": { "properties": { "timeDuration": { "properties": { "duration": { "type": "integer" }, "unit": { "description": "Time duration unit for a Burn Rate Slo.", "enum": [ "unspecified", "hours" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "additionalProperties": false } }, "required": [ "timeDuration" ], "type": "object", "additionalProperties": false }, "single": { "properties": { "timeDuration": { "properties": { "duration": { "type": "integer" }, "unit": { "description": "Time duration unit for a Burn Rate Slo.", "enum": [ "unspecified", "hours" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "additionalProperties": false } }, "required": [ "timeDuration" ], "type": "object", "additionalProperties": false } }, "type": "object", "x-kubernetes-validations": [ { "message": "Exactly one of single or dual must be set", "rule": "has(self.single) != has(self.dual)" } ], "additionalProperties": false } }, "required": [ "rules", "type" ], "type": "object", "additionalProperties": false }, "errorBudget": { "properties": { "rules": { "items": { "properties": { "condition": { "description": "Condition to match", "properties": { "threshold": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Threshold to match to.", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true } }, "required": [ "threshold" ], "type": "object", "additionalProperties": false }, "override": { "description": "Alert overrides.", "properties": { "priority": { "description": "Priority to override it", "enum": [ "p1", "p2", "p3", "p4", "p5" ], "type": "string" } }, "required": [ "priority" ], "type": "object", "additionalProperties": false } }, "required": [ "condition" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "required": [ "rules" ], "type": "object", "additionalProperties": false }, "sloDefinition": { "properties": { "sloRef": { "properties": { "backendRef": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object", "x-kubernetes-validations": [ { "message": "Exactly one of id or name must be set", "rule": "has(self.id) != has(self.name)" } ], "additionalProperties": false }, "resourceRef": { "description": "Reference to a resource within the cluster.", "properties": { "name": { "description": "Name of the resource.", "type": "string" }, "namespace": { "description": "Kubernetes namespace.", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false } }, "type": "object", "x-kubernetes-validations": [ { "message": "Exactly one of backendRef or resourceRef must be set", "rule": "has(self.backendRef) != has(self.resourceRef)" } ], "additionalProperties": false } }, "required": [ "sloRef" ], "type": "object", "additionalProperties": false } }, "required": [ "sloDefinition" ], "type": "object", "x-kubernetes-validations": [ { "message": "Exactly one of errorBudget or burnRate is required", "rule": "has(self.errorBudget) != has(self.burnRate)" } ], "additionalProperties": false }, "tracingImmediate": { "description": "Immediate alerts for traces.", "properties": { "notificationPayloadFilter": { "description": "Filter for the notification payload.", "items": { "type": "string" }, "type": "array" }, "tracingFilter": { "description": "A simple tracing filter.", "properties": { "simple": { "description": "Simple tracing filter paired with a latency.", "properties": { "latencyThresholdMs": { "format": "int64", "type": "integer" }, "tracingLabelFilters": { "description": "Filter for traces.", "properties": { "applicationName": { "items": { "description": "Filter - values and operation.", "properties": { "operation": { "description": "Tracing filter operations.", "enum": [ "includes", "endsWith", "startsWith", "isNot", "is" ], "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" } }, "required": [ "operation", "values" ], "type": "object", "additionalProperties": false }, "type": "array" }, "operationName": { "items": { "description": "Filter - values and operation.", "properties": { "operation": { "description": "Tracing filter operations.", "enum": [ "includes", "endsWith", "startsWith", "isNot", "is" ], "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" } }, "required": [ "operation", "values" ], "type": "object", "additionalProperties": false }, "type": "array" }, "serviceName": { "items": { "description": "Filter - values and operation.", "properties": { "operation": { "description": "Tracing filter operations.", "enum": [ "includes", "endsWith", "startsWith", "isNot", "is" ], "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" } }, "required": [ "operation", "values" ], "type": "object", "additionalProperties": false }, "type": "array" }, "spanFields": { "items": { "description": "Filter for spans", "properties": { "filterType": { "description": "Filter - values and operation.", "properties": { "operation": { "description": "Tracing filter operations.", "enum": [ "includes", "endsWith", "startsWith", "isNot", "is" ], "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" } }, "required": [ "operation", "values" ], "type": "object", "additionalProperties": false }, "key": { "type": "string" } }, "required": [ "filterType", "key" ], "type": "object", "additionalProperties": false }, "type": "array" }, "subsystemName": { "items": { "description": "Filter - values and operation.", "properties": { "operation": { "description": "Tracing filter operations.", "enum": [ "includes", "endsWith", "startsWith", "isNot", "is" ], "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" } }, "required": [ "operation", "values" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "tracingThreshold": { "description": "Alerts for when traces crosses a threshold.", "properties": { "notificationPayloadFilter": { "description": "Filter for the notification payload.", "items": { "type": "string" }, "type": "array" }, "rules": { "description": "Rules that match the alert to the data.", "items": { "description": "The rule to match the alert's conditions.", "properties": { "condition": { "description": "The condition to match to.", "properties": { "conditionType": { "default": "moreThan", "description": "Condition type.", "enum": [ "moreThan" ], "type": "string" }, "spanAmount": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Threshold amount.", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "timeWindow": { "description": "Time window to evaluate.", "properties": { "specificValue": { "description": "Time window type for tracing.", "enum": [ "5m", "10m", "15m", "20m", "30m", "1h", "2h", "4h", "6h", "12h", "24h", "36h" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "spanAmount", "timeWindow" ], "type": "object", "additionalProperties": false } }, "required": [ "condition" ], "type": "object", "additionalProperties": false }, "minItems": 1, "type": "array" }, "tracingFilter": { "description": "Filter the base collection.", "properties": { "simple": { "description": "Simple tracing filter paired with a latency.", "properties": { "latencyThresholdMs": { "format": "int64", "type": "integer" }, "tracingLabelFilters": { "description": "Filter for traces.", "properties": { "applicationName": { "items": { "description": "Filter - values and operation.", "properties": { "operation": { "description": "Tracing filter operations.", "enum": [ "includes", "endsWith", "startsWith", "isNot", "is" ], "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" } }, "required": [ "operation", "values" ], "type": "object", "additionalProperties": false }, "type": "array" }, "operationName": { "items": { "description": "Filter - values and operation.", "properties": { "operation": { "description": "Tracing filter operations.", "enum": [ "includes", "endsWith", "startsWith", "isNot", "is" ], "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" } }, "required": [ "operation", "values" ], "type": "object", "additionalProperties": false }, "type": "array" }, "serviceName": { "items": { "description": "Filter - values and operation.", "properties": { "operation": { "description": "Tracing filter operations.", "enum": [ "includes", "endsWith", "startsWith", "isNot", "is" ], "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" } }, "required": [ "operation", "values" ], "type": "object", "additionalProperties": false }, "type": "array" }, "spanFields": { "items": { "description": "Filter for spans", "properties": { "filterType": { "description": "Filter - values and operation.", "properties": { "operation": { "description": "Tracing filter operations.", "enum": [ "includes", "endsWith", "startsWith", "isNot", "is" ], "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" } }, "required": [ "operation", "values" ], "type": "object", "additionalProperties": false }, "key": { "type": "string" } }, "required": [ "filterType", "key" ], "type": "object", "additionalProperties": false }, "type": "array" }, "subsystemName": { "items": { "description": "Filter - values and operation.", "properties": { "operation": { "description": "Tracing filter operations.", "enum": [ "includes", "endsWith", "startsWith", "isNot", "is" ], "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" } }, "required": [ "operation", "values" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "required": [ "rules" ], "type": "object", "additionalProperties": false } }, "type": "object", "x-kubernetes-validations": [ { "message": "Exactly one of logsImmediate, logsThreshold, logsRatioThreshold, logsTimeRelativeThreshold, metricThreshold, tracingThreshold, tracingImmediate, flow, logsAnomaly, metricAnomaly, logsNewValue, logsUniqueCount, sloThreshold must be set", "rule": "(has(self.logsImmediate) ? 1 : 0) + (has(self.logsThreshold) ? 1 : 0) + (has(self.logsRatioThreshold) ? 1 : 0) + (has(self.logsTimeRelativeThreshold) ? 1 : 0) + (has(self.metricThreshold) ? 1 : 0) + (has(self.tracingThreshold) ? 1 : 0) + (has(self.tracingImmediate) ? 1 : 0) + (has(self.flow) ? 1 : 0) + (has(self.logsAnomaly) ? 1 : 0) + (has(self.metricAnomaly) ? 1 : 0) + (has(self.logsNewValue) ? 1 : 0) + (has(self.logsUniqueCount) ? 1 : 0) + (has(self.sloThreshold) ? 1 : 0) == 1" } ], "additionalProperties": false }, "dataSources": { "description": "Data sources to run the alert on.", "items": { "description": "Data source to run the alert on.", "properties": { "dataSet": { "description": "Dataset of the data source.", "minLength": 1, "type": "string" }, "dataSpace": { "description": "Data space of the data source.", "minLength": 1, "type": "string" } }, "required": [ "dataSet", "dataSpace" ], "type": "object", "additionalProperties": false }, "type": "array" }, "description": { "description": "Description of the alert", "type": "string" }, "enabled": { "default": true, "description": "Enable/disable the alert.", "type": "boolean" }, "entityLabels": { "additionalProperties": { "type": "string" }, "description": "Labels attached to the alert.", "type": "object" }, "groupByKeys": { "description": "Grouping fields for multiple alerts.", "items": { "type": "string" }, "type": "array" }, "incidentsSettings": { "description": "Settings for the attached incidents.", "properties": { "notifyOn": { "default": "triggeredOnly", "description": "When to notify.", "enum": [ "triggeredOnly", "triggeredAndResolved" ], "type": "string" }, "retriggeringPeriod": { "description": "When to re-notify.", "properties": { "minutes": { "description": "Delay between re-triggered alerts.", "format": "int64", "type": "integer" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "name": { "description": "Name of the alert", "minLength": 0, "type": "string" }, "notificationGroup": { "description": "Where notifications should be sent to.", "properties": { "destinations": { "description": "Do not use.\nDeprecated: This field is deprecated and will be removed in a future version.", "items": { "properties": { "connector": { "description": "Connector is the connector for the destination. Should be one of backendRef or resourceRef.", "properties": { "backendRef": { "description": "BackendRef is a reference to a backend resource.", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object", "additionalProperties": false }, "resourceRef": { "description": "ResourceRef is a reference to a Kubernetes resource.", "properties": { "name": { "description": "Name of the resource.", "type": "string" }, "namespace": { "description": "Kubernetes namespace.", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false } }, "type": "object", "x-kubernetes-validations": [ { "message": "Exactly one of backendRef or resourceRef must be set", "rule": "has(self.backendRef) != has(self.resourceRef)" } ], "additionalProperties": false }, "notifyOn": { "default": "triggeredOnly", "description": "When to notify.", "enum": [ "triggeredOnly", "triggeredAndResolved" ], "type": "string" }, "preset": { "description": "Preset is the preset for the destination. Should be one of backendRef or resourceRef.", "properties": { "backendRef": { "description": "BackendRef is a reference to a backend resource.", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object", "additionalProperties": false }, "resourceRef": { "description": "ResourceRef is a reference to a Kubernetes resource.", "properties": { "name": { "description": "Name of the resource.", "type": "string" }, "namespace": { "description": "Kubernetes namespace.", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false } }, "type": "object", "x-kubernetes-validations": [ { "message": "Exactly one of backendRef or resourceRef must be set", "rule": "has(self.backendRef) != has(self.resourceRef)" } ], "additionalProperties": false }, "resolvedRoutingOverrides": { "description": "Optional routing configuration to override from the connector/preset for resolved notifications.", "properties": { "configOverrides": { "properties": { "connectorConfigFields": { "description": "Connector configuration fields.", "items": { "properties": { "fieldName": { "description": "The name of the configuration field.", "type": "string" }, "template": { "description": "The template for the configuration field.", "type": "string" } }, "required": [ "fieldName", "template" ], "type": "object", "additionalProperties": false }, "type": "array" }, "messageConfigFields": { "description": "Notification message configuration fields.", "items": { "properties": { "fieldName": { "description": "The name of the configuration field.", "type": "string" }, "template": { "description": "The template for the configuration field.", "type": "string" } }, "required": [ "fieldName", "template" ], "type": "object", "additionalProperties": false }, "type": "array" }, "payloadType": { "description": "The ID of the output schema to use for routing notifications", "type": "string" } }, "required": [ "payloadType" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "retriggeringPeriodMinutes": { "description": "The time in minutes before a new notification is sent for this destination.", "format": "int64", "minimum": 0, "type": "integer" }, "triggeredRoutingOverrides": { "description": "The routing configuration to override from the connector/preset for triggered notifications.", "properties": { "configOverrides": { "properties": { "connectorConfigFields": { "description": "Connector configuration fields.", "items": { "properties": { "fieldName": { "description": "The name of the configuration field.", "type": "string" }, "template": { "description": "The template for the configuration field.", "type": "string" } }, "required": [ "fieldName", "template" ], "type": "object", "additionalProperties": false }, "type": "array" }, "messageConfigFields": { "description": "Notification message configuration fields.", "items": { "properties": { "fieldName": { "description": "The name of the configuration field.", "type": "string" }, "template": { "description": "The template for the configuration field.", "type": "string" } }, "required": [ "fieldName", "template" ], "type": "object", "additionalProperties": false }, "type": "array" }, "payloadType": { "description": "The ID of the output schema to use for routing notifications", "type": "string" } }, "required": [ "payloadType" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "required": [ "connector", "notifyOn", "triggeredRoutingOverrides" ], "type": "object", "additionalProperties": false }, "type": "array" }, "groupByKeys": { "description": "Group notification by these keys.", "items": { "type": "string" }, "type": "array" }, "router": { "description": "The router for notifications (Notification Center feature) where to route notifications to.", "properties": { "notifyOn": { "default": "triggeredOnly", "description": "When to notify.", "enum": [ "triggeredOnly", "triggeredAndResolved" ], "type": "string" } }, "required": [ "notifyOn" ], "type": "object", "additionalProperties": false }, "webhooks": { "description": "Webhooks to trigger for notifications.", "items": { "description": "Settings for a notification webhook.", "properties": { "integration": { "description": "Type and spec of webhook.", "properties": { "integrationRef": { "description": "Reference to the webhook.", "properties": { "backendRef": { "description": "Backend reference for the outbound webhook.", "properties": { "id": { "description": "Webhook ID.", "format": "int64", "type": "integer" }, "name": { "description": "Name of the webhook.", "type": "string" } }, "type": "object", "x-kubernetes-validations": [ { "message": "One of id or name is required", "rule": "has(self.id) != has(self.name)" } ], "additionalProperties": false }, "resourceRef": { "description": "Resource reference for use with the alert notification.", "properties": { "name": { "description": "Name of the resource.", "type": "string" }, "namespace": { "description": "Kubernetes namespace.", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false } }, "type": "object", "x-kubernetes-validations": [ { "message": "Exactly one of backendRef or resourceRef is required", "rule": "has(self.backendRef) || has(self.resourceRef)" } ], "additionalProperties": false }, "recipients": { "description": "Recipients for the notification.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "x-kubernetes-validations": [ { "message": "Exactly one of integrationRef or recipients is required", "rule": "has(self.integrationRef) || has(self.recipients)" } ], "additionalProperties": false }, "notifyOn": { "default": "triggeredOnly", "description": "When to notify.", "enum": [ "triggeredOnly", "triggeredAndResolved" ], "type": "string" }, "retriggeringPeriod": { "description": "When to re-trigger.", "properties": { "minutes": { "description": "Delay between re-triggered alerts.", "format": "int64", "type": "integer" } }, "type": "object", "additionalProperties": false } }, "required": [ "integration", "notifyOn", "retriggeringPeriod" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "x-kubernetes-validations": [ { "message": "At most one of Destinations or Router can be set.", "rule": "!(has(self.destinations) && has(self.router))" } ], "additionalProperties": false }, "notificationGroupExcess": { "description": "Do not use.\nDeprecated: Legacy field for when multiple notification groups were attached.", "items": { "description": "Notification group to use for alert notifications.", "properties": { "destinations": { "description": "Do not use.\nDeprecated: This field is deprecated and will be removed in a future version.", "items": { "properties": { "connector": { "description": "Connector is the connector for the destination. Should be one of backendRef or resourceRef.", "properties": { "backendRef": { "description": "BackendRef is a reference to a backend resource.", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object", "additionalProperties": false }, "resourceRef": { "description": "ResourceRef is a reference to a Kubernetes resource.", "properties": { "name": { "description": "Name of the resource.", "type": "string" }, "namespace": { "description": "Kubernetes namespace.", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false } }, "type": "object", "x-kubernetes-validations": [ { "message": "Exactly one of backendRef or resourceRef must be set", "rule": "has(self.backendRef) != has(self.resourceRef)" } ], "additionalProperties": false }, "notifyOn": { "default": "triggeredOnly", "description": "When to notify.", "enum": [ "triggeredOnly", "triggeredAndResolved" ], "type": "string" }, "preset": { "description": "Preset is the preset for the destination. Should be one of backendRef or resourceRef.", "properties": { "backendRef": { "description": "BackendRef is a reference to a backend resource.", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object", "additionalProperties": false }, "resourceRef": { "description": "ResourceRef is a reference to a Kubernetes resource.", "properties": { "name": { "description": "Name of the resource.", "type": "string" }, "namespace": { "description": "Kubernetes namespace.", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false } }, "type": "object", "x-kubernetes-validations": [ { "message": "Exactly one of backendRef or resourceRef must be set", "rule": "has(self.backendRef) != has(self.resourceRef)" } ], "additionalProperties": false }, "resolvedRoutingOverrides": { "description": "Optional routing configuration to override from the connector/preset for resolved notifications.", "properties": { "configOverrides": { "properties": { "connectorConfigFields": { "description": "Connector configuration fields.", "items": { "properties": { "fieldName": { "description": "The name of the configuration field.", "type": "string" }, "template": { "description": "The template for the configuration field.", "type": "string" } }, "required": [ "fieldName", "template" ], "type": "object", "additionalProperties": false }, "type": "array" }, "messageConfigFields": { "description": "Notification message configuration fields.", "items": { "properties": { "fieldName": { "description": "The name of the configuration field.", "type": "string" }, "template": { "description": "The template for the configuration field.", "type": "string" } }, "required": [ "fieldName", "template" ], "type": "object", "additionalProperties": false }, "type": "array" }, "payloadType": { "description": "The ID of the output schema to use for routing notifications", "type": "string" } }, "required": [ "payloadType" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "retriggeringPeriodMinutes": { "description": "The time in minutes before a new notification is sent for this destination.", "format": "int64", "minimum": 0, "type": "integer" }, "triggeredRoutingOverrides": { "description": "The routing configuration to override from the connector/preset for triggered notifications.", "properties": { "configOverrides": { "properties": { "connectorConfigFields": { "description": "Connector configuration fields.", "items": { "properties": { "fieldName": { "description": "The name of the configuration field.", "type": "string" }, "template": { "description": "The template for the configuration field.", "type": "string" } }, "required": [ "fieldName", "template" ], "type": "object", "additionalProperties": false }, "type": "array" }, "messageConfigFields": { "description": "Notification message configuration fields.", "items": { "properties": { "fieldName": { "description": "The name of the configuration field.", "type": "string" }, "template": { "description": "The template for the configuration field.", "type": "string" } }, "required": [ "fieldName", "template" ], "type": "object", "additionalProperties": false }, "type": "array" }, "payloadType": { "description": "The ID of the output schema to use for routing notifications", "type": "string" } }, "required": [ "payloadType" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "required": [ "connector", "notifyOn", "triggeredRoutingOverrides" ], "type": "object", "additionalProperties": false }, "type": "array" }, "groupByKeys": { "description": "Group notification by these keys.", "items": { "type": "string" }, "type": "array" }, "router": { "description": "The router for notifications (Notification Center feature) where to route notifications to.", "properties": { "notifyOn": { "default": "triggeredOnly", "description": "When to notify.", "enum": [ "triggeredOnly", "triggeredAndResolved" ], "type": "string" } }, "required": [ "notifyOn" ], "type": "object", "additionalProperties": false }, "webhooks": { "description": "Webhooks to trigger for notifications.", "items": { "description": "Settings for a notification webhook.", "properties": { "integration": { "description": "Type and spec of webhook.", "properties": { "integrationRef": { "description": "Reference to the webhook.", "properties": { "backendRef": { "description": "Backend reference for the outbound webhook.", "properties": { "id": { "description": "Webhook ID.", "format": "int64", "type": "integer" }, "name": { "description": "Name of the webhook.", "type": "string" } }, "type": "object", "x-kubernetes-validations": [ { "message": "One of id or name is required", "rule": "has(self.id) != has(self.name)" } ], "additionalProperties": false }, "resourceRef": { "description": "Resource reference for use with the alert notification.", "properties": { "name": { "description": "Name of the resource.", "type": "string" }, "namespace": { "description": "Kubernetes namespace.", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false } }, "type": "object", "x-kubernetes-validations": [ { "message": "Exactly one of backendRef or resourceRef is required", "rule": "has(self.backendRef) || has(self.resourceRef)" } ], "additionalProperties": false }, "recipients": { "description": "Recipients for the notification.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "x-kubernetes-validations": [ { "message": "Exactly one of integrationRef or recipients is required", "rule": "has(self.integrationRef) || has(self.recipients)" } ], "additionalProperties": false }, "notifyOn": { "default": "triggeredOnly", "description": "When to notify.", "enum": [ "triggeredOnly", "triggeredAndResolved" ], "type": "string" }, "retriggeringPeriod": { "description": "When to re-trigger.", "properties": { "minutes": { "description": "Delay between re-triggered alerts.", "format": "int64", "type": "integer" } }, "type": "object", "additionalProperties": false } }, "required": [ "integration", "notifyOn", "retriggeringPeriod" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "x-kubernetes-validations": [ { "message": "At most one of Destinations or Router can be set.", "rule": "!(has(self.destinations) && has(self.router))" } ], "additionalProperties": false }, "type": "array" }, "phantomMode": { "default": false, "type": "boolean" }, "priority": { "default": "p5", "description": "Priority of the alert.", "enum": [ "p1", "p2", "p3", "p4", "p5" ], "type": "string" }, "schedule": { "description": "Alert activity schedule. Will be activated all the time if not specified.", "properties": { "activeOn": { "description": "Schedule to have the alert active.", "properties": { "dayOfWeek": { "items": { "description": "Day of the week.", "enum": [ "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" ], "type": "string" }, "type": "array" }, "endTime": { "default": "23:59", "description": "Time of day.", "pattern": "^(0\\d|1\\d|2[0-3]):[0-5]\\d$", "type": "string" }, "startTime": { "default": "00:00", "description": "Time of day.", "pattern": "^(0\\d|1\\d|2[0-3]):[0-5]\\d$", "type": "string" } }, "required": [ "dayOfWeek" ], "type": "object", "additionalProperties": false }, "timeZone": { "default": "UTC+00", "description": "Time zone.", "pattern": "^UTC[+-]\\d{2}$", "type": "string" } }, "required": [ "timeZone" ], "type": "object", "additionalProperties": false } }, "required": [ "alertType", "name", "priority" ], "type": "object", "x-kubernetes-validations": [ { "message": "groupByKeys is not supported for this alert type", "rule": "!has(self.alertType.logsImmediate) || !has(self.groupByKeys)" }, { "message": "Phantom alerts must not have a notification group set", "rule": "!(self.phantomMode && has(self.notificationGroup))" } ], "additionalProperties": false }, "status": { "description": "AlertStatus defines the observed state of Alert", "properties": { "conditions": { "items": { "description": "Condition contains details for one aspect of the current state of this API Resource.", "properties": { "lastTransitionTime": { "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "format": "date-time", "type": "string" }, "message": { "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", "maxLength": 32768, "type": "string" }, "observedGeneration": { "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", "format": "int64", "minimum": 0, "type": "integer" }, "reason": { "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", "maxLength": 1024, "minLength": 1, "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "type": "string" }, "status": { "description": "status of the condition, one of True, False, Unknown.", "enum": [ "True", "False", "Unknown" ], "type": "string" }, "type": { "description": "type of condition in CamelCase or in foo.example.com/CamelCase.", "maxLength": 316, "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "type": "string" } }, "required": [ "lastTransitionTime", "message", "reason", "status", "type" ], "type": "object", "additionalProperties": false }, "type": "array" }, "id": { "type": "string" }, "printableStatus": { "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object" }