Perf MBean

Partial ObjectName:
WebSphere:*,type=Perf


MBean Perf

Management interface for the Performance Monitoring Infrastructure (PMI) subsystem. WebSphere Performance Monitoring Infrastructure (PMI) maintains the Stats from various components in a tree structure. Perf MBean operations can be targeted towards (a) a given element in the PMI tree -- when the recursive parameter is false (b) a given element in the PMI tree and all its children (and their children, and so on) -- when the recursive parameter is true.


Operation Summary
com.ibm.websphere.pmi.PmiModuleConfiggetConfig(javax.management.ObjectName objectName)
           Returns the static descriptions of performance data that is associated with the specified MBean
com.ibm.websphere.pmi.PmiModuleConfiggetConfig(java.lang.String objectName)
           Returns the static descriptions of performance data that is associated with the specified Stats type
com.ibm.websphere.pmi.PmiModuleConfig[]getConfigs(java.util.Locale locale)
           Returns the Stats configuration information for all the Stats/PMI modules.
com.ibm.websphere.pmi.stat.WSStatsgetStatsObject(javax.management.ObjectName objectName, java.lang.Boolean recursive)
           Returns the Stats object for a given MBean.
com.ibm.websphere.pmi.stat.WSStats[]getStatsArray(javax.management.ObjectName[] objectName, java.lang.Boolean recursive)
           Returns an array of Stats objects for an array of MBeans.
com.ibm.websphere.pmi.stat.WSStats[]getStatsArray(com.ibm.websphere.pmi.stat.StatDescriptor[] objectName, java.lang.Boolean recursive)
           Returns an array of Stats objects for an array of StatDescriptors.
com.ibm.websphere.pmi.stat.MBeanLevelSpec[]getInstrumentationLevel(javax.management.ObjectName objectName, java.lang.Boolean recursive)
           Returns an array of MBeanLevelSpec.
com.ibm.websphere.pmi.stat.StatLevelSpec[]getInstrumentationLevel(com.ibm.websphere.pmi.stat.StatDescriptor statDescriptor, java.lang.Boolean recursive)
           Returns an array of StatLevelSpec.
java.lang.StringgetStatisticSet()
           Returns the statistic set that is currently in use.
java.lang.StringgetCustomSetString()
           Returns the current statistic set specification in fine-grained string format
com.ibm.websphere.pmi.stat.StatDescriptor[]listStatMembers(com.ibm.websphere.pmi.stat.StatDescriptor statDescriptor, java.lang.Boolean recursive)
           Returns an array of child StatDescriptors.
voidsetInstrumentationLevel(com.ibm.websphere.pmi.stat.MBeanLevelSpec mbeanLevelSpec, java.lang.Boolean recursive)
           Sets the instrumentation level for an MBean.
voidsetInstrumentationLevel(com.ibm.websphere.pmi.stat.MBeanLevelSpec[] mbeanLevelSpec, java.lang.Boolean recursive)
           Sets the instrumentation level for an array of MBeans.
voidsetInstrumentationLevel(com.ibm.websphere.pmi.stat.StatLevelSpec[] statLevelSpec, java.lang.Boolean recursive)
           Set the instrumentation level for the Stats object specified in StatLevelSpec[]
voidsetStatisticSet(java.lang.String statisticSet)
           Set instrumentation level using statistic sets.
voidsetCustomSetString(java.lang.String customSetSpec, java.lang.Boolean recursive)
           Set custom statistic set using fine-grained control.
voidappendCustomSetString(java.lang.String customSetSpec, java.lang.Boolean recursive)
           Append custom statistic set using fine-grained control.
voidsavePMIConfiguration()
           Save the runtime monitoring specification to the configuration file.
com.ibm.websphere.pmi.PmiModuleConfig[]getConfigs()
           Deprecated.  As of 6,0, this method is deprecated.
com.ibm.websphere.pmi.stat.WSStatsgetStatsObject(com.ibm.websphere.pmi.stat.MBeanStatDescriptor msd, java.lang.Boolean recursive)
           Deprecated.  As of 6,0, this method is deprecated.
com.ibm.websphere.pmi.stat.WSStatsgetStatsObject(com.ibm.ws.pmi.server.DataDescriptor datadescriptor, java.lang.Boolean recursive)
           Deprecated.  As of 6,0, this method is deprecated.
