Monitoring Interfaces

The interfaces in the Web Objects API that support the monitoring functionality fall into three categories:

• Interfaces for specifying the settings

  The methods in these interfaces provide the ability to specify which monitoring information to retrieve.  

• Interfaces for retrieving the results

  The methods in these interfaces provide the ability to retrieve and inspect the actual monitoring information.  

• Interfaces for manipulating the results

  The methods in these interfaces provide the ability to take actions, such as disconnecting sessions or killing jobs, on the results of the monitoring.

All of these interfaces are located in the com.microstrategy.web.objects.admin.monitors package.

All of the monitoring calls work only on the server where the session is created. As a result, in a cluster of servers, the data returned will not be for the full cluster, but instead for only a single server in the cluster. However, you can choose the specific server in a cluster on which the session is created, effectively bypassing the clustering mechanism. This can be accomplished using a session flag in the EnumDSSXMLSessionFlags enumeration, which will be processed by the Java XML API in the CreateSession call. In that method, if the session flag is passed, the clustering mechanism will be bypassed, and the flag will be stripped from the session flags passed to MicroStrategy Intelligence Server.