| Ofir Sonsino | 49351d7 | 2017-10-24 10:18:23 +0300 | [diff] [blame] | 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 | |
| Ofir Sonsino | 0e1e6a9 | 2017-11-08 11:31:34 +0200 | [diff] [blame] | 7 | Where to Access Log Information |
| 8 | -------------------------------- |
| Ofir Sonsino | 49351d7 | 2017-10-24 10:18:23 +0300 | [diff] [blame] | 9 | |
| Ofir Sonsino | 0e1e6a9 | 2017-11-08 11:31:34 +0200 | [diff] [blame] | 10 | +------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 11 | | Location | Type | Description | |
| Ofir Sonsino | 50552cd | 2017-11-08 12:17:53 +0200 | [diff] [blame] | 12 | +================================================+=====================+===========================================================================================================================================================================================+ |
| Ofir Sonsino | 0e1e6a9 | 2017-11-08 11:31:34 +0200 | [diff] [blame] | 13 | | /usr/local/tomcat/logs/catalina.YYYY-MM-DD.log | Jetty server log | Tomcat server information | |
| 14 | +------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 15 | | /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". | |
| 16 | +------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 17 | | /opt/app/vid/logs/vid/application.log | Application logging | This log describes internal flows within VID. | |
| 18 | +------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 19 | | /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. | |
| 20 | | | | The file is located under: WEB-INF/classes/logback.xml. | |
| 21 | | | | This log holds the application's debug and trace level output. | |
| 22 | +------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 23 | | /opt/app/vid/logs/vid/error.log | Application logging | This log holds the application's exceptions info and error level output. | |
| 24 | +------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 25 | | /opt/app/vid/logs/vid/metrics.log | Application logging | This log holds the metrics info on application's transactions. | |
| 26 | +------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| Ofir Sonsino | 49351d7 | 2017-10-24 10:18:23 +0300 | [diff] [blame] | 27 | |
| Bartosz Gardziejewski | b2f2380 | 2019-07-03 11:24:32 +0200 | [diff] [blame] | 28 | |
| 29 | How to create error report |
| 30 | -------------------------- |
| 31 | |
| 32 | In case of error appearance a red button with "Create report" on it, will show up. |
| 33 | |
| 34 | .. image:: ./images/VID_errorReportButton.png |
| 35 | .. image:: ./images/VID_errorReportSDC.png |
| 36 | |
| 37 | Pressing that button will show window with data collected from GUI and fetched from API. |
| 38 | |
| 39 | .. image:: ./images/VID_errorReportDownloading.png |
| 40 | |
| 41 | That data may be download by pressing "download" button. |
| 42 | **After closing the report window, data may not be available.** |