Method of providing open access to application profiling data

[0001] This invention relates generally to profiling tools for analyzing the execution path or characteristics of a software application, and more particularly to a method and apparatus for providing open access to application profiling data across a network.

[0002] Profiling tools are used to evaluate applications for a variety of purposes including, for example, “trouble shooting”, “application tuning”, and “resource utilization optimization”. It is known in the prior art to use profiling tools that analyze a software execution path in a specific execution environment, language or operating system. However, where the application consists of more than one process or more than one language (e.g. a simple client-server networked application where the client is written in Java and the server has C stored procedures in an Relational Database Management System (RDBMS)), the client profiling tool traces only the single client activity, and is not capable of tracing the execution path across the network.

[0003] To further compound these problems, prior art profiling tools incorporate vendor specific or proprietary data collection engines and data exchange formats. Consequently, it is difficult to correlate execution traces detected by different vendor profiling tools in a distributed system incorporating diverse execution environments, languages and/or operating systems. Each profiling tool requires a specific or proprietary collection agent for each execution environment.

[0004] In the prior art model of application profiling, each application is assumed to be written in one programming language and executed on one computing machine in one execution environment. The profiling traces are composed of trace events, which occur sequentially, and which are stored in large files for later transport to profiling tools. The transmission of such large files can be a significant stress on a communication system. In addition, real time or near real time profiling of application is very difficult in such a system.

[0005] The advent of computer networking, and more recently the Internet, has, however, changed and expanded what constitutes an application. Over the Internet, an application may have a number of parts, written in a number of different programming languages, distributed on a number of different computer machines, and operated in a number different execution environments (herein referred to as “distributed environment”). The machines, languages, and environments of such an application are typically from a number of different vendors.

[0006] It is exceedingly difficult to develop a profiling tool that is able to interface with all of the products that may be available from various vendors in this environment. This is assuming that the vendors are prepared to disclose their application programming interfaces (APIs) to profiling tool vendors who may be competitors. Further, any change to the APIs may cause operability problems to the profiling tools. There are significant problems with developing and maintaining profiling tools, which are able to interface with products of a number of vendors (distributed access).

[0007] Additionally, prior art profiling tools obtain and store trace events in sequential form. In a distributed environment, trace events are not sequential especially as between different machines. There is no capability to correlate trace events between different machines or processes.

[0008] Recently, the Java programming language has been expanded to define a Java Virtual Machine Profiling Tool (JVMPI) for profiling hooks in a Java virtual machine. JVMPI is a two-way function call interface between the Java virtual machine and an in-process profiler or collection agent. On the one hand, the virtual machine notifies the collection agent of various events, corresponding to, for example, heap allocation, method calls, etc. The collection agent then communicates with a front-end analysis client, which may or may not run in the same process as the collection agent. On the other hand, the collection agent issues control requests to the Java virtual machine through the JVMPI. For example, the collection agent can turn on/off a specific event notification, based on the needs of the analysis client. The client may reside in a different process on the same machine, or on a remote machine connected via a network using vendor specific wire protocol suitable to the analysis client.

[0009] Although profiling tools based on JVMPI are useful for obtaining a variety of information performance data, the prior art problems relating to lack of distributed access and correlation capabilities remain.

[0010] A portion of the disclosure of this patent document contains material, which is subject to copyright protection. The copyright owner has no objection to the facsimile reproduction by anyone of the patent document, as it appears in the Patent and Trademark Office patent file or records, but otherwise reserves all copyright rights whatsoever.

[0011] The essential problem with the prior art application profiling model is the lack of a consistent data exchange format between collection engines and analysis portions of profiling tools of different vendors. For each execution environment, the analysis portions remain essential unchanged, but each of the vendors has to modify their collection engines accordingly. The inventors have discovered that an open data exchange format may be adapted for application profiling data that allows a single collection agent in an execution environment to provide the profiling data to any number of profiling tools from different vendors. Thus, vendors are able to focus on the development of the analysis portions of their profiling tools and allow other parties, such as vendors of the execution environments, to provide the collection agents.

[0012] Conversely, the open data exchange format also allows a profiling tool to obtain analysis data from more than one collection agent using only one standard interface. Thus, a profiling tool is able to profile an application executing on more than one machine and execution environment where the data exchange format provides attributes to correlate the trace events.

[0013] The open data exchange format thus has a number of advantages including allowing application vendors to retain confidentiality and revision options for their internal APIs without affecting the profiling tools; and reducing development and maintenance costs for profiling tool vendors.

[0014] According to the present invention, an open data structure is provided for exchanging profiling data in the form of trace elements between collection agents and analysis agents in a profiling tool. The data structure accommodates transmission of the profiling data in fragments across a network for storage in a database repository or receipt by one or more analysis agents. Each of the fragments comprises one or more trace elements defining trace events. The data structure of trace elements includes attributes, which define a logical hierarchy between the trace elements. More particularly, correlation attributes are provided with each trace element to enable the analysis clients to correlate the trace elements. Each of the trace elements defines a relationship to each of the other trace elements in a trace, and is not just a sequence of collated trace elements. Thus, for example, a profiling tool is able to correlate a method call to an object.

[0015] The data structure according to the present invention facilitates distributed access to profiling data across a network. Also, only a single collection agent is required per execution environment, thereby overcoming the prior art requirement for multiple vendor-specific proprietary collection agents.

[0016] According to the preferred embodiment, the data structure for the profiling data conforms to XML (Extensible Markup Language). Thus, the load on the network to transport the profiling data is more evenly distributed as the data is sent in XML fragments instead of large files.

[0030] Referring to FIG. 1, a profiling tool is shown comprising one or more Java Virtual Machines (JVM) 100, associated collection agents 102, and analysis clients 104. Each JVM 100 incorporates a Java Virtual Machine Profiling Interface (JVMPI) 120 for communicating with an associated collection agent 102. The collection agents 102 request and receive event or trace data from the JVMs 100 over the JVMPIs 120 in accordance with standard JVMPI protocol, as discussed in greater detail below. The collection agents 102 then encode and transmit the trace data in the form of trace elements, over a network (e.g. Internet 200), to at least one analysis client 104. The trace elements received by the analysis clients 104 are correlated using identification or correlation attribute definitions and references which define logical relationships between the elements, the details of which are set forth below.

[0031] The collection agents 102 are stored on computer readable mediums 150 such as, for example, diskettes, zip drives, CDs, and hard drives.

[0032] As discussed above, the preferred embodiment is described herein with reference to a Java application environment, with XML being used for implementation of the data structure. However, it is contemplated that the principles of the invention may be extended to other application environments and the data structures may be implemented using other languages, such as other mark-up languages (SGML, etc.). It is further contemplated that principles of the invention may be extended to programming languages other than object orientated languages such as Java.

[0033] The collection agent 102 uses the following command line syntax to attach itself to the JVM 100:

java -XrunpiAgent [:<option=value[,option=value]*]

[-Xbootclasspath:<location of picb.jar>,<location of rt.jar>] <Java class>

[0034] The JVM 100 attempts to locate the profiler agent library called ipAgent in the Java library directory. Once located, the JVM 100 loads the profiler agent library and hooks for the entry point in a well-known manner. The options supported in the first argument to the invocation command do not form part of the present invention. The collection agent 102 obtains a function call interface by issuing a GetEnv call on the JavaVM pointer in a well known manner. The GetEnv function returns a pointer to a JVMPI_Interface. The JVMPI_Interface returned by GetEnv has all the functions set up except for NotifyEvent. The collection agent 102 must set up the NotifyEvent function pointer.

[0035] The JVM 100 sends an event, through the JVMPI 120, to the collection agent 102 by calling NotifyEvent with a JVMPI_Interface data structure as the argument. The JVMPI_Event structure contains the event type, the pointer of the current thread, and other event-specific information, all of which is well known according to the JVMPI specification.

[0036] The event-specific information of a trace event is received by the collection agent 102 and is then converted to a data structure in the format of trace elements, which, as discussed above, define or represent trace events of object oriented programming languages.

[0037] The trace elements of a trace are emitted to Analysis Clients 104 as XML fragments, where each XML fragment comprises one or more trace elements. Alternatively, the trace elements may be collected and emitted to the Analysis Clients 104 as XML document. The trace elements are formatted as text in compliance with the XML standard.

[0038] According to the present embodiment of the invention, the trace elements represent logic components of object oriented programming languages. The logic components include, for example, threads, methods, objects, and classes. Trace elements further include elements to provide context information about a trace as a whole such as, for example, a node trace element to identify the JVM 100 that a trace event is from.

[0039] Each of the trace elements contains at least one correlation attribute. A number of different correlation attributes are defined according to this invention. The correlation attributes include other trace elements, reference numbers, time information, and counter information. The primary correlation attribute for associating a trace element to a parent element is by referring to the parent trace element and parent reference number. In particular, each parent trace element or identifier (Id) has a reference number attribute. All parent events are represented by trace elements (or Ids) and are further assigned unique identifying reference numbers. All related or associated trace elements reference parent trace elements (or Ids) and their reference numbers in a nested logical hierarchy. Trace elements in combination with reference numbers uniquely identify instances of certain components of the application.

[0040] According to the present embodiment of the invention, the trace elements for defining tracing events of object oriented programming languages are listed in Table 1 in the Id (identifier) column. Each Id has a defining element and an undefining element as shown in Table 1. A defining element provides the information related to an Id. For example, the defining element for a thread Id (see below) contains, among other entries, the name of the thread.

[0041] An Id is valid until its undefining element arrives. Where a defining element is enabled, the defining element is sent before the Id appears in other elements. An undefining element invalidates the Id. There are two kinds of Ids; transient Ids and non transient Ids. Both have the same logical lifetime as prescribed by their defining and undefining elements. However, transient Id values may be reused after they have been undefined, and in fact may be reused as a different type of Id. The value of a transientThreadId, for example, may be redefined as a transientClassId after a thread ends. Non transient Ids are unique within the scope of a trace.

[0042]

TABLE 1
Id	Defining element	Undefining element
ThreadId	ThreadStart	threadEnd
TransientThreadId	ThreadStart	threadEnd
ObjId	ObjAlloc	objFree
TransientObjId	objAlloc, objMove, objDef	objFree, objMove
ClassId	ClassDef	classUnload
TransientClassId	ClassDef	classUnload
MethodId	MethodDef	defining classUnload
TransientMethodId	MethodDef	defining classUnload
LineTableId	LineTable	not applicable
NodeId	Node	not applicable
ProcessId	ProcessCreate	not available
AgentId	AgentCreate	agentDestroy
TraceId	TraceStart	traceEnd

[0043] Identifiers (Ids) and identifier references (IdRef) define a logical hierarchy between the various trace elements. Thus, as discussed in greater detail below with reference to FIGS. 2–11, threads, classes, methods, and objects each have unique Ids which are referenced by other elements in accordance with defined relationships of the Id/IdRef attributes. Specifically, with reference to FIG. 2, a <node nodeId> contains a <processCreate processId, nodeIdRef> which contains an <agentCreate agentId, processIdRef> which contains a <traceStart traceId, agentIdRef> which, in turn, contains most other elements by means of the traceIdRef. The forgoing nested element hierarchy is established by element referring back to its parent through a specific IdRef attribute.

[0044] Many of the trace elements share the same attributes. The following attributes appear in more than one element:

• [0045] Time
  • [0046] The time attribute denotes the time at which an event started.
  • [0047] The format of the time attribute is “utc.fff” where
    • [0048] 1 utc is the number of seconds elapsed (expressed as an unsigned 32-bit value formatted as a string) since midnight (00:00:00), Jan. 1, 1970, coordinated universal time, according to the system clock.
    • [0049] 2 fff is the fraction of seconds (expressed as an unsigned 32-bit value formatted as a string) to the highest precision that can be retrieved.
• [0050] transientThreadId/transientThreadIdRef
  • [0051] The transientThreadId attribute defines and transientThreadIdRef attribute refers to the thread that an element has occurs in. The transientThreadId's may be reused as threads are started and ended. The transientThreadId attribute is expressed as an unsigned 32-bit value formatted as a string.
• [0052] threadId/threadIdRef
  • [0053] The threadId attribute defines and threadIdRef attribute refers to the thread that an element occurs in. The threadId's are unique within the scope of a trace regardless of how many threads are started and ended. The threadId attribute is expressed as an unsigned 32-bit value formatted as a string.
