Td User Manual

Internal

• events-java-threads

REFACTOR

NEW SYNTAX

td <field-name>:<regex> [procedure] ./stacks.txt

Fields:

• thread-name
• os-prio
• prio
• tid
• nid
• thread-state
• daemon
• object-wait-monitor
• stack

Generic Procedures

count

TODO - link

describe

TODO - link

exclude

TODO - link

output

TODO - link

timegaps

TODO - link

td Specific Procedures

count

Counts the number of stack traces (possibly only those that matched the query, if a query was used) per thread dump, in a time series CSV format.

names

Thread dump names, alphabetically (subject to query).

REFACTOR

Overview

tda (Thread Dump Analyzer) is a command-line utility that can be used to process Java thread dumps.

This documentation defines a thread dump as the result of one invocation of the jstack command, or of sending SIGQUIT (-3) into the Java virtual machine process. A thread dump consists in a set of stack traces, one stack trace for each thread in the Java virtual machine.

tda works by default in a manner similar to grep, processing the thread dump file sequentially, one thread dump at a time. Multiple thread dumps (i.e. the result of multiple invocations, at different moments in time), may be present in the file, and tda distinguishes this situation, by handling each thread dump individually. Once the stack trances are parsed, tda matches their content against the given regular expression and displays the stack traces that match.

The regular expression uses the grep syntax. More details about supported regular expressions are available in the "Regular Expression Syntax" section.

Syntax

tda [options] [regex|command] <thread-dump-file> [thread-dump-file, ...]

grep Mode

The utility filters and displays at standard output only the stack traces that match the given regular expression. For example:

   tda http- thread-dump-file.txt

will display at stdout only the stack traces that contain "http-", anywhere in the stack trace, including method invocation lines. The regular expression is optional. If missing, all stack traces present in the file will be displayed. The output can be modified with the following options:

-c

Counts the number of threads that match the regular expression, and display the number. If only the file name is specified, the regular expression is assumed to be "match all".

-v

Invert match. Select the stack traces that do not match the regular expression.

Regular Expression Syntax

tda is designed to use the same regular expressions as grep.

If the regular expression contains spaces, it can be specified on command line by enclosing it in double quotes: double quotes preserve spaces, which are passed as such to the Java runtime:

tda "on object monitor" thread-dump-file.txt

Other Commands

split

Extracts individual thread dumps from the a thread dump file that contains a concatenation of multiple thread dumps, and places them into separate files. The files are named based on the counter and timestamp (if available).

diff

tda diff <thread-dump-file1.out> <thread-dump-file2.out>

The current implementation of the diff command compares two thread dumps and displays the names of the threads that are found in one dump, but not in another, based on a TID comparison.

version

Displays the tda version.

help

Displays a brief in-line help that contains a link to this page.

Extensions

--<ExtensionClassName> 

--FSI, 
--FFM

where the class should be available in com/novaordis/universus/tdanalyzer/extensions.

To review this.