diff options
| author |   Ofir Sonsino <os0695@att.com> | 2017-11-08 16:55:45 +0200 |
|---|---|---|
| committer | Ofir Sonsino <os0695@att.com> | 2017-11-08 16:55:45 +0200 |
| commit | b07d7922c9bba8d33918ecdb2fd3d3bc03175b9f (patch) | |
| tree | c16da6ad68dee60b327bff15a9f612c96aa3014b /docs/logging.rst | |
| parent | 50552cd71c58a5708679702f7e61e9c63bc93729 (diff) | |
Update ReadTheDocs docs folder
Change-Id: Ifec6f6fd659b1a6d6a3c23f2c02eb2c1fdc0973e
Issue-ID: VID-71
Signed-off-by: Ofir Sonsino <os0695@att.com>
Diffstat (limited to 'docs/logging.rst')
| -rw-r--r-- | docs/logging.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/logging.rst b/docs/logging.rst new file mode 100644 index 00000000..52d18e85 --- /dev/null +++ b/docs/logging.rst @@ -0,0 +1,27 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Logging +======= + +Where to Access Log Information +-------------------------------- + ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Location | Type | Description | ++================================================+=====================+===========================================================================================================================================================================================+ +| /usr/local/tomcat/logs/catalina.YYYY-MM-DD.log | Jetty server log | Tomcat server information | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/audit.log | Application audit | An audit record is created in response to code transactions/operations taking place in VID. For instance "start logging". | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/application.log | Application logging | This log describes internal flows within VID. | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/debug.log | Application logging | Higher level logging can be enabled on demand by editing the logback.xml inside the server docker. | +| | | The file is located under: WEB-INF/classes/logback.xml. | +| | | This log holds the application's debug and trace level output. | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/error.log | Application logging | This log holds the application's exceptions info and error level output. | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/metrics.log | Application logging | This log holds the metrics info on application's transactions. | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + |