Fix exception in healthcheck with http
[sdc.git] / docs / logging.rst
index 1eb68c2..a59f340 100644 (file)
@@ -7,9 +7,11 @@ Logging
 
 Where to Access Information
 ---------------------------
-the logs for the application are available in the docker it self at /var/lib/jetty/logs/
-in Heat deployment the dockers are maped into /data/logs on the vm where the application is running.
-In OOM you can use the logging project to accses the logging collected from the applications.
+The logs for the application are available in the docker itself at /var/lib/jetty/logs/
+In Heat deployment the dockers are mapped into /data/logs on the vm where the application is running.
+In OOM you can use the logging project to access the logs collected from the applications.
+
+In the OOM deployment the log location in the docker is /var/log/onap
 
 
 +-------------------------------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
@@ -17,39 +19,67 @@ In OOM you can use the logging project to accses the logging collected from the
 +===============================+==========================================+=====================+===========================================================================================================================================================================================+=====================+
 | BE catalog and onboarding     | /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/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.                                                                                                                                 |                     |
+|                               | /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/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/transaction.log | application logging | Not currently in use, will be used in future releases.                                                                                                                                    | 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.                                                                                                                                 |                     |
+|                               | /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      |
+|                               | /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/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               |
+|                               | /data/logs/FE/SDC/SDC-FE/all.log         | application logging | On demand we can enable log aggregation into one file for easier debugging, 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.                                                                                                                                 |                     |
 +-------------------------------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 
+Changing log level
+------------------
+SDC uses logback for logging.
+In order to change the level you will need to access the docker.
+Update the logback.xml inside the docker according to your need - the change does not require a restart of the docker.
+
+To change the level for all logs, change the following value:
+
+::
+
+    <root level="INFO">
+
+
+To change the level for logs of some specific packages, change the following value:
+
+::
+
+    <logger level="INFO" name="org.openecomp.sdc" />
+
+
+To aggregate all the logs from all levels into a single log file called all.log change the following property to true:
+
+::
+
+    <property name="enable-all-log" scope="context" value="false" />
+
+
+
 
 Error / Warning Messages
 ------------------------
 
-Respone Types
-=============
+Response Types
+==============
 
 ::
 
@@ -159,7 +189,7 @@ Respone Types
 ---------SVC4003------------------------------
 ==============================================
 
-- %1 - Users's ID
+- %1 - User's ID
 
 ::
 
@@ -172,7 +202,7 @@ Respone Types
 ---------SVC4004-----------------------------
 =============================================
 
-- %1 - Users's email address
+- %1 - User's email address
 
 ::
 
@@ -198,7 +228,7 @@ Respone Types
 ---------SVC4006------------------------------
 ==============================================
 
-- %1 - Users's USER_ID
+- %1 - User's USER_ID
 
 ::
 
@@ -222,7 +252,7 @@ Respone Types
 ---------SVC4008-----------------------------
 =============================================
 
-- %1 - Users's USER_ID 
+- %1 - User's USER_ID 
 
 ::
 
@@ -958,7 +988,7 @@ Respone Types
 
 - %1-resource/service
 - %2-artifact/artifacts
-- %3-semicolomn separated list of artifact
+- %3-semicolon separated list of artifact
 
 ::
 
@@ -1403,7 +1433,7 @@ Respone Types
 
     ADDITIONAL_INFORMATION_VALUE_NOT_ALLOWED_CHARACTERS: {
         code: 400,
-        message: 'Error: Invalid Content. Additional information contains non-english characters.',
+        message: 'Error: Invalid Content. Additional information contains non-English characters.',
         messageId: "SVC4525"
     }
 
@@ -2093,7 +2123,7 @@ Respone Types
 ==============================================
 
 - %1 - Product
-- %2 - Aabbreviated/Full"
+- %2 - Abbreviated/Full"
 
 ::
 
@@ -2611,7 +2641,7 @@ Respone Types
 
 ::
 
-    ARTIFACT_ALRADY_EXIST_IN_DIFFERENT_TYPE_IN_CSAR: {
+    ARTIFACT_ALREADY_EXIST_IN_DIFFERENT_TYPE_IN_CSAR: {
         code: 400,
         message: "Error: artifact %1 in type %2 already exists in type %3.",
         messageId: "SVC4619"
@@ -2624,7 +2654,7 @@ Respone Types
 
     FAILED_RETRIVE_ARTIFACTS_TYPES: {
         code: 400,
-        message: "Error: Failed to retrieve list of suported artifact types.",
+        message: "Error: Failed to retrieve list of supported artifact types.",
         messageId: "SVC4620"
     }
 
@@ -3252,7 +3282,7 @@ Respone Types
 
     INVALID_SERVICE_TYPE: {
         code: 400,
-        message: 'Error: Invalid Content. Serivce type is not allowed to contain characters like <>:"\/|?* and space characters other than regular space.',
+        message: 'Error: Invalid Content. Service type is not allowed to contain characters like <>:"\/|?* and space characters other than regular space.',
         messageId: "SVC4666"
     }
 
@@ -3734,3 +3764,14 @@ Respone Types
       message: "Error: Interface operation input  parameter name should not be empty",
       messageId: "SVC46703"
     }
+
+---------SVC4750-----------------------------
+==============================================
+
+::
+
+    MISSING_TENANT_NAME: {
+      code: 400,
+      message: "Error: Missing Tenant name.",
+      messageId: "SVC4750"
+    }
\ No newline at end of file