diff options
| author |   Idan Amit <ia096e@intl.att.com> | 2017-10-15 16:56:07 +0300 |
|---|---|---|
| committer | Idan Amit <ia096e@intl.att.com> | 2017-10-15 16:56:07 +0300 |
| commit | ffe5d67c3fa0eb1820cc43c2b2453470a5078f59 (patch) | |
| tree | 14a75c95e3a14a2b5d0650f6fa5ad37c17f6bc73 | |
| parent | 44fdf15aabb3be980c57f8be437fed497e694b3b (diff) | |
Setup Read The Docs for SDC
Added logging section to read the docs
Change-Id: I0c59a2be18719f2e8a561fbe89217936896419ab
Issue-Id: SDC-419
Signed-off-by: Idan Amit <ia096e@intl.att.com>
| -rw-r--r-- | docs/onap-developer/docs-templates-platform-component-logging.rst | 40 |
1 files changed, 32 insertions, 8 deletions
diff --git a/docs/onap-developer/docs-templates-platform-component-logging.rst b/docs/onap-developer/docs-templates-platform-component-logging.rst index 8d480e2832..eed1568d2b 100644 --- a/docs/onap-developer/docs-templates-platform-component-logging.rst +++ b/docs/onap-developer/docs-templates-platform-component-logging.rst @@ -3,12 +3,36 @@ Logging & Diagnostic Information -------------------------------- -Description of how to interact with and diagnose problems with the components -as delivered. +Description on how to interact with and diagnose problems with the components as delivered. -Where to Access Information -+++++++++++++++++++++++++++ - - -Error / Warning Messages -++++++++++++++++++++++++ ++--------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| 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. | | ++--------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
\ No newline at end of file |