DMAAP-BC - Update Release Note Date
[dmaap/buscontroller.git] / docs / logging / logging.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2    .. http://creativecommons.org/licenses/by/4.0
3
4 Logging
5 =======
6
7 .. note::
8    * This section is used to describe the informational or diagnostic messages emitted from
9      a software component and the methods or collecting them.
10
11    * This section is typically: provided for a platform-component and sdk; and
12      referenced in developer and user guides
13
14    * This note must be removed after content has been added.
15
16
17 Where to Access Information
18 ---------------------------
19 Bus Controller uses logback framework to generate logs found under logs/ONAP.
20 Logs are organized into files:
21 application.log - contains general logs
22 error.log - contains errors
23 audit.log - contains transactions for audit trail
24 server.log - contains jetty server specific logging
25
26 Error / Warning Messages
27 ------------------------
28 Logging to error.log will distinguish critical errors from warnings.