Skip to content

Commit

Permalink
Merge pull request kairosdb#262 from paladini/update_log_documentation
Browse files Browse the repository at this point in the history
Add "Logging" section to the documentation.
  • Loading branch information
brianhks committed Mar 12, 2016
2 parents 6318ffb + e43909e commit 9b68a9e
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/docs/Logging.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
============
Logging
============

KairosDB create it's log files in ``/opt/kairosdb/log/``. It works in a daily basis, so every day a new log is created and named as **kairosdb.log**; when the next day comes *kairosdb.log* is compressed and renamed to *kairosdb.<YYYY-MM-DD>.log*, where <YYYY-MM-DD> is the date when this specific log file was created.

Starting from KairosDB 1.1.2, a more robust logging system will be used. From this version, KairosDB will compress logs everyday in order to minimize the space used for log files. Also, every time a log file reaches 100mb, it will be compressed and a new one will be generated for the same day (until the end of the day, when a new log file will be generated too).

**Note:** KairosDB uses the well-know Logback framework to manage it's log files. If you have questions about Logback, please refer to their forums.

If you want to change these logging settings, please take a look at ``/opt/kairosdb/conf/logging/logback.xml`` and at `Logback documentation`_.

.. _Logback documentation: http://logback.qos.ch/manual/configuration.html
1 change: 1 addition & 0 deletions src/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Contents:
ImportExport
WebUI
Configuration
Logging
Statistics
KairosClient
CassandraSchema
Expand Down

0 comments on commit 9b68a9e

Please sign in to comment.