2.7, 2.8, 2.9: put session name before arguments for create command

[lttng-docs.git] / 2.8 / lttng-docs-2.8.txt

diff --git a/2.8/lttng-docs-2.8.txt b/2.8/lttng-docs-2.8.txt
index 33efee6a3a1faa05b4510023e7099d0d91feb8bf..3863c2be84fc0b225364583a288cd8438a3853ec 100644 (file)
--- a/2.8/lttng-docs-2.8.txt
+++ b/2.8/lttng-docs-2.8.txt
@@ -1,7 +1,7 @@
 The LTTng Documentation
 =======================
 Philippe Proulx <pproulx@efficios.com>
-v2.8, 6 December 2016
+v2.8, 8 December 2016
 
 
 include::../common/copyright.txt[]
@@ -4051,7 +4051,9 @@ wget http://lttng.org/files/lttng-tools/lttng-tools-latest-2.8.tar.bz2 &&
 tar -xf lttng-tools-latest-2.8.tar.bz2 &&
 cd lttng-tools-2.8.* &&
 ./configure --libdir=/usr/local/lib32 CFLAGS=-m32 CXXFLAGS=-m32 \
-            LDFLAGS='-L/usr/local/lib32 -L/usr/lib32' &&
+            LDFLAGS='-L/usr/local/lib32 -L/usr/lib32' \
+            --disable-bin-lttng --disable-bin-lttng-crash \
+            --disable-bin-lttng-relayd --disable-bin-lttng-sessiond &&
 make &&
 cd src/bin/lttng-consumerd &&
 sudo make install &&
@@ -4362,7 +4364,7 @@ The path:{liblttng-ust-cyg-profile*.so} helpers can add instrumentation
 to the entry and exit points of functions.
 
 man:gcc(1) and man:clang(1) have an option named
-https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html[`-finstrument-functions`]
+https://gcc.gnu.org/onlinedocs/gcc/Instrumentation-Options.html[`-finstrument-functions`]
 which generates instrumentation calls for entry and exit to functions.
 The LTTng-UST function tracing helpers,
 path:{liblttng-ust-cyg-profile.so} and
@@ -4586,6 +4588,31 @@ lttng view
 ----
 ====
 
+In the resulting trace, an <<event,event record>> generated by a Java
+application using `java.util.logging` is named `lttng_jul:event` and
+has the following fields:
+
+`msg`::
+  Log record's message.
+
+`logger_name`::
+  Logger name.
+
+`class_name`::
+  Name of the class in which the log statement was executed.
+
+`method_name`::
+  Name of the method in which the log statement was executed.
+
+`long_millis`::
+  Logging time (timestamp in milliseconds).
+
+`int_loglevel`::
+  Log level integer value.
+
+`int_threadid`::
+  ID of the thread in which the log statement was executed.
+
 You can use the opt:lttng-enable-event(1):--loglevel or
 opt:lttng-enable-event(1):--loglevel-only option of the
 man:lttng-enable-event(1) command to target a range of JUL log levels
@@ -4734,6 +4761,37 @@ lttng view
 ----
 ====
 
+In the resulting trace, an <<event,event record>> generated by a Java
+application using log4j is named `lttng_log4j:event` and
+has the following fields:
+
+`msg`::
+  Log record's message.
+
+`logger_name`::
+  Logger name.
+
+`class_name`::
+  Name of the class in which the log statement was executed.
+
+`method_name`::
+  Name of the method in which the log statement was executed.
+
+`filename`::
+  Name of the file in which the executed log statement is located.
+
+`line_number`::
+  Line number at which the log statement was executed.
+
+`timestamp`::
+  Logging timestamp.
+
+`int_loglevel`::
+  Log level integer value.
+
+`thread_name`::
+  Name of the Java thread in which the log statement was executed.
+
 You can use the opt:lttng-enable-event(1):--loglevel or
 opt:lttng-enable-event(1):--loglevel-only option of the
 man:lttng-enable-event(1) command to target a range of Apache log4j log levels
@@ -5053,6 +5111,33 @@ lttng view
 ----
 ====
 
+In the resulting trace, an <<event,event record>> generated by a Python
+application is named `lttng_python:event` and has the following fields:
+
+`asctime`::
+  Logging time (string).
+
+`msg`::
+  Log record's message.
+
+`logger_name`::
+  Logger name.
+
+`funcName`::
+  Name of the function in which the log statement was executed.
+
+`lineno`::
+  Line number at which the log statement was executed.
+
+`int_loglevel`::
+  Log level integer value.
+
+`thread`::
+  ID of the Python thread in which the log statement was executed.
+
+`threadName`::
+  Name of the Python thread in which the log statement was executed.
+
 You can use the opt:lttng-enable-event(1):--loglevel or
 opt:lttng-enable-event(1):--loglevel-only option of the
 man:lttng-enable-event(1) command to target a range of Python log levels
@@ -5638,7 +5723,7 @@ To output LTTng traces to a non-default location:
 --
 [role="term"]
 ----
-lttng create --output=/tmp/some-directory my-session
+lttng create my-session --output=/tmp/some-directory
 ----
 --
 
@@ -6569,7 +6654,7 @@ To use LTTng live:
 --
 [role="term"]
 ----
-lttng create --live my-session
+lttng create my-session --live
 ----
 --
 +
@@ -6636,7 +6721,7 @@ To take a snapshot:
 --
 [role="term"]
 ----
-lttng create --snapshot my-session
+lttng create my-session --snapshot
 ----
 --
 +