From aa41076737c6f58f524d10c806904889ddc606d1 Mon Sep 17 00:00:00 2001 From: Vidya Shinde Date: Mon, 14 Aug 2017 14:07:25 +0530 Subject: [PATCH] [LOG] Add canonicalization for SO logs Canonicalization of path for log provider configuration file and log files Change-Id: I7d84f18e3ccf47aadb1bc84b60f8b6403b5c05c0 Issue-ID: LOG-21 Signed-off-by: Vidya Shinde --- onap/so/README.md | 52 ++++++++++++ onap/so/conf/logback.apihandler-infra.xml | 110 ++++++++++++++++++++++++++ onap/so/conf/logback.appc.xml | 110 ++++++++++++++++++++++++++ onap/so/conf/logback.asdc.xml | 110 ++++++++++++++++++++++++++ onap/so/conf/logback.bpmn.xml | 110 ++++++++++++++++++++++++++ onap/so/conf/logback.msorequestsdbadapter.xml | 110 ++++++++++++++++++++++++++ onap/so/conf/logback.network.xml | 110 ++++++++++++++++++++++++++ onap/so/conf/logback.sdnc.xml | 110 ++++++++++++++++++++++++++ onap/so/conf/logback.tenant.xml | 110 ++++++++++++++++++++++++++ onap/so/conf/logback.vnf.xml | 110 ++++++++++++++++++++++++++ 10 files changed, 1042 insertions(+) create mode 100644 onap/so/README.md create mode 100644 onap/so/conf/logback.apihandler-infra.xml create mode 100644 onap/so/conf/logback.appc.xml create mode 100644 onap/so/conf/logback.asdc.xml create mode 100644 onap/so/conf/logback.bpmn.xml create mode 100644 onap/so/conf/logback.msorequestsdbadapter.xml create mode 100644 onap/so/conf/logback.network.xml create mode 100644 onap/so/conf/logback.sdnc.xml create mode 100644 onap/so/conf/logback.tenant.xml create mode 100644 onap/so/conf/logback.vnf.xml diff --git a/onap/so/README.md b/onap/so/README.md new file mode 100644 index 0000000..13f41a1 --- /dev/null +++ b/onap/so/README.md @@ -0,0 +1,52 @@ +#################################################################################################################################################################### +## SO Logging Configuration +==================================================================================================================================================================== +SO has 2 docker containers with names - testlab_mso_1 and testlab_mariadb_1. +The canonical logging implementation is only done for the container, testlab_mso_1. +SO has 9 sub-modules and each module has its own logback.xml file. +Canonical logs will be generated at /var/log/onap/so/ +==================================================================================================================================================================== +## Instructions for deployment +==================================================================================================================================================================== +### SO logging deployment for sub-modules +------------------------------------------------------------------------------------------------------------------------------------------------------------------- + 1. Create the canonical path for log provider, /etc/onap/so/conf.d/, on the host VM. + 2. Copy the canonical logback.xmls listed below from 'so' directory (of gerrit) into the path created in step 1. + 2.1. logback.apihandler-infra.xml + 2.2. logback.appc.xml + 2.3. logback.asdc.xml + 2.4. logback.bpmn.xml + 2.5. logback.msorequestsdbadapter.xml + 2.6. logback.network.xml + 2.7. logback.sdnc.xml + 2.8. logback.tenant.xml + 2.9. logback.vnf.xml + 3. Create the canonical path for logs, /var/log/onap/so, on the host VM. + 4. Provide write permissions for "others" users for directory created in step 3. + 5. Volume-Mount: The so container requires two host paths mapped as volume in the container + 5.1. Log file path: + Host path - /var/log/onap/so/ mapped to + Container path - /var/log/onap/so/ + 5.2. Log provider file path has two mappings: + # The below container paths are where the provider files are kept initially + /etc/onap/so/conf.d/logback.apihandler-infra.xml : /var/berks-cookbooks/mso-config/files/default/mso-api-handler-infra-config/logback.apihandler-infra.xml + /etc/onap/so/conf.d/logback.network.xml : /var/berks-cookbooks/mso-config/files/default/mso-po-adapter-config/logback.network.xml + /etc/onap/so/conf.d/logback.tenant.xml : /var/berks-cookbooks/mso-config/files/default/mso-po-adapter-config/logback.tenant.xml + /etc/onap/so/conf.d/logback.vnf.xml : /var/berks-cookbooks/mso-config/files/default/mso-po-adapter-config/logback.vnf.xml + /etc/onap/so/conf.d/logback.appc.xml : /var/berks-cookbooks/mso-config/files/default/mso-appc-adapter-config/logback.appc.xml + /etc/onap/so/conf.d/logback.msorequestsdbadapter.xml : /var/berks-cookbooks/mso-config/files/default/mso-requests-db-adapter-config/logback.msorequestsdbadapter.xml + /etc/onap/so/conf.d/logback.asdc.xml : /var/berks-cookbooks/mso-config/files/default/mso-asdc-controller-config/logback.asdc.xml + /etc/onap/so/conf.d/logback.sdnc.xml : /var/berks-cookbooks/mso-config/files/default/mso-sdnc-adapter-config/logback.sdnc.xml + /etc/onap/so/conf.d/logback.bpmn.xml : /var/berks-cookbooks/mso-config/files/default/mso-bpmn-config/logback.bpmn.xml + + # The below container paths are where the provider files are copied to after the docker starts + /etc/onap/so/conf.d/logback.apihandler-infra.xml : /etc/mso/config.d/logback.apihandler-infra.xml + /etc/onap/so/conf.d/logback.network.xml : /etc/mso/config.d/logback.network.xml + /etc/onap/so/conf.d/logback.tenant.xml : /etc/mso/config.d/logback.tenant.xml + /etc/onap/so/conf.d/logback.vnf.xml : /etc/mso/config.d/logback.vnf.xml + /etc/onap/so/conf.d/logback.appc.xml : /etc/mso/config.d/logback.appc.xml + /etc/onap/so/conf.d/logback.msorequestsdbadapter.xml : /etc/mso/config.d/logback.msorequestsdbadapter.xml + /etc/onap/so/conf.d/logback.asdc.xml : /etc/mso/config.d/logback.asdc.xml + /etc/onap/so/conf.d/logback.sdnc.xml : /etc/mso/config.d/logback.sdnc.xml + /etc/onap/so/conf.d/logback.bpmn.xml : /etc/mso/config.d/logback.bpmn.xml +#################################################################################################################################################################### diff --git a/onap/so/conf/logback.apihandler-infra.xml b/onap/so/conf/logback.apihandler-infra.xml new file mode 100644 index 0000000..9951f1d --- /dev/null +++ b/onap/so/conf/logback.apihandler-infra.xml @@ -0,0 +1,110 @@ + + + + + + + + + + + + + + + + + + + ${logDirectory}/${auditLogName}.log + + ${logDirectory}/${auditLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${metricsLogName}.log + + ${logDirectory}/${metricsLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${errorLogName}.log + + ${logDirectory}/${errorLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + INFO + + + + ${queueSize} + + + + ${logDirectory}/${debugLogName}.log + + ${logDirectory}/${debugLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + true + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/onap/so/conf/logback.appc.xml b/onap/so/conf/logback.appc.xml new file mode 100644 index 0000000..71c997b --- /dev/null +++ b/onap/so/conf/logback.appc.xml @@ -0,0 +1,110 @@ + + + + + + + + + + + + + + + + + + + ${logDirectory}/${auditLogName}.log + + ${logDirectory}/${auditLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${metricsLogName}.log + + ${logDirectory}/${metricsLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${errorLogName}.log + + ${logDirectory}/${errorLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + INFO + + + + ${queueSize} + + + + ${logDirectory}/${debugLogName}.log + + ${logDirectory}/${debugLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + true + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/onap/so/conf/logback.asdc.xml b/onap/so/conf/logback.asdc.xml new file mode 100644 index 0000000..9edc5a2 --- /dev/null +++ b/onap/so/conf/logback.asdc.xml @@ -0,0 +1,110 @@ + + + + + + + + + + + + + + + + + + + ${logDirectory}/${auditLogName}.log + + ${logDirectory}/${auditLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${metricsLogName}.log + + ${logDirectory}/${metricsLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${errorLogName}.log + + ${logDirectory}/${errorLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + INFO + + + + ${queueSize} + + + + ${logDirectory}/${debugLogName}.log + + ${logDirectory}/${debugLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + true + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/onap/so/conf/logback.bpmn.xml b/onap/so/conf/logback.bpmn.xml new file mode 100644 index 0000000..44a3e77 --- /dev/null +++ b/onap/so/conf/logback.bpmn.xml @@ -0,0 +1,110 @@ + + + + + + + + + + + + + + + + + + + ${logDirectory}/${auditLogName}.log + + ${logDirectory}/${auditLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${metricsLogName}.log + + ${logDirectory}/${metricsLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${errorLogName}.log + + ${logDirectory}/${errorLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + INFO + + + + ${queueSize} + + + + ${logDirectory}/${debugLogName}.log + + ${logDirectory}/${debugLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + true + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/onap/so/conf/logback.msorequestsdbadapter.xml b/onap/so/conf/logback.msorequestsdbadapter.xml new file mode 100644 index 0000000..538b283 --- /dev/null +++ b/onap/so/conf/logback.msorequestsdbadapter.xml @@ -0,0 +1,110 @@ + + + + + + + + + + + + + + + + + + + ${logDirectory}/${auditLogName}.log + + ${logDirectory}/${auditLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${metricsLogName}.log + + ${logDirectory}/${metricsLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${errorLogName}.log + + ${logDirectory}/${errorLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + INFO + + + + ${queueSize} + + + + ${logDirectory}/${debugLogName}.log + + ${logDirectory}/${debugLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + true + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/onap/so/conf/logback.network.xml b/onap/so/conf/logback.network.xml new file mode 100644 index 0000000..4261667 --- /dev/null +++ b/onap/so/conf/logback.network.xml @@ -0,0 +1,110 @@ + + + + + + + + + + + + + + + + + + + ${logDirectory}/${auditLogName}.log + + ${logDirectory}/${auditLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${metricsLogName}.log + + ${logDirectory}/${metricsLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${errorLogName}.log + + ${logDirectory}/${errorLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + INFO + + + + ${queueSize} + + + + ${logDirectory}/${debugLogName}.log + + ${logDirectory}/${debugLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + true + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/onap/so/conf/logback.sdnc.xml b/onap/so/conf/logback.sdnc.xml new file mode 100644 index 0000000..25bdc8a --- /dev/null +++ b/onap/so/conf/logback.sdnc.xml @@ -0,0 +1,110 @@ + + + + + + + + + + + + + + + + + + + ${logDirectory}/${auditLogName}.log + + ${logDirectory}/${auditLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${metricsLogName}.log + + ${logDirectory}/${metricsLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${errorLogName}.log + + ${logDirectory}/${errorLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + INFO + + + + ${queueSize} + + + + ${logDirectory}/${debugLogName}.log + + ${logDirectory}/${debugLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + true + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/onap/so/conf/logback.tenant.xml b/onap/so/conf/logback.tenant.xml new file mode 100644 index 0000000..79c847f --- /dev/null +++ b/onap/so/conf/logback.tenant.xml @@ -0,0 +1,110 @@ + + + + + + + + + + + + + + + + + + + ${logDirectory}/${auditLogName}.log + + ${logDirectory}/${auditLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${metricsLogName}.log + + ${logDirectory}/${metricsLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${errorLogName}.log + + ${logDirectory}/${errorLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + INFO + + + + ${queueSize} + + + + ${logDirectory}/${debugLogName}.log + + ${logDirectory}/${debugLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + true + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/onap/so/conf/logback.vnf.xml b/onap/so/conf/logback.vnf.xml new file mode 100644 index 0000000..85f4c60 --- /dev/null +++ b/onap/so/conf/logback.vnf.xml @@ -0,0 +1,110 @@ + + + + + + + + + + + + + + + + + + + ${logDirectory}/${auditLogName}.log + + ${logDirectory}/${auditLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${metricsLogName}.log + + ${logDirectory}/${metricsLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + + + ${logDirectory}/${errorLogName}.log + + ${logDirectory}/${errorLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + INFO + + + + ${queueSize} + + + + ${logDirectory}/${debugLogName}.log + + ${logDirectory}/${debugLogName}.%d{yyyy-MM-dd}.%i.log + + ${maxFileSize} + + ${maxHistory} + ${totalSizeCap} + + + ${pattern} + + + + ${queueSize} + + true + + + + + + + + + + + + + + + + + + \ No newline at end of file -- 2.16.6