Skip to main content

syslog-ng contributions redefined

syslog-ng has been around for about 12 years now, but I think the biggest change in the project's life is imminent: with the upcoming release of syslog-ng OSE 3.2, syslog-ng will become an independent entity.

Until now, syslog-ng was primarily maintained & developed by BalaBit, copyrights needed to be reassigned in order to grant BalaBit special privileges. BalaBit used her privileges to create a dual-licensed fork of syslog-ng, named "syslog-ng Premium Edition". The value we offer over the Open Source Edition of syslog-ng are things that larger enterprises require:
  • support on a large number of UNIX platforms (27 as of 3.1),
  • smaller and larger feature differences (like the encrypted/digitally signed logfile feature)
  • better test coverage and release management
  • longer term support
Although perfectly legal, this business model was not welcome in various Free Software communities, and has caused friction and harm, because BalaBit has enjoyed a privilege that no others could get. We plan to fix this situation and we've worked hard in the past months to make this possible.

We're letting syslog-ng go: no signed Contributory License Agreements will be required in order to contribute to syslog-ng in the future.

This is not just a matter of policy: while BalaBit wants to be a true citizen of the Free Software world, we also need to ensure the continued revenue stream that the Premium Edition provides. The adjusted business model allows us to deliver what our customers need, and at the same time make it possible for anyone else in the community to have the same privileges as BalaBit has.

The syslog-ng changes in 3.2 that I feel are most important are detailed below.

Plugins

syslog-ng was transformed from being a monolithic executable, to a core and a set of plugins.

Plugins range from source and destination drivers, filters, parsers, rewrite objects, anything can be extended with the use of a relatively simple plugin.

And this change didn't transform the configuration file format, it remained the same as before: readable and flexible. If you don't want to look under the hood, no functionality has changed, except plugins are loaded at runtime, and as a side effect, the syntax error reports are way better.

The core is licensed under the LGPL and plugins are licensed under the GPL. This legal framework allows BalaBit to deliver value to its customers in non-free plugins and syslog-ng related services.

syslog-ng Configuration Library

syslog-ng is an infrastructure element: very flexible, but sometimes intimidating. For example, having to specify the pad_size() option for an HP-UX /dev/log device explicitly makes syslog-ng flexible, but not very user-friendly.

It is common to share working configuration snippets on the mailing list or elsewhere in the syslog-ng community. We try to concentrate this effort with the creation of the syslog-ng Configuration Library (aka SCL). This library is a set of config snippets that can be included into a syslog-ng configuration file, using proper defaults but still allowing customization.

For example: we've created a source driver named "system()" which automatically expands to the local log devices as needed by the current Operating System syslog-ng runs on, but it is also possible to create application specific configuration snippets (for example apache source?) and ship it as a ready to use config block. See this post for more information.

This makes it possible to create a configuration file that will run on each of your platforms. In fact, we did that too: syslog-ng now comes with a default configuration file.

Support for non-syslog messages

Since syslog-ng is now plugin based and even the "syslog" message format as such is a plugin, it is now quite easy to add support for non-syslog message sources. As an example, we've added a plugin to parse Linux process accounting records, which makes it trivial to collect this data as well and possibly use it as a source of information when correllating data.

Future plugins like creating a MIB aware SNMP listener, or possibly processing netflow data, but I'd like to create a generic SQL source as well.

Support for these formats doesn't mean that syslog-ng would transform them into textual messages: proper name-value structure is kept and it is possible to put them into nicely structured SQL tables. Of course if all you want to transform them to text for readability, that's possible too with the use of a template().

patterndb project

Like I announced before, we're starting a parallel project to create a set of message patterns directly usable with syslog-ng's db-parser().

Current state

The changes are happening in the syslog-ng 3.2 repository at:

http://git.balabit.hu/

We have created a source-only 3.2alpha1 release of the current state. It runs our automated test harness on Linux, but of course it is not yet recommended in production environments. The release can be downloaded from www.balabit.com.

There were significant changes in how syslog-ng is compiled, thus it is expected that we have build issues on non-Linux systems. We expect to address these issues as they are found and create a 3.2beta1 release, for a longer beta testing.

Future

Parallel to fixing up the remaining issues on syslog-ng 3.2, we're going to open new ways to improve syslog-ng in the 3.3 branch. The most important item on our product backlog is to address the scalability problems and improve performance of syslog-ng.

Summary

With the upcoming changes in syslog-ng OSE 3.2 possible contributions will be greatly expanded:
  • write a pattern for your favourite application and process log data faster + easier
  • write an SCL configuration snippet, make your application easier to integrate with syslog-ng
  • write a plugin for your favourite NoSQL database,
  • write a plugin for a transformation that syslog-ng is not capable of doing right now (what about facility / severity rewrite rules? easy as a piece of cake)
  • write a plugin for things that you do with an external script
  • or contribute to the core of syslog-ng.
And all this without having to sign paperwork.

Comments

Popular posts from this blog

Troubleshooting our Buderus Logamatic 4000 based heating system, part V (temperature sensors)

In this series of blog posts I am revisiting the process of troubleshooting the heating system in our new house. In the past installments I've described the most important elements of the system (and the ones I fixed), since those didn't reveal the true issue with my heating, I needed to go on. This post is about my monitoring gear. Temperature sensing was a key element of finding the solution. First of all, I have a number of analogue temperature gauges around the boiler/furnace, each attached to a specific section of the system. What I had to learn was that these gauges are very slow to react, and thus were pretty much unusable for my goals. If your temperature has very low volatility, they might be fine, but if you want to understand how and why temperature changes, you will need something that gives you a reading every 10-30 seconds. To address this problem I used a dormant Raspberry Pi and a pair or Onewire sensors I had lying around. These were of the type DS18

From RPi to ESPHome, from DIY to a professional solution

Avid readers of this blog may know that I have add a few temperature sensors to my heating setup (exactly 8 of them), in order to troubleshoot an issue we had as we moved into our new house. The description how I did that is described in this post. I used DS18B20 sensors and a Raspberry Pi to monitor temperature changes which delivered measurements to my Homeassistant installation over MQTT using rpi-temperature-mqtt . Over time, I added more and more functionality to this RPi: controlling the boiler via relays and also monitoring the serial bus of my Buderus boiler. Adding all these functions incrementally was pretty simple, but as a professional software engineer, I was feeling increasingly uncomfortable with how I would reproduce the same installation should the RPi fail. As a software professional I believe in CI/CD systems, automated tests and deployment. Infrastructure as Code and all that. I have to confess that this deployment was completely unlike show it should have been don

Sniffing the Buderus Logamatic 4000 bus

Avid readers of this blog might know that I already had a couple of projects around the heating in our house. The latest addition to these projects is a mechanism to listen in on the Buderus's bus to gather and log information such as outside temperature, target temperatures in the heating circuits, turn-on and turn-off temperatures of the burner, etc. My intention with this information is to improve heating efficiency (as measured in gas used) and also to get a more in-depth understanding of the engineering aspects of this system (mechanical & electronic engineering and computer science). Previously I've installed DS18B20 sensors all around, monitoring the system from the "outside", by sniffing the bus, I get a peek into the inside of the system. When I started, I've found the site https://www.holzleitner.com/el/buderus-monitor/index-en.html which contained a reverse-engineered description of how the bus system of Buderus works. Then I've stumbled into t