From 39a0a2da92b89aaea7225cb0521efb5fb033954a Mon Sep 17 00:00:00 2001 From: sekharhuawei Date: Wed, 2 Sep 2020 00:38:40 +0530 Subject: Developer guide for cxf-logging Issue-ID: SO-3153 Signed-off-by: sekharhuawei Change-Id: Ibfc12aa9de93762320badaabacbdcd82555eda6b --- docs/developer_info/Cxf_Logging.rst | 210 ++++++++++++++++++++++++++ docs/developer_info/developer_information.rst | 1 + 2 files changed, 211 insertions(+) create mode 100644 docs/developer_info/Cxf_Logging.rst (limited to 'docs') diff --git a/docs/developer_info/Cxf_Logging.rst b/docs/developer_info/Cxf_Logging.rst new file mode 100644 index 0000000000..ea2bbf56ce --- /dev/null +++ b/docs/developer_info/Cxf_Logging.rst @@ -0,0 +1,210 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2020 Huawei Technologies Co., Ltd. + +CXF-logging: +============= +It is a logging framework from SO. Here basically we are having 2 interceptors which extends AbstractSoapInterceptor. + +SOAPLoggingInInterceptor: ++++++++++++++++++++++++++++ + +* This interceptor is responsible for Capturing requestId , client ip address , invocation id, service name, instance id, entry timestamp , log timestamp, Elapsed time for each request and update the MDC logger with staus In-progress. + +SOAPLoggingOutInterceptor: +++++++++++++++++++++++++++++ +* This interceptor is responsible for log timestamp , elapsed time for each request and checks for if there is any exception update the MDC loggers with 500 response code otherwise update the status as completed. + + +cxf-logging Used By below components of SO: +++++++++++++++++++++++++++++++++++++++++++++ +The cxf-logging framework is used by below components of so. + +mso-openstack-adapter. +mso-requests-db-adapter. +mso-sdnc-adapter. +mso-infrastructure-bpmn. + +cxf-logging dependency for using in other components: +++++++++++++++++++++++++++++++++++++++++++++++++++++++ + + + org.onap.so + cxf-logging + ${project.version} + + + +pom.xml: ++++++++++ + + + + 4.0.0 + + + org.onap.so + so + 1.6.0-SNAPSHOT + + + CXFLogging + Common CXF Logging Classes + + + + + org.apache.cxf + cxf-rt-rs-client + ${cxf.version} + + + + + org.apache.cxf + cxf-rt-bindings-soap + ${cxf.version} + + + + + + org.apache.cxf + cxf-rt-transports-http + ${cxf.version} + + + + + + javax.servlet + javax.servlet-api + + + + + + org.slf4j + slf4j-ext + + + + + + org.slf4j + slf4j-api + + + + + + + + + src/main/resources + true + + + + + + src/main/java + + + + *.java + + + + + + + + + + cxf-logging + + + +Configuration file: +++++++++++++++++++++ +Here we can do configure the logger properties for the cxf-logging. + + + + + + + + + + + + + + + + + + + + + + + + + + ${pattern} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/developer_info/developer_information.rst b/docs/developer_info/developer_information.rst index 1b9e83b840..a060da60b0 100644 --- a/docs/developer_info/developer_information.rst +++ b/docs/developer_info/developer_information.rst @@ -21,5 +21,6 @@ SO Developer Information BPMN_Project_Deployment_Strategy.rst BPMN-INFRA_Workflow_Understanding.rst Mso_Openstack_Adapter.rst + Cxf_Logging.rst instantiate/index.rst FAQs.rst -- cgit 1.2.3-korg