• [0054] methodId/methodIdRef
  • [0055] The methodId attribute defines and the methodIdRef attribute refers to the method that an element is associated with. The methodId's are unique within the scope of a trace regardless of whether the owning class is unloaded. This attribute is also expressed as a 32-bit unsigned value in string format.
• [0056] transientMethodId/transientMethodIdRef
  • [0057] The transientMethodId defines and transientMethodIdRef refers to the method that an element is associated with. The transientMethodId's may be reused when their owning classes are unloaded. This attribute is expressed as a 32-bit unsigned value in string format.
• [0058] lineTableId/lineTableIdRef
  • [0059] The lineTableId attribute defines and the lineTableIdRef attribute refers to the lineTable element associated with a line reference ticket
  • [0060] This attribute identifies a specific instance of a method invocation (methodEntry and methodExit, or methodCall and methodReturn), using a counter that is unique within the current thread. The ticket may be a list of 32-bit unsigned values (in string format) to allow for more than 32-bit unsigned values. The ticket attribute syntax is:
  • [0061] ticket=“number[,number]*” where the numbers are listed from low order to high order.
• [0062] transientObjId/transientObjIdRef
  • [0063] The transientObjId attribute defines and the transientObjIdRef attribute refers to an object associated with an element. This attribute is expressed as a 32-bit unsigned value in string format. The transientObjId associated with a given object may change during garbage collection. This can be tracked by observing objMove elements. Generally, it is safer to use objId and objIdRef respectively to refer to objects, unless low-level memory analysis is required.
• [0064] objId/objIdRef
  • [0065] The objId attribute defines and the objIdRef attribute refers to an object associated with an element. However, unlike transientObjId and transientObjIdRef, this attribute cannot be changed by garbage collection. This attribute is also expressed as a 32-bit unsigned value in string format.
• [0066] transientClassId/transientClassIdRef
  • [0067] The transientClassId attribute defines and the transientClassIdRef attribute refers to a class associated with an element. This attribute is expressed as a 32-bit unsigned value in string format. The transientClassId attribute associated with a given class may be reused as a result of garbage collection. Such use can be tracked by observing classUnload elements. Generally, it is safer to use classId and classIdRef respectively to refer to classes, unless low-level memory analysis is required.
• [0068] classId/classIdRef
  • [0069] The classId attribute defines and the classIdRef attribute refers to a class associated with an element, but unlike transientClassId and transientClassIdRef, this attribute is not reused after garbage collection. This attribute is also expressed as a 32-bit unsigned value in string format.
• [0070] threadCpuTime
  • [0071] This attribute indicates the total CPU time consumed by the current thread in nanoseconds at the time of the event. The format of the threadCpuTime attribute is “sss.fff” where
    • [0072] 3 sss is the number of seconds (expressed as a 32-bit unsigned value in string format) of CPU processing time consumed by the thread.
    • [0073] 4 fff is the fraction of seconds (expressed as a 32-bit unsigned value in string format) to the highest precision that can be retrieved.
• [0074] sequenceCounter
  • [0075] This is a counter indicating the sequence of the current event relative to other events associated with the current object. The count is 0 at object allocation and is incremented by one for each:
    • [0076] 5 Method entry on a method for the object instance (methodEntry).
    • [0077] 6 Method exit on a method for the object instance (methodExit).
    • [0078] 7 Free of the object (objFree).
  • [0079] The sequenceCounter remains “0” if invoking a static method.
• [0080] contextData
  • [0081] This is data provided by a context service to associate with a method entry. A known mechanism is used for registering the context service, and the contents of the contextData attribute is defined by the specific context service.
• [0082] collationValue
  • [0083] The purpose of this attribute is to allow elements to be collated when emitted on a stream that does not guarantee the order of delivery. The attribute starts from the value “1” on a traceStart element, and is incremented for each element emitted after that. The collationValue is defined by the traceStart and traceEnd elements. The collationValue is a list of 32-bit unsigned values (in string format) to allow for more than 32-bit unsigned values. The collationValue attribute syntax is: collationValue=“number[,number]*” where the numbers are listed from low order to high order.
• [0084] traceId/traceIdRef
  • [0085] traceId defines and traceIdRef refers to a UUID (universal unique identifier) that uniquely identifies a trace instance.
• [0086] isArray
  • [0087] This attribute defines the data type of an array, the values of which are shown in Table 2.

[0088]

	TABLE 2
	VALUE	MEANING
	“0”	normal object (i.e., not an array)
	“2”	array of objects
	“4”	array of Booleans
	“5”	array of chars
	“6”	array of floats
	“7”	array of doubles
	“8”	array of bytes
	“9”	array of shorts
	“10”	array of ints
	“11”	array of longs

[0089] In accordance with the best mode of the invention at the time of filing this application, descriptions will now be provided of the various trace elements formatted in compliance with the XML standard:

[0090]

traceRoot
<!ELEMENT traceRoot (node | processCreate | agentCreate |
agentDestroy | (methodCall | methodReturn | objDef | value | classDef |
methodDef | tag | code)* | ( traceStart | traceEnd | processSuspend |
processResume | option | filter | classDef | classUnload | methodDef |
methodEntry | methodExit | methodCall | value | methodReturn | line |
objAlloc | gcAlloc | objFree | objMove | gcFinish | threadStart |
threadEnd | runtimeInitDone | runtimeShutdown | throw | catch |
methodCount)*)>

[0091] As indicated above, traceRoot is the root element for a valid trace XML document as shown in FIG. 2.

[0092]

	objRef
	<!ELEMENT objRef EMPTY>
	<!ATTLIST objRef
	name CDATA #IMPLIED

[0093] A string containing the name of the object reference.

[0094]

	transientObjIdRef CDATA #IMPLIED
	objIdRef CDATA #IMPLIED
	>

[0095] This element is used to associate a name with an transientObjId.

[0096]

	code
	<!ELEMENT code EMPTY>
	<!ATTLIST code
	type CDATA #IMPLIED

• • [0097] the type of code that exists in this element. Valid types are:
• [0098] Reference
  • [0099] the value attribute is a reference to an external source for the code.
• [0100] Java
  • [0101] the value attribute is text containing Java source code.
• [0102] C++
  • [0103] the value attribute is text containing C++source code.
• [0104] C
  • [0105] the value attribute is text containing C source code.
• [0106] value CDATA #IMPLIED
  • [0107] the actual text of the code, or if the type is “Reference”, then it contains a reference to an external source for the code. The format of the external reference is a URI.
• [0108] >

[0109] The code element is used to insert textual lines of code into the XML file. Thus, in the event that lines of code are to be preserved when the XML file is parsed, such lines are inserted into the code element with the result that the parser extracts the lines of code exactly as they appear in the element.

[0110]

	tag
	<!ELEMENT tag EMPTY>
	<!ATTLIST tag
	name CDATA #IMPLIED

[0111] The name of the tag.

[0112]

	value CDATA #IMPLIED
	The value of the tag.
	>

[0113] The tag element contains the information that is associated with a specific tag, expressed as name value pairs.

Trace Behaviour

• • [0114] The following elements provide information about a trace as a whole:
  • [0115] 8 node
  • [0116] 9 processCreate
  • [0117] 10 agentCreate
  • [0118] 11 agentDestroy
  • [0119] 12 traceStart
  • [0120] 13 traceEnd
  • [0121] 14 processSuspend
  • [0122] 15 processResume
  • [0123] 16 option
  • [0124] 17 filter
  • [0125] The hierarchical relationship of the trace behavior elements is set forth in FIG. 3.

[0126]

	node
	<! ELEMENT node EMPTY>
	<!ATTLIST node
	nodeId CDATA #REQUIRED
	a UUID to uniquely refer to this node.
	hostname CDATA #REQUIRED

[0127] The name of the machine on which the instrumented JVM is running.

• [0128] ipaddress CDATA #REQUIRED
  • [0129] A list of IP addresses associated with the hostname. The list has the form ipaddress=n1.n2.n3.n4[,m1.m2.m3.m4] * where n and m are unsigned numbers within the range 0 to 255.
  • [0130] Note: The number of period-delimited numbers that make up an IP address is protocol-specific.
• [0131] timezone CDATA #IMPLIED
  • [0132] A positive integer that represents the local time difference in minutes from GMT, moving westward from Greenwich.
• [0133] time CDATA #IMPLIED
  • [0134] The time represented here is the time when the machine was last booted, not the time at which this element was generated.

[0135]

	>
	processCreate
	<!ELEMENT processCreate EMPTY>
	<!ATTLIST processCreate
	processId CDATA #REQUIRED
	a UUID that uniquely identifies this process.
	name CDATA #IMPLIED
	the name of the process
	pid CDATA #REQUIRED
	the platform-specific process identification
	nodeIdRef CDATA #REQUIRED
	a UUID that references the node element that represents the
	host machine.
	time CDATA #REQUIRED

• • [0136] The time represented here is the time at which the process was started, not the time at which this element was generated.
• [0137] environment CDATA #IMPLIED
  • [0138] a string containing platform-specific environment information for the process
• [0139] applicationExecutable CDATA #IMPLIED
  • [0140] the name of the application started in the process followed by the parameters passed to the application

[0141]

>
agentCreate
<!ELEMENT agentCreate EMPTY>
<!ATTLIST agentCreate
agentId CDATA #REQUIRED
a UUID that uniquely identifies this instance of the agent.
processIdRef CDATA #REQUIRED
a UUID that references the processCreate element that represents
the process.
agentName CDATA #REQUIRED
the name of the agent.
time CDATA #REQUIRED
agentParameters CDATA #IMPLIED

[0142] The option string that was passed to the agent on the -XrunpiAgent parameter.

[0143]

	version CDATA #IMPLIED
	a string representing the version of the agent
	>
	agentDestroy
	<!ELEMENT agentDestroy EMPTY>
	<!ATTLIST agentDestroy
	agentIdRef CDATA #REQUIRED
	a UUID that references the matching agentCreate element.
	time CDATA #REQUIRED
	>
	traceStart
	<!ELEMENT traceStart EMPTY>
	<!ATTLIST traceStart
	traceId CDATA #REQUIRED
	agentIdRef CDATA #REQUIRED

• • [0144] A UUID that references the agentCreate element that represents the agent that is producing this trace.

[0145]

	time CDATA #REQUIRED
	collationValue CDATA #IMPLIED
	>
	traceEnd
	<!ELEMENT traceEnd EMPTY>
	<!ATTLIST traceEnd
	traceIdRef CDATA #REQUIRED
	time CDATA #REQUIRED
	collationValue CDATA #IMPLIED
	>
	processSuspend
	<!ELEMENT processSuspend EMPTY>
	<!ATTLIST processSuspend
	time CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

[0146] This element indicates that the execution of the process has been suspended.

[0147]

	processResume
	<!ELEMENT processResume EMPTY>
	<!ATTLIST processResume
	time CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

[0148] The foregoing element indicates that the execution of the process has resumed.

[0149]

	option
	<!ELEMENT option EMPTY>
	<!ATTLIST option
	key CDATA #IMPLIED
	A string that represents the name of the option.
	value CDATA #IMPLIED
	A string that represents the value of the option.
	traceIdRef CDATA #IMPLIED
	>

[0150] A collection agent 102 may be assigned any number of agent-specific key/value pair options. In addition to the agent performing the specific action as specified by the option, the agent echoes the option through the option element.

[0151]

	filter
	<!ELEMENT filter EMPTY>
	<!ATTLIST filter
	pattern CDATA #REQUIRED
	A prefix or suffix string which is compared against the
	class name. (For example, java*”, “sun.com.*”,“*print”.)
	genericPattern CDATA #REQUIRED

• • [0152] Indicates if the pattern contains a wildcard, and what kind of wildcard it has. The values are:

[0153]

none
The pattern requires an exact match.
prefix
The pattern has a prefix wildcard and matches anything ending
with the pattern.
suffix
The pattern has a suffix wildcard and matches anything
starting with the pattern.
mode CDATA #REQUIRED
Either include or exclude.
traceIdRef CDATA #IMPLIED
>

