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 | |
---|---|
PmiModuleConfig | getConfig( Returns the static descriptions of performance data that is associated with the specified MBean |
PmiModuleConfig | getConfig( Returns the static descriptions of performance data that is associated with the specified Stats type |
PmiModuleConfig[] | getConfigs( Returns the Stats configuration information for all the Stats/PMI modules. |
WSStats | getStatsObject( Returns the Stats object for a given MBean. |
WSStats[] | getStatsArray( Returns an array of Stats objects for an array of MBeans. |
WSStats[] | getStatsArray( Returns an array of Stats objects for an array of StatDescriptors. |
MBeanLevelSpec[] | getInstrumentationLevel( Returns an array of MBeanLevelSpec. |
StatLevelSpec[] | getInstrumentationLevel( Returns an array of StatLevelSpec. |
java.lang.String | getStatisticSet() Returns the statistic set that is currently in use. |
java.lang.String | getCustomSetString() Returns the current statistic set specification in fine-grained string format |
StatDescriptor[] | listStatMembers( Returns an array of child StatDescriptors. |
void | setInstrumentationLevel( Sets the instrumentation level for an MBean. |
void | setInstrumentationLevel( Sets the instrumentation level for an array of MBeans. |
void | setInstrumentationLevel( Set the instrumentation level for the Stats object specified in StatLevelSpec[] |
void | setStatisticSet( Set instrumentation level using statistic sets. |
void | setCustomSetString( Set custom statistic set using fine-grained control. |
void | appendCustomSetString( Append custom statistic set using fine-grained control. |
void | savePMIConfiguration() Save the runtime monitoring specification to the configuration file. |
PmiModuleConfig[] | getConfigs() Deprecated.As of 6,0, this method is deprecated. |
WSStats | getStatsObject( Deprecated.As of 6,0, this method is deprecated. |
WSStats | getStatsObject( Deprecated.As of 6,0, this method is deprecated. |
WSStats[] | getStatsArray( Deprecated.As of 6,0, this method is deprecated. |
WSStats[] | getStatsArray( Deprecated.As of 6,0, this method is deprecated. |
java.lang.String | getStatsString( Deprecated.As of 6,0, this method is deprecated. |
java.lang.String | getStatsString( Deprecated.As of 6,0, this method is deprecated. |
void | setInstrumentationLevel( Deprecated.As of 6,0, this method is deprecated. |
void | setInstrumentationLevel( Deprecated.As of 6,0, this method is deprecated. |
void | setInstrumentationLevel( Deprecated.As of 6,0, this method is deprecated. |
MBeanLevelSpec[] | getInstrumentationLevel( Deprecated.As of 6,0, this method is deprecated. |
PerfLevelDescriptor[] | getInstrumentationLevel( Deprecated.As of 6,0, this method is deprecated. |
java.lang.String | getInstrumentationLevelString() Deprecated.As of 6,0, this method is deprecated. |
MBeanStatDescriptor[] | listStatMembers( Deprecated.As of 6,0, this method is deprecated. |
MBeanStatDescriptor[] | listStatMembers( Deprecated.As of 6,0, this method is deprecated. |
DataDescriptor[] | listStatMembers( Deprecated.As of 6,0, this method is deprecated. |
java.lang.String | listStatMemberNames( Deprecated.As of 6,0, this method is deprecated. |
Operation Detail |
---|
public PmiModuleConfig getConfig(
javax.management.ObjectName objectName
)
Returns the static descriptions of performance data that is associated with the specified MBean
objectName
-
The ObjectName for the requested MBean
administrator
operator
public PmiModuleConfig getConfig(
java.lang.String objectName
)
Returns the static descriptions of performance data that is associated with the specified Stats type
objectName
-
Stats type
administrator
operator
public PmiModuleConfig[] getConfigs(
java.util.Locale locale
)
Returns the Stats configuration information for all the Stats/PMI modules.
locale
-
Locale to used for translation. Null implies server default locale
administrator
operator
public WSStats getStatsObject(
javax.management.ObjectName objectName,
java.lang.Boolean recursive
)
Returns the Stats object for a given MBean.
objectName
-
ObjectName for the requested MBean recursive
-
Is operation recursive?
administrator
operator
public WSStats[] getStatsArray(
javax.management.ObjectName[] objectName,
java.lang.Boolean recursive
)
Returns an array of Stats objects for an array of MBeans.
objectName
-
Array of target MBeans recursive
-
Is operation recursive?
administrator
operator
public WSStats[] getStatsArray(
StatDescriptor[] objectName,
java.lang.Boolean recursive
)
Returns an array of Stats objects for an array of StatDescriptors.
objectName
-
Array of target StatDescriptors recursive
-
Is operation recursive?
administrator
operator
public MBeanLevelSpec[] getInstrumentationLevel(
javax.management.ObjectName objectName,
java.lang.Boolean recursive
)
Returns an array of MBeanLevelSpec.
objectName
-
ObjectName for the requested MBean recursive
-
Is operation recursive?
administrator
operator
public StatLevelSpec[] getInstrumentationLevel(
StatDescriptor statDescriptor,
java.lang.Boolean recursive
)
Returns an array of StatLevelSpec.
statDescriptor
-
StatDescriptor of a Stats in PMI tree recursive
-
Is operation recursive?
administrator
operator
public java.lang.String getStatisticSet()
Returns the statistic set that is currently in use.
administrator
operator
public java.lang.String getCustomSetString()
Returns the current statistic set specification in fine-grained string format
administrator
operator
public StatDescriptor[] listStatMembers(
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.
statDescriptor
-
The parent StatDescriptor recursive
-
True indicates all children and false indicates immediate children
administrator
operator
public void setInstrumentationLevel(
MBeanLevelSpec mbeanLevelSpec,
java.lang.Boolean recursive
)
Sets the instrumentation level for an MBean.
mbeanLevelSpec
-
A descriptor including a MBean ObjectName, an optional StatDescriptor, and the instrumentation level recursive
-
Is operation recursive?
administrator
operator
public void setInstrumentationLevel(
MBeanLevelSpec[] mbeanLevelSpec,
java.lang.Boolean recursive
)
Sets the instrumentation level for an array of MBeans.
mbeanLevelSpec
-
An array of descriptors including a MBean ObjectName, an optional StatDescriptor, and the instrumentation level recursive
-
Is operation recursive?
administrator
operator
public void setInstrumentationLevel(
StatLevelSpec[] statLevelSpec,
java.lang.Boolean recursive
)
Set the instrumentation level for the Stats object specified in StatLevelSpec[]
statLevelSpec
-
An array of StatDescriptors recursive
-
Is operation recursive?
administrator
operator
public void setStatisticSet(
java.lang.String statisticSet
)
Set instrumentation level using statistic sets.
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
administrator
operator
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.
customSetSpec
-
The custom set specification in fine-grained string format recursive
-
Is operation recursive?
administrator
operator
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.
customSetSpec
-
The custom set specification in fine-grained string format recursive
-
Is operation recursive?
administrator
operator
public void savePMIConfiguration()
Save the runtime monitoring specification to the configuration file.
administrator
operator
public PmiModuleConfig[] getConfigs()
Deprecated.
As of 6,0, this method is deprecated.
Returns the static descriptions of performance data in all statistic providers
administrator
operator
public WSStats getStatsObject(
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
msd
-
The descriptor including the target ObjectName and an optional StatDescriptor recursive
-
Is operation recursive?
administrator
operator
public WSStats getStatsObject(
DataDescriptor datadescriptor,
java.lang.Boolean recursive
)
Deprecated.
As of 6,0, this method is deprecated.
Return the Stats Object for the DataDescriptor
datadescriptor
-
DataDescriptor for the requested PMI module recursive
-
Is operation recursive?
administrator
operator
public WSStats[] getStatsArray(
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
msd
-
An array of descriptors including the target ObjectNames and optional StatDescriptors recursive
-
Is operation recursive?
administrator
operator
public WSStats[] getStatsArray(
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
dataDescriptor
-
An array of Data Descriptors recursive
-
Is operation recursive?
administrator
operator
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.
objectName
-
ObjectName for the requested MBean recursive
-
Is operation recursive?
administrator
operator
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.
objectName
-
ObjectName for the requested MBean submoduleName
-
Name of the submodule in that MBean recursive
-
Is operation recursive?
administrator
operator
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
levelSpecString
-
The instrumentation level settings in String format recursive
-
Is operation recursive?
administrator
operator
public void setInstrumentationLevel(
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
perfLevelSpec
-
A PerfDescriptor recursive
-
Is operation recursive?
administrator
operator
public void setInstrumentationLevel(
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
perfLevelSpec
-
PerfDescriptor array recursive
-
Is operation recursive?
administrator
operator
public MBeanLevelSpec[] getInstrumentationLevel(
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
msd
-
The descriptor including the MBean ObjectName and an optional StatDescriptor recursive
-
Is operation recursive?
administrator
operator
public PerfLevelDescriptor[] getInstrumentationLevel(
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
dataDescriptor
-
The DataDescriptor for the requested PMI module recursive
-
Is operation recursive?
administrator
operator
public java.lang.String getInstrumentationLevelString()
Deprecated.
As of 6,0, this method is deprecated.
Return the String for the higher level PMI modules - a string with a list of PMI_MODULE_NAME=LEVEL seperated by ':'
administrator
operator
public 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
objectName
-
The ObjectName for the requested MBean
administrator
operator
public MBeanStatDescriptor[] listStatMembers(
MBeanStatDescriptor objectName
)
Deprecated.
As of 6,0, this method is deprecated.
Return an array of MBeanStatDescriptors for its immediate children in PMI hierarchy
objectName
-
The descriptor including the MBean ObjectName and an optional StatDescriptor
administrator
operator
public DataDescriptor[] listStatMembers(
DataDescriptor dataDescriptor
)
Deprecated.
As of 6,0, this method is deprecated.
Return an array of DataDescriptors for its immediate children in PMI hierarchy
dataDescriptor
-
DataDescriptor for the requested PMI module
administrator
operator
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
objectName
-
The ObjectName for the requested MBean
administrator
operator