diff --git a/docs/source/news.rst b/docs/source/news.rst index e6dcb9f..7f30c04 100644 --- a/docs/source/news.rst +++ b/docs/source/news.rst @@ -7,7 +7,7 @@ What's New Documentation: * Documented how to add log levels, and how to filter Eliot logs. - +* Logstash configuration is closer to modern version's options, though still untested. 1.3.0 ^^^^^ diff --git a/docs/source/outputting/elasticsearch.rst b/docs/source/outputting/elasticsearch.rst index 7be957d..7293756 100644 --- a/docs/source/outputting/elasticsearch.rst +++ b/docs/source/outputting/elasticsearch.rst @@ -1,6 +1,8 @@ Using Logstash and ElasticSearch to Process Eliot Logs ====================================================== +.. note:: Logstash, Elasticsearch and Kibana change frequently. These instructions might not be quite accurate. + `ElasticSearch`_ is a search and analytics engine which can be used to store Eliot logging output. The logs can then be browsed by humans using the `Kibana`_ web UI, or on the command-line using the `logstash-cli`_ tool. Automated systems can access the logs using the ElasticSearch query API. diff --git a/docs/source/outputting/logstash_standalone.conf b/docs/source/outputting/logstash_standalone.conf index fba6645..992b7cd 100644 --- a/docs/source/outputting/logstash_standalone.conf +++ b/docs/source/outputting/logstash_standalone.conf @@ -22,29 +22,10 @@ output { } elasticsearch { - # Documents in ElasticSearch are identified by tuples of (index, mapping - # type, document_id). - # References: - # - http://logstash.net/docs/1.3.2/outputs/elasticsearch - # - http://stackoverflow.com/questions/15025876/what-is-an-index-in-elasticsearch - # We make the document id unique (for a specific index/mapping type pair) by # using the relevant Eliot fields. This means replaying messages will not # result in duplicates, as long as the replayed messages end up in the same - # index (see below). + # index. document_id => "%{task_uuid}_%{task_level}" - - # By default logstash sets the index to include the current date. When we - # get to point of replaying log files on startup for crash recovery we might - # want to use the last modified date of the file instead of current date, - # otherwise we'll get documents ending up in wrong index. - - #index => "logstash-%{+YYYY.MM.dd}" - - index_type => "Eliot" - - # In a centralized ElasticSearch setup we'd be specifying host/port - # or some such. In this setup we run it ourselves: - embedded => true } }