Monitoring

The monitoring feature of the Web Objects API allows you to monitor jobs, user connections, database connections, and caches in real-time. Objects being monitored are actionable in this API— that is, there are administrative operations that can be performed on the objects. For example, a user connection can be forced to disconnect, a job can be killed, or a database connection can be disconnected.

The following monitoring functionality is exposed through the Web Objects API:

• The ability to retrieve jobs, user connections, database connections, and caches, including additionally:

  • The ability to filter the results on a set of filter criteria  

  • The ability to sort the results on one or more fields  

  • The ability to obtain a count of items, grouped by the values of one or more fields  

  • The ability to specify a maximum number of items to retrieve, discarding any items above that maximum  

• The ability to kill jobs, disconnect user and database connections, and manipulate caches, including additionally:

  • The ability to perform multiple actions in one round-trip to MicroStrategy Intelligence Server (batch processing) 

  • The availability of partial failures to determine whether to show the end user a message when parts of the batch job fail 

• The ability to purge caches— including report, element, and object caches

Refer to the interfaces section for all of the interfaces that are available for monitoring. These interfaces help you understand the code samples provided in the use cases section.