package
0.26.2
Repository: https://github.com/nwest1/benthos.git
Documentation: pkg.go.dev

# Packages

Package condition contains logical operators that, based on their configuration, return boolean values from messages under certain circumstances.

# Functions

Descriptions returns a formatted string of collated descriptions of each type.
New creates a processor type based on a processor configuration.
NewArchive returns a Archive processor.
NewArchiveConfig returns a ArchiveConfig with default values.
NewBatch returns a Batch processor.
NewBatchConfig returns a BatchConfig with default values.
NewBoundsCheck returns a BoundsCheck processor.
NewBoundsCheckConfig returns a BoundsCheckConfig with default values.
NewCombine returns a Combine processor.
NewCombineConfig returns a CombineConfig with default values.
NewCompress returns a Compress processor.
NewCompressConfig returns a CompressConfig with default values.
NewConditional returns a Conditional processor.
NewConditionalConfig returns a default ConditionalConfig.
NewConfig returns a configuration struct fully populated with default values.
NewDecode returns a Decode processor.
NewDecodeConfig returns a DecodeConfig with default values.
NewDecompress returns a Decompress processor.
NewDecompressConfig returns a DecompressConfig with default values.
NewDedupe returns a Dedupe processor.
NewDedupeConfig returns a DedupeConfig with default values.
NewEncode returns a Encode processor.
NewEncodeConfig returns a EncodeConfig with default values.
NewFilter returns a Filter processor.
NewFilterConfig returns a FilterConfig with default values.
NewFilterParts returns a FilterParts processor.
NewFilterPartsConfig returns a FilterPartsConfig with default values.
NewGrok returns a Grok processor.
NewGrokConfig returns a GrokConfig with default values.
NewHash returns a Hash processor.
NewHashConfig returns a HashConfig with default values.
NewHashSample returns a HashSample processor.
NewHashSampleConfig returns a HashSampleConfig with default values.
NewHTTP returns a HTTP processor.
NewHTTPConfig returns a HTTPConfig with default values.
NewInsertPart returns a InsertPart processor.
NewInsertPartConfig returns a InsertPartConfig with default values.
NewJMESPath returns a JMESPath processor.
NewJMESPathConfig returns a JMESPathConfig with default values.
NewJSON returns a JSON processor.
NewJSONConfig returns a JSONConfig with default values.
NewMergeJSON returns a MergeJSON processor.
NewMergeJSONConfig returns a MergeJSONConfig with default values.
NewMetadata returns a Metadata processor.
NewMetadataConfig returns a MetadataConfig with default values.
NewMetric returns a Metric processor.
NewMetricConfig returns a MetricConfig with default values.
NewNoop returns a Noop processor.
NewProcessField returns a ProcessField processor.
NewProcessFieldConfig returns a default ProcessFieldConfig.
NewProcessMap returns a ProcessField processor.
NewProcessMapConfig returns a default ProcessMapConfig.
NewSample returns a Sample processor.
NewSampleConfig returns a SampleConfig with default values.
NewSelectParts returns a SelectParts processor.
NewSelectPartsConfig returns a SelectPartsConfig with default values.
NewSplit returns a Split processor.
NewSplitConfig returns a SplitConfig with default values.
NewText returns a Text processor.
NewTextConfig returns a TextConfig with default values.
NewThrottle returns a Throttle processor.
NewThrottleConfig returns a ThrottleConfig with default values.
NewUnarchive returns a Unarchive processor.
NewUnarchiveConfig returns a UnarchiveConfig with default values.
SanitiseConfig returns a sanitised version of the Config, meaning sections that aren't relevant to behaviour are removed.

# Constants

String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.
String constants representing each processor type.

# Variables

Constructors is a map of all processor types with their specs.

# Structs

