Output Modules

class wishbone.module.null.Null(actor_config, selection=None, payload=None, native_events=False, parallel_streams=1, *args, **kwargs)

Purges events.

Purges incoming events.

Parameters:

- selection(str)("data")
   |  The event key to submit.

- payload(str)(None)
   |  The string to submit.
   |  If defined takes precedence over `selection`.

- native_events(bool)(False)
   |  If True, outgoing events are native events.

- parallel_streams(int)(1)
   |  The number of outgoing parallel data streams.

Queues:

- inbox
   |  incoming events

class wishbone.module.stdout.STDOUT(actor_config, selection=None, payload=None, native_events=False, parallel_streams=1, counter=False, prefix='', pid=False, colorize=False, foreground_color='WHITE', background_color='RESET', color_style='NORMAL')

Prints event data to STDOUT.

Prints incoming events to STDOUT. When <complete> is True, the complete event including headers is printed to STDOUT.

You can optionally define the colors used.

Parameters:

- background_color(str)("RESET")
   |  The background color.
   |  Valid values: BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, RESET

- colorize(bool)(False)
   |  When True all STDOUT output is wrapped in between ANSI color
   |  escape sequences defined by `foreground_color`, `background_color`,
   |  `color_style`.

- color_style(str)("NORMAL")
   |  The coloring style to use
   |  Valid values: DIM, NORMAL, BRIGHT

- counter(bool)(False)
   |  Puts an incremental number for each event in front
   |  of each event.

- foreground_color(str)("WHITE")
   |  The foreground color.
   |  Valid values: BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE

- native_events(bool)(False)
   |  If True, outgoing events are native events.

- parallel_streams(int)(1)
   |  The number of outgoing parallel data streams.

- payload(str)(None)
   |  The string to submit.
   |  If defined takes precedence over `selection`.

- pid(bool)(False)
   |  Includes the pid of the process producing the output.

- prefix(str)("")*
   |  Puts the prefix in front of each printed event.

- selection(str)(None)
   |  The event key to submit.
   |  If ``None`` the complete event is selected.

Queues:

- inbox
   |  Incoming events.

class wishbone.module.wbsyslog.Syslog(actor_config, selection='data', payload=None, native_events=False, parallel_streams=1, level=5, ident='sphinx-build')

Submits event data to syslog.

Logevents have following format:

(6, 1367682301.430527, ‘Router’, ‘Received SIGINT. Shutting down.’)

The first value corresponds to the syslog severity level.

Parameters:

- ident(str)(<script_name>)*
   |  The syslog id string.
   |  If not provided the script name is used.
   |  (Can be a dynamic value)

- level(int)(5)*
   |  The loglevel.
   |  (Can be a dynamic value)

- native_events(bool)(False)
   |  If True, outgoing events are native events.

- payload(str)(None)
   |  The string to submit.
   |  If defined takes precedence over `selection`.

- parallel_streams(int)(1)
   |  The number of outgoing parallel data streams.

- selection(str)("data")
   |  The event key to submit.

Queues:

- inbox
   |  incoming events