com.sap.tc.logging.perf
Interface ISatRecord

All Known Implementing Classes:

SatRecord

public interface ISatRecord

Field Summary

static int	NUMBERNOTAPPL number not applicable
static int	NUMBERNOTSET number not provided
static int	PROVIDERDSR JDSR
static int	PROVIDERJARM JARM
static int	PROVIDERTREX TREX
static int	STATENOTCLOSED activity not properly closed JARM Request: not all components of request were closed JARM Component: component not closed JARM Action: N/A DSR Action: N/A unclosed actions are not being written DSR Call: N/A unclosed calls are not being written DSR Trace: N/A trace records does not need to be closed
static int	STATEOK no error occured JARM Request: all components of request and request itself ended correctly JARM Component: component ended correctly JARM Action: N/A DSR: N/A all statistics and trace information is collected only if the component works correctly DSR Trace: N/A
static int	STATESUBRECORDOVERFLOW activity closed because of too many subrecords JARM Request: request closed because too many component calls were done JARM Component: N/A JARM Action: N/A DSR Action: N/A DSR Call: N/A DSR Trace: N/A
static java.lang.String	STRINGNOTAPPL string not applicable
static java.lang.String	STRINGNOTSET string not provided; in 6.20 JARM names could have the value "nameNotDefined" instead of " "
static int	TYPEDSRACTION DSR Action
static int	TYPEDSREXTCALL DSR External Call
static int	TYPEDSRINTCALL DSR Internal Call
static int	TYPEDSRTRACE DSR Trace
static int	TYPEJARMACT JARM Action
static int	TYPEJARMCOMP JARM Component
static int	TYPEJARMREQ JARM request
static int	TYPETREXTRACE TREX Trace

Method Summary

java.lang.String	getClassName() name of module or class JARM: N/A DSR Trace: module name
java.lang.String	getClassVersion() version of module or class JARM: N/A DSR Trace: version of module
java.lang.String	getDescr() description of activity (short text) JARM Request: applicable starting with 6.30 JARM Component: applicable starting with 6.30 JARM Action: action string DSR Action: Action Additional Info DSR External Call: Additional Info DSR Internal Call: Additional Info DSR Trace: Trace Message
long	getGrossCpuTime() CPU gross time (in ms) of the activity JARM Request: constant NUMBERNOTAPPL if CPU time is not available JARM Component: constant NUMBERNOTAPPL if CPU time is not available or if component is not closed correctly JARM Action: N/A
long	getGrossTime() duration (in ms) of the activity (elapsed) JARM Component: constant NUMBERNOTAPPL if component is not closed correctly JARM Action: N/A DSR Action: responce time DSR External Call: call time DSR Internal Call: call time DSR Trace: duration from trace record
int	getLevel() nesting level JARM Request: N/A JARM Component: indicates, how deep component is nested; 0 <-> main level JARM Action: N/A DSR Action: allways 0 DSR External Call: allways 0 DSR Internal Call: indicates the level in the call stack; 0 <-> main level DSR Trace: allways 0
java.lang.String	getName() name of activity JARM Request: name JARM Component: name JARM Action: N/A DSR Action: action type DSR External Call: destination DSR Internal Call: module name DSR Trace: module/method name
long	getNetCpuTime() net time (in ms) of activity (CPU); this is the gross time minus the time which was spent in subcalls JARM Request: N/A JARM Component: constant NUMBERNOTAPPL if CPU time is not available or if component is not closed correctly or at least one direct subcomponent is not closed correctly JARM Action: N/A
long	getNetTime() net time (in ms) of activity (elapsed); this is the gross time minus the time which was spent in subcalls JARM Request: N/A JARM Component: constant NUMBERNOTAPPL if component is not closed correctly or at least one direct subcomponent is not closed correctly JARM Action: N/A DSR Action: aggregated net time for all nested external calls in the DSR action DSR External Call: N/A DSR Trace: N/A
int	getNumberOfSubRecords() number of sub-records JARM Request: number of components JARM Component: number of actions JARM Action: N/A DSR Action: number of all internal end external call records associated with this action DSR External Call: N/A DSR Internal Call: N/A DSR Trace: N/A
int	getOutData() amount of transfered data (in bytes) JARM Action: N/A DSR Action: aggreageted number of bytes transferred within all nested internal and external calls DSR External Call: (aggregated) number of transfered bytes to and from the corresponding called component DSR Internal Call: number of thransfered bytes with the current internal call DSR Trace: N/A
java.util.Properties	getProps() specific properties for this activity JARM Request: N/A JARM Component: applicable starting with 6.30 JARM Action: N/A DSR Action: associated component name, component version, predefined action- and service types DSR Call: associated component name, component version DSR Trace: Trace File Path, Maximum number of trace files in the ring buffer
int	getProvider() provider of record; see constants PROVIDERxxx above
int	getRecType() type of record; see constants TYPExxx above .
int	getSeqNumber() sequence number JARM Request: N/A JARM Component: indicates the call sequence of the components; starts with 0 JARM Action: indicates the call sequence of the actions; starts with 0 DSR Action: indicates the action sequence number within a DSR transaction DSR External Call: N/A - external call can be aggregated into a single call record DSR Internal Call: indicates the internal call sequence number within a DSR action DSR Trace: indicated the trace record sequence number within a DSR transaction
long	getStartTS() start time stamp of activity; difference, measured in milliseconds,
int	getState() status of activity; see constants STATUSxxx above
java.lang.String	getUserName() user name JARM Request: user JARM Component: N/A JARM Action: N/A DSR: user id from the passport (allways available)

Field Detail

PROVIDERJARM

public static final int PROVIDERJARM

JARM

PROVIDERDSR

public static final int PROVIDERDSR

JDSR

PROVIDERTREX

public static final int PROVIDERTREX

TREX

TYPEJARMREQ

public static final int TYPEJARMREQ

JARM request

TYPEJARMCOMP

public static final int TYPEJARMCOMP

JARM Component

TYPEJARMACT

public static final int TYPEJARMACT

JARM Action

TYPEDSRACTION

public static final int TYPEDSRACTION

DSR Action

TYPEDSREXTCALL

public static final int TYPEDSREXTCALL

DSR External Call

TYPEDSRINTCALL

public static final int TYPEDSRINTCALL

DSR Internal Call

TYPEDSRTRACE

public static final int TYPEDSRTRACE

DSR Trace

TYPETREXTRACE

public static final int TYPETREXTRACE

TREX Trace

STRINGNOTAPPL

public static final java.lang.String STRINGNOTAPPL

string not applicable

NUMBERNOTAPPL

public static final int NUMBERNOTAPPL

number not applicable

STRINGNOTSET

public static final java.lang.String STRINGNOTSET

string not provided;
in 6.20 JARM names could have the value "nameNotDefined" instead of " "

NUMBERNOTSET

public static final int NUMBERNOTSET

number not provided

STATEOK

public static final int STATEOK

  no error occured
  JARM Request: all components of request and request itself ended correctly 

  JARM Component: component ended correctly
  JARM Action: N/A
  DSR: N/A  all statistics and trace information is collected only if the component works correctly
  DSR Trace: N/A
 

STATENOTCLOSED

public static final int STATENOTCLOSED

  activity not properly closed
  JARM Request: not all components of request were closed
  JARM Component: component not closed
  JARM Action: N/A
  DSR Action: N/A unclosed actions are not being written
  DSR Call: N/A unclosed calls are not being written
  DSR Trace: N/A trace records does not need to be closed
 

STATESUBRECORDOVERFLOW

public static final int STATESUBRECORDOVERFLOW

  activity closed because of too many subrecords
  JARM Request: request closed because too many component calls were done
  JARM Component: N/A
  JARM Action: N/A
  DSR Action: N/A
  DSR Call: N/A
  DSR Trace: N/A
 

Method Detail

getProvider

public int getProvider()

provider of record; see constants PROVIDERxxx above

Returns:

int the information provider

getRecType

public int getRecType()

type of record; see constants TYPExxx above .

Returns:

int the record type

getSeqNumber

public int getSeqNumber()

  sequence number
  JARM Request: N/A
  JARM Component: indicates the call sequence of the components; starts with 0
  JARM Action: indicates the call sequence of the actions; starts with 0
  DSR Action: indicates the action sequence number within a DSR transaction
  DSR External Call: N/A - external call can be aggregated into a single call record
  DSR Internal Call: indicates the internal call sequence number within a DSR action
  DSR Trace: indicated the trace record sequence number within a DSR transaction
  

Returns:

int the sequence number corresponding to the record type semantics

getLevel

public int getLevel()

  nesting level
  JARM Request: N/A
  JARM Component: indicates, how deep component is nested; 0 <-> main level
  JARM Action: N/A
  DSR Action: allways 0
  DSR External Call: allways 0
  DSR Internal Call: indicates the level in the call stack; 0 <-> main level
  DSR Trace: allways 0
  

Returns:

int the nested level which corresponds to the record type semantics

getName

