| Rich Bennett | 4b00193 | 2017-10-16 09:25:01 -0400 | [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 | |
| 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 | |
| Idan Amit | 441f20c | 2017-10-17 10:10:24 +0300 | [diff] [blame^] | 16 | +--------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
| 17 | | Server | Location | Type | Description | Rolling | |
| 18 | +--------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
| 19 | | BE | /data/logs/BE/2017_03_10.stderrout.log | Jetty server log | The log describes info regarding Jetty startup and execution | the log rolls daily | |
| 20 | + +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
| 21 | | | /data/logs/BE/SDC/SDC-BE/audit.log | application audit | An audit record is created for each operation in SDC | rolls at 20 mb | |
| 22 | + +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
| 23 | | | /data/logs/BE/SDC/SDC-BE/debug.log | application logging | We can enable higher logging on demand by editing the logback.xml inside the server docker. | rolls at 20 mb | |
| 24 | | | | | The file is located under:,config/catalog-be/logback.xml. | | |
| 25 | | | | | This log holds the debug and trace level output of the application. | | |
| 26 | + +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
| 27 | | | /data/logs/BE/SDC/SDC-BE/error.log | application logging | This log holds the info and error level output of the application. | rolls at 20 mb | |
| 28 | + +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
| 29 | | | /data/logs/BE/SDC/SDC-BE/transaction.log | application logging | Not currently in use. will be used in future relases. | rolls at 20 mb | |
| 30 | + +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
| 31 | | | /data/logs/BE/SDC/SDC-BE/all.log | application logging | On demand, we can enable log aggregation into one file for easier debugging. This is done by editing the logback.xml inside the server docker. | rolls at 20 mb | |
| 32 | | | | | The file is located under:,config/catalog-be/logback.xml. | | |
| 33 | | | | | To allow this logger, set the value for this property to true This log holds all logging output of the application. | | |
| 34 | +--------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
| 35 | | FE | /data/logs/FE/2017_03_10.stderrout.log | Jetty server log | The log describes info regarding the Jetty startup and execution | the log rolls daily | |
| 36 | + +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
| 37 | | | /data/logs/FE/SDC/SDC-FE/debug.log | application logging | We can enable higher logging on demand by editing the logback.xml inside the server docker. | rolls at 20 mb | |
| 38 | | | | | The file is located,under: config/catalog-fe/logback.xml. | | |
| 39 | | | | | This log holds the debug and trace level output of the application. | | |
| 40 | + +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
| 41 | | | /data/logs/FE/SDC/SDC-FE/error.log | application logging | This log holds the Info and Error level output of the application. | rolls at 20 mb | |
| 42 | + +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
| 43 | | | /data/logs/FE/SDC/SDC-FE/all.log | application logging | On demand we can enable log aggregation into one file for easier debuging, by editing the logback.xml inside the server docker.The file is located under: config/catalog-fe/logback.xml. | rolls | |
| 44 | | | | | To allow this logger set this property to true | | |
| 45 | | | | | This log holds all the logging output of the application. | | |
| 46 | +--------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
| 47 | |
| Rich Bennett | 4b00193 | 2017-10-16 09:25:01 -0400 | [diff] [blame] | 48 | |
| 49 | Where to Access Information |
| 50 | --------------------------- |
| 51 | |
| 52 | |
| 53 | Error / Warning Messages |
| 54 | ------------------------ |