On Thu, Mar 12, 2015 at 10:06:29PM +0100, Michael Biebl wrote:
> Am 12.03.2015 um 18:12 schrieb Marc Fournier:
> > Package: rsyslog
> > Version: 8.8.0-3
> > Severity: wishlist
> > Tags: patch
> > 
> > Dear Maintainer,
> > 
> > Starting with version 8.7.0, rsyslog comes with a new module allowing to
> > publish log messages to Apache Kafka. The support lib needed for this
> > (librkafka-dev) is part of Debian since Jessie.
> > 
> > The attached patch adds the bits needed to build this module as a
> > separate package (based on how support for omelasticsearch was done).
> > 
> > Thanks taking this request in account, and thanks for maintaining this
> > package in Debian !
> 
> Thanks for your contribution, Marc.
> 
> Patch looks good. Since I don't have a Apache Kafka setup, I don't know,
> what environment I need to have installed and what configuration steps
> need to be done to make the plugin work.
> 
> Could you write a README.Debian, similar to
> debian/rsyslog-mongodb.README.Debian and update the patch accordingly?
> 
> I think this would be helpful for people installing this plugin.

Here you go!

As Kafka isn't part of Debian and as a production service can be
non-trivial to setup, I'm pointing people to the official documentation and
staying voluntarily vague about this point. I hope this is OK.

Cheers,
Marc
>From a849a7c5063f4f1840404cd7038a5732446c8d5e Mon Sep 17 00:00:00 2001
From: Marc Fournier <marc.fourn...@camptocamp.com>
Date: Mon, 16 Mar 2015 23:11:45 +0100
Subject: [PATCH 2/2] Add README.Debian for omkafka module

---
 debian/rsyslog-kafka.README.Debian | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 debian/rsyslog-kafka.README.Debian

diff --git a/debian/rsyslog-kafka.README.Debian b/debian/rsyslog-kafka.README.Debian
new file mode 100644
index 0000000..0470e37
--- /dev/null
+++ b/debian/rsyslog-kafka.README.Debian
@@ -0,0 +1,26 @@
+How to use rsyslog and Apache Kafka
+===================================
+
+Starting with version 8.7.0, rsyslog comes with an output module named
+“omkafka”, allowing to publish log messages to an Apache Kafka message broker.
+
+Apache Kafka isn't part of the Debian archive, and documenting how to set it up
+is out of the scope of this document. Fortunately, setting up a single-node
+Kafka service is quite easy. The following instructions should be enough to get
+started: https://kafka.apache.org/documentation.html#quickstart
+
+At this point, you'll have to alter your rsyslog configuration, typically by
+adding the following lines to rsyslog.conf (or to a seperate files such as
+/etc/rsyslog.d/kafka.conf, which will be included by the main config file):
+
+ module(load="omkafka")
+ *.* action(type="omkafka" topic="test")
+
+Don't forget to restart the rsyslogd daemon, and make sure the “topic”
+parameter matches one of the topics in Kafka. You should then be able to start
+consuming the logs stored in Kafka with the consumer of your choice. A trivial
+consumer comes with the Kafka server installation.
+
+The full configuration details of this module, are found in the following file
+(which is part of the rsyslog-doc package):
+/usr/share/doc/rsyslog-doc/html/configuration/modules/omkafka.html
-- 
2.1.4

Reply via email to