com.ibm.websphere.objectgrid.management
Interface AgentManagerMBean

public interface AgentManagerMBean

This MBean interface allows a client process to access different attributes and statistical data about a specific Agent on a server process. The Agent Manager MBean is scoped at the map level and therefore can access statistical data for every agent run against the specified map. In a dynamic ObjectGrid environment, the object name pattern for this MBean is:

 com.ibm.websphere.objectgrid:type=AgentManager,name=Agent-<map>,partition=<partition id>,objectgrid=<objectgrid>,host=<host>,ogServerName=<server>
 

If ObjectGrid is running in a WebSphere Application Server process, more key=value pairs may be added to the object name.

Since:

WAS XD 6.1.0.5, XC10

Method Summary

double	getAgentInflationTime(String agentClassName) Gets the specified agent's inflation time attribute loaded up by the retrieveStatsModule() method.
double	getAgentSerializationTime(String agentClassName) Gets the specified agent's serialization time attribute loaded up by the retrieveStatsModule() method.
double	getFailureCount(String agentClassName) Gets the specified agent's failure count attribute loaded up by the retrieveStatsModule() method.
double	getInvocationCount(String agentClassName) Gets the specified agent's invocation count attribute loaded up by the retrieveStatsModule() method.
double	getPartitionCount(String agentClassName) Gets the specified agent's partition count attribute loaded up by the retrieveStatsModule() method.
double	getReduceTime(String agentClassName) Gets the specified agent's total reduce time attribute loaded up by the retrieveStatsModule() method.
double	getResultInflationTime(String agentClassName) Gets the specified agent's result inflation time attribute loaded up by the retrieveStatsModule() method.
double	getResultSerializationTime(String agentClassName) Gets the specified agent's result serialization time attribute loaded up by the retrieveStatsModule() method.
double	getTotalDurationTime(String agentClassName) Gets the specified agent's total run time attribute loaded up by the retrieveStatsModule() method.
AgentStatsModule	retrieveStatsModule(String agentClassName) Gets the AgentStatsModule used to retrieve statistics associated with the specified agent class

Method Detail

getReduceTime

double getReduceTime(String agentClassName)

Gets the specified agent's total reduce time attribute loaded up by the retrieveStatsModule() method.

Parameters:

agentClassName - The fully qualified class name of the agent

Returns:

the reduce time for this agent in milliseconds

See Also:

retrieveStatsModule(String), AgentStatsModule.getReduceTime(boolean copy)

getTotalDurationTime

double getTotalDurationTime(String agentClassName)

Gets the specified agent's total run time attribute loaded up by the retrieveStatsModule() method.

Parameters:

agentClassName - The fully qualified class name of the agent

Returns:

the total run time for this agent in milliseconds

See Also:

retrieveStatsModule(String), AgentStatsModule.getTotalDurationTime(boolean copy)

getAgentSerializationTime

double getAgentSerializationTime(String agentClassName)

Gets the specified agent's serialization time attribute loaded up by the retrieveStatsModule() method.

Parameters:

agentClassName - The fully qualified class name of the agent

Returns:

the time it takes to serialize the agent in milliseconds

See Also:

retrieveStatsModule(String), AgentStatsModule.getAgentSerializationTime(boolean copy)

getAgentInflationTime

double getAgentInflationTime(String agentClassName)

Gets the specified agent's inflation time attribute loaded up by the retrieveStatsModule() method.

Parameters:

agentClassName - The fully qualified class name of the agent

Returns:

the time it takes to inflate the agent in milliseconds

See Also:

retrieveStatsModule(String), AgentStatsModule.getAgentInflationTime(boolean copy)

getResultInflationTime

double getResultInflationTime(String agentClassName)

Gets the specified agent's result inflation time attribute loaded up by the retrieveStatsModule() method.

Parameters:

agentClassName - The fully qualified class name of the agent

Returns:

the time it takes to inflate the agent results for a given partition in milliseconds

See Also:

retrieveStatsModule(String), AgentStatsModule.getResultInflationTime(boolean copy)

getResultSerializationTime

double getResultSerializationTime(String agentClassName)

Gets the specified agent's result serialization time attribute loaded up by the retrieveStatsModule() method.

Parameters:

agentClassName - The fully qualified class name of the agent

Returns:

the time it takes to serialize the agent results for a given partition in milliseconds

See Also:

retrieveStatsModule(String), AgentStatsModule.getResultSerializationTime(boolean copy)

getPartitionCount

double getPartitionCount(String agentClassName)

Gets the specified agent's partition count attribute loaded up by the retrieveStatsModule() method.

Parameters:

agentClassName - The fully qualified class name of the agent

Returns:

the number of partitions this agent is sent to

See Also:

retrieveStatsModule(String), AgentStatsModule.getPartitionCount(boolean copy)

getFailureCount

double getFailureCount(String agentClassName)

Gets the specified agent's failure count attribute loaded up by the retrieveStatsModule() method.

Parameters:

agentClassName - The fully qualified class name of the agent

Returns:

the failure count for the specified agent

See Also:

retrieveStatsModule(String), AgentStatsModule.getFailureCount(boolean copy)

getInvocationCount

double getInvocationCount(String agentClassName)

Gets the specified agent's invocation count attribute loaded up by the retrieveStatsModule() method.

Parameters:

agentClassName - The fully qualified class name of the agent

Returns:

the invocation count for the specified agent

See Also:

retrieveStatsModule(String), AgentStatsModule.getInvocationCount(boolean copy)

retrieveStatsModule

AgentStatsModule retrieveStatsModule(String agentClassName)

Gets the AgentStatsModule used to retrieve statistics associated with the specified agent class

Parameters:

agentClassName - The fully qualified class name of the agent

Returns:

an AgentStatsModule for statistics associated with the specified agent class

See Also:

AgentStatsModule