How to enable Client Side API logging for Mid-Tier, Developer Studio or email Engine.

This log is useful to trace the API calls done from a client to AR server and the logs can provide a "script" for java driver to replicate the same calls

 

This knowledge article may contain information that does not apply to version 21.05 or later which runs in a container environment. Please refer to Article Number 000385088 for more information about troubleshooting BMC products in containers.

1. Find the arsys_sample.xml file.   Locations include:

   1. midtier/WEB-INF/lib for the MidTier.   Or

   2. /lib directory for the AR Server Email Engine. Or

   3. DeveloperStudio\plugins\com.bmc.arsys.studio.api_9.1.6.build005 for Developer Studi​o

2. Copy the arsys_sample.xml as arsys_api.xml and move into your classpath. Locations include:

   1. WEB-INF/classes for MidTier

   2. ARemail for AR Server Email engine

   3. DeveloperStudio folder for Dev Studio

3. Modify the parameter  <apiRecording></apiRecording> to <apiRecording>31</apiRecording>

   1. Possible values for apiRecording:

0 No Logging
1 Logging ON
2 Record in append mode in the files.
4 Record start and finish Time
8 Record Elapsed Time in ms
16 Combine the command and result files into the result file
32 Do not record result data output
64 Buffer the file output
Example: 
To specify that "Combine the command and result files into the result file" (16) + "Record start and finish Time" (4) + " Logging ON " (1), set the  apiRecording parameter to 21.  

4. Modify the parameter  <apiRecordingLogDir></apiRecordingLogDir> to     <apiRecordingLogDir>VALID FILE SYSTEM PATH</apiRecordingLogDir>

Example: <apiRecordingLogDir>C:\\Program Files\\Apache Software Foundation\\Tomcat 9.0\\logs</apiRecordingLogDir>

5. Restart your client (either midtier, email engine or developer studio).

You should now get files midtier<ARServer name>*_arapires.log and <username><ARServer name>*_arapires.log file in the working directory of your java virtual machine used to run midtier, dev studio or email engine or where specified  by the parameter     apiRecordingLogDir 

The file names will include the user doing those API calls. In some cases like midtier a "Midtier Service" user will be seen

Additional Info:
Steps to enable ARAPILOGGING client side logging for Smart IT:
Link : https://communities.bmc.com/docs/DOC-128423