TivoliPerfEngine MBean

Partial ObjectName:
WebSphere:*,type=TivoliPerfEngine

MinimalAccessCheck:
true


MBean TivoliPerfEngine

Management interface for the configuration of the Tivoli Performance Viewer subsystem.


Operation Summary
java.lang.BooleanisActive()
           Returns true if the monitoring engine is currently monitoring a system.
voidrestart()
           Restarts TPV
voidmonitorServer(UserPreferences userPreferences)
           Begin monitoring the server for the given user.
ServerBean[]getMonitoredServers(java.lang.String userId)
           Get all servers that are being monitored for a given user.
voiddisableServer(UserPreferences userPreferences)
           Stop monitoring the server for the given user.
java.lang.BooleanisServerMonitored(java.lang.String userId, ServerBean server)
           Returns true if the specified server is being monitored by the given user.
voidregister(UserPreferences userPreferences)
           Registers a user session with the Tivoli performance viewer.
StatResult[]get(StatRequest[] requests)
           Gets the data for the given user and server.
SummarygetSummary(StatRequest requests)
           Gets the summary data for the given user and server.
TreeNodeDatagetIdentifierTree(StatRequest request)
           Gets the MBean Stat Descriptor identifier tree for a monitored server.
StatResult[]getFromBuffer(StatRequest[] requests)
           Gets data directly from the buffer without transforming it.
voidstartLogging(UserPreferences up)
           Starts Logging on a server.
java.lang.BooleanisServerLogging(ServerBean up)
           Determines if a server is logging.
voidstopLogging(UserPreferences up)
           Stop logging on this server.
AdvisorChartDatagetAdvisorChartData(UserPreferences serverName, java.util.Locale locale)
           Get data for Advisor charts.
voidsetUserPreferences(UserPreferences preferences)
           Update a user's monitoring and logging preferences for a server.
UserPreferencesgetUserPreferences(UserPreferences preferences)
           Gets a user's monitoring and logging preferences for a server.
ServerBeangetServerFromLog(java.lang.String userId, java.lang.String logName)
           Gets the information about a log file for a given user.

Operation Detail

isActive

public java.lang.Boolean isActive()
Returns true if the monitoring engine is currently monitoring a system.
Security Roles:
administrator
operator

restart

public void restart()
Restarts TPV
Security Roles:
administrator
operator

monitorServer

public void monitorServer(UserPreferences userPreferences)
Begin monitoring the server for the given user.
Parameters:
userPreferences - The user's monitoring preferences for a specifc server.
Security Roles:
administrator
operator

getMonitoredServers

public ServerBean[] getMonitoredServers(java.lang.String userId)
Get all servers that are being monitored for a given user.
Parameters:
userId - The user id
Security Roles:
administrator
operator

disableServer

public void disableServer(UserPreferences userPreferences)
Stop monitoring the server for the given user.
Parameters:
userPreferences - The user data about the server to stop monitoring.
Security Roles:
administrator
operator

isServerMonitored

public java.lang.Boolean isServerMonitored(java.lang.String userId, ServerBean server)
Returns true if the specified server is being monitored by the given user.
Parameters:
userId - The userId.
server - The server.
Security Roles:
administrator
operator

register

public void register(UserPreferences userPreferences)
Registers a user session with the Tivoli performance viewer.
Parameters:
userPreferences - The user data about the server to register with.
Security Roles:
administrator
operator

get

public StatResult[] get(StatRequest[] requests)
Gets the data for the given user and server.
Parameters:
requests - The updated values the user wants to monitor.
Security Roles:
administrator
operator

getSummary

public Summary getSummary(StatRequest requests)
Gets the summary data for the given user and server.
Parameters:
requests - The updated values the user wants to monitor.
Security Roles:
administrator
operator

getIdentifierTree

public TreeNodeData getIdentifierTree(StatRequest request)
Gets the MBean Stat Descriptor identifier tree for a monitored server.
Parameters:
request - The updated values the user wants to monitor.
Security Roles:
administrator
operator

getFromBuffer

public StatResult[] getFromBuffer(StatRequest[] requests)
Gets data directly from the buffer without transforming it.
Parameters:
requests - The values being requested.
Security Roles:
administrator
operator

startLogging

public void startLogging(UserPreferences up)
Starts Logging on a server.
Parameters:
up - The User Preferences.
Security Roles:
administrator
operator

isServerLogging

public java.lang.Boolean isServerLogging(ServerBean up)
Determines if a server is logging.
Parameters:
up - A bean identifying the server
Security Roles:
administrator
operator

stopLogging

public void stopLogging(UserPreferences up)
Stop logging on this server.
Parameters:
up - The User Preferences.
Security Roles:
administrator
operator

getAdvisorChartData

public AdvisorChartData getAdvisorChartData(UserPreferences serverName, java.util.Locale locale)
Get data for Advisor charts.
Parameters:
serverName - The user's preferences.
locale - The user's locale.
Security Roles:
administrator
operator

setUserPreferences

public void setUserPreferences(UserPreferences preferences)
Update a user's monitoring and logging preferences for a server.
Parameters:
preferences - The user's monitoring preferences for a single server. The user can set the following values as given in the example below: set pref [java::new com.ibm.ws.tpv.engine.UserPreferences] $pref setServerName server_name $pref setNodeName node_name $pref setUserId user_id $pref setRefreshRate 10 (Refer Infocenter for allowed values) $pref setBufferSize 10 (Refer Infocenter for allowed values) $pref setLoggingDuration 300 (Specify in seconds) $pref setLogFileSize 5242880 (Specify in bytes) $pref setNumLogFiles 3 $pref setLogFileName tpv_log
Security Roles:
administrator
operator

getUserPreferences

public UserPreferences getUserPreferences(UserPreferences preferences)
Gets a user's monitoring and logging preferences for a server.
Parameters:
preferences - The user's monitoring preferences for a single server that should be updated to reflect the settings used by the monitoring engine. The user can set the following values as given in the example below: set tpvName [$AdminControl completeObjectName type=TivoliPerfEngine,*] set tpvOName [$AdminControl makeObjectName $tpvName] set pref [java::new com.ibm.ws.tpv.engine.UserPreferences] $pref setServerName server_name $pref setNodeName node_name $pref setUserId user_id set params [java::new {java.lang.Object[]} 1] $params set 0 $pref set sigs [java::new {java.lang.String[]} 1] $sigs set 0 com.ibm.ws.tpv.engine.UserPreferences set res [java::cast com.ibm.ws.tpv.engine.UserPreferences [$AdminControl invoke_jmx $tpvOName getUserPreferences $params $sigs]]
Security Roles:
administrator
operator

getServerFromLog

public ServerBean getServerFromLog(java.lang.String userId, java.lang.String logName)
Gets the information about a log file for a given user.
Parameters:
userId - The user id
logName - Name of the log file
Security Roles:
administrator
operator

Copyright IBM Corp. 1996-2005