Processor Reference

Processor Reference #

One reference page per pipeline processor, generated from the framework source and kept in a uniform format: what it does, its configuration parameters, and an example. The same catalog is discoverable at runtime via GET /pipeline/processors (?grouped=1 groups by category).

Record-scope processors operate on the current record inside for_each sub-chains; pipeline-scope processors run against the pipeline context; the consumer/for_each/queue_output trio moves batches through queues.

Framework #

ProcessorDescription
echoLogs a configured message.
dagExecutes a DAG of processors with parallel and dependency-based execution.
for_eachSplits a batch into records, runs a sub-chain per record, re-encodes the batch.

Queue #

ProcessorDescription
consumerConsumes a queue (by name or label selector) and exposes the batch to the pipeline.
queue_outputAppends the processed batch onto a target queue — the two-stage pipeline bridge.

Elasticsearch #

ProcessorDescription
bulk_indexingBulk-indexes documents into Elasticsearch for high-throughput ingestion.
json_indexingIndexes JSON documents into Elasticsearch.
indexing_mergeMerges small documents into combined indexing requests before writing.
merge_to_bulkMerges events into Elasticsearch bulk requests.

Output transport #

ProcessorDescription
otlp_exportShips the processed batch to any OTLP/gRPC collector.

General #

ProcessorDescription
httpSends HTTP requests to external services.
smtpSends email notifications via SMTP.
replayReplays recorded events for testing or reprocessing.

Parsing #

ProcessorDescription
dissectFast, regex-free delimiter-based field extraction.
grokRegex-based extraction with the %{PATTERN:name} syntax and a 350+ definition pattern library.
jsonDecodes a JSON string field into structured attributes.
xmlXML → map conversion.
csvParses a CSV line into named fields.
kvParses key=value pairs out of a string field.
urlSplits a URL or path?query field into structured parts.
urldecodeURL-decodes string fields.
dateParses a timestamp from a field into the record’s canonical Timestamp.
date_formatRenders a timestamp field in any layout/timezone.
useragentDependency-free User-Agent classifier.
syslog_decodeDecodes syslog numeric codes into names.
web_logPreset parsers for classic web server log formats.
stringString-function toolbox: substring, split/join/concat, tests, regex replace.
decode_base64_fieldBase64-decodes a single string field.
decompress_gzip_fieldGunzips a string or bytes field in place.

Transform #

ProcessorDescription
mutateField-level mutations covering the Logstash mutate surface.
field_standardizeNormalizes record keys to the canonical INFINI log data model naming.
otel_normalizeMaps source fields onto the canonical OTel log structure.
context_enrichPromotes collection context into the record’s Fields.
extract_arrayPulls elements out of an array field.
decode_durationConverts Go duration strings into numeric durations.

Enrichment #

ProcessorDescription
geoipGeographical enrichment from a MaxMind mmdb database.
cidrTests an IP field against a list of networks.
registered_domainSplits a domain into its registered domain via the Public Suffix List.
community_idComputes the Community ID flow hash for network events.
fingerprintHashes fields into a stable deduplication identity.
enrich_esJoins the record against an Elasticsearch/Easysearch index.
pattern_taggerTags records with the log pattern they belong to.
add_localeStamps events with the host’s timezone abbreviation or UTC offset.

Routing & Governance #

ProcessorDescription
throttlePer-key rate limiting (token bucket); exceeding records are tagged or dropped.
sampleProbabilistic sampling by ratio.
cloneDuplicates the current record N times with optional mutations.
drop_eventMarks the current record to be dropped from the batch.
drop_fieldsRemoves fields; with keep: true inverts into prune semantics.
redactMasks sensitive substrings in the configured fields.

Sink & Advanced #

ProcessorDescription
pizza_bulkShips the batch to a Pizza engine via its /_bulk endpoint.
scriptArbitrary record transforms in ECMAScript (goja).
Edit Edit this page