diff options
| author |   Ofir Sonsino <os0695@att.com> | 2017-11-08 11:31:34 +0200 |
|---|---|---|
| committer | Ofir Sonsino <os0695@att.com> | 2017-11-08 11:31:34 +0200 |
| commit | 0e1e6a925e99446cdd653b606b04c2fc43fb28c0 (patch) | |
| tree | d788259eaa8d040753b5eb7df81054c9a4763718 /docs/docs-logging.rst | |
| parent | ce389b5342e7614c5d79533b718710dc4b76e6b8 (diff) | |
Update ReadTheDocs docs folder
Change-Id: Ia95169494404548706371f608b4e53ac8ffa6ad2
Issue-ID: VID-71
Signed-off-by: Ofir Sonsino <os0695@att.com>
Diffstat (limited to 'docs/docs-logging.rst')
| -rw-r--r-- | docs/docs-logging.rst | 34 |
1 files changed, 19 insertions, 15 deletions
diff --git a/docs/docs-logging.rst b/docs/docs-logging.rst index ee1cc739..e9a424b1 100644 --- a/docs/docs-logging.rst +++ b/docs/docs-logging.rst @@ -4,20 +4,24 @@ Logging ======= -Where to Access Information ---------------------------- +Where to Access Log Information +-------------------------------- -+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Location | Type | Description | -+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| /opt/app/vid/logs/vid/application.log | Jetty server log | This log describes inner flows inside VID | -+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| /opt/app/vid/logs/vid/audit.log | application audit | An audit record is created for some of the operations in VID | -+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| /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. | -| | | The file is located under: WEB-INF/classes/logback.xml. | -| | | This log holds the debug and trace level output of the application. | -+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| /opt/app/vid/logs/vid/error.log | application logging | This log holds the info and error level output of the application. | -+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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. | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |