diff --git a/docs/documentation.rst b/docs/documentation.rst index 5ed3adf0259745430c7e4facf3fa8697feacdfa3..5d096ee8ac471eb3a784a9dda2d232ada693b119 100644 --- a/docs/documentation.rst +++ b/docs/documentation.rst @@ -104,7 +104,7 @@ the system up if necessary (see `Scaling`_). Integration With Syslog ~~~~~~~~~~~~~~~~~~~~~~~ -The lens2 daemon is meant to be connected to a syslog server, usually +The lens daemon is meant to be connected to a syslog server, usually a 'collector' for your remote logs, via a FIFO. Lens supports a number of syslog-like formats for its input: @@ -143,6 +143,19 @@ daemon. Furthermore, the indexer daemon will block reading from the FIFO whenever the ES backend is unavailable. + +Integration With Elasticsearch +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +Some maintenance tasks on the Elasticsearch cluster will be +required. For instance, Lens periodically removes old logs from the +index; unless the Elasticsearch index is optimized once in a while, it +will grow unbounded. + + + + Web Application Deployment ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -218,6 +231,13 @@ can reliably insert upwards of 2500 logs/sec. +Links +----- + +A project that is very similar to Lens, but bigger and better, is +Logstash_. + + .. _Elasticsearch: http://www.elasticsearch.org/ @@ -226,3 +246,4 @@ can reliably insert upwards of 2500 logs/sec. .. _Flask: http://flask.pocoo.org/ .. _Flask deployment documentation: http://flask.pocoo.org/docs/deploying/ .. _flup: http://pypi.python.org/pypi/flup +.. _Logstash: http://www.logstash.net/