Comment

Cribl Compatible

Synopsis

Adds a comment to the pipeline configuration for documentation purposes.

Schema

comment:
  - comment: <string>
  - description: <text>
  - tag: <string>

Configuration

Field	Required	Default	Description
comment	Y	-	The comment text to include
description	N	-	Additional explanatory note
tag	N	-	Identifier for the comment

Details

The processor does not modify any data, and is used purely for adding explanatory notes.

note

Comments are preserved in the pipeline configuration but have no impact on data processing.

Comments can help document the pipeline logic, business rules, data transformations, configuration rationale, and implementation details.

tip

Use meaningful tags to organize and categorize comments for better pipeline management.

Examples

Basic

A simple explanatory pipeline comment:

comment: - comment: "Process only high severity events"

Complex Logic

Documenting complex rules is good practice:

comment: - comment: "Apply specific processing for production environment" - description: "Production requires additional validation steps" - tag: "env-specific"

Section Headers

Comments can be used as section dividers:

comment: - comment: "=== Data Enrichment Section ===" - tag: "section-header"

Implementation Notes

Implementation details can be highlighted:

comment: - comment: "TODO: Add support for custom field mapping" - description: "Pending feature implementation in v2.0" - tag: "todo"