Monitor incoming or outgoing CXF SOAP payload in CA Service desk Manager
Article ID: 416397
Updated On:
Products
Issue/Introduction
The following article discusses the means to review the payload content involved in SOAP web services calls, for incoming and outgoing activity, allowing one to toggle which content is logged.
Environment
Release: CA Service Desk Manager 17.4 RU4 and above
Resolution
The variable NX_WEBSVC_SOAP_LOGGING may be included in the NX.ENV, located under the SDM install folder.
To implement the above setting
- Take a backup of the existing NX.env file
- Run the appropriate command to configure the logging
To set the baseline logging (no payload output)
pdm_options_mgr -c -s WEBSVC_SOAP_LOGGING -v 0 -a pdm_option.inst
pdm_options_mgr -c -s WEBSVC_SOAP_LOGGING -v 0 -a pdm_option.inst -t
To log incoming payloads
pdm_options_mgr -c -s WEBSVC_SOAP_LOGGING -v 1 -a pdm_option.inst
pdm_options_mgr -c -s WEBSVC_SOAP_LOGGING -v 1 -a pdm_option.inst -t
To log outgoing payloads
pdm_options_mgr -c -s WEBSVC_SOAP_LOGGING -v 2 -a pdm_option.inst
pdm_options_mgr -c -s WEBSVC_SOAP_LOGGING -v 2 -a pdm_option.inst -t - Once the above is set, recycle CA Service desk services for the change to take effect.
Logging is recorded in the NX_ROOT\log\jsrvr.log
Additional Information
The above logging should only be activated for purposes of debug and tracing as this logging is highly resource intensive.
To enable logging for BOTH incoming or outgoing SOAP calls, please review Logging and Debug Tracing for CXF based Web Services. To avoid confusion, please use one or the other method of logging described in the KB Articles, and not both.
The following is a sample output for the @NX_WEBSVC_SOAP_LOGGING=1 NX.env setting (incoming payloads) for the "login" web service call.
11/24 20:59:58.200 [http-nio-8080-exec-1] INFO SOAPMessageHandler 101 Inbound message:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.ca.com/UnicenterServicePlus/xxxxx">
<soapenv:Header/>
<soapenv:Body>
<ser:login>
<username>xxxxx</username>
<password>xxxxx</password>
</ser:login>
</soapenv:Body></soapenv:Envelope>
....
11/24 21:00:02.152 [http-nio-8080-exec-1] INFO usdsda 1124 Web Services session created xxxx; user(xxxxx); IP(xxx.xxx.xxx.xxx); session count 1
Note: The above will expose user credentials as part of the payload. The above credential set will be user readable.
The following is a sample output for the @NX_WEBSVC_SOAP_LOGGING=2 NX.env setting (outgoing payloads) for the "login" web service call.
11/24 21:17:35.113 [http-nio-8080-exec-1] INFO usdsda 1124 Web Services session created 970906455; user(xxxxx); IP(xxx.xxx.xxx.xxx); session count 1
11/24 21:17:35.254 [http-nio-8080-exec-1] INFO SOAPMessageHandler 99 Outbound message:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><ns2:loginResponse xmlns:ns2="http://www.ca.com/UnicenterServicePlus/xxxxx"><loginReturn>xxxx</loginReturn></ns2:loginResponse></soap:Body></soap:Envelope>
Feedback
