Endevor web services usage report
search cancel

Endevor web services usage report

book

Article ID: 416872

calendar_today

Updated On:

Products

Endevor Zowe

Issue/Introduction

We have implemented Webservices and have begun rolling it out to our developers. Our management is asking if there is any reporting available that can provide us with information on the usage of these tools?

Environment

Endevor v19

Resolution

Check out Web Services Feature Registration and Event Logging (PTF LU13088)

The Usage logging for REST API can be used to report the REST API activates (who is using the REST API, at what time, using what REST API client tools). 

Here is the instruction on how to turn on the Usage logging for Endevor REST API: 

  1. Apply Endevor PTF LU13088 and CCS 15.0 PTF LU14236
  2. Update the web services using WSTOMINS action=UPGRADE after apply the PTF. 
  3. Update Endevor configuration file (default name is ENDEVOR.cfg), specify either UsageLogPath (Uss path for the new REST API usage logging) or UsageLogDD (DSN for the new REST API usage logging) in wsParameters section.  
  4. Recycle Tomcat. 

Once user perform the REST API actions using client tools such as Eclipse UI plugin, Explorer for Endevor, or Team Build,  the REST API usage logging can be found at the specified USS location (Usage.log.yyyy-MM-dd), or in the defined dataset (in CSV format). 

Sample messages in the usage logging:

2025/02/12,07:44:00.550,List Element,2.21,200,400,USER_ID,CFG_FILE,TeamBuildExportz/dev-version
2025/02/12,07:44:08.940,List Element,2.21,200,281,USER_ID,CFG_FILE,EndevorExplorer/1.9.2
2025/02/12,09:53:21.236,Add Element,2.21,200,4794,USER_ID,CFG_FILE,EndevorZoweCLI/7.7.6

 

Powered by Wolken Software