Archive is a processor that can selectively archive parts of a message into a single part using a chosen archive type.
ArchiveConfig contains configuration fields for the Archive processor.
Batch is a processor that combines messages into a batch until a size limit or other condition is reached, at which point the batch is sent out.
BatchConfig contains configuration fields for the Batch processor.
BoundsCheck is a processor that checks each message against a set of bounds and rejects messages if they aren't within them.
BoundsCheckConfig contains configuration fields for the BoundsCheck processor.
Combine is a processor that combines messages into a batch until a target number of message parts is reached, at which point the batch is sent out.
CombineConfig contains configuration fields for the Combine processor.
Compress is a processor that can selectively compress parts of a message as a chosen compression algorithm.
CompressConfig contains configuration fields for the Compress processor.
Conditional is a processor that only applies child processors under a certain condition.
ConditionalConfig is a config struct containing fields for the Conditional processor.
Config is the all encompassing configuration struct for all processor types.
Decode is a processor that can selectively decode parts of a message following a chosen scheme.
DecodeConfig contains configuration fields for the Decode processor.
Decompress is a processor that can decompress parts of a message following a chosen compression algorithm.
DecompressConfig contains configuration fields for the Decompress processor.
Dedupe is a processor that deduplicates messages either by hashing the full contents of message parts or by hashing the value of an interpolated string.
DedupeConfig contains configuration fields for the Dedupe processor.
Encode is a processor that can selectively encode parts of a message following a chosen scheme.
EncodeConfig contains configuration fields for the Encode processor.
Filter is a processor that checks each message against a condition and rejects the message if a condition returns false.
FilterConfig contains configuration fields for the Filter processor.
FilterParts is a processor that checks each part from a message against a condition and removes the part if the condition returns false.
FilterPartsConfig contains configuration fields for the FilterParts processor.
Grok is a processor that executes Grok queries on a message part and replaces the contents with the result.
GrokConfig contains configuration fields for the Grok processor.
Hash is a processor that can selectively hash parts of a message following a chosen algorithm.
HashConfig contains configuration fields for the Hash processor.
HashSample is a processor that removes messages based on a sample factor by hashing its contents.
HashSampleConfig contains configuration fields for the HashSample processor.
HTTP is a processor that performs an HTTP request using the message as the request body, and returns the response.
HTTPConfig contains configuration fields for the HTTP processor.
InsertPart is a processor that inserts a new message part at a specific index.
InsertPartConfig contains configuration fields for the InsertPart processor.
JMESPath is a processor that executes JMESPath queries on a message part and replaces the contents with the result.
JMESPathConfig contains configuration fields for the JMESPath processor.
JSON is a processor that performs an operation on a JSON payload.
JSONConfig contains configuration fields for the JSON processor.
MergeJSON is a processor that merges JSON parsed message parts into a single value.
MergeJSONConfig contains configuration fields for the MergeJSON processor.
Metadata is a processor that performs an operation on the Metadata of a message.
MetadataConfig contains configuration fields for the Metadata processor.
Metric is a processor that creates a metric from extracted values from a message part.
MetricConfig contains configuration fields for the Metric processor.
Noop is a no-op processor that does nothing.
ProcessField is a processor that applies a list of child processors to a field extracted from the original payload.
ProcessFieldConfig is a config struct containing fields for the ProcessField processor.
ProcessMap is a processor that applies a list of child processors to a new payload mapped from the original, and after processing attempts to overlay the results back onto the original payloads according to more mappings.
ProcessMapConfig is a config struct containing fields for the ProcessMap processor.
Sample is a processor that drops messages based on a random sample.
SampleConfig contains configuration fields for the Sample processor.
SelectParts is a processor that selects parts from a message to append to a new message.
SelectPartsConfig contains configuration fields for the SelectParts processor.
Split is a processor that splits messages into a message per part.
SplitConfig is a configuration struct containing fields for the Split processor, which breaks message batches down into batches of a smaller size.
Text is a processor that performs a text based operation on a payload.
TextConfig contains configuration fields for the Text processor.
Throttle is a processor that limits the stream of a pipeline to one message batch per period specified.
ThrottleConfig contains configuration fields for the Throttle processor.
TypeSpec Constructor and a usage description for each processor type.
Unarchive is a processor that can selectively unarchive parts of a message following a chosen archive type.
UnarchiveConfig contains configuration fields for the Unarchive processor.

# Interfaces

Type reads a message, performs a processing operation, and returns either a slice of messages resulting from the process to be propagated through the pipeline, or a response that should be sent back to the source instead.