com.sap.tc.logging.perf
Class SatRecord

java.lang.Object
  |
  +--com.sap.tc.logging.perf.SatRecord

All Implemented Interfaces:

ISatRecord

public class SatRecord

extends java.lang.Object

implements ISatRecord

the class contains the constants and methods to get the attributes of a Single Active Trace (SAT) record

if a record type is not explicitely mentioned in the method documentation it provides the data as generally described in the documentation

Field Summary

java.lang.String	className name of module or class JARM: N/A DSR Trace: module name
java.lang.String	classVersion version of module or class JARM: N/A DSR Trace: version of module
java.lang.String	descr 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: @Todo Mario, Markus DSR Call: @Todo Mario, Markus DSR Trace: @Todo Mario, Markus
long	grossCpuTime 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	grossTime duration (in ms) of the activity (elapsed) JARM Component: constant NUMBERNOTAPPL if component is not closed correctly JARM Action: not applicable DSR Action: @Todo Mario, Markus DSR Call: @Todo Mario, Markus DSR Trace: @Todo Mario, Markus
int	level nesting level JARM Request: not applicable JARM Component: indicates, how deep component is nested; 0 <-> main level JARM Action: not applicable DSR Action: @Todo Mario, Markus DSR Call: @Todo Mario, Markus DSR Trace: @Todo Mario, Markus
java.lang.String	name name of activity JARM Request: name JARM Component: name JARM Action: not applicable DSR Action: @Todo Mario, Markus DSR Call: @Todo Mario, Markus DSR Trace: @Todo Mario, Markus
long	netCpuTime 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	netTime net time (in ms) of activity (elapsed); this is the gross time minus the time which is spend in subcalls JARM Request: not applicable JARM Component: constant NUMBERNOTAPPL if component is not closed correctly or at least one direct subcomponent is not closed correctly JARM Action: not applicable DSR Action: @Todo Mario, Markus DSR Call: @Todo Mario, Markus DSR Trace: @Todo Mario, Markus
int	numberOfSubRecords number of sub-records JARM Request: number of components JARM Component: number of actions JARM Action: not applicable DSR Action: @Todo Mario, Markus DSR Call: @Todo Mario, Markus DSR Trace: @Todo Mario, Markus
int	outData amount of transfered data (in bytes) JARM Action: not applicable
java.util.Properties	prop specific properties for this activity JARM Request: not applicable JARM Component: applicable starting with 6.30 JARM Action: not applicable DSR Action: @Todo Mario, Markus DSR Call: @Todo Mario, Markus DSR Trace: @Todo Mario, Markus
int	provider provider of record; see constants PROVIDERxxx above
int	recType type of record; see constants TYPExxx above
int	seqNumber sequence number JARM Request: not applicable 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: @Todo Mario, Markus DSR Call: @Todo Mario, Markus DSR Trace: @Todo Mario, Markus
long	startTS the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC
int	state status of activity; see constants STATUSxxx above
java.lang.String	userName user name JARM Request: user JARM Component: not applicable JARM Action: not applicable DSR: user id from the passport, if available, else name of the principal that is associated with the thread context

Fields inherited from interface com.sap.tc.logging.perf.ISatRecord

NUMBERNOTAPPL, NUMBERNOTSET, PROVIDERDSR, PROVIDERJARM, PROVIDERTREX, STATENOTCLOSED, STATEOK, STATESUBRECORDOVERFLOW, STRINGNOTAPPL, STRINGNOTSET, TYPEDSRACTION, TYPEDSREXTCALL, TYPEDSRINTCALL, TYPEDSRTRACE, TYPEJARMACT, TYPEJARMCOMP, TYPEJARMREQ, TYPETREXTRACE

Constructor Summary

SatRecord()
CONSTRUCTORS

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)

Methods inherited from class java.lang.Object

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

Field Detail

provider

public int provider

provider of record; see constants PROVIDERxxx above

recType

public int recType

type of record; see constants TYPExxx above

seqNumber

public int seqNumber

sequence number
JARM Request: not applicable
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: @Todo Mario, Markus DSR Call: @Todo Mario, Markus DSR Trace: @Todo Mario, Markus

level

public int level

nesting level
JARM Request: not applicable
JARM Component: indicates, how deep component is nested; 0 <-> main level JARM Action: not applicable DSR Action: @Todo Mario, Markus DSR Call: @Todo Mario, Markus DSR Trace: @Todo Mario, Markus

name

public java.lang.String name

name of activity JARM Request: name JARM Component: name JARM Action: not applicable DSR Action: @Todo Mario, Markus DSR Call: @Todo Mario, Markus DSR Trace: @Todo Mario, Markus

userName

public java.lang.String userName

user name

JARM Request: user JARM Component: not applicable JARM Action: not applicable DSR: user id from the passport, if available, else name of the principal that is associated with the thread context

state

public int state

status of activity; see constants STATUSxxx above

startTS

public long startTS

the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC

grossTime

public long grossTime

duration (in ms) of the activity (elapsed)
JARM Component: constant NUMBERNOTAPPL if component is not closed correctly JARM Action: not applicable DSR Action: @Todo Mario, Markus DSR Call: @Todo Mario, Markus DSR Trace: @Todo Mario, Markus

netTime

public long netTime

net time (in ms) of activity (elapsed); this is the gross time minus the time which is spend in subcalls
JARM Request: not applicable
JARM Component: constant NUMBERNOTAPPL if component is not closed correctly or at least one direct subcomponent is not closed correctly JARM Action: not applicable DSR Action: @Todo Mario, Markus DSR Call: @Todo Mario, Markus DSR Trace: @Todo Mario, Markus

grossCpuTime

public long grossCpuTime

  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
  

See Also:

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

netCpuTime

public long netCpuTime

  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
  

outData

public int outData

amount of transfered data (in bytes) JARM Action: not applicable

numberOfSubRecords

public int numberOfSubRecords

number of sub-records
JARM Request: number of components
JARM Component: number of actions JARM Action: not applicable DSR Action: @Todo Mario, Markus DSR Call: @Todo Mario, Markus DSR Trace: @Todo Mario, Markus

descr

public java.lang.String descr

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: @Todo Mario, Markus DSR Call: @Todo Mario, Markus DSR Trace: @Todo Mario, Markus

prop

public java.util.Properties prop

specific properties for this activity JARM Request: not applicable
JARM Component: applicable starting with 6.30 JARM Action: not applicable DSR Action: @Todo Mario, Markus DSR Call: @Todo Mario, Markus DSR Trace: @Todo Mario, Markus

className

public java.lang.String className

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

classVersion

public java.lang.String classVersion

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

Constructor Detail

SatRecord

public SatRecord()

CONSTRUCTORS

Method Detail

getProvider

public int getProvider()

Description copied from interface: ISatRecord

provider of record; see constants PROVIDERxxx above

Specified by:

getProvider in interface ISatRecord

Following copied from interface: com.sap.tc.logging.perf.ISatRecord

Returns:

int the information provider

getRecType

public int getRecType()

Description copied from interface: ISatRecord

type of record; see constants TYPExxx above .

Specified by:

getRecType in interface ISatRecord

Following copied from interface: com.sap.tc.logging.perf.ISatRecord

Returns:

int the record type

getSeqNumber

public int getSeqNumber()

Description copied from interface: ISatRecord

  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
  

Specified by:

getSeqNumber in interface ISatRecord

Following copied from interface: com.sap.tc.logging.perf.ISatRecord

Returns:

int the sequence number corresponding to the record type semantics

getLevel

public int getLevel()

Description copied from interface: ISatRecord

  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
  

Specified by:

getLevel in interface ISatRecord

Following copied from interface: com.sap.tc.logging.perf.ISatRecord

Returns:

int the nested level which corresponds to the record type semantics

getName

public java.lang.String getName()

Description copied from interface: ISatRecord

  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
  

Specified by:

getName in interface ISatRecord

Following copied from interface: com.sap.tc.logging.perf.ISatRecord

Returns:

String record name

getUserName

public java.lang.String getUserName()

Description copied from interface: ISatRecord

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

Specified by:

getUserName in interface ISatRecord

Following copied from interface: com.sap.tc.logging.perf.ISatRecord

Returns:

String user name associated with the SAT record

getState

public int getState()

Description copied from interface: ISatRecord

status of activity; see constants STATUSxxx above

Specified by:

getState in interface ISatRecord

Following copied from interface: com.sap.tc.logging.perf.ISatRecord

Returns:

int record state

getStartTS

public long getStartTS()

Description copied from interface: ISatRecord

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

Specified by:

getStartTS in interface ISatRecord

Following copied from interface: com.sap.tc.logging.perf.ISatRecord

Returns:

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

getGrossTime

public long getGrossTime()

Description copied from interface: ISatRecord

  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
  

Specified by:

getGrossTime in interface ISatRecord

Following copied from interface: com.sap.tc.logging.perf.ISatRecord

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()

Description copied from interface: ISatRecord

  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
  

Specified by:

getNetTime in interface ISatRecord

Following copied from interface: com.sap.tc.logging.perf.ISatRecord

Returns:

long net time in milliseconds

getGrossCpuTime

public long getGrossCpuTime()

Description copied from interface: ISatRecord

  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
  

Specified by:

getGrossCpuTime in interface ISatRecord

Following copied from interface: com.sap.tc.logging.perf.ISatRecord

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()

Description copied from interface: ISatRecord

  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
  

Specified by:

getNetCpuTime in interface ISatRecord

Following copied from interface: com.sap.tc.logging.perf.ISatRecord

Returns:

long net CPU time in milliseconds

getOutData

public int getOutData()

Description copied from interface: ISatRecord

  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
  

Specified by:

getOutData in interface ISatRecord

Following copied from interface: com.sap.tc.logging.perf.ISatRecord

Returns:

int number of transfered bytes (outgoing + ingoing)

getNumberOfSubRecords

public int getNumberOfSubRecords()

Description copied from interface: ISatRecord

  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
  

Specified by: 
getNumberOfSubRecords in interface ISatRecord

Following copied from interface: com.sap.tc.logging.perf.ISatRecord

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

getDescr

public java.lang.String getDescr()

Description copied from interface: ISatRecord

  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
  

Specified by:

getDescr in interface ISatRecord

Following copied from interface: com.sap.tc.logging.perf.ISatRecord

Returns:

String activity description

getProps

public java.util.Properties getProps()

Description copied from interface: ISatRecord

  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
  

Specified by:

getProps in interface ISatRecord

Following copied from interface: com.sap.tc.logging.perf.ISatRecord

Returns:

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

getClassName

public java.lang.String getClassName()

Description copied from interface: ISatRecord

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

Specified by:

getClassName in interface ISatRecord

getClassVersion

public java.lang.String getClassVersion()

Description copied from interface: ISatRecord

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

Specified by:

getClassVersion in interface ISatRecord