Cribl · Schema

Collector

ConfigurationData LakeData PipelinesData RoutingEdge ComputingInfrastructure as CodeObservabilitySearchSecurity DataStream ProcessingTelemetry

Properties

Name	Type	Description
id	string	Unique identifier for the collector
type	string	The collector type such as rest, script, database, or s3
schedule	object	The collection schedule configuration
conf	object	Collector-specific configuration
description	string	A human-readable description of the collector

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Collector",
  "title": "Collector",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the collector"
    },
    "type": {
      "type": "string",
      "description": "The collector type such as rest, script, database, or s3"
    },
    "schedule": {
      "type": "object",
      "description": "The collection schedule configuration",
      "properties": {
        "cronSchedule": {
          "type": "string",
          "description": "Cron expression for scheduled collection"
        },
        "enabled": {
          "type": "boolean",
          "description": "Whether the schedule is enabled"
        }
      }
    },
    "conf": {
      "type": "object",
      "description": "Collector-specific configuration"
    },
    "description": {
      "type": "string",
      "description": "A human-readable description of the collector"
    }
  }
}