Inputs

There are several inputs avalable, all of them are available in the logdispatchr.inputs module.

class logdispatchr.inputs.BaseInput(**kwargs)[source]

Bases: object

This class takes stuff from a source, and converts it in the standard internal message format. It is also the base class for any input.

Parameters:
  • formatter (str) – A string identifying the formatter to use
  • key (str) – the identifier for the messages comming from this source
  • max_waiting_messages (queue.Queue) – the size of the internal queue.
get()[source]
Returns:the next message in the queue
Return type:Message

See also

Models

has_available_message()[source]
Return type:boolean
Returns:wether we have messages waiting or not.
setup()[source]

Any operation needed before actually recieving messages. Should be overriden in child classes if needed.

class logdispatchr.inputs.LogdispatchrUDPInput(**kwargs)[source]

Bases: logdispatchr.inputs.BaseInput

Listens to forwarded messages from other logdispatchr instances. Please see the “models” page of the documentation to know more about the exchange format

Parameters:
  • host (str) – the host to bind to. The most common is 0.0.0.0, to listen to all interfaces, but localhost or 127.0.0.1 are a possibility
  • port (int) – the port we should listen to
get()
Returns:the next message in the queue
Return type:Message

See also

Models

has_available_message()
Return type:boolean
Returns:wether we have messages waiting or not.
class logdispatchr.inputs.UDPSyslogInput(**kwargs)[source]

Bases: logdispatchr.inputs.BaseInput

A naïve UDP rsyslog reciever. Doesn’t parse the recieved message.

Parameters:
  • host (str) – the host to bind to. The most common is 0.0.0.0, to listen to all interfaces, but localhost or 127.0.0.1 are a possibility
  • port (int) – the port we should listen to
get()
Returns:the next message in the queue
Return type:Message

See also

Models

has_available_message()
Return type:boolean
Returns:wether we have messages waiting or not.