Logging Schema

The logging plugin manages the collection and storage of operational data within the OBLV Deploy system. It provides logging capabilities that you can use for monitoring, troubleshooting, and ensuring the security of the system. You can customize the logging plugin to meet specific logging requirements for recording the operational data of your system.

Logging plugin schema

The logging 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 logging plugin schema:

  {
    "$id": "http://example.com/oblv_k8_schema/json-schemas/plugins/logging-schema.json",
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Logging Plugin Schema",
    "description": "Schema for logging plugin configuration.",
    "$ref": "/oblv_k8_schema/json-schemas/plugins/plugins-base-schema.json",
    "type": "object",
    "properties": {
      "spec": {
        "type": "object",
        "properties": {
          "volumes": {
            "$ref": "/oblv_k8_schema/json-schemas/privileges/volumes.json"
          },
          "logsAccess": {
            "$ref": "/oblv_k8_schema/json-schemas/privileges/listener.json"
          },
          "outboundConnections": {
            "$ref": "/oblv_k8_schema/json-schemas/privileges/outbound.json"
          },
          "env": {
            "$ref": "/oblv_k8_schema/json-schemas/privileges/env.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 logging operations.
volumes	Specifies the storage volumes that can be mounted and accessed by the plugin, crucial for storing log data.
logsAccess	Defines the access configuration for logs, detailing how logs can be listened to and by whom.
outboundConnections	Outlines rules for outbound connections, used for forwarding logs to external monitoring and management systems.
env	Manages the environment variables for the plugin, allowing custom configuration settings that influence the logging behaviour.
securityContext	Sets the security attributes for the plugin.