How to enable MILESTONE level logging for SOAP SDM Web Services.

Products

• CA Service Desk Manager
• CA Service Management - Service Desk Manager

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.

Steps:
1. 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

2. Recycle the CA SDM service(s) after running the above commands.

Note:
Recycle the services according to your environment’s configuration type:

Conventional setup: Recycle CA SDM services on the primary and secondary servers in the proper sequence.

Advanced Availability (AA) setup: Follow AA best practices when restarting the Background, Standby, and Application servers.

Details Logged:
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:

INFO USDLogHandler ? USDJWS: <timestamp> - xxx.xxx.xxx.xxx - <username> : login
INFO usdjws65 ? Web Services session created <SID> from caller IP xxx.xxx.xxx.xxx
INFO USDLogHandler ? USDJWS: <timestamp> - xxx.xxx.xxx.xxx - <SID>: doSelect - objectType=pcat, whereClause=tenant.name

Here, xxx.xxx.xxx.xxx represents the actual IP address of the caller.

Important Notes:
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.

Additional Information

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 KB Article 137240.  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 KB Article 137240.  Both methods may be needed to obtain a fuller picture of the web services activity, depending on the situation.

To monitor the payload of incoming and out going call from CA Servicedesk manager CXF webservices, Then please use KB Article 416397  for the detailed steps.