com.sap.util.monitor.jarm
Class OverviewMonitor

java.lang.Object
  |
  +--com.sap.util.monitor.jarm.OverviewMonitor

public class OverviewMonitor

extends java.lang.Object

This class provides an API to deliver all collected monitoring information. Copies of the data are returned in order to avoid synchronization conflicts with the current monitoring.

Constructor Summary

OverviewMonitor()

Method Summary

static ApplThreadOverview[]	getApplThreads() A application specific overview about the thread activities is returned.
static ComponentOverview[]	getComponents(java.lang.String namePattern, int maxResults) Gives an overview about the components used by the requests.
static ComponentOverviewExt[]	getComponentsExt(java.lang.String namePattern, int maxResults) Gives an overview about the components used by the requests (including CPU specific data).
static RequestSummary	getSummaryOfRequests() Returns key numbers for all requests issued since startup.
static RequestSummaryExt	getSummaryOfRequestsExt() Returns key numbers for all requests issued since startup (including CPU specific data).
static ComponentOverview[]	getTopComponents(int criterion, java.lang.String namePattern, int maxResults) Gives an overview about the top components according to special criteria like gross time, number of calls.
static ComponentOverviewExt[]	getTopComponentsExt(int criterion, java.lang.String namePattern, int maxResults) Gives an overview about the top components according to special criteria like gross time, number of calls (including CPU specific data).
static 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.
static 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).
static 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, ... (including CPU specific data)
static 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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OverviewMonitor

public OverviewMonitor()

Method Detail

getApplThreads

public static ApplThreadOverview[] getApplThreads()

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; the array entries are sorted according to the thread name

getTopRequests

public static 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.

Parameters:

retOverview - ConfMonitor.REQOVERVIEWALL <-> return all collected monitoring data; ConfMonitor.REQOVERVIEWNONE <-> 'null' is returned ConfMonitor.REQOVERVIEWHEADER <-> only header information is returned, but no data about tasks or single components

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" (there could be several requests with the same name; thus "abc" could deliver more than one request

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 static 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).

Parameters:

retOverview - ConfMonitor.REQOVERVIEWALL <-> return all collected monitoring data; ConfMonitor.REQOVERVIEWNONE <-> 'null' is returned ConfMonitor.REQOVERVIEWHEADER <-> only header information is returned, but no data about tasks or single components

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" (there could be several requests with the same name; thus "abc" could deliver more than one request

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 static RequestSummary getSummaryOfRequests()

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 static RequestSummaryExt getSummaryOfRequestsExt()

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 static ComponentOverview[] getTopComponents(int criterion,
                                                   java.lang.String namePattern,
                                                   int maxResults)

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

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 static ComponentOverviewExt[] getTopComponentsExt(int criterion,
                                                         java.lang.String namePattern,
                                                         int maxResults)

Gives an overview about the top components according to special criteria like gross time, number of calls (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 static ComponentOverview[] getComponents(java.lang.String namePattern,
                                                int maxResults)

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 static ComponentOverviewExt[] getComponentsExt(java.lang.String namePattern,
                                                      int maxResults)

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 static 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, ... (including CPU specific data)

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 static 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

Parameters:

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