com.ibm.websphere.pmi.stat.WSStats[]getStatsArray(com.ibm.websphere.pmi.stat.MBeanStatDescriptor[] msd, java.lang.Boolean recursive)
           Deprecated.  As of 6,0, this method is deprecated.
com.ibm.websphere.pmi.stat.WSStats[]getStatsArray(com.ibm.ws.pmi.server.DataDescriptor[] dataDescriptor, java.lang.Boolean recursive)
           Deprecated.  As of 6,0, this method is deprecated.
java.lang.StringgetStatsString(javax.management.ObjectName objectName, java.lang.Boolean recursive)
           Deprecated.  As of 6,0, this method is deprecated.
java.lang.StringgetStatsString(javax.management.ObjectName objectName, java.lang.String submoduleName, java.lang.Boolean recursive)
           Deprecated.  As of 6,0, this method is deprecated.
voidsetInstrumentationLevel(java.lang.String levelSpecString, java.lang.Boolean recursive)
           Deprecated.  As of 6,0, this method is deprecated.
voidsetInstrumentationLevel(com.ibm.ws.pmi.server.PerfLevelDescriptor perfLevelSpec, java.lang.Boolean recursive)
           Deprecated.  As of 6,0, this method is deprecated.
voidsetInstrumentationLevel(com.ibm.ws.pmi.server.PerfLevelDescriptor[] perfLevelSpec, java.lang.Boolean recursive)
           Deprecated.  As of 6,0, this method is deprecated.
com.ibm.websphere.pmi.stat.MBeanLevelSpec[]getInstrumentationLevel(com.ibm.websphere.pmi.stat.MBeanStatDescriptor msd, java.lang.Boolean recursive)
           Deprecated.  As of 6,0, this method is deprecated.
com.ibm.ws.pmi.server.PerfLevelDescriptor[]getInstrumentationLevel(com.ibm.ws.pmi.server.DataDescriptor dataDescriptor, java.lang.Boolean recursive)
           Deprecated.  As of 6,0, this method is deprecated.
java.lang.StringgetInstrumentationLevelString()
           Deprecated.  As of 6,0, this method is deprecated.
com.ibm.websphere.pmi.stat.MBeanStatDescriptor[]listStatMembers(javax.management.ObjectName objectName)
           Deprecated.  As of 6,0, this method is deprecated.
com.ibm.websphere.pmi.stat.MBeanStatDescriptor[]listStatMembers(com.ibm.websphere.pmi.stat.MBeanStatDescriptor objectName)
           Deprecated.  As of 6,0, this method is deprecated.
com.ibm.ws.pmi.server.DataDescriptor[]listStatMembers(com.ibm.ws.pmi.server.DataDescriptor dataDescriptor)
           Deprecated.  As of 6,0, this method is deprecated.
java.lang.StringlistStatMemberNames(javax.management.ObjectName objectName)
           Deprecated.  As of 6,0, this method is deprecated.

Operation Detail

getConfig

public com.ibm.websphere.pmi.PmiModuleConfig getConfig(javax.management.ObjectName objectName)
Returns the static descriptions of performance data that is associated with the specified MBean
Parameters:
objectName - The ObjectName for the requested MBean
Security Roles:
administrator
operator

getConfig

public com.ibm.websphere.pmi.PmiModuleConfig getConfig(java.lang.String objectName)
Returns the static descriptions of performance data that is associated with the specified Stats type
Parameters:
objectName - Stats type
Security Roles:
administrator
operator

getConfigs

public com.ibm.websphere.pmi.PmiModuleConfig[] getConfigs(java.util.Locale locale)
Returns the Stats configuration information for all the Stats/PMI modules.
Parameters:
locale - Locale to used for translation. Null implies server default locale
Security Roles:
administrator
operator

getStatsObject

public com.ibm.websphere.pmi.stat.WSStats getStatsObject(javax.management.ObjectName objectName, java.lang.Boolean recursive)
Returns the Stats object for a given MBean.
Parameters:
objectName - ObjectName for the requested MBean
recursive - Is operation recursive?
Security Roles:
administrator
operator

getStatsArray

public com.ibm.websphere.pmi.stat.WSStats[] getStatsArray(javax.management.ObjectName[] objectName, java.lang.Boolean recursive)
Returns an array of Stats objects for an array of MBeans.
Parameters:
objectName - Array of target MBeans
recursive - Is operation recursive?
Security Roles:
administrator
operator

getStatsArray

public com.ibm.websphere.pmi.stat.WSStats[] getStatsArray(com.ibm.websphere.pmi.stat.StatDescriptor[] objectName, java.lang.Boolean recursive)
Returns an array of Stats objects for an array of StatDescriptors.
Parameters:
objectName - Array of target StatDescriptors
recursive - Is operation recursive?
Security Roles:
administrator
operator

getInstrumentationLevel

public com.ibm.websphere.pmi.stat.MBeanLevelSpec[] getInstrumentationLevel(javax.management.ObjectName objectName, java.lang.Boolean recursive)
Returns an array of MBeanLevelSpec.
Parameters:
objectName - ObjectName for the requested MBean
recursive - Is operation recursive?
Security Roles:
administrator
operator

getInstrumentationLevel

public com.ibm.websphere.pmi.stat.StatLevelSpec[] getInstrumentationLevel(com.ibm.websphere.pmi.stat.StatDescriptor statDescriptor, java.lang.Boolean recursive)
Returns an array of StatLevelSpec.
Parameters:
statDescriptor - StatDescriptor of a Stats in PMI tree
recursive - Is operation recursive?
Security Roles:
administrator
operator

getStatisticSet

public java.lang.String getStatisticSet()
Returns the statistic set that is currently in use.
Security Roles:
administrator
operator

getCustomSetString

public java.lang.String getCustomSetString()
Returns the current statistic set specification in fine-grained string format
Security Roles:
administrator
operator

listStatMembers

public com.ibm.websphere.pmi.stat.StatDescriptor[] listStatMembers(com.ibm.websphere.pmi.stat.StatDescriptor statDescriptor, java.lang.Boolean recursive)
Returns an array of child StatDescriptors. Includes all children if recursive is true or just the immediate children if recursive is false.
Parameters:
statDescriptor - The parent StatDescriptor
recursive - True indicates all children and false indicates immediate children
Security Roles:
administrator
operator

setInstrumentationLevel

public void setInstrumentationLevel(com.ibm.websphere.pmi.stat.MBeanLevelSpec mbeanLevelSpec, java.lang.Boolean recursive)
Sets the instrumentation level for an MBean.
Parameters:
mbeanLevelSpec - A descriptor including a MBean ObjectName, an optional StatDescriptor, and the instrumentation level
recursive - Is operation recursive?
Security Roles:
administrator
operator

setInstrumentationLevel

public void setInstrumentationLevel(com.ibm.websphere.pmi.stat.MBeanLevelSpec[] mbeanLevelSpec, java.lang.Boolean recursive)
Sets the instrumentation level for an array of MBeans.
Parameters:
mbeanLevelSpec - An array of descriptors including a MBean ObjectName, an optional StatDescriptor, and the instrumentation level
recursive - Is operation recursive?
Security Roles:
administrator
operator

setInstrumentationLevel

public void setInstrumentationLevel(com.ibm.websphere.pmi.stat.StatLevelSpec[] statLevelSpec, java.lang.Boolean recursive)
Set the instrumentation level for the Stats object specified in StatLevelSpec[]
Parameters:
statLevelSpec - An array of StatDescriptors
recursive - Is operation recursive?
Security Roles:
administrator
operator

setStatisticSet

public void setStatisticSet(java.lang.String statisticSet)
Set instrumentation level using statistic sets.
Parameters:
statisticSet - Valid sets are defined as constants in com.ibm.websphere.pmi.stat.StatConstants: STATISTIC_SET_NONE, STATISTIC_SET_BASIC, STATISTIC_SET_EXTENDED, STATISTIC_SET_ALL
Security Roles:
administrator
operator

setCustomSetString

public void setCustomSetString(java.lang.String customSetSpec, java.lang.Boolean recursive)
Set custom statistic set using fine-grained control. The format of the custom set specification string is STATS_NAME=ID1,ID2,ID3 seperated by ':', where STATS_NAME and IDs are the statistic IDs defined in WS*Stat interfaces in com.ibm.websphere.pmi.stat package. Use * to enable all the statistics in the given PMI module. For example, to enable all the statistics for JVM and active count, pool size for thread pool use the string: jvmRuntimeModule=*:threadPoolModule=3,4. The string jvmRuntimeModule is the value of the constant WSJVMStats.NAME and threadPoolModule is the value of WSThreadPoolStats.NAME.
Parameters:
customSetSpec - The custom set specification in fine-grained string format
recursive - Is operation recursive?
Security Roles:
administrator
operator

appendCustomSetString

public void appendCustomSetString(java.lang.String customSetSpec, java.lang.Boolean recursive)
Append custom statistic set using fine-grained control. The format of the custom set specification string is STATS_NAME=ID1,ID2,ID3 seperated by ':', where STATS_NAME and IDs are the statistic IDs defined in WS*Stat interfaces in com.ibm.websphere.pmi.stat package. Use * to enable all the statistics in the given PMI module. For example, to enable all the statistics for JVM and active count, pool size for thread pool use the string: jvmRuntimeModule=*:threadPoolModule=3,4. The string jvmRuntimeModule is the value of the constant WSJVMStats.NAME and threadPoolModule is the value of WSThreadPoolStats.NAME.
Parameters:
customSetSpec - The custom set specification in fine-grained string format
recursive - Is operation recursive?
Security Roles:
administrator
operator

savePMIConfiguration

public void savePMIConfiguration()
Save the runtime monitoring specification to the configuration file.
Security Roles:
administrator
operator

getConfigs

public com.ibm.websphere.pmi.PmiModuleConfig[] getConfigs()
Deprecated.  As of 6,0, this method is deprecated.

Returns the static descriptions of performance data in all statistic providers
Security Roles:
administrator
operator

getStatsObject

public com.ibm.websphere.pmi.stat.WSStats getStatsObject(com.ibm.websphere.pmi.stat.MBeanStatDescriptor msd, java.lang.Boolean recursive)
Deprecated.  As of 6,0, this method is deprecated.

Returns Stats object for the MBeanStatDescriptor which includes an ObjectName and an optional StatDescriptor
Parameters:
msd - The descriptor including the target ObjectName and an optional StatDescriptor
recursive - Is operation recursive?
Security Roles:
administrator
operator

getStatsObject

public com.ibm.websphere.pmi.stat.WSStats getStatsObject(com.ibm.ws.pmi.server.DataDescriptor datadescriptor, java.lang.Boolean recursive)
Deprecated.  As of 6,0, this method is deprecated.

Return the Stats Object for the DataDescriptor
Parameters:
datadescriptor - DataDescriptor for the requested PMI module
recursive - Is operation recursive?
Security Roles:
administrator
operator

getStatsArray

public com.ibm.websphere.pmi.stat.WSStats[] getStatsArray(com.ibm.websphere.pmi.stat.MBeanStatDescriptor[] msd, java.lang.Boolean recursive)
Deprecated.  As of 6,0, this method is deprecated.

Returns an array of Stats objects for the array of MBeanStatDescriptors
Parameters:
msd - An array of descriptors including the target ObjectNames and optional StatDescriptors
recursive - Is operation recursive?
Security Roles:
administrator
operator

getStatsArray

public com.ibm.websphere.pmi.stat.WSStats[] getStatsArray(com.ibm.ws.pmi.server.DataDescriptor[] dataDescriptor, java.lang.Boolean recursive)
Deprecated.  As of 6,0, this method is deprecated.

Returns an array of Stats objects for the array of DataDescriptors
Parameters:
dataDescriptor - An array of Data Descriptors
recursive - Is operation recursive?
Security Roles:
administrator
operator

getStatsString

public java.lang.String getStatsString(javax.management.ObjectName objectName, java.lang.Boolean recursive)
Deprecated.  As of 6,0, this method is deprecated.

Returns the Stats object for a given MBean in String format.
Parameters:
objectName - ObjectName for the requested MBean
recursive - Is operation recursive?
Security Roles:
administrator
operator

getStatsString

public java.lang.String getStatsString(javax.management.ObjectName objectName, java.lang.String submoduleName, java.lang.Boolean recursive)
Deprecated.  As of 6,0, this method is deprecated.

Returns the Stats object for a given MBean in String format.
Parameters:
objectName - ObjectName for the requested MBean
submoduleName - Name of the submodule in that MBean
recursive - Is operation recursive?
Security Roles:
administrator
operator

