Plugins: utilities

Pass

This plugin simply passes the action and payload along, printing out information on stdout along the way. It's mostly used for debugging.

Configuration

field	type	description
line	int	(optional) print a brief summary on stdout every n alerts. 0 turns off. Default 100.
dump	int	(optional) dump the data payload to stdout every n alerts. 0 turns off. Default 0.

Input

No requirements.

Output

No requirements.

Actions

• alert: print a brief summary or dump the payload as dictated by the configuration. Pass on payload unmodified.
• revoke: dump the payload if dump is not 0. Pass on payload unmodified.
• reset: dump the payload if dump is not 0. Pass on payload unmodified.
• report: dump the payload. Pass on payload unmodified.

SeriesBinner

This plugin takes a list of numbers and bins them. For instance, it will take a time series and make a time distribution.

Configuration

field	type	description
in_field	string	name of field from which to extract data
out_xfield	string	name of x axis field for output data, to contain bin edges
out_yfield	string	name of y axis field for output data, to contain bin contents
nbins	int	number of bins
xlow	float	low edge of histogram
xhigh	float	high edge of histogram
flags	list(string)	(optional) options

The flags are as follows:

flag	description
overflow	calculate underflow and overflow
stats	calculate mean and rms

Input

SeriesBinner reads the payload field identified by field in its configuration. The payload is assumed to be an array-like object such as a list or tuple.

Output

SeriesBinner adds the following fields to the payload, many of which simply copy the configuration.

field	type	description
in_field	string	name of field from which to extract data
out_xfield	string	name of x axis field for output data, to contain bin edges
out_yfield	string	name of y axis field for output data, to contain bin contents
nbins	int	number of bins
xlow	float	low edge of histogram
xhigh	float	high edge of histogram
count	int	number of entries in input data
underflow	int	number of underflows (if overflow flag on)
overflow	int	number of overflows (if overflow flag on)
mean	float	mean of input data, regardless of whether within histogram range (if stats flag on)
rms	float	RMS of input data, regardless of whether within histogram range (if stats flag on)
(out_xfield)	numpy.array	low edges of histogram bins
(out_yfield)	numpy.array	histogram bin contents

Actions

action	description
alert	bin input data, alert downstream
revoke	forward
reset	forward
report	forward

BinnedAccumulator