-.TH "LTTNG" "1" "July 18th, 2013" "" ""
+.TH "LTTNG" "1" "February 05th, 2014" "" ""
.SH "NAME"
lttng \(em LTTng 2.x tracer control command line tool
those traces is done using the babeltrace(1) text viewer.
We introduce the notion of \fBtracing domains\fP which is essentially a type of
-tracer (kernel or user space for now). In the future, we could see a third
-tracer being for instance an hypervisor. For some commands, you'll need to
-specify on which domain the command operates (-u or -k). For instance, the
-kernel domain must be specified when enabling a kernel event.
+tracer (kernel, user space or JUL for now). In the future, we could see more
+tracer like for instance an hypervisor. For some commands, you'll need to
+specify on which domain the command operates (\-u, \-k or \-j). For instance,
+the kernel domain must be specified when enabling a kernel event.
In order to trace the kernel, the session daemon needs to be running as root.
LTTng provides the use of a \fBtracing group\fP (default: tracing). Whomever is
root daemon or even a Bob daemon. We highly recommend starting the session
daemon at boot time for stable and long term tracing.
-All user-space applications instrumented with lttng-ust(3) will
-automatically register to the session daemon. This feature gives you the
-ability to list available traceable applications and tracepoints on a per user
-basis. (See \fBlist\fP command).
+Each user-space application instrumented with lttng-ust(3) will automatically
+register with the root session daemon and its user session daemon. This allows
+each daemon to list the available traceable applications and tracepoints at any
+given moment (See the \fBlist\fP command).
.SH "OPTIONS"
.PP
variable LTTNG_HOME. This is useful when the user running the commands has
a non-writeable home directory.
+The session name MUST NOT contain the character '/'.
+
.B OPTIONS:
.TP
URL, if one is specified, as the default snapshot output. Every channel will be set
in overwrite mode and with mmap output (splice not supported).
.TP
-.BR "\-\-live USEC"
+.BR "\-\-live [USEC]"
Set the session exclusively in live mode. The paremeter is the delay in micro
seconds before the data is flushed and streamed. The live mode allows you to
stream the trace and view it while it's being recorded by any tracer. For that,
you need a lttng-relayd and this session requires a network URL (\-U or
-\-C/\-D).
+\-C/\-D). If no USEC nor URL is provided, the default is to use a timer value
+set to 1000000 and the network URL set to net://127.0.0.1.
To read a live session, you can use babeltrace(1) or the live streaming
protocol in doc/live-reading-protocol.txt. Here is an example:
.BR "\-u, \-\-userspace"
Apply for the user-space tracer
.TP
+.BR "\-j, \-\-jul"
+Apply for Java application using Java Util Logging interface (JUL)
+.TP
.BR "\-\-tracepoint"
Tracepoint event (default). Userspace tracer supports wildcards at the end
of string. Don't forget to quote to deal with bash expansion.
.TP
.BR "\-\-loglevel NAME"
Tracepoint loglevel range from 0 to loglevel. Listed in the help (\-h).
+For the JUL domain, the loglevel ranges are detailed with the \-\-help
+option thus starting from SEVERE to FINEST.
.TP
.BR "\-\-loglevel-only NAME"
Tracepoint loglevel (only this loglevel).
'$ctx.vtid == 1234'
.fi
+.TP
+.BR "\-x, \-\-exclude LIST"
+Add exclusions to UST tracepoints:
+Events that match any of the items in the comma-separated LIST are not
+enabled, even if they match a wildcard definition of the event.
+
+This option is also applicable with the \fB\-a, \-\-all\fP option,
+in which case all UST tracepoints are enabled except the ones whose
+names match any of the items in LIST.
.RE
.PP
.TP
.BR "\-u, \-\-userspace"
Apply for the user-space tracer
+.TP
+.BR "\-j, \-\-jul"
+Apply for Java application using Java Util Logging interface (JUL)
.RE
.PP
With \-k alone, it will list all available kernel events (except the system
calls events).
+With \-j alone, the available JUL event from registered application will be
+list. The event corresponds to the Logger name in the Java JUL application.
With \-u alone, it will list all available user-space events from registered
applications. Here is an example of 'lttng list \-u':
.TP
.BR "\-u, \-\-userspace"
Select user-space domain.
+.TP
+.BR "\-j, \-\-jul"
+Apply for Java application using JUL
+.TP
+.BR "\-f, \-\-fields"
+List event fields
.PP
.B SESSION OPTIONS:
.TP
.BR "\-\-list-options"
Simple listing of options
-.TP "\-\-no-wait"
+.TP
+.BR "\-\-no-wait"
Don't wait for data availability.
.RE
.PP
.RE
.PP
+.SH "JUL DOMAIN"
+This section explains the JUL domain (\-j, \-\-jul) where JUL stands for Java
+Util Logging. You can use that feature by using the \fBliblttng-ust-jul.so\fP
+from the lttng-ust(3) project.
+
+The LTTng Java Agent uses JNI to link the UST tracer to the Java application
+that uses the agent. Thus, it behaves similarly to the UST domain (\-u). When
+enabling events with the JUL domain, you enable a Logger name that will then be
+mapped to a default UST tracepoint called \fBlttng_jul:jul_event\fP in the
+\fBlttng_jul_channel\fP. Using the lttng-ctl API, any JUL events must use the
+tracepoint event type (same as \-\-tracepoint).
+
+Because of the default immutable channel (\fBlttng_jul_channel\fP), the
+\fBenable-channel\fP command CAN NOT be used with the JUL domain thus not
+having any \-j option.
+
+For JUL event, loglevels are supported with the JUL ABI values. Use \fBlttng
+enable-event \-h\fP to list them. Wildcards are NOT supported except the "*"
+meaning all events (same as \-a).
+
+Exactly like the UST domain, if the Java application has the same UID as you,
+you can trace it. Same goes for the tracing group accessing root applications.
+
+Finally, you can list every Logger name that are available from JUL registered
+applications to the session daemon by using \fBlttng list \-j\fP.
+
+Here is an example on how to use this domain.
+
+.nf
+$ lttng list -j
+[...]
+$ lttng create aSession
+$ lttng enable-event -s aSession -j MyCustomLoggerName
+$ lttng start
+.fi
+
+More information can be found in the lttng-ust documentation, see
+java-util-logging.txt
+.PP
+
.SH "EXIT VALUES"
.PP
On success 0 is returned and a positive value on error. Value of 1 means a command
projects / lttng-tools.git / blobdiff