com.ibm.wsspi.pmi.factory

Interface StatsGroup


  1. public interface StatsGroup
StatsGroup is a logical collection of similar StatsInstance. The group will provide an aggregated view of all the instances that are part of the group by aggregating the corresponding statistics in the individual instances.

The aggregation logic is handled by WebSphere Performance Monitoring Infrastructure (PMI).


Method Summary

Modifier and Type Method and Description
  1. int
getInstrumentationLevel()
Return the current instrumentation/monitoring level for this StatsGroup.
  1. javax.management.ObjectName
getMBean()
Return the MBean name associated with this StatsGroup.
  1. com.ibm.websphere.pmi.stat.MBeanStatDescriptor
getMBeanStatDescriptor()
Deprecated. No replacement.
  1. java.lang.String
getName()
Returns the name of the group
  1. void
setMBean(javax.management.ObjectName mBeanName)
Associate a managed object MBean with this StatsGroup.

Method Detail

getName

  1. java.lang.String getName()
Returns the name of the group
Returns:
instance name

getMBean

  1. javax.management.ObjectName getMBean( )
Return the MBean name associated with this StatsGroup. Return null if no MBean is associated.
Returns:
MBean ObjectName

setMBean

  1. void setMBean(javax.management.ObjectName mBeanName)
Associate a managed object MBean with this StatsGroup. This is required to access the statistics by calling getStats() on the managed object MBean.
Parameters:
mBeanName - managed object ObjectName

getInstrumentationLevel

  1. int getInstrumentationLevel()
Return the current instrumentation/monitoring level for this StatsGroup. The instrumentation level will only affect the grouping ability of the StatsGroup and not the instrumentation level of the individual StatsInstance. The instrumentation level is set via Administrative Console, WSAdmin, PerfMBean and PMI API. The default instrumentaion level is LEVEL_NONE when the instance is created. The various levels are defined in com.ibm.websphere.pmi.PmiConstants
Returns:
instrumentation level

getMBeanStatDescriptor

  1. com.ibm.websphere.pmi.stat.MBeanStatDescriptor getMBeanStatDescriptor( )
Deprecated. No replacement.
Returns the MBeanStatDescriptor for this StatsGroup. If an MBean is associated with the StatsGroup then the ObjectName will be returned as part of the MBeanStatDescriptor.
Returns:
MBeanStatDescriptor of the StatsGroup