Telemetry Schema

The telemetry plugin is used for monitoring and understanding the performance and behaviour of systems deployed within OBLV Deploy. It captures and transmits telemetry data, providing insights that help in performance tuning, anomaly detection, and system health monitoring. The telemetry collects and transmits data in real-time across Kubernetes systems.

Telemetry plugin schema

The telemetry plugin schema inherits from the basic plugin schema, and adds the spec field as required. The following JSON presents an example of the structure of the telemetry plugin schema:

  {
    "$id": "http://example.com/oblv_k8_schema/json-schemas/plugins/telemetry-schema.json",
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Telemetry Plugin Schema",
    "description": "Schema for telemetry plugin configuration.",
    "$ref": "/oblv_k8_schema/json-schemas/plugins/plugins-base-schema.json",
    "type": "object",
    "properties": {
      "spec": {
        "type": "object",
        "properties": {
          "ports": {
            "$ref": "/oblv_k8_schema/json-schemas/privileges/ports.json"
          },
          "outboundConnections": {
            "$ref": "/oblv_k8_schema/json-schemas/privileges/outbound.json"
          },
          "securityContext": {
            "$ref": "/oblv_k8_schema/json-schemas/privileges/security-context.json"
          }
        }
    }
    },
    "required": [
      "spec"
    ]
  }

The key values from the JSON object above are described in the table below.

Field	Description
spec	Contains detailed configurations specific to telemetry operations.
ports	Specifies the network ports that the telemetry service uses for collecting and transmitting data.
outboundConnections	Defines the rules for outbound connections that the telemetry service can establish, used for transmitting telemetry data to external monitoring systems.
securityContext	Sets the security attributes and capabilities for the telemetry service.