This model describes a system alert, related to a Kubernetes objects, such as a Cluster, Node, Service, Deployment, Pod, etc.

Example:

{
        "type": "System",
        "metadata": {
            "objectType": "Pod",
            "objectId": "14aecb16-ed6a-41f4-9be5-6e29b4e5cdce",
            "objectName": "logger-67b576f56b-krvqs",
            "clusterId": "f99e055f-b35d-208b-63b1-f4222b80151a",
            "clusterName": "realtheory-cluster-01",
            "nodeId": "c9e25d58-29a2-4d5f-b158-244f052f7d6f",
            "nodeName": "aks-userpool-15373879-vmss00002w",
            "customResourceDefinitionId": "00000000-0000-0000-0000-000000000000",
            "customResourceDefinitionName": "",
            "namespaceId": "0b3c50fe-5116-44bd-b229-543251be4e74",
            "namespaceName": "web-app",
            "serviceId": "ffd1d0e9-f543-418c-ac1c-6daed2649078",
            "serviceName": "logger-svc",
            "replicaSetId": "3726cad5-163d-4de1-8076-b09ab86e6941",
            "replicaSetName": "logger-67b576f56b",
            "deploymentId": "b3039e89-64f9-44de-8164-e97a95e17880",
            "deploymentName": "logger",
            "daemonSetId": "00000000-0000-0000-0000-000000000000",
            "daemonSetName": "",
            "statefulSetId": "00000000-0000-0000-0000-000000000000",
            "statefulSetName": "",
            "customResourceId": "00000000-0000-0000-0000-000000000000",
            "customResourceName": "",
            "jobId": "00000000-0000-0000-0000-000000000000",
            "jobName": "",
            "cronJobId": "00000000-0000-0000-0000-000000000000",
            "cronJobName": "",
            "podId": "14aecb16-ed6a-41f4-9be5-6e29b4e5cdce",
            "podName": "logger-67b576f56b-krvqs"
        },
        "id": "12a3ae02-5b90-3701-6534-d4d9ab751e5d",
        "key": "PodOOMKilledHealthCheck::14aecb16ed6a41f49be56e29b4e5cdce",
        "title": "The pod has been recently terminated with the OOMKilled status.",
        "message": "The 'Pod OOM Killed Check' has identified a high impact health concern on pod 'logger-67b576f56b-krvqs'.",
        "details": "Last Pod Status: OOMKilled, Last Exit Code: 137, Last Terminated: 2024-09-05 16:14:36Z",
        "comments": "",
        "level": "High",
        "category": "Health",
        "source": "Pod OOM Killed Check (health check)",
        "sourceId": "ddc94c84-4e77-40d9-a76c-cb8bac863f28",
        "url": "",
        "state": "New",
        "advisoryId": "00000000-0000-0000-0000-000000000000",
        "created": "2024-08-07T10:16:35.0176406Z",
        "updated": "2024-09-05T16:20:09.6787782Z",
        "postponedUntil": null,
        "expires": "2024-09-05T16:25:08.1769592Z"
    }

where:

type - Indicates the type of Alert. Supported values include 'System'.
metadata
- objectType: Indicates the type of Kubernetes object that the Alert is linked to. Supported examples include 'Cluster', 'Node', 'Service', 'Deployment', 'Pod', etc.
- objectId: Represents the ID of the Kubernetes object that the Alert is linked to.
- objectName: Represents the name of the Kubernetes object that the Alert is linked to.
- clusterId: Represents the ID of the Cluster that contains the Kubernetes object that the Alert is linked to.
- clusterName: Represents name of the Cluster that contains the Kubernetes object that the Alert is linked to.
- nodeId: Represents the ID of the Node associated with the Kubernetes object that the Alert is linked to. This value can be empty (represented by all zeros) if not applicable.
- nodeName: Represents the name of the Node associated with the Kubernetes object that the Alert is linked to. This value can be empty if not applicable.
- customerResourceDefinitionId: Represents the ID of the Custom Resource Definition associated with the Kubernetes object that the Alert is linked to. This value can be empty (represented by all zeros) if not applicable.
- customResourceDefinitionName: Represents the name of the Custom Resource Definition associated with the Kubernetes object that the Alert is linked to. This value can be empty if not applicable.
- namespaceId: Represents the ID of the Namespace associated with the Kubernetes object that the Alert is linked to. This value can be empty (represented by all zeros) if not applicable.
- namespaceName: Represents the name of the Namespace associated with the Kubernetes object that the Alert is linked to. This value can be empty if not applicable.
- serviceId: Represents the ID of the Service associated with the Kubernetes object that the Alert is linked to. This value can be empty (represented by all zeros) if not applicable.
- serviceName: Represents the name of the Service associated with the Kubernetes object that the Alert is linked to. This value can be empty if not applicable.
- replicaSetId: Represents the ID of the ReplicaSet associated with the Kubernetes object that the Alert is linked to. This value can be empty (represented by all zeros) if not applicable.
- replicaSetName: Represents the name of the ReplicaSet associated with the Kubernetes object that the Alert is linked to. This value can be empty if not applicable.
- deploymentId: Represents the ID of the Deployment associated with the Kubernetes object that the Alert is linked to. This value can be empty (represented by all zeros) if not applicable.
- deploymentName: Represents the name of the Deployment associated with the Kubernetes object that the Alert is linked to. This value can be empty if not applicable.
- daemonSetId: Represents the ID of the DaemonSet associated with the Kubernetes object that the Alert is linked to. This value can be empty (represented by all zeros) if not applicable.
- daemonSetName: Represents the name of the DaemonSet associated with the Kubernetes object that the Alert is linked to. This value can be empty if not applicable.
- statefulSetId: Represents the ID of the StatefulSet associated with the Kubernetes object that the Alert is linked to. This value can be empty (represented by all zeros) if not applicable.
- statefulSetName: Represents the name of the StatefulSet associated with the Kubernetes object that the Alert is linked to. This value can be empty if not applicable.
- customResourceId: Represents the ID of the Custom Resource associated with the Kubernetes object that the Alert is linked to. This value can be empty (represented by all zeros) if not applicable.
- customResourceName: Represents the name of the Custom Resource associated with the Kubernetes object that the Alert is linked to. This value can be empty if not applicable.
- jobId: Represents the ID of the Job associated with the Kubernetes object that the Alert is linked to. This value can be empty (represented by all zeros) if not applicable.
- jobName: Represents the name of the Job associated with the Kubernetes object that the Alert is linked to. This value can be empty if not applicable.
- cronJobId: Represents the ID of the CronJob associated with the Kubernetes object that the Alert is linked to. This value can be empty (represented by all zeros) if not applicable.
- cronJobName: Represents the name of the CronJob associated with the Kubernetes object that the Alert is linked to. This value can be empty if not applicable.
- podId: Represents the ID of the Pod associated with the Kubernetes object that the Alert is linked to. This value can be empty (represented by all zeros) if not applicable.
- podName: Represents the name of the Pod associated with the Kubernetes object that the Alert is linked to. This value can be empty if not applicable.
id: Represents the ID of the Alert.
key: Represents an internal key that uniquely identifies the Alert. This value is intended for internal use only and should not be modified.
title: Represents the short title associated with the Alert.
message: Represents the summary message associated with the Alert.
details: Represents specific details associated with the Alert.
comments: Represents any user comments associated with Alert. The comments are inherited from the Rule that created the Alert.
`level': Represents the severity of the Alert. Supported values are Normal, High and, Critical.
category: Represents the broad category of the Alert. Supported values are Health, Performance, Cost and, Governance.
source: Represents the name of the Rule that created the Alert.
sourceId: Represents the ID of the Rule that created the Alert.
url: Represents a custom URL associated with the Alert. The URL is inherited from the Rule that created the Alert.
state: Represents the state of the Alert. Supported values are New, Read, Flagged, Hidden, Postponed, and Dismissed.
advisoryId: Represents the ID of the advisory associated with the Alert. This value can be empty (represented by all zeros) if not applicable.
created: Represents the UTC time that the Alert was created.
updated: Represents the UTC time that the Alert was last modified.
expires: Represents the UTC time that the Alert is set to expire.
postponedUntil: Represents the UTC time that the Alert is postponed until.

Documentation Index