setInstrumentationLevel

public void setInstrumentationLevel(java.lang.String levelSpecString, java.lang.Boolean recursive)
Deprecated.  As of 6,0, this method is deprecated.

Set the instrumentation level based on the levels specified in the string parameter
Parameters:
levelSpecString - The instrumentation level settings in String format
recursive - Is operation recursive?
Security Roles:
administrator
operator

setInstrumentationLevel

public void setInstrumentationLevel(com.ibm.ws.pmi.server.PerfLevelDescriptor perfLevelSpec, java.lang.Boolean recursive)
Deprecated.  As of 6,0, this method is deprecated.

Set the instrumentation level for the PMI module specified in PerfLevelDescriptor to be the new level
Parameters:
perfLevelSpec - A PerfDescriptor
recursive - Is operation recursive?
Security Roles:
administrator
operator

setInstrumentationLevel

public void setInstrumentationLevel(com.ibm.ws.pmi.server.PerfLevelDescriptor[] perfLevelSpec, java.lang.Boolean recursive)
Deprecated.  As of 6,0, this method is deprecated.

Set the instrumentation level for the PMI module specified in PerfLevelDescriptor to be the new level
Parameters:
perfLevelSpec - PerfDescriptor array
recursive - Is operation recursive?
Security Roles:
administrator
operator

getInstrumentationLevel

public com.ibm.websphere.pmi.stat.MBeanLevelSpec[] getInstrumentationLevel(com.ibm.websphere.pmi.stat.MBeanStatDescriptor msd, java.lang.Boolean recursive)
Deprecated.  As of 6,0, this method is deprecated.

Return an array of MBeanLevelSpec - the descriptor including a MBean ObjectName, an optional StatDescriptor, and the instrumentation level
Parameters:
msd - The descriptor including the MBean ObjectName and an optional StatDescriptor
recursive - Is operation recursive?
Security Roles:
administrator
operator

getInstrumentationLevel

public com.ibm.ws.pmi.server.PerfLevelDescriptor[] getInstrumentationLevel(com.ibm.ws.pmi.server.DataDescriptor dataDescriptor, java.lang.Boolean recursive)
Deprecated.  As of 6,0, this method is deprecated.

Return an array of PerfLevelDescriptor for the given PMI module
Parameters:
dataDescriptor - The DataDescriptor for the requested PMI module
recursive - Is operation recursive?
Security Roles:
administrator
operator

getInstrumentationLevelString

public java.lang.String getInstrumentationLevelString()
Deprecated.  As of 6,0, this method is deprecated.

Return the String for the top level PMI modules - a string with a list of PMI_MODULE_NAME=LEVEL seperated by ':'
Security Roles:
administrator
operator

listStatMembers

public com.ibm.websphere.pmi.stat.MBeanStatDescriptor[] listStatMembers(javax.management.ObjectName objectName)
Deprecated.  As of 6,0, this method is deprecated.

Return an array of MBeanStatDescriptors for its immediate children in PMI hierarchy
Parameters:
objectName - The ObjectName for the requested MBean
Security Roles:
administrator
operator

listStatMembers

public com.ibm.websphere.pmi.stat.MBeanStatDescriptor[] listStatMembers(com.ibm.websphere.pmi.stat.MBeanStatDescriptor objectName)
Deprecated.  As of 6,0, this method is deprecated.

Return an array of MBeanStatDescriptors for its immediate children in PMI hierarchy
Parameters:
objectName - The descriptor including the MBean ObjectName and an optional StatDescriptor
Security Roles:
administrator
operator

listStatMembers

public com.ibm.ws.pmi.server.DataDescriptor[] listStatMembers(com.ibm.ws.pmi.server.DataDescriptor dataDescriptor)
Deprecated.  As of 6,0, this method is deprecated.

Return an array of DataDescriptors for its immediate children in PMI hierarchy
Parameters:
dataDescriptor - DataDescriptor for the requested PMI module
Security Roles:
administrator
operator

listStatMemberNames

public java.lang.String listStatMemberNames(javax.management.ObjectName objectName)
Deprecated.  As of 6,0, this method is deprecated.

Return a list of submodule names under the MBean
Parameters:
objectName - The ObjectName for the requested MBean
Security Roles:
administrator
operator

Copyright IBM Corp. 1996-2005