com.sap.util.monitor.jarm
Interface IRmiMonitor

All Superinterfaces:

IConfMonitor, java.rmi.Remote

public interface IRmiMonitor

extends IConfMonitor, java.rmi.Remote

this interface provides all methods and attributes necessary to access the monitored data via RMI

Fields inherited from interface com.sap.util.monitor.jarm.IConfMonitor

COMPLEVEL, COMPLEVELBASIC, COMPLEVELDETAIL, COMPLEVELMEDIUM, COMPPROPERTIESGETSWITCH, COMPPROPERTIESSETSWITCH, COMPTRACELEVEL, CONSUMERCLASS, CONSUMERPREFIX, CONSUMERRESTART, CONSUMERSWITCH, KEYINSTRCHECK, KEYMAXREQCOMPHIGH, KEYMAXREQCOMPLOW, KEYMONITOR, KEYPARTNEREXCL, KEYVERSION, LOGFILEDIR, LOGLEVEL, MONITORPREFIX, NAMENOTSET, NOCOMPACTIVE, NUMBERNOTSET, REQCOMPNOTCLOSED, REQCOMPTOOMANYHIGH, REQCOMPTOOMANYLOW, REQOK, REQOVERVIEWALL, REQOVERVIEWHEADER, REQOVERVIEWNONE, RESETALL, RESETCOMPONENTS, RESETREQUESTS, RESETUSERS, RMIPORT, RMIPREFIX, RMISTARTREGISTRY, RMISWITCH, TOPACCGROSSTIME, TOPCALLNUM, TOPGROSSCPUTIME, TOPGROSSTIME, TOPNETCPUTIME, TOPNETTIME, TOPOUTDATA, TRACESWITCH, UNDEFDATA, UNDEFNAME, UNDEFTIME, VALUEALL, VALUENONE, VALUEOFF, VALUEON

Method Summary

ApplThreadOverview[]	getApplThreads() A application specific overview about the thread activities is returned.
ComponentOverview[]	getComponents(java.lang.String namePattern, int maxResults) Gives an overview about the components used by the requests.
ComponentOverviewExt[]	getComponentsExt(java.lang.String namePattern, int maxResults) Gives an overview about the components used by the requests (including CPU specific data).
boolean	getMonitorSwitch() Indicates whether monitoring is switched on or off could also be done by getProperties()
java.util.Properties	getProperties() Delivers the parameters currently valid for monitoring;
RequestSummary	getSummaryOfRequests() Returns key numbers for all requests issued since startup.
RequestSummaryExt	getSummaryOfRequestsExt() Returns key numbers for all requests issued since startup (including CPU specific data).
ComponentOverview[]	getTopComponents(int criterion, java.lang.String namePattern, int maxResults) Gives an overview about the top components according to special criteria like gross time, amount of outbound data.
ComponentOverviewExt[]	getTopComponentsExt(int criterion, java.lang.String namePattern, int maxResults) Gives an overview about the top components according to special criteria like gross time, amount of outbound data (including CPU specific data).
RequestOverview[]	getTopRequests(int retOverview, int criterion, java.lang.String namePattern, int maxResults) Gives an overview about the top requests according to special criteria like gross time, amount of outbound data.
RequestOverviewExt[]	getTopRequestsExt(int retOverview, int criterion, java.lang.String namePattern, int maxResults) Gives an overview about the top requests according to special criteria like gross time, amount of outbound data (including CPU specific data).
UserOverview[]	getTopUsers(int criterion, java.lang.String namePattern, int maxResults) Gives an overview about the top users according to special criteria like gross time, number of calls, ...
void	resetMonitorData(int criterion) reset collected monitoring data reset user data (criterion: ConfMonitor.RESETUSERS): the accumulated user data is resetted; data which is being collected in currently open requests or in requests which are finished but not yet condensed is not touched reset component data (criterion: ConfMonitor.RESETCOMPONENTS): the accumulated component data is resetted; data which is being collected in currently open requests or in requests which are finished but not yet condensed is not touched; component attributes like description and the interface for component specific properties are not changed reset request data (criterion: ConfMonitor.RESETREQUESTS): the accumulated request data is resetted; data which is being collected in currently open requestsis not touched; different to the reset of components and users the requests which are finished but not yet condensed are deleted reset all data (criterion: ConfMonitor.RESETALL): combination of all cases above
void	setMonitorOff() Switches monitoring off; is valid for requests which start after this call could also be done by setProperties()
void	setMonitorOn() Switches monitoring on; is valid for requests which start after this call could also be done by setProperties()
void	setProperties(java.util.Properties props) Set monitoring parameters;

Method Detail

getApplThreads

public ApplThreadOverview[] getApplThreads()
                                    throws java.rmi.RemoteException

A application specific overview about the thread activities is returned. Only these threads are listed which are still alive and which were used by applications instrumented with monitor API calls.

Returns:

array with one entry for every thread; if no thread was ever used by an application with monitoring switched on, null is returned consistency is guaranteed on an entry basis, this means for each thread the information is consistent, but the information across all the entries is collected at slightly different timestamps

getTopRequests

public RequestOverview[] getTopRequests(int retOverview,
                                        int criterion,
                                        java.lang.String namePattern,
                                        int maxResults)
                                 throws java.rmi.RemoteException

Gives an overview about the top requests according to special criteria like gross time, amount of outbound data.

Parameters:

retOverview - ConfMonitor.REQOVERVIEWALL <-> return all collected monitoring data; ConfMonitor.REQOVERVIEWNONE <-> 'null' is returned currently only ConfMonitor.REQOVERVIEWALL makes sense for call; the parameter was just added to be able to make compatible extensions in future

criterion - ConfMonitor.TOPGROSSTIME, ConfMonitor.TOPOUTDATA

namePattern - restriction for request name; allowed are
- null or "*": no restriction
- "prefix[*]": only names which starts with "prefix"; e.g. "wcm*" or "abc"

maxResults - maximum number of result entries;
internally only ConfMonitor.initNrTops records are stored; this will be the upper limit of result entries if no restriction applies

Returns:

array with one entry for each request; if no request is matching or retOverview = ConfMonitor.REQOVERVIEWNONE, null is returned; the entries are sorted according the criterion; null is also returned if criterion has no correct value

getTopRequestsExt

public RequestOverviewExt[] getTopRequestsExt(int retOverview,
                                              int criterion,
                                              java.lang.String namePattern,
                                              int maxResults)
                                       throws java.rmi.RemoteException

Gives an overview about the top requests according to special criteria like gross time, amount of outbound data (including CPU specific data).

Parameters:

retOverview - ConfMonitor.REQOVERVIEWALL <-> return all collected monitoring data; ConfMonitor.REQOVERVIEWNONE <-> 'null' is returned currently only ConfMonitor.REQOVERVIEWALL makes sense for call; the parameter was just added to be able to make compatible extensions in future

criterion - ConfMonitor.TOPGROSSTIME, ConfMonitor.TOPOUTDATA

namePattern - restriction for request name; allowed are
- null or "*": no restriction
- "prefix[*]": only names which starts with "prefix"; e.g. "wcm*" or "abc"

maxResults - maximum number of result entries;
internally only ConfMonitor.initNrTops records are stored; this will be the upper limit of result entries if no restriction applies

Returns:

array with one entry for each request; if no request is matching or retOverview = ConfMonitor.REQOVERVIEWNONE, null is returned; the entries are sorted according the criterion; null is also returned if criterion has no correct value

getSummaryOfRequests

public RequestSummary getSummaryOfRequests()
                                    throws java.rmi.RemoteException

Returns key numbers for all requests issued since startup.

Returns:

structure of key numbers like avg. response time and average amount of outbound data

getSummaryOfRequestsExt

public RequestSummaryExt getSummaryOfRequestsExt()
                                          throws java.rmi.RemoteException

Returns key numbers for all requests issued since startup (including CPU specific data).

Returns:

structure of key numbers like avg. response time and average amount of outbound data

getTopComponents

public ComponentOverview[] getTopComponents(int criterion,
                                            java.lang.String namePattern,
                                            int maxResults)
                                     throws java.rmi.RemoteException

Gives an overview about the top components according to special criteria like gross time, amount of outbound data.

Parameters:

criterion - ConfMonitor.TOPGROSSTIME, ConfMonitor.TOPOUTDATA ConfMonitor.TOPNETTIME, ConfMonitor.TOPCALLNUM

namePattern - restriction for component name; allowed are
- null or "*": no restriction
- "[*]": only names which starts with ""; e.g. "wcm*" or "a.b.c"

maxResults - maximum number of result entries; the value is restricted by ConfMonitor.initMaxCompRet; if a big number is used, the response time could be high!!

Returns:

array with one entry for each component; if no component is matching, null is returned; the entries are sorted according the criterion

getTopComponentsExt

public ComponentOverviewExt[] getTopComponentsExt(int criterion,
                                                  java.lang.String namePattern,
                                                  int maxResults)
                                           throws java.rmi.RemoteException

Gives an overview about the top components according to special criteria like gross time, amount of outbound data (including CPU specific data).

Parameters:

criterion - ConfMonitor.TOPGROSSTIME, ConfMonitor.TOPOUTDATA ConfMonitor.TOPNETTIME, ConfMonitor.TOPCALLNUM ConfMonitor.TOPGROSSCPUTIME, ConfMonitor.TOPNETCPUTIME

namePattern - restriction for component name; allowed are
- null or "*": no restriction
- "[*]": only names which starts with ""; e.g. "wcm*" or "a.b.c"

maxResults - maximum number of result entries; the value is restricted by ConfMonitor.initMaxCompRet; if a big number is used, the response time could be high!!

Returns:

array with one entry for each component; if no component is matching, null is returned; the entries are sorted according the criterion

getComponents

public ComponentOverview[] getComponents(java.lang.String namePattern,
                                         int maxResults)
                                  throws java.rmi.RemoteException

Gives an overview about the components used by the requests.

Parameters:

namePattern - restriction for component name; allowed are
- null or "*": no restriction
- "[*]": only names which starts with ""; e.g. "wcm*" or "a.b.c"

maxResults - maximum number of result entries; the value is restricted by ConfMonitor.initMaxCompRet; if a big number is used, the response time could be high!!

Returns:

array with one entry for each component; if no component is matching, null is returned; no special sequence guaranteed

getComponentsExt

public ComponentOverviewExt[] getComponentsExt(java.lang.String namePattern,
                                               int maxResults)
                                        throws java.rmi.RemoteException

Gives an overview about the components used by the requests (including CPU specific data).

Parameters:

namePattern - restriction for component name; allowed are
- null or "*": no restriction
- "[*]": only names which starts with ""; e.g. "wcm*" or "a.b.c"

maxResults - maximum number of result entries; the value is restricted by ConfMonitor.initMaxCompRet; if a big number is used, the response time could be high!!

Returns:

array with one entry for each component; if no component is matching, null is returned; no special sequence guaranteed

getTopUsers

public UserOverview[] getTopUsers(int criterion,
                                  java.lang.String namePattern,
                                  int maxResults)
                           throws java.rmi.RemoteException

Gives an overview about the top users according to special criteria like gross time, number of calls, ...

Parameters:

criterion - ConfMonitor.TOPGROSSTIME, ConfMonitor.TOPACCGROSSTIME, ConfMonitor.TOPCALLNUM

namePattern - restriction for component name; allowed are
- null or "*": no restriction
- "[*]": only names which starts with ""; e.g. "wcm*" or "a.b.c"

maxResults - maximum number of result entries; the value is restricted by ConfMonitor.initMaxUserRet; if a big number is used, the response time could be high!!

Returns:

array with one entry for each user; if no user is matching, null is returned; the entries are sorted according the criterion

resetMonitorData

public void resetMonitorData(int criterion)
                      throws java.rmi.RemoteException

reset collected monitoring data
reset user data (criterion: ConfMonitor.RESETUSERS):
the accumulated user data is resetted; data which is being collected in currently open requests or in requests which are finished but not yet condensed is not touched
reset component data (criterion: ConfMonitor.RESETCOMPONENTS):
the accumulated component data is resetted; data which is being collected in currently open requests or in requests which are finished but not yet condensed is not touched; component attributes like description and the interface for component specific properties are not changed
reset request data (criterion: ConfMonitor.RESETREQUESTS):
the accumulated request data is resetted; data which is being collected in currently open requestsis not touched; different to the reset of components and users the requests which are finished but not yet condensed are deleted
reset all data (criterion: ConfMonitor.RESETALL):
combination of all cases above

Parameters:

criterion - ConfMonitor.RESETALL, CONFMONITOR.RESETREQUESTS, ConfMonitor.RESETCOMPONENTS, ConfMonitor.RESETUSERS

setMonitorOn

public void setMonitorOn()
                  throws java.rmi.RemoteException

Switches monitoring on;
is valid for requests which start after this call
could also be done by setProperties()

setMonitorOff

public void setMonitorOff()
                   throws java.rmi.RemoteException

Switches monitoring off;
is valid for requests which start after this call
could also be done by setProperties()

getMonitorSwitch

public boolean getMonitorSwitch()
                         throws java.rmi.RemoteException

Indicates whether monitoring is switched on or off
could also be done by getProperties()

Returns:

true <-> monitoring is switched on

getProperties

public java.util.Properties getProperties()
                                   throws java.rmi.RemoteException

Delivers the parameters currently valid for monitoring;

Returns:

the properties object

setProperties

public void setProperties(java.util.Properties props)
                   throws MonitorException,
                          java.rmi.RemoteException

Set monitoring parameters;

Parameters:

props - properties object containing the key-value pairs for the parameters; only parameters contained in the properties object will be changed;
to be handled parameter names have to start with "jarm/"

Throws:

MonitorException - thrown if there are wrong parameters used