diff options
author | Idan Amit <ia096e@intl.att.com> | 2017-10-17 10:10:24 +0300 |
---|---|---|
committer | Idan Amit <ia096e@intl.att.com> | 2017-10-17 10:10:24 +0300 |
commit | 441f20cd57cd0165819b7c22f4c7bf85e6a1e889 (patch) | |
tree | 43deec252f5865503031bdec503ac4fce472d463 | |
parent | db447ae656d85710082d5f69b363120905826193 (diff) |
Setup Read The Docs for SDC
Added logs table from the wiki to the logging page of the docs
Change-Id: Ifa847a04c064874fe4ac36c08ddccc3889a0ce77
Issue-ID: SDC-419
Signed-off-by: Idan Amit <ia096e@intl.att.com>
-rw-r--r-- | docs/logging.rst | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/logging.rst b/docs/logging.rst index 39eabfba79..b1ce120d99 100644 --- a/docs/logging.rst +++ b/docs/logging.rst @@ -13,6 +13,38 @@ Logging * This note must be removed after content has been added. ++--------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| Server | Location | Type | Description | Rolling | ++--------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| 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 | ++ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| | /data/logs/BE/SDC/SDC-BE/audit.log | application audit | An audit record is created for each operation in SDC | rolls at 20 mb | ++ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| | /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 | +| | | | The file is located under:,config/catalog-be/logback.xml. | | +| | | | This log holds the debug and trace level output of the application. | | ++ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| | /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 | ++ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| | /data/logs/BE/SDC/SDC-BE/transaction.log | application logging | Not currently in use. will be used in future relases. | rolls at 20 mb | ++ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| | /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 | +| | | | The file is located under:,config/catalog-be/logback.xml. | | +| | | | To allow this logger, set the value for this property to true This log holds all logging output of the application. | | ++--------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| 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 | ++ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| | /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 | +| | | | The file is located,under: config/catalog-fe/logback.xml. | | +| | | | This log holds the debug and trace level output of the application. | | ++ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| | /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 | ++ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| | /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 | +| | | | To allow this logger set this property to true | | +| | | | This log holds all the logging output of the application. | | ++--------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ + Where to Access Information --------------------------- |