The Python destination allows you to write your own destination in Python. You can import external Python modules to process the messages, and send them to other services or servers.

Important Information

  • The Python block must be a top-level block in the syslog-ng OSE configuration file.\

  • If you store the Python code in a separate Python file and only include it in the syslog-ng OSE configuration file, make sure that the PYTHON_PATH environment variable includes the path to the Python file, and export the PYTHON_PATH environment variable.\

  • Starting with 3.26, syslog-ng OSE assigns a persist name to Python sources and destinations. The persist name is generated from the class name. If you want to use the same Python class multiple times in your syslog-ng OSE configuration, add a unique persist-name() to each source or destination, otherwise syslog-ng OSE will not start.

Python destinations consist of two parts. The first is a syslog-ng OSE destination object that you define in your syslog-ng OSE configuration and use in the log path. This object references a Python class, which is the second part of the Python destination. The Python class processes the log messages it receives, and can do virtually anything that you can code in Python. You can either embed the Python class into your syslog-ng OSE configuration file, or store it in an external Python file.

For this test, we will embed the Python class into the configuration file.

Status

Architecture Status
x86 Works
ARM Works

Configuration File Used 

@version: 3.33
@include "scl.conf"

​destination console{
  file(/dev/stdout);
};

​source s_python{
  python(
    class("TestPython")
      options(
        "option1" "value1",
        "option2" "value2"
      )
    );
  };

  ​python {
    from syslogng import LogSource
    from syslogng import LogMessage
    import time​class

    TestPython(LogSource):

    def init(self, options): # optional
      print("init")
      print(options)
      self.exit = False
      return True​

    def deinit(self): # optional
      print("deinit")

    def run(self): # mandatory
      print("run")
      while not self.exit:
        # Must create a message
        msg = LogMessage("this is a log message from Python Source")
        self.post_message(msg)
        time.sleep(1)

    def request_exit(self): # mandatory
      print("exit")
      self.exit = True
  };

  ​log {
    source(s_python);
    destination(console);
  };

Proof

Updated: