Add Python agent support
[lttng-tools.git] / doc / man / lttng.1
index 2dda28a16004c8e4aafe9b9f5096b25ad22d8bf9..47f273144c797cc3970a2e1b42b54e1fff6d29e5 100644 (file)
@@ -27,10 +27,11 @@ kernel and/or instrumented applications (lttng-ust(3)). Aggregating and reading
 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, 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.
+tracer (kernel, user space, JUL, LOG4J or Python 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, \-l, \-j
+or \-p). 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
@@ -539,6 +540,12 @@ Apply for the user-space tracer
 .BR "\-j, \-\-jul"
 Apply for Java application using Java Util Logging interface (JUL)
 .TP
+.BR "\-l, \-\-log4j"
+Apply for Java application using LOG4J
+.TP
+.BR "\-p, \-\-python"
+Apply for Python application using the logging module.
+.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.
@@ -552,6 +559,10 @@ e.g.:
 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.
+For the LOG4J domain, loglevels range from FATAL to TRACE which are also
+detailed in the help.
+For the Python domain, loglevels range from CRITICAL to DEBUG which are
+detailed in the help as well.
 .TP
 .BR "\-\-loglevel-only NAME"
 Tracepoint loglevel (only this loglevel).
@@ -700,6 +711,12 @@ Apply for the user-space tracer
 .TP
 .BR "\-j, \-\-jul"
 Apply for Java application using Java Util Logging interface (JUL)
+.TP
+.BR "\-l, \-\-log4j"
+Apply for Java application using LOG4J
+.TP
+.BR "\-p, \-\-python"
+Apply for Python application using the logging module.
 .RE
 .PP
 
@@ -718,6 +735,10 @@ 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 \-l alone, the available LOG4J event from registered application will be
+list. The event corresponds to the Logger name in the Java LOG4J application.
+With \-p alone, the available Python event from registered application will be
+list. The event corresponds to the Logger name in the Python application.
 With \-u alone, it will list all available user-space events from registered
 applications. Here is an example of 'lttng list \-u':
 
@@ -748,6 +769,12 @@ Select user-space domain.
 .BR "\-j, \-\-jul"
 Apply for Java application using JUL
 .TP
+.BR "\-l, \-\-log4j"
+Apply for Java application using LOG4J
+.TP
+.BR "\-p, \-\-python"
+Apply for Python application using the logging module.
+.TP
 .BR "\-f, \-\-fields"
 List event fields
 
@@ -1009,33 +1036,32 @@ arguments
 .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.
+.SH "JUL/LOG4J DOMAIN"
+
+This section explains the JUL and LOG4J domain where JUL stands for Java Util
+Logging. You can use these by using the \fBliblttng-ust-<domain>-jni.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).
+enabling events, you enable a Logger name that will then be mapped to a default
+UST tracepoint called \fBlttng_jul:<domain>_event\fP in the
+\fBlttng_<domain>_channel\fP. Using the lttng-ctl API, any JUL/LOG4J 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.
+Because of the default immutable channel, the \fBenable-channel\fP command CAN
+NOT be used with the JUL and LOG4J domain thus not having any options.
 
-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).
+Also, loglevels are supported. 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.
+Finally, you can list every Logger name that are available from registered
+applications to the session daemon by using \fBlttng list \-j\fP or \fB\-l\fP.
 
-Here is an example on how to use this domain.
+Here is an example on how to use the JUL domain.
 
 .nf
 $ lttng list -j
This page took 0.02602 seconds and 5 git commands to generate.