[0154] The class filter is set by a client 104. Filters control which classes are traced using the profiling tool of the present invention. Filters are provided in blocks where a new block of filters completely replaces the current filter definitions. Matching is done by querying the active block of filters until the first match is found based on the supplied pattern. The class is then either included or excluded from the trace based on the mode. If the entire block of filters is traversed and no match is found, then the class is included in the trace. It should be noted that some classes are included in the trace even if they have been filtered out. This occurs if a reference is made to the class from a class that has not been filtered out. For example, the methodCall element can cause this to occur.

Threads

[0155] The elements which provide information about threads are set forth in FIG. 4. Other elements point to a THREAD element's transientThreadId to identify the thread they are running in.

[0156]

	threadStart
	<!ELEMENT threadStart EMPTY>
	<!ATTLIST threadStart
	transientThreadId CDATA #IMPLIED

• • [0157] This attribute identifies the thread, and allows other trace elements to reference it through the transientThreadIdRef attribute.
• [0158] threadId CDATA #IMPLIED
  • [0159] This attribute identifies the thread, and allows other trace elements to reference it through the threadIdRef attribute.
• [0160] time CDATA #IMPLIED
• [0161] groupName CDATA #IMPLIED
  • [0162] Group to which the thread belongs.
• [0163] parentName CDATA #IMPLIED
  • [0164] Name of parent.
• [0165] transientObjIdRef CDATA #IMPLIED
  • [0166] The objAlloc that defines this transientObjIdRef may not be available, so the possibility of a dangling reference must be accounted for.
• [0167] objIdRef CDATA #IMPLIED
  • [0168] The objAlloc that defines this objIdRef may not be available. In this case the value of objIdRef is “0”.
• [0169] threadName CDATA #IMPLIED
  • [0170] Name of thread being started.

[0171]

	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>
	threadEnd
	<!ELEMENT threadEnd EMPTY>
	<!ATTLIST threadEnd
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	time CDATA #IMPLIED
	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

[0172] This element indicates the end of the thread identified by the transientThreadIdRef or threadIdRef value.

Classes

[0173] The hierarchical relationship of the class elements is set forth in FIG. 5. Definitions of these elements are as follows:

[0174]

	classDef
	<!ELEMENT classDef EMPTY>
	<!ATTLIST classDef
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	time CDATA #IMPLIED

• • [0175] The time represented here is the actual time that the class was loaded, not the time at which this element was generated.
• [0176] numInterfaces CDATA #IMPLIED
  • [0177] Number of interfaces implemented by this class. Expressed as an unsigned 32-bit value in string format.

[0178]

	transientClassId CDATA #IMPLIED
	classId CDATA #IMPLIED
	sourceName CDATA #IMPLIED

• • [0179] A string containing the fully qualified path of the class source file. (Note: this is revisited to enhance the specification to support more languages beyond Java). If for some reason the source file name cannot be determined, the string “” is returned.
• [0180] name CDATA #IMPLIED
  • [0181] The name of the class. If for some reason the source file name cannot be determined, the string “” is returned.
• [0182] access CDATA #IMPLIED
  • [0183] The access type for this class. The valid values are “public”, “private”, . . .
• [0184] numStaticFields CDATA #IMPLIED
  • [0185] The number of static fields declared within the class. Expressed as an unsigned 32-bit value in string format.
• [0186] numMethods CDATA #IMPLIED
  • [0187] The number of methods defined within the class. Expressed as an unsigned 32-bit value in string format.
• [0188] numInstanceFields CDATA #IMPLIED
  • [0189] The number of instance fields declared within the class. Expressed as an unsigned 32-bit value in string format.

[0190]

	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

• • [0191] The foregoing element defines a class.

[0192]

	methodDef
	<!ELEMENT methodDef return? parameter* exception*>
	<!ATTLIST methodDef
	name CDATA #IMPLIED

• • [0193] A string containing the name of the method.
• [0194] signature CDATA #IMPLIED
  • [0195] A string containing the signature of the method. The signature is expressed in the notation specified by the sigNotation attribute.
• [0196] access CDATA #IMPLIED
  • [0197] The access type for this method. The valid values are “public”, “private”, . . .
• [0198] startLineNumber CDATA #IMPLIED
  • [0199] The starting source line number of the method. Note: This attribute may not be produced if the source line information is not available.
• [0200] endLineNumber CDATA #IMPLIED
  • [0201] The ending source line number of the method. Note: This attribute may not be produced if the source line information is not available.
• [0202] sigNotation CDATA #IMPLIED
  • [0203] Contains a value that declares the notation the signature is expressed in. Supported values are in Table 3.

[0204]

TABLE 3
sigNotation
value	COMMENTS
JNI	Currently only JNI signature notation is supported. If this
	attribute is not present, the value JNI is assumed. JNI
	signature notation is defined in the Java Native Interface
	Specification
XML	The signature is specified by child elements of this
	methodDef element. In this case, the signature attribute
	may be an empty string.

[0205]

	transientClassIdRef CDATA #IMPLIED
	classIdRef CDATA #IMPLIED
	methodId CDATA #IMPLIED

• • [0206] The identifier of the method.
• [0207] transientMethodId CDATA #IMPLIED
  • [0208] The identifier of the method.

[0209]

	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

[0210] Although technically part of the classDef event, the methodDef element is broken out into a separate element so that it can be optionally output only when referenced.

[0211]

	Return
	<!ELEMENT return EMPTY>
	<!ATTLIST return
	transientClassIdRef CDATA #IMPLIED
	classIdRef CDATA #IMPLIED
	>
	parameter
	<!ELEMENT parameter EMPTY>
	<!ATTLIST parameter
	name CDATA #IMPLIED
	A string containing the name of the parameter.
	transientClassIdRef CDATA #IMPLIED
	classIdRef CDATA #IMPLIED
	>
	exception
	<!ELEMENT exception EMPTY>
	<!ATTLIST exception
	transientClassIdRef CDATA #IMPLIED
	classIdRef CDATA #IMPLIED
	>
	Objects

[0212] The hierarchical relationship of the object elements is set forth in FIG. 6.

[0213]

	objAlloc
	<!ELEMENT objAlloc EMPTY>
	<!ATTLIST objAlloc
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	time CDATA #IMPLIED
	isArray CDATA #IMPLIED
	transientObjId CDATA #IMPLIED
	objId CDATA #IMPLIED
	size CDATA #IMPLIED

[0214] Size in number of bytes expressed as an unsigned 32-bit value in string format.

• [0215] transientClassIdRef CDATA #IMPLIED
  • [0216] a reference to the class to which this object belongs, or the array element class if isArray is “2” (array of objects)
• [0217] classIdRef CDATA #IMPLIED
  • [0218] a reference to the class to which this object belongs, or the array element class if isArray is “2” (array of objects)
• [0219] contextData CDATA #IMPLIED
  • [0220] Data provided by the context service to associate with the object allocation. The mechanism for registering the context service is still to be defined. The contents of the contextData attribute is defined by the specific context service.

[0221]

	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

[0222] This element traces storage allocation. It can be used in conjunction with other elements such as the methodEntry element to identify an associated object.

Methods and Values

[0223] The methodEntry and methodExit elements are output when a method is entered, and when the method returns respectively. The methodCall and methodReturn elements are output when a method is about to be called, and after a method returns. It is not necessary for an agent to produce both methodEntry/Exit and methodCall/Return for a each method invocation. The semantics associated with the generation of these elements is agent specific. The hierarchical arrangement of these elements is set forth in FIG. 7.

[0224]

	methodEntry
	<!ELEMENT methodEntry (value*)>
	<!ATTLIST methodEntry
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	time CDATA #IMPLIED
	methodIdRef CDATA #IMPLIED
	transientMethodIdRef CDATA #IMPLIED
	ticket CDATA #IMPLIED
	transientObjIdRef CDATA #IMPLIED

• • [0225] This value is “0” if invoking a static method.
• [0226] objIdRef CDATA #IMPLIED
  • [0227] This value is “0” if invoking a static method.

[0228]

	transientClassIdRef CDATA #IMPLIED
	classIdRef CDATA #IMPLIED
	threadCpuTime CDATA #IMPLIED
	sequenceCounter CDATA #IMPLIED
	contextData CDATA #IMPLIED
	stackDepth CDATA #IMPLIED

[0229] The current depth of the stack including the current method being executed.

[0230]

	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

Note: the optional nested value elements represent parameter values.

[0231]

	methodExit
	<!ELEMENT methodExit (value*)>
	<!ATTLIST methodExit
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	time CDATA #IMPLIED
	ticket CDATA #IMPLIED
	threadCpuTime CDATA #IMPLIED
	methodIdRef CDATA #IMPLIED
	transientMethodIdRef CDATA #IMPLIED
	transientObjIdRef CDATA #IMPLIED

• • [0232] This value is “0” if exiting a static method.
• [0233] objIdRef CDATA #IMPLIED
  • [0234] This value is “0” if exiting a static method.

[0235]

	transientClassIdRef CDATA #IMPLIED
	classIdRef CDATA #IMPLIED
	sequenceCounter CDATA #IMPLIED
	contextData CDATA #IMPLIED
	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>
	Note:
	the optional nested value elements represent parameter values and return value.

[0236]

	methodCall
	<!ELEMENT methodCall (value*)>
	<!ATTLIST methodCall
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	time CDATA #IMPLIED
	methodIdRef CDATA #IMPLIED
	transientMethodIdRef CDATA #IMPLIED
	ticket CDATA #IMPLIED
	transientObjIdRef CDATA #IMPLIED

• • [0237] This value is “0” if invoking a static method.
• [0238] objIdRef CDATA #IMPLIED
  • [0239] This value is “0” if invoking a static method.

[0240]

	transientClassIdRef CDATA #IMPLIED
	classIdRef CDATA #IMPLIED
	threadCpuTime CDATA #IMPLIED
	sequenceCounter CDATA #IMPLIED
	contextData CDATA #IMPLIED
	stackDepth CDATA #IMPLIED

[0241] The current depth of the stack including the current method being executed.

[0242]

	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>
	Note:
	the optional nested value elements represent parameter values.

[0243]

	methodReturn
	<!ELEMENT methodReturn (value*)>
	<!ATTLIST methodReturn
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	time CDATA #IMPLIED
	ticket CDATA #IMPLIED
	threadCpuTime CDATA #IMPLIED
	methodIdRef CDATA #IMPLIED
	transientMethodIdRef CDATA #IMPLIED
	transientObjIdRef CDATA #IMPLIED

• • [0244] This value is “0” if returning from a static method.
• [0245] objIdRef CDATA #IMPLIED
  • [0246] This value is “0” if returning from a static method.

[0247]

	transientClassIdRef CDATA #IMPLIED
	classIdRef CDATA #IMPLIED
	sequenceCounter CDATA #IMPLIED
	contextData CDATA #IMPLIED
	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>
	Note:
	the optional nested value elements represent parameter values and return value.

[0248]

	objDef
	<!ELEMENT objDef EMPTY>
	<!ATTLIST objDef
	objId CDATA #REQUIRED
	isArray CDATA #IMPLIED
	size CDATA #IMPLIED

[0249] Size in number of bytes expressed as an unsigned 32-bit value in string format.

• [0250] classIdRef CDATA #IMPLIED
  • [0251] a reference to the class to which this object belongs, or the array element class if isArray is “2” (array of objects)

[0252]

	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	<

[0253] The objDef element holds identity information for an object, which can be referred to by elements associated with the object, such as the value element.

[0254]

	value
	<!ELEMENT value pcdata>
	<!ATTLIST value
	parameterName CDATA #IMPLIED

[0255] An optional parameter name associated with the value.

• [0256] referenceName CDATA #IMPLIED

[0257] An optional reference name associated with the value. For example, a variable name.

• [0258] objIdRef CDATA #IMPLIED
  • [0259] Refers the object associated with this value. The objIdRef value is “0” if the value is a primitive type.
• [0260] serializationFormat CDATA #IMPLIED
  • [0261] An implementation defined value that identifies the format used to serialize the object value.
• [0262] type CDATA #IMPLIED
  • [0263] Is one of the following in Table 4.

[0264]

TABLE 4
Type	Value
“serializedObjValueRef”	the value attribute is a reference (format
	to be defined) to a serialized object located
	elsewhere
“serializedObjValue”	the value attribute is a serialized object.
“serializedObjValueInline”	the serialized object is located in the pcdata.
	The value attribute is not used when this type
	is specified.
“boolean”	the value attribute is a string representation
	of a boolean value
“char”	the value attribute is a string representation
	of a char value
“int”	the value attribute is a string representation
	of an int value
“long”	the value attribute is a string representation
	of a long value
“float”	the value attribute is a string representation
	of a float value
“double”	the value attribute is a string representation
	of a double value
“string”	the value attribute is a string
“opaque”	the value is unknown. The value attribute is
	not used when this type is specified.

• [0265] value CDATA #IMPLIED
  • [0266] The actual value of the data as specified by the type attribute.

[0267]

	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

[0268] The value element is used to reference a data value, either for parameter values in a methodCall, or for the return value of a methodReturn.

[0269]

	methodCount
	<!ELEMENT methodCount EMPTY>
	<!ATTLIST methodCount
	count CDATA #IMPLIED

• • [0270] The number of times the method has been invoked since the start of the trace. Expressed as a 32-bit unsigned value in string format. This value is maintained even while tracing is suspended.
• [0271] methodIdRef CDATA #IMPLIED
  • [0272] Refers to the id of the method being counted.
• [0273] transientMethodIdRef CDATA #IMPLIED
  • [0274] Refers to the id of the method being counted.

[0275]

	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

[0276] The methodCount element tracks the number of times a particular method has been invoked. This element is designed to aid in collecting code coverage information. A methodCount element is produced for every method for every class loaded by the application. The count includes all method invocations regardless of whether tracing has been enabled or not. In other words, the data is collected even before a traceStart and even after a traceEnd. The elements are produced just prior to the agentDestroy element being produced. In addition, an agent may be requested to produce the methodCount elements at any arbitrary time before the agentDestroy element is produced.

Lines

[0277] These elements are designed to capture line coverage type information. The hierarchical arrangement of these elements is set forth in FIG. 8.

[0278]

	lineTable
	<!ELEMENT lineTable EMPTY>
	<!ATTLIST lineTable
	lineTableId CDATA #REQUIRED
	methodIdRef CDATA #REQUIRED
	sourceName CDATA #IMPLIED
	startLine CDATA #IMPLIED
	endLine CDATA #IMPLIED
	sourceCoordinateType CDATA #IMPLIED

• • [0279] Specifies the type of the source coordinates specified in the sourceCoordinateTable attribute.
  • [0280] The following values are defined:
  • [0281] “lineNumber”—the values in the sourceCoordinateTable are source line numbers. This is the simplest numbering scheme, but it fails to allow fine grained mapping for multiple Coverage Blocks on a single line.
  • [0282] “byteOffset”—the values in the sourceCoordinateTable are byte offsets into the file. A precise location in the file of the start of the source for the given Coverage Block.
• [0283] sourceCoordinateTable CDATA #IMPLIED
  • [0284] space delimited list of values in Coverage Block order that represents a source coordinates of the type specified by the sourceCoordinateType attribute. The table is indexed by Coverage Block number. A Coverage Block is defined as follows:
    • [0285] 18 Basic Block (BB)—contiguous instructions block with exactly one entry and one exit point.
    • [0286] 19 Coverage Block (CB)—BB with some restrictions. Each source line start considered a label thus adding an entry point. Each call statement considered as a potential exit point. Each exception-handling block considered an entry point. In some cases instructions capable of rising exceptions may be considered as exit points.
• [0287] >
  • [0288] One LINE_TABLE is provided per file segment which the method source is located in. By defining startLine and endLine, a line number table has to be a continuous segment of source.

[0289]

	line
	<!ELEMENT line EMPTY>
	<!ATTLIST line
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	lineTableIdRef CDATA #IMPLIED
	time CDATA #IMPLIED
	blockIndex CDATA #IMPLIED

• • [0290] An index into the sourceCoordinateTable of the associated lineTable. This allows the Coverage Block number to be mapped to the source coordinates of the source being executed. Expressed as a 32-bit unsigned value in string format.

[0291]

	traceIdRef CDATA #IMPLIED
	>

[0292] This element is produced for each Coverage Block that is executed.

Memory Management

[0293] The gcStart, objFree, classUnload, objMove, and gcFinish elements (along with objAlloc) are for tracing storage management. The hierarchical arrangement of these elements is set forth in FIG. 9.

[0294]

	GcStart
	<!ELEMENT gcStart EMPTY>
	<!ATTLIST gcStart
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	time CDATA #IMPLIED
	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

[0295] This element is produced when garbage collection (GC) is about to start.

[0296]

	objFree
	<!ELEMENT objFree EMPTY>
	<!ATTLIST objFree
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	time CDATA #IMPLIED
	transientObjIdRef CDATA #IMPLIED
	objIdRef CDATA #IMPLIED
	sequenceCounter CDATA #IMPLIED
	contextData CDATA #IMPLIED
	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

[0297] This element is produced when an object is freed.

[0298]

	classUnload
	<!ELEMENT classUnload EMPTY>
	<!ATTLIST classUnload
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	time CDATA #IMPLIED
	transientClassIdRef CDATA #IMPLIED
	classIdRef CDATA #IMPLIED
	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

[0299]

	objMove
	<!ELEMENT objMove EMPTY>
	<!ATTLIST objMove
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	time CDATA #IMPLIED
	transientObjIdRef CDATA #IMPLIED
	objIdRef CDATA #IMPLIED
	newObjId CDATA #IMPLIED

[0300] The new object id. See transientObjId for more information

[0301]

	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

[0302] This element is produced when an object is moved in the heap, and is always sent between a pair of gcStart and gcFinish elements. When an object is moved, its transientObjId is changed. All future references to this object use the new transientObjId value. To avoid having to map and track these changes, it is much simpler to use the objId to refer to the object, as this id does not change. Note: Because objId, classId, objIdRef and classIdRef are provided, it is anticipated that objMove need not be traced by a client unless low level memory analysis is required.

[0303]

	gcFinish
	<!ELEMENT gcFinish EMPTY>
	<!ATTLIST gcFinish
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	time CDATA #IMPLIED
	totalObjSpace CDATA #IMPLIED

• • [0304] Total amount of object space (in bytes) expressed as a 32-bit unsigned value in string format.
• [0305] usedObjSpace CDATA #IMPLIED
  • [0306] Amount of space used by the objects (in bytes) expressed as a 32-bit unsigned value in string format.
• [0307] usedObjects CDATA #IMPLIED

