Skip to content

Latest commit

 

History

History
60 lines (60 loc) · 20.1 KB

EVENT_VIEW_MODEL_DETAILS_REFERENCE.md

File metadata and controls

60 lines (60 loc) · 20.1 KB
Name Tag When present Description Value schema Example values
AlarmID (empty) Alerting alarm state changes UUID v7 for the alarm 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "format": "uuid",
  "type": "string"
}
 
  • "0190db1d-5d37-70a8-95bd-4092c918ecbe"
AlarmSeverity (empty) Alerting alarm state changes Alarm severity information 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "enum": [
    "clear",
    "minor",
    "major",
    "warning",
    "severe",
    "critical"
  ],
  "type": "string"
}
 
  • "major"
  • "severe"
AlarmThresholdID (empty) Alerting alarm state changes ID of the Alerting Policy Threshold. Today it is a number in string, but this should not be assumed as such. Can be UUID or other in future. Will stay as string. 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "12716"
AlarmPolicyID (empty) Alerting alarm state changes ID of the Alerting Policy. Today it is a number in string, but this should not be assumed as such. Can be UUID or other in future. Will stay as string. 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "4085"
AlarmPolicyName (empty) Alerting alarm state changes Descriptive name of the Alerting Policy. 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "V4 DDoS - UDP Flood"
AlarmSeverityLabel (empty) Alerting alarm state changes Label 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "enum": [
    "Clear",
    "Minor",
    "Major",
    "Severe",
    "Warning",
    "Critical"
  ],
  "type": "string"
}
 
  • "Severe"
  • "Critical"
AlarmPolicyApplication (empty) Alerting alarm state changes Policy Application type the alarm belongs to 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "ddos"
  • "core"
  • "query-to-policy"
  • "kmetrics"
AlarmPolicyDashboardID misc Alerting alarm state changes Alerting Policy Dashboard ID. Usage discouraged. 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "number"
}
 
  • 123456
AlarmPolicyMetadataSubType (empty) NMS application alarm state changes Policy Sub Type 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "bgp_neighbors"
  • "interfaces"
  • "devices"
  • "custom"
AlarmParentPolicyID (empty) Alerting alarm state changes Parent Policy ID 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "123456"
AlertingSearchURL url Alerting alarm state changes Hyperlink to the alerting search URL 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "format": "uri",
  "type": "string"
}
AlarmBaselineSource misc Alerting alarm state changes Baseline source code information, internal meaning. Use AlarmBaselineDescription for descriptive information instead. 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "integer"
}
 
  • 0
  • 5
  • 15
AlarmBaselineDescription (empty) Alerting alarm state changes Baseline source descriptive code information 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "ACT_NOT_USED_BASELINE"
  • "ACT_BASELINE_USED_FOUND"
  • "ACT_BASELINE_MISSING_DEFAULT_INSTEAD_OF_HIGHEST"
AlarmPolicyMetadataType (empty) NMS application alarm state changes Policy Type 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "UpDown"
  • "MetricsThreshold"
(any) bgp_neighbor NMS application alarm state changes TBD 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "TBD"
(any) dimension Alerting alarm state changes Alarm dimension information. Name represents the dimension name and Value represents the dimension value 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "1.1.2.3/16"
  • "Arizona, US"
  • "237.84.2.178/24"
(any) metric Alerting alarm state changes Alarm metric values. Name represents the metric name and Value represents the metric value. Please note the type may vary! 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "anyOf": [
    {
      "type": "number"
    },
    {
      "type": "string"
    }
  ]
}
 
  • 123456
  • 10000.13
  • "down"
Baseline (empty) NMS application alarm state changes Baseline value for the main metric (non-zero if the alarm is triggered with baselines used) 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "number"
}
 
  • 42.25
  • 10001
DashboardAlarmURL url Alerting alarm state changes Hyperlink to the alarm dashboard 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "format": "uri",
  "type": "string"
}
DetailsAlarmURL url Alerting alarm state changes Hyperlink to alarm details 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "format": "uri",
  "type": "string"
}
DeviceId device Alerting alarm state changes for a policy with device as a dimension Device ID 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "123456"
DeviceName device Alerting alarm state changes Device name 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "c435b_iad2_kentik_com"
DeviceType device Alerting alarm state changes for a policy with device as a dimension Device type 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "router"
DeviceLabels device_labels Alerting alarm state changes for a policy with device as a dimension Comma-separated list of device labels for a policy with device as a dimension 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "foo, bar, baz"
  • "routers, network, cloud"
(any) device_label Alerting alarm state changes for a policy with device as a dimension Array of objects representing a list of device labels for a policy with device as a dimension 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "Color": {
      "type": "string"
    },
    "Name": {
      "type": "string"
    },
    "Type": {
      "type": "string"
    },
    "Value": {
      "type": "string"
    }
  },
  "type": "object"
}
 
  • {
      "Color": "#ff0000",
      "IsDark": true,
      "Name": "foo"
    }
  • {
      "Color": "#66ff66",
      "IsDark": false,
      "Name": "bar"
    }
AlarmPolicyLabels (empty) Alerting alarm state changes for a policy with labels Comma-separated list of source policy labels 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "foo, bar, baz"
(any) policy_label Alerting alarm state changes for a policy with labels Array of objects representing a list of source policy labels 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "Color": {
      "type": "string"
    },
    "Name": {
      "type": "string"
    },
    "Type": {
      "type": "string"
    },
    "Value": {
      "type": "string"
    }
  },
  "type": "object"
}
 
  • {
      "Color": "#ff0000",
      "IsDark": true,
      "Name": "foo"
    }
  • {
      "Color": "#66ff66",
      "IsDark": false,
      "Name": "bar"
    }
AlarmPolicyApplicationMetadata misc Alerting alarm state changes Policy Metadata as stringified JSON format. Usage discouraged. 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "{}"
RuleID (empty) Alerting alarm state changes UUID v7 for the rule - alerting system configuration ID. Usage discouraged. 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "format": "uuid",
  "type": "string"
}
 
  • "0190db1d-5d37-70a8-95bd-4092cafebabe"
MitigationID (empty) Mitigation state transition Mitigation unique ID 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "123456789"
MitigationType (empty) Mitigation state transition Mitigation type 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "enum": [
    "manual",
    "auto"
  ],
  "type": "string"
}
 
  • "manual"
  • "auto"
MitigationPolicyID (empty) Mitigation state transition Policy ID of the alarm that triggered mitigation 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "123465"
MitigationPolicyName (empty) Mitigation state transition Policy name of the alarm that triggered mitigation 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "V4 DDoS - UDP Flood"
MitigationPlatformID (empty) Mitigation state transition Platform ID for the mitigation 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "1234567"
MitigationPlatformName (empty) Mitigation state transition Platform name for the mitigation 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "BlackHole-Mitigation"
  • "pnap_all"
MitigationMethodID (empty) Mitigation state transition Platform method ID for the mitigation 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "1234567"
MitigationMethodName (empty) Mitigation state transition Platform method name for the mitigation 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "BlackHole_SOC"
  • "PhoenixNAP_Route_Injection"
MitigationAlarmID (empty) Mitigation state transition Alarm ID for the alarm that triggered the mitigation 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "0190db1d-5d37-70a8-95bd-4092c918ecbe"
MitigationAlertIP (empty) Mitigation state transition Target Alert IP/CIDR for the mitigation 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "10.0.0.2/24"
LastMitigationEvent (empty) Mitigation state transition Detailed event name for the mitigation transition that triggered the notification 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "skipWait"
  • "start"
MitigationURL url Mitigation state transition Hyperlink to mitigation details in Kentik Portal 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "format": "uri",
  "type": "string"
}
InsightID (empty) Insight information is provided Insight unique ID 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "a430344572"
InsightName (empty) Insight information is provided Insight system name 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "core.networkHealth.deviceTrafficIncrease"
InsightDataSourceType (empty) Insight information is provided Insight data source type 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "alerting"
InsightPlainDescription (empty) Insight information is provided Insight human-readable description 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "Device c435b_iad2_kentik_com received 1055% more traffic than usual at this time of day"
InsightDetailsURL url Insight information is provided Hyperlink to insight details 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "format": "uri",
  "type": "string"
}
InsightsSeverityURL url Insight information is provided Hyperlink to insight search page with given severity 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "format": "uri",
  "type": "string"
}
InsightsMainURL url Insight information is provided Hyperlink to insight dashboard page 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "format": "uri",
  "type": "string"
}
TestName (empty) Synthetics Test health state change Synthetic test name 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
TestID (empty) Synthetics Test health state change Synthetic test unique ID 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "123456"
TestType (empty) Synthetics Test health state change Synthetic test type 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "page_load"
(any) label Synthetics Test health state change and others Assigned label 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "Color": {
      "type": "string"
    },
    "Name": {
      "type": "string"
    },
    "Type": {
      "type": "string"
    },
    "Value": {
      "type": "string"
    }
  },
  "type": "object"
}
 
  • {
      "Color": "#ff6600",
      "IsDark": false,
      "Name": "foo",
      "Type": "synth_test"
    }
(any) statistic Synthetics Test health state change Statistical information for the test 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "anyOf": [
    {
      "type": "number"
    },
    {
      "type": "string"
    }
  ]
}
 
  • 18
  • "1 (5.56%)"
OriginAgentName origin Synthetics Test health state change Origin agent name for synthetic test 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}
 
  • "Sydney, Australia"
OriginAgentId origin Synthetics Test health state change Origin agent name for synthetic test. Usage discouraged 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "number"
}
 
  • 123456
OriginAgentDetails url Origin agent details URL Origin agent name for synthetic test. Usage discouraged 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "format": "uri",
  "type": "string"
}
(any) issue Synthetics Test health state change Issue information for the test 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "Description": {
      "type": "string"
    },
    "DetailedInfo": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "Labels": {
      "items": {
        "properties": {
          "Color": {
            "type": "string"
          },
          "IsDark": {
            "type": "boolean"
          },
          "Name": {
            "type": "string"
          },
          "Type": {
            "type": "string"
          },
          "Value": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "Origin": {
      "type": "string"
    },
    "Severity": {
      "type": "string"
    },
    "Status": {
      "type": "string"
    },
    "Target": {
      "type": "string"
    },
    "TargetAgent": {
      "type": "string"
    },
    "TargetName": {
      "type": "string"
    },
    "Type": {
      "type": "string"
    },
    "Url": {
      "format": "uri",
      "type": "string"
    },
    "UrlLabel": {
      "type": "string"
    }
  },
  "type": "object"
}
 
  • {
      "Description": "Bangalore, India: PING ⇒ Sydney, Australia warning",
      "DetailedInfo": [
        "Packet Loss: 20.00% (warning)",
        "Jitter: 0.11ms (healthy)",
        "Latency: 234.10ms (healthy)"
      ],
      "Labels": [],
      "Origin": "Bangalore, India",
      "Severity": "warning",
      "Status": "warning",
      "Target": "172.105.181.24",
      "TargetAgent": "274",
      "TargetName": "Sydney, Australia",
      "Type": "PING",
      "Url": "https://portal.our1.kentik.com/v4/synthetics/tests/5476/results/agent/300/274?start=1725361200",
      "UrlLabel": "Open Subtest Details"
    }
SyntheticsTestURL url Synthetics Test health state change Hyperlink to the synthetic test 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "format": "uri",
  "type": "string"
}