public interface

PerformanceMonitorBean

implements WebBean
com.microstrategy.web.beans.PerformanceMonitorBean

Class Overview

The MonitorBean is a bean which is used to monitor performance counters on a cluster of Intelligence Servers. Each MonitorBean is meant to correspond to one graph object within the GUI. New MonitorBean objects can be obtained from the PerformanceMonitorBeanManager class.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract void addCounter(String category, String instance, String counter)
This method tells the API to begin monitoring the given counter.
abstract void addCounter(String serverName, String category, String instance, String counter)
This method tells the API to begin monitoring the given counter.
abstract Categories getAvailableCategories(String serverName)
Returns a Categories collection of the categories which are available on the given server.
abstract WebPerformanceMonitor getMonitor()
Returns the WebPerformanceMonitor that this bean is monitoring.
abstract String getMonitorID()
Returns the DSSID of the WebPerformanceMonitor that this bean is monitoring.
abstract Categories getMonitoredCategories(String serverName)
Returns a Categories collection of the monitored categories for the given server.
abstract boolean isMonitored(String serverName, String category, String instance, String counter)
Returns whether the given counter is monitored.
abstract void removeCounter(String category, String instance, String counter)
This method tells the API to quit monitoring the given counter, if it is being monitored.
abstract void removeCounter(String serverName, String category, String instance, String counter)
This method tells the API to quit monitoring the given counter, if it is being monitored.
abstract void setMonitor(WebPerformanceMonitor monitor)
Sets the WebPerformanceMonitor to use to monitor using this bean.
abstract void setMonitorID(String monitorID)
Sets the monitor ID corresponding to the WebPerformanceMonitor to use to monitor using this bean.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebBean
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract void addCounter (String category, String instance, String counter)

This method tells the API to begin monitoring the given counter. The counter will be monitored on the counter which the session is associated with on the bean. This must be called for each counter for which data will be retrieved. The method adds the counter to the existing WebMonitor object on the bean.

Parameters
category The name of the category.
instance The name of the instance.
counter The name of the counter.
Throws
IllegalArgumentException Thrown if the given counter does not exist on the given
WebBeanException Thrown if error countered while loading the WebMonitor object. Intelligence Server.

public abstract void addCounter (String serverName, String category, String instance, String counter)

This method tells the API to begin monitoring the given counter. This must be called for each counter for which data will be retrieved. The method adds the counter to the existing WebMonitor object on the bean.

Parameters
serverName The name of the Intelligence Server that the counter resides upon.
category The name of the category.
instance The name of the instance.
counter The name of the counter.
Throws
IllegalArgumentException Thrown if the given counter does not exist on the given
WebBeanException Thrown if error countered while loading the WebMonitor object. Intelligence Server.

public abstract Categories getAvailableCategories (String serverName)

Returns a Categories collection of the categories which are available on the given server.

Parameters
serverName The name of the Intelligence Server to obtain counters for.
Returns
  • A Categories collection containing all available counters for the server.

public abstract WebPerformanceMonitor getMonitor ()

Returns the WebPerformanceMonitor that this bean is monitoring.

Returns
  • the performance monitor being monitored by the bean.
Throws
WebBeanException if an error was encountered while loading the performance monitor.

public abstract String getMonitorID ()

Returns the DSSID of the WebPerformanceMonitor that this bean is monitoring.

Returns
  • DSSID of the performance monitor being monitored by the bean.

public abstract Categories getMonitoredCategories (String serverName)

Returns a Categories collection of the monitored categories for the given server. This collection will only contain those counters which are currently being monitored by this bean.

Parameters
serverName The name of the Intelligence Server to obtain counters for.
Returns
  • A Categories collection containing only those counters being monitored.
Throws
WebBeanException thrown if there is a problem retrieving information from the specified server

public abstract boolean isMonitored (String serverName, String category, String instance, String counter)

Returns whether the given counter is monitored.

Parameters
serverName The name of the server that the monitor belongs to.
category The name of the category.
instance The name of the instance.
counter The name of the counter.
Returns
  • Whether the given monitor is currently enabled.
Throws
WebBeanException thrown if there is a problem retrieving information from the specified server

public abstract void removeCounter (String category, String instance, String counter)

This method tells the API to quit monitoring the given counter, if it is being monitored. The method removes the counter from the existing WebMonitor object on the bean. This method will quit monitoring a monitor type which has no server associated with it, which means to only monitor the server that the session is created on.

Parameters
category The name of the category.
instance The name of the instance.
counter The name of the counter.
Throws
IllegalArgumentException Thrown if the given counter does not exist or is not being logged on the given
WebBeanException Thrown if error countered while loading the WebMonitor object. Intelligence Server.

public abstract void removeCounter (String serverName, String category, String instance, String counter)

This method tells the API to quit monitoring the given counter, if it is being monitored. The method removes the counter from the existing WebMonitor object on the bean.

Parameters
serverName The name of the Intelligence Server that the counter resides upon.
category The name of the category.
instance The name of the instance.
counter The name of the counter.
Throws
IllegalArgumentException Thrown if the given counter does not exist or is not being logged on the given
WebBeanException Thrown if error countered while loading the WebMonitor object. Intelligence Server.

public abstract void setMonitor (WebPerformanceMonitor monitor)

Sets the WebPerformanceMonitor to use to monitor using this bean.

Parameters
monitor The performance monitor that the bean should use to monitor.

public abstract void setMonitorID (String monitorID)

Sets the monitor ID corresponding to the WebPerformanceMonitor to use to monitor using this bean.

Parameters
monitorID The ID of the performance monitor.
Throws
IllegalArgumentException if the monitor ID passed is incorrect.