Skip to content

Latest commit

 

History

History
89 lines (77 loc) · 3.27 KB

index.md

File metadata and controls

89 lines (77 loc) · 3.27 KB
Raw

Processors

Processors receive entries and transform them, parsing, setting or deleting properties. They can filter, group, call external scripts, derivate data, and many more.

Processors operate always in serial mode. That is, when multiple processors are present in a flow, they are chained so one entry must pass through all of them (unless it is filtered) until it is sent to the transporters phase.

A processor can ben synchronous or asynchronous. Either way, entries alwais mantain their relative order, and are processed this way.

This is the core set of included processors:

Configuration

Every processor is configured the same way in the JSON configuration file:

"processors" : {
	"parser" : {
		"type" : "csvparser",
		"when" : {
			"filter" : "${originalMessage}.startsWith('a')",
			"nomatch" : "block"
		},
		"config" : {
			"output" : "csv",
			"cores" : 4,
			"options" : {
				"trim" : true,
				"cast" : true,
				"delimiter" : ",",
				"columns" : [
					"VMail Message","Day Mins","Eve Mins","Night Mins","Intl Mins","CustServ Calls",
					"Day Calls","Day Charge","Eve Calls","Eve Charge","Night Calls","Night Charge",
					"Intl Calls","Intl Charge","Area Code","Phone","Account Length","Int'l Plan",
					"VMail Plan","State"
				]
			}
		}
	}
}

Let's look at each section of the JSON configuration:

  • ID : The first key (parser) is the ID / Reference of the processor. It can be whatever name you like (following JSON rules), and will be used as a reference in other sections.
  • type : The type of the processor (as seen before).
  • config : These are the particular configuration parameters of each processor type.
  • when : Optional. It defines a very first filter for entries.
    • filter : Can be an expression or false. If an entry match the expression, it will be sent to flows; otherwise the entry is ignored.
    • match : Can be process (default), bypass or block. If process, when entry match the filter expression, it is processed by the component. On bypass mode, the component ignores the entry and sends it to the next component in the flow. if block, the entry is completely ignored.
    • nomatch : Can be process, bypass or block. Action to perform when the entry doesn't match the filter.

Processor Groups

A chain of processors can be grouped under a single ID, so it's easy to reference it, using this single ID instead of the complete list of processor IDs:

{
	"processorGroups" : {
		"chain1" : ["procc1","procc2","procc3"]
	},

	"flows" : [
		// Non grouped mode
		{"from":"*", "processors":["procc1","procc2","procc3"]},
		// Grouped modes
		{"from":"*", "processors":"$chain1"},
		{"from":"*", "processors":["$chain1"]},
		// Mixed mode
		{"from":"*", "processors":["$chain1","$chain2","another_procc"]},
	]
}

Back