Ottomata has submitted this change and it was merged. Change subject: Added README.md markdown file ......................................................................
Added README.md markdown file Change-Id: Ie4170698c6b241ac50ea33d41c7d405bee8100c2 --- A README.md 1 file changed, 83 insertions(+), 0 deletions(-) Approvals: Ottomata: Verified; Looks good to me, approved Diederik: Looks good to me, but someone else must approve diff --git a/README.md b/README.md new file mode 100644 index 0000000..c88a537 --- /dev/null +++ b/README.md @@ -0,0 +1,83 @@ +varnishkafka - varnish log collector with Apache Kafka integration +================================================================== + +Copyright (c) 2013 [Wikimedia Foundation](http://www.wikimedia.org) + +Copyright (c) 2013 [Magnus Edenhill](http://www.edenhill.se/) + +[https://github.com/wikimedia/varnishkafka](https://github.com/wikimedia/varnishkafka) + +# Description + +**varnishkafka** is a varnish log collector with an integrated Apache Kafka +producer. +It was written from scratch with performance and modularity in mind, +**varnishkafka** consumes about a third of the CPU that varnishncsa does and +has a far more frugal memory approach. + +# Supported outputs and formats + +Currently supported outputs: + + * kafka - produce messages to one or more Apache Kafka brokers + * stdout - write log messages to stdout (as varnishncsa does) + +Currently supported output formats: + + * string - arbitrary text output according to the configured formatting. + * json - output as JSON with configurable field, field types and names. + +New formats and outputs can easily be added. + +# Configuration + +**varnishkafka** is configured with a configuration file and is designed +to operate as a system daemon. + +Please see the configuration file example, +*varnishkafka.conf.example*, for a full description of configuration properties. + +The standard Varnish VSL command line arguments are supposed, both through +the command line and configuration file. + +# License + +**varnishkafka** is licensed under the 2-clause BSD license. + + +The Apache Kafka support is provided by [librdkafka](https://github.com/edenhill/librdkafka) + + +# Usage + +## Requirements + libvarnishapi + librdkafka + libyajl + pthreads + zlib + +## Instructions + +### Building + + make + sudo make install + # or to install in another location than /usr/local, set DESTDIR env + # to the filesystem root of your choice. + sudo make DESTDIR=/usr make install + + +### Run + + # If /etc/varnishkafka.conf exists + varnishkafka + + # Alternative configuration path + varnishkafka -S /path/to/varnishkafka.conf + + # Read offline log file + varnishkafka -r varnishlog.vsl + + # Usage description + varnishkafka -h -- To view, visit https://gerrit.wikimedia.org/r/83347 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Ie4170698c6b241ac50ea33d41c7d405bee8100c2 Gerrit-PatchSet: 1 Gerrit-Project: operations/software/varnish/varnishkafka Gerrit-Branch: master Gerrit-Owner: Edenhill <mag...@edenhill.se> Gerrit-Reviewer: Diederik <dvanli...@wikimedia.org> Gerrit-Reviewer: Faidon Liambotis <fai...@wikimedia.org> Gerrit-Reviewer: Mark Bergsma <m...@wikimedia.org> Gerrit-Reviewer: Ottomata <o...@wikimedia.org> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
