Inputs

file

class logcabin.inputs.file.File(path, statedir=None)

Tails events from a log file on disk.

Creates events with the field ‘data’ set to the line received.

Parameters:
  • path (string) – path on the file system to the log file(s), wildcards may be used to match multiple files.
  • statedir (string) – writable directory to store state for files

Example:

File(path='/var/log/syslog')

udp

class logcabin.inputs.udp.Udp(port, allow_hosts=[])

Receives from a udp port.

Creates events with the field ‘data’ set to the packet received.

Parameters:
  • port (integer) – listening port
  • allow_hosts (list) – udp authorized clients or empty for disable

Example:

Udp(port=6000)

Udp(port=6000, allow_hosts=['1.1.1.1', '192.168.1.1'])

zeromq

class logcabin.inputs.zeromq.Zeromq(address='tcp://*:2120', mode='bind', socket='PULL')

Receives from a zeromq socket.

Creates events with the field ‘data’ set to the packet received.

Parameters:
  • address (string) – zeromq address to bind on (default: tcp://*:2120)
  • mode (string) – connect or bind (default: bind)
  • socket (string) – PULL or SUB (default: PULL)

Example:

Zeromq(address='tcp://*:2121', mode='bind', socker='PULL')