NAME

threaddump - creates a thread dump of the OX middleware, including virtual threads.

SYNOPSIS

threaddump [-f file] [--format plain|json] [--overwrite] [--print-classic] [-H jmxHost] [-p jmxPort] [-l jmxLogin] [-s jmxPassword]

DESCRIPTION

This command line tool creates a thread dump of the OX middleware.

The middleware runs its HTTP work on virtual threads, which the classic thread dump does not list - neither jstack nor jcmd Thread.print reports them. Only the dump written by -f covers virtual threads. That dump in turn performs no deadlock analysis, so use --print-classic in addition when a deadlock is suspected; both options can be combined, and each produces its own separate dump.

The dump file is written by the middleware itself, so its path is resolved on the middleware's host, not on the host running this tool. The tool needs no jcmd binary, which the container image does not ship.

OPTIONS

-f, --file arg : The path name of the file in which to dump the threads, including virtual ones; e.g. "/tmp/threads.txt"

--format arg : The format of the dump file: "plain" (default) or "json". Note that "json" carries no lock information

--overwrite : Overwrite the dump file if it already exists

--print-classic : Print the classic thread dump to the terminal — a separate dump that reports lock ownership and detects deadlocks, but omits virtual threads

-H, --host jmxHost : The optional JMX host (default:localhost)

-l, --login jmxLogin : The optional JMX login (if JMX authentication is enabled)

-p, --port jmxPort : The optional JMX port (default:9999)

-s, --password jmxPassword : The optional JMX password (if JMX authentication is enabled)

-h, --help : Prints a help text

--responsetimeout : The optional response timeout in seconds when reading data from server (default: 0s; infinite)

EXAMPLES

threaddump -f /tmp/threads.txt

Writes a dump covering virtual threads to /tmp/threads.txt on the middleware's host.

threaddump --print-classic

Prints the classic thread dump, including deadlock analysis, to the terminal.

threaddump -f /tmp/threads.txt --print-classic

Both of the above: the file covers the virtual threads, the terminal output covers locks and deadlocks.