[0308] Number of used objects on the heap expressed as a 32-bit unsigned value in string format.

[0309]

	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

• • [0310] This element is produced when the garbage collection phase is finished.
    Exceptions

[0311] The throw and catch elements encapsulate the exception behavior of an application. The hierarchical arrangement of these elements is set forth in FIG. 10.

[0312]

	throw
	<!ELEMENT throw EMPTY>
	<!ATTLIST throw
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	time CDATA #IMPLIED
	objIdRef CDATA #IMPLIED

• • [0313] The objIdRef is not available if the class of the exception object is being filtered out. When this is the case, the objIdRef attribute is set to the value “-Unavailable-”.JVMPI Implementation Note: The objIdRef may not be available for all versions of the JVM. Some JVMs do not provide the API required to map the exception objects handle to an transientObjId. When this is the case, the objIdRef attribute is set to the value “-Unavailable-”.
• [0314] transientObjIdRef CDATA #IMPLIED
  • [0315] JVMPI Implementation Note: The transientObjIdRef may not be available for all versions of the JVM. Some JVMs do not provide the API required to map the exception objects handle to an transientObjId. When this is the case, the transientObjIdRef attribute is set to the value “-Unavailable-”.
• [0316] objHandle CDATA #IMPLIED
  • [0317] Represents the original object handle of the exception object. This handle does not correlate to transientObjId or objId attributes and thus cannot be used to determine the class of the exception object. It is emitted as a 32-bit unsigned value in string format. This attribute is provided solely to be able to correlate THROW and CATCH elements with each other when the transientObjId and objId attributes are unavailable. See the description of the transientObjIdRef and objIdRef attributes for a discussion of their availability.
• [0318] methodIdRef CDATA #IMPLIED
  • [0319] The identifier of the method on which the exception is thrown (also called the method which is processing the exception).
• [0320] transientMethodIdRef CDATA #IMPLIED
  • [0321] The identifier of the method on which the exception is thrown (also called the method which is processing the exception).
• [0322] ticket CDATA #IMPLIED
  • [0323] The ticket value of the method on which the exception is thrown (also called the method which is processing the exception).

[0324]

	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

[0325] When an exception is thrown, a throw element is generated for each unfiltered stack frame that processes the exception. Processing the exception includes simply letting the exception percolate to the next stack frame. A throw element is also generated for the stack frame that catches the exception.

[0326]

	catch
	<!ELEMENT catch EMPTY>
	<!ATTLIST catch
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	time CDATA #IMPLIED
	objIdRef CDATA #IMPLIED

• • [0327] A reference to the exception object. The objIdRef is not available if the class of the exception object is being filtered out. When this is the case, the objIdRef attribute is set to the value “-Unavailable-”.Implementation Note: The objIdRef may not be available for all versions of the JVM. Some JVMs do not provide the API required to map the exception objects handle to an transientObjId. When this is the case, the objIdRef attribute is set to the value “-Unavailable-”.
• [0328] transientObjIdRef CDATA #IMPLIED
  • [0329] A reference to the exception object. Implementation Note: The transientObjIdRef may not be available for all versions of the JVM. Some JVMs do not provide the API required to map the exception objects handle to an transientObjId. When this is the case, the transientObjIdRef attribute is set to the value “-Unavailable-”.
• [0330] objHandle CDATA #IMPLIED
  • [0331] Represents the original object handle of the exception object. This handle does not correlate to transientObjId or objId attributes and thus cannot be used to determine the class of the exception object. It is emitted as a 32-bit unsigned value in string format. This attribute is provided solely to be able to correlate THROW and CATCH elements with each other when the transientObjId and objId attributes are unavailable. See the description of the transientObjIdRef and objIdRef attributes for a discussion of their availability.
• [0332] methodIdRef CDATA #IMPLIED
  • [0333] The identifier of the method on which the exception is caught.
• [0334] transientMethodIdRef CDATA #IMPLIED
  • [0335] The identifier of the method on which the exception is caught.
• [0336] ticket CDATA #IMPLIED
  • [0337] The ticket value of the method on which the exception is caught.

[0338]

	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

[0339] A catch element is generated when the exception reaches an unfiltered stack frame that defines a catch clause for the exception.

Runtime

[0340] These elements track the initialization and shutdown of the program runtime. The hierarchical arrangement of these elements is set forth in FIG. 11.

[0341]

	runtimeInitDone
	<!ELEMENT runtimeInitDone EMPTY>
	<!ATTLIST runtimeInitDone
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	time CDATA #IMPLIED
	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

[0342] The runtimeInitDone element is produced when the program runtime environment initialization is complete (e.g., for Java it is produced when the JVM initialization is done).

[0343]

	runtimeShutdown
	<!ELEMENT runtimeShutdown EMPTY>
	<!ATTLIST runtimeShutdown
	transientThreadIdRef CDATA #IMPLIED
	threadIdRef CDATA #IMPLIED
	time CDATA #IMPLIED
	collationValue CDATA #IMPLIED
	traceIdRef CDATA #IMPLIED
	>

[0344] The runtimeShutdown element is produced when the program runtime environment terminates (e.g., for Java it is produced when the JVM being traced is shutting down).

[0345] Turning to FIG. 12, parts of a sample trace are shown. The illustrated sample is set forth solely for purposes of illustration and is not intended to limit the scope of the invention. Text denoted as 1200 is a header showing the context of the trace, which provided, for example, nodeId (node id reference) as “60646da0-3298-11d5-a73d-a0c48e000000”. Text denoted as 1202 shows the nested hierarchical structure of the trace elements. For example, <methodEntry threadIdRef=“2” time=“987446612.236409” methodIdRef=“2612” objIdRef=“2627” classIdRef=“2617” threadCpuTime=“0.2303312” stackDepth=“1”/> shows that a method 2612 called object 2627 of class 2617 at time 987446612.236409. Text denoted as 1204 shows the end of this trace.

[0346] Variations and modifications of the invention are contemplated. For example, the specific XML code fragments set forth herein are provided for the purpose of establishing a best mode of the invention. A person of ordinary skill in the art may conceive of other modes of expressing the functionality inherent in the disclosed code. Such a person may also conceive of further alternative embodiments of the invention, all of which are believed to fall within the sphere and scope of the invention as defined by the appended claims.