[DMAAP-BC] Consolidate bus controller repos

[dmaap/buscontroller.git] / docs / logging.rst

diff --git a/docs/logging.rst b/docs/logging.rst
new file mode 100644 (file)
index 0000000..676a106
--- /dev/null
+++ b/docs/logging.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+   .. http://creativecommons.org/licenses/by/4.0
+
+Logging
+=======
+
+Where to Access Information
+---------------------------
+Bus Controller uses logback framework to generate logs found under logs/ONAP.
+Logs are organized into files:
+
+- application.log - contains general logs
+- error.log - contains errors
+- audit.log - contains transactions for audit trail
+- server.log - contains jetty server specific logging
+
+Error / Warning Messages
+------------------------
+Logging to error.log will distinguish critical errors from warnings.