Skip to content

Commit

Permalink
Text for the loggers
Browse files Browse the repository at this point in the history
  • Loading branch information
Frédéric Haziza authored and Frédéric Haziza committed Jan 23, 2018
1 parent 07e522c commit 3ab8d09
Showing 1 changed file with 20 additions and 16 deletions.
36 changes: 20 additions & 16 deletions docs/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,21 +52,26 @@ Logging

A similar mechanism is used to overwrite the default logging settings.

The ``--log <file>`` argument is used to configuration where the logs go.
Without it, we look at the ``DEFAULT/log_conf`` key/value pair from the loaded configuration.
If the latter doesn't exist, there is no logging capabilities.

The ``<file>`` argument can either be a file path in ``INI`` or ``YAML``
format, or *keyword*. In the latter case, the logging mechanism will search for a log file, using that keyword, in the default loggers.

Currently, ``default``, ``debug``, ``syslog``, ``logstash`` and
``logstash-debug`` are `available`_.

Using the logstash logger, We leverage the famous *ELK* stack. *ELK*
stands for **E**\ lasticsearch, **L**\ ogstash and **K**\
ibana. Logstash receives the logs. Elasticsearch stores them and make
them searchable. Kibana contacts the Elasticsearch service to display
the logs in a web interface.
The ``--log <file>`` argument is used to configuration where the logs
go. Without it, we look at the ``DEFAULT/log_conf`` key/value pair
from the loaded configuration. If the latter doesn't exist, there is
no logging capabilities.

The ``<file>`` argument can either be a file path in ``INI`` or
``YAML`` format, or a *keyword*. In the latter case, the logging
mechanism will search for a log file, using that keyword, in the
`default loggers
<https://github.com/NBISweden/LocalEGA/tree/dev/lega/conf/loggers>`_. Currently,
``default``, ``debug``, ``syslog``, ``logstash`` and
``logstash-debug`` are available.

Using the `logstash logger
<https://github.com/NBISweden/LocalEGA/blob/dev/lega/conf/loggers/logstash-debug.yaml>`_,
We leverage the famous *ELK* stack. *ELK* stands for **E**\
lasticsearch, **L**\ ogstash and **K**\ ibana. Logstash receives the
logs. Elasticsearch stores them and make them searchable. Kibana
contacts the Elasticsearch service to display the logs in a web
interface.

.. image:: /static/Kibana.png
:target: _static/Kibana.png
Expand All @@ -90,4 +95,3 @@ file there.
.. _NBIS Github repo: https://github.com/NBISweden/LocalEGA
.. _Docker: https://github.com/NBISweden/LocalEGA/tree/dev/deployments/docker
.. _OpenStack cloud: https://github.com/NBISweden/LocalEGA/tree/dev/deployments/terraform
.. _available: https://github.com/NBISweden/LocalEGA/tree/dev/lega/conf/loggers

0 comments on commit 3ab8d09

Please sign in to comment.