docs/docs-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
  20 +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
  21 | Location                                 | Type                | Description                                                                                                                                                                               | Rolling             |
  22 +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
  23 | /opt/app/vid/logs/vid/application.log    | Jetty server log    | This log describes inner flows inside VID                                                                                                                                                 | the log rolls daily |
  24 +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
  25 | /opt/app/vid/logs/vid/audit.log          | application audit   | An audit record is created for some of the operations in VID                                                                                                                              | rolls at 20 mb      |
  26 +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
  27 | /opt/app/vid/logs/vid/debug.log          | application logging | We can enable higher logging on demand by editing the logback.xml inside the server docker.                                                                                               | rolls at 20 mb      |
  28 |                                          |                     | The file is located under: WEB-INF/classes/logback.xml.                                                                                                                                   |                     |
  29 |                                          |                     | This log holds the debug and trace level output of the application.                                                                                                                       |                     |
  30 +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
  31 | /opt/app/vid/logs/vid/error.log          | application logging | This log holds the info and error level output of the application.                                                                                                                        | rolls at 20 mb      |
  32 +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
  33
  34
  35 Error / Warning Messages
  36 ------------------------