com.sap.util.monitor.jarm
Interface IConfMonitor

All Known Subinterfaces:

IRmiMonitor, JarmJmxMonitorMBean

All Known Implementing Classes:

ConfMonitor

public interface IConfMonitor

Interface contains constants and configuration parameters used for monitoring.

Field Summary

static java.lang.String	COMPLEVEL parameter name for component monitor level of JARM; values: 0 (= IConfMonitor.COMPLEVELBASIC) 1 (= IConfMonitor.COMPLEVELMEDIUM) 2 (= IConfMonitor.COMPLEVELDETAIL)
static int	COMPLEVELBASIC component monitor level: basic (default)
static int	COMPLEVELDETAIL component monitor level: detail
static int	COMPLEVELMEDIUM component monitor level: medium
static java.lang.String	COMPPROPERTIESGETSWITCH parameter name for getting component specific properties (on / off)
static java.lang.String	COMPPROPERTIESSETSWITCH parameter name for setting component specific properties (on / off)
static java.lang.String	COMPTRACELEVEL parameter name for component trace level of JARM; if tracing and monitoring is on for a request the most detailed level defined by COMPLEVEL and COMPTRACELEVEL is used; values: see COMPLEVEL
static java.lang.String	CONSUMERCLASS common postfix for consumer classname
static java.lang.String	CONSUMERPREFIX common prefix for all monitor consumer parameters
static java.lang.String	CONSUMERRESTART common postfix for consumer restart time
static java.lang.String	CONSUMERSWITCH common postfix to switch consumer on / off
static java.lang.String	KEYINSTRCHECK parameter name for checking the jarm instrumentation;
static java.lang.String	KEYMAXREQCOMPHIGH parameter name for setting an upper limit of components for a request; if the limit is reached the next startComponent call to the monitor handle will end the request.
static java.lang.String	KEYMAXREQCOMPLOW parameter name for setting an upper limit of components for a request; if the limit is reached the next endRequest call will end the request even if the name does not match.
static java.lang.String	KEYMONITOR parameter name for switching monitoring on / off values: VALUEON, VALUEOFF
static java.lang.String	KEYPARTNEREXCL parameter name for excluding communication partners to be integrated with JARM (e.g.
static java.lang.String	KEYVERSION parameter name for getting the JARM version; obviously parameter could not be set from outside format: x.y.z
static java.lang.String	LOGFILEDIR parameter name for directory of log file; name of log file = 'jarm.log'
static java.lang.String	LOGLEVEL parameter name for log level of JARM; value: 0, 1, 2
static java.lang.String	MONITORPREFIX common prefix for all monitoring parameters
static java.lang.String	NAMENOTSET name not set
static java.lang.String	NOCOMPACTIVE no component active
static int	NUMBERNOTSET number not set
static int	REQCOMPNOTCLOSED not all components of request were closed
static int	REQCOMPTOOMANYHIGH request closed because of too many components (upper limit); the number of components reached the value described by the paramter KEYMAXREQCOMPHIGH
static int	REQCOMPTOOMANYLOW request closed because of too many components (lower limit); the request was closed by endRequest() without checking whether the request name matches
static int	REQOK all components of request and request itself ended correctly
static int	REQOVERVIEWALL all data available for the request should be returned
static int	REQOVERVIEWHEADER only request header should be returned; there is no information about tasks and components returned
static int	REQOVERVIEWNONE no request overview data should be returned
static int	RESETALL reset all monitor data
static int	RESETCOMPONENTS reset component data
static int	RESETREQUESTS reset request data
static int	RESETUSERS reset user data
static java.lang.String	RMIPORT parameter name for rmi port
static java.lang.String	RMIPREFIX common prefix for all monitor rmi parameters
static java.lang.String	RMISTARTREGISTRY parameter name for start rmi registry switch (on / off)
static java.lang.String	RMISWITCH parameter name for switching rmi access of monitoring on / off values: VALUEON, VALUEOFF
static int	TOPACCGROSSTIME hit list for accumulated gross time
static int	TOPCALLNUM hit list for number of calls
static int	TOPGROSSCPUTIME hit list for gross CPU time
static int	TOPGROSSTIME hit list for average gross time
static int	TOPNETCPUTIME hit list for net CPU time
static int	TOPNETTIME hit list for average net time
static int	TOPOUTDATA hit list for outbound data
static java.lang.String	TRACESWITCH parameter name to switch tracing of JARM data on / off; tracing is used by data recipients values: VALUEON, VALUEOFF
static int	UNDEFDATA amount of data not defined
static java.lang.String	UNDEFNAME name not defined
static long	UNDEFTIME time not defined
static java.lang.String	VALUEALL parameter value ALL
static java.lang.String	VALUENONE parameter value NONE
static java.lang.String	VALUEOFF parameter value OFF used for MONITORKEY, CONSUMERSWITCH
static java.lang.String	VALUEON parameter value ON used for MONITORKEY, CONSUMERSWITCH

Field Detail

UNDEFTIME

public static final long UNDEFTIME

time not defined

UNDEFDATA

public static final int UNDEFDATA

amount of data not defined

UNDEFNAME

public static final java.lang.String UNDEFNAME

name not defined

NAMENOTSET

public static final java.lang.String NAMENOTSET

name not set

NUMBERNOTSET

public static final int NUMBERNOTSET

number not set

NOCOMPACTIVE

public static final java.lang.String NOCOMPACTIVE

no component active

TOPGROSSTIME

public static final int TOPGROSSTIME

hit list for average gross time

TOPNETTIME

public static final int TOPNETTIME

hit list for average net time

TOPOUTDATA

public static final int TOPOUTDATA

hit list for outbound data

TOPCALLNUM

public static final int TOPCALLNUM

hit list for number of calls

TOPACCGROSSTIME

public static final int TOPACCGROSSTIME

hit list for accumulated gross time

TOPGROSSCPUTIME

public static final int TOPGROSSCPUTIME

hit list for gross CPU time

TOPNETCPUTIME

public static final int TOPNETCPUTIME

hit list for net CPU time

RESETALL

public static final int RESETALL

reset all monitor data

RESETREQUESTS

public static final int RESETREQUESTS

reset request data

RESETCOMPONENTS

public static final int RESETCOMPONENTS

reset component data

RESETUSERS

public static final int RESETUSERS

reset user data

REQOK

public static final int REQOK

all components of request and request itself ended correctly

REQCOMPNOTCLOSED

public static final int REQCOMPNOTCLOSED

not all components of request were closed

REQCOMPTOOMANYLOW

public static final int REQCOMPTOOMANYLOW

request closed because of too many components (lower limit); the request was closed by endRequest() without checking whether the request name matches

REQCOMPTOOMANYHIGH

public static final int REQCOMPTOOMANYHIGH

request closed because of too many components (upper limit); the number of components reached the value described by the paramter KEYMAXREQCOMPHIGH

REQOVERVIEWNONE

public static final int REQOVERVIEWNONE

no request overview data should be returned

REQOVERVIEWALL

public static final int REQOVERVIEWALL

all data available for the request should be returned

REQOVERVIEWHEADER

public static final int REQOVERVIEWHEADER

only request header should be returned; there is no information about tasks and components returned

MONITORPREFIX

public static final java.lang.String MONITORPREFIX

common prefix for all monitoring parameters

CONSUMERPREFIX

public static final java.lang.String CONSUMERPREFIX

common prefix for all monitor consumer parameters

CONSUMERSWITCH

public static final java.lang.String CONSUMERSWITCH

common postfix to switch consumer on / off

CONSUMERCLASS

public static final java.lang.String CONSUMERCLASS

common postfix for consumer classname

CONSUMERRESTART

public static final java.lang.String CONSUMERRESTART

common postfix for consumer restart time

KEYMONITOR

public static final java.lang.String KEYMONITOR

parameter name for switching monitoring on / off values: VALUEON, VALUEOFF

KEYMAXREQCOMPLOW

public static final java.lang.String KEYMAXREQCOMPLOW

parameter name for setting an upper limit of components for a request; if the limit is reached the next endRequest call will end the request even if the name does not match.
value must not be higher than "jarm/maxreqcomphigh" default: 2500

KEYMAXREQCOMPHIGH

public static final java.lang.String KEYMAXREQCOMPHIGH

parameter name for setting an upper limit of components for a request; if the limit is reached the next startComponent call to the monitor handle will end the request.
value must not be lower than "jarm/maxreqcomplow" default: 2600

KEYVERSION

public static final java.lang.String KEYVERSION

parameter name for getting the JARM version; obviously parameter could not be set from outside
format: x.y.z

TRACESWITCH

public static final java.lang.String TRACESWITCH

parameter name to switch tracing of JARM data on / off; tracing is used by data recipients values: VALUEON, VALUEOFF

RMIPREFIX

public static final java.lang.String RMIPREFIX

common prefix for all monitor rmi parameters

RMISWITCH

public static final java.lang.String RMISWITCH

parameter name for switching rmi access of monitoring on / off values: VALUEON, VALUEOFF

RMISTARTREGISTRY

public static final java.lang.String RMISTARTREGISTRY

parameter name for start rmi registry switch (on / off)

RMIPORT

public static final java.lang.String RMIPORT

parameter name for rmi port

COMPPROPERTIESSETSWITCH

public static final java.lang.String COMPPROPERTIESSETSWITCH

parameter name for setting component specific properties (on / off)

COMPPROPERTIESGETSWITCH

public static final java.lang.String COMPPROPERTIESGETSWITCH

parameter name for getting component specific properties (on / off)

COMPLEVEL

public static final java.lang.String COMPLEVEL

parameter name for component monitor level of JARM;
values: 0 (= IConfMonitor.COMPLEVELBASIC) 1 (= IConfMonitor.COMPLEVELMEDIUM) 2 (= IConfMonitor.COMPLEVELDETAIL)

COMPTRACELEVEL

public static final java.lang.String COMPTRACELEVEL

parameter name for component trace level of JARM; if tracing and monitoring is on for a request the most detailed level defined by COMPLEVEL and COMPTRACELEVEL is used;
values: see COMPLEVEL

LOGLEVEL

public static final java.lang.String LOGLEVEL

parameter name for log level of JARM; value: 0, 1, 2

LOGFILEDIR

public static final java.lang.String LOGFILEDIR

parameter name for directory of log file; name of log file = 'jarm.log'

KEYINSTRCHECK

public static final java.lang.String KEYINSTRCHECK

parameter name for checking the jarm instrumentation;

KEYPARTNEREXCL

public static final java.lang.String KEYPARTNEREXCL

parameter name for excluding communication partners to be integrated with JARM (e.g. Sherlok)

VALUEON

public static final java.lang.String VALUEON

parameter value ON

used for MONITORKEY, CONSUMERSWITCH

VALUEOFF

public static final java.lang.String VALUEOFF

parameter value OFF

used for MONITORKEY, CONSUMERSWITCH

VALUEALL

public static final java.lang.String VALUEALL

parameter value ALL

VALUENONE

public static final java.lang.String VALUENONE

parameter value NONE

COMPLEVELBASIC

public static final int COMPLEVELBASIC

component monitor level: basic (default)

COMPLEVELMEDIUM

public static final int COMPLEVELMEDIUM

component monitor level: medium

COMPLEVELDETAIL

public static final int COMPLEVELDETAIL

component monitor level: detail