public java.lang.String getName()

  name of activity
  JARM Request: name
  JARM Component: name
  JARM Action: N/A
  DSR Action: action type
  DSR External Call: destination
  DSR Internal Call: module name
  DSR Trace: module/method name
  

Returns:

String record name

getUserName

public java.lang.String getUserName()

  user name
  JARM Request: user
  JARM Component: N/A
  JARM Action: N/A
  DSR: user id from the passport (allways available)
  

Returns:

String user name associated with the SAT record

getState

public int getState()

status of activity; see constants STATUSxxx above

Returns:

int record state

getStartTS

public long getStartTS()

start time stamp of activity; difference, measured in milliseconds,

Returns:

long start time stamp in milliseconds since midnight, January 1, 1970 UTC

getGrossTime

public long getGrossTime()

  duration (in ms) of the activity (elapsed)
  JARM Component: constant NUMBERNOTAPPL if component is not closed correctly
  JARM Action: N/A
  DSR Action: responce time
  DSR External Call: call time
  DSR Internal Call: call time
  DSR Trace: duration from trace record
  

Returns:

long activity elapsed time in milliseconds

See Also:

com.sap.jdsr.writer.DsrISubRecordCall1#getCallTime(int), com.sap.jdsr.writer.DsrISubRecordCall2#getCallTime(int)

getNetTime

public long getNetTime()

  net time (in ms) of activity (elapsed); this is the gross time minus the
  time which was spent in subcalls
  JARM Request: N/A
  JARM Component: constant NUMBERNOTAPPL if component is not closed correctly
                  or at least one direct subcomponent is not closed correctly
  JARM Action: N/A
  DSR Action: aggregated net time for all nested external calls in the DSR action
  DSR External Call: N/A
  DSR Trace: N/A
  

Returns:

long net time in milliseconds

getGrossCpuTime

public long getGrossCpuTime()

  CPU gross time (in ms) of the activity
  JARM Request: constant NUMBERNOTAPPL if CPU time is not available
  JARM Component: constant NUMBERNOTAPPL if CPU time is not available                 
                  or if component is not closed correctly
  JARM Action: N/A
  

Returns:

long activity CPU time in milliseconds

See Also:

com.sap.jdsr.writer.DsrISubRecordCall1#getCallTime(int), com.sap.jdsr.writer.DsrISubRecordCall2#getCallTime(int)

getNetCpuTime

public long getNetCpuTime()

  net time (in ms) of activity (CPU); this is the gross time minus the
  time which was spent in subcalls
  JARM Request: N/A
  JARM Component: constant NUMBERNOTAPPL if CPU time is not available
                  or if component is not closed correctly
                  or at least one direct subcomponent is not closed correctly
  JARM Action: N/A
  

Returns:

long net CPU time in milliseconds

getOutData

public int getOutData()

  amount of transfered data (in bytes)
  JARM Action: N/A
  DSR Action: aggreageted number of bytes transferred within all nested internal and
              external calls
  DSR External Call: (aggregated) number of transfered bytes to and from the corresponding
                     called component
  DSR Internal Call: number of thransfered bytes with the current internal call
  DSR Trace: N/A
  

Returns:

int number of transfered bytes (outgoing + ingoing)

getNumberOfSubRecords

public int getNumberOfSubRecords()

  number of sub-records
  JARM Request: number of components
  JARM Component: number of actions
  JARM Action: N/A
  DSR Action: number of all internal end external call records associated with this action
  DSR External Call: N/A
  DSR Internal Call: N/A
  DSR Trace: N/A
  

Returns:
int number of subrecords available in the current SAT record

getDescr

public java.lang.String getDescr()

  description of activity (short text)
  JARM Request: applicable starting with 6.30
  JARM Component: applicable starting with 6.30
  JARM Action: action string
  DSR Action: Action Additional Info
  DSR External Call: Additional Info
  DSR Internal Call: Additional Info
  DSR Trace: Trace Message
  

Returns:

String activity description

getProps

public java.util.Properties getProps()

  specific properties for this activity
  JARM Request: N/A
  JARM Component: applicable starting with 6.30
  JARM Action: N/A
  DSR Action: associated component name, component version, predefined action- and service types
  DSR Call: associated component name, component version
  DSR Trace: Trace File Path, Maximum number of trace files in the ring buffer
  

Returns:

Properties properties for this activity, null if no properties exist.

getClassName

public java.lang.String getClassName()

name of module or class JARM: N/A DSR Trace: module name

getClassVersion

public java.lang.String getClassVersion()

version of module or class JARM: N/A DSR Trace: version of module