Enable MILESTONE level logging for SOAP SDM Web Services.
Article ID: 15273
Updated On:
Products
Issue/Introduction
How can we find out more information about web services sessions, such as login time, login user, IP address of the logged in user, and API call?
Environment
CA Service Desk Manager 17.x.
Resolution
To enable the WEBSVC_LOGGING option and capture detailed web service activity in CA SDM, follow the steps below.
- Run the following commands to install and activate the WEBSVC_LOGGING option:
pdm_options_mgr -c -s WEBSVC_LOGGING -v 1 -a pdm_option.inst
pdm_options_mgr -c -s WEBSVC_LOGGING -v 1 -a pdm_option.inst -t - Recycle the CA SDM service(s) after running the above commands.
Recycle the services according to your environment’s configuration type. Please see Install/Uninstall Options Manager Options for further details.
Once enabled, the system will log the following details for every web services session:
Source IP address of the request
Username making the call
Web services method invoked
Session ID (SID)
Timestamp of the request
The log entries will be written to: NX_ROOT\log\jsrvr.log
Sample Log Output, as applied for the "login" web services method and a createObject call to the cr object.
11/24 20:52:41.538 [http-nio-8080-exec-2] INFO usdsda 1124 Web Services session created xxxx; user(xxxxx); IP(xxx.xxx.xxx.xxx); session count 1
11/24 20:52:41.546 [http-nio-8080-exec-2] INFO usdsda 1124 Web Services login by xxxxx. Assigned Session ID xxxx
11/24 20:52:41.680 [http-nio-8080-exec-2] INFO SOAPMessageHandler 59 USDJWS - methodName=login - remoteIP=xxx.xxx.xxx.xxx - sid/user=xxxxx - duration=4456(ms)
11/24 20:53:09.911 [http-nio-8080-exec-4] INFO SOAPMessageHandler 59 USDJWS - methodName=createObject - remoteIP=xxx.xxx.xxx.xxx - sid/user=xxxx- objectType=cr - duration=186(ms)
Additional Information
Enabling this option may have a minor performance impact due to increased I/O activity.
The jsrvr.log file may fill up and roll over more quickly than usual.
It is strongly recommended to test this configuration in a non-production environment first before applying it to production.
The above logging will generate information on the web services calls that are being made, which includes some statistical data about the calls.
For more extensive, DEBUG and TRACE level logging, which exposes additional details about the SOAP calls being made as well as other interactions such as Attachments and Exports, please review SOAP Logging/Tracing, including Export, and Attachments.
However, the logging details that are generated via the instructions in this KB Article (enabling the WEBSVC_LOGGING options) are not exposed as part of the logging configuration described in the above article. Both methods may be needed to obtain a fuller picture of the web services activity, depending on the situation.
Please review Monitor incoming and outgoing SOAP payload in CA Service desk Manager to monitor the payload of incoming and outgoing call from CA SDM CXF webservices. MILESTONE level logging for SOAP SDM Web Services is also available.
Feedback
