Document features of LTTng 2.6

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>

diff --git a/contents/understanding-lttng/core-concepts/domain.md b/contents/understanding-lttng/core-concepts/domain.md
index 724af91cb3d6dc2e95f5c706c0a08a314d49fe61..b0cb5281cbe58a9e7aced9d35a3ca09d4eeb0004 100644 (file)
--- a/contents/understanding-lttng/core-concepts/domain.md
+++ b/contents/understanding-lttng/core-concepts/domain.md
@@ -5,11 +5,12 @@ id: domain
 A tracing _domain_ is the official term the LTTng project uses to
 designate a tracer category.
 
-There are currently three known domains:
+There are currently four known domains:
 
   * Linux kernel
   * user space
-  * Java Util Logging (JUL)
+  * `java.util.logging` (JUL)
+  * log4j
 
 Different tracers expose common features in their own interfaces, but,
 from a user's perspective, you still need to target a specific type of

diff --git a/contents/understanding-lttng/plumbing/lttng-consumerd.md b/contents/understanding-lttng/plumbing/lttng-consumerd.md
index 3bd76fa7617f06e8c3cb94ab04723113b0d95d4c..6d99b954fa3714b13e09ff2fea0e3118c7db7eea 100644 (file)
--- a/contents/understanding-lttng/plumbing/lttng-consumerd.md
+++ b/contents/understanding-lttng/plumbing/lttng-consumerd.md
@@ -33,7 +33,7 @@ collecting kernel trace data.
 
 As new tracing domains are added to LTTng, the development community's
 intent is to minimize the need for additionnal consumer daemon instances
-dedicated to them. For instance, the Java Util Logging (JUL) domain
+dedicated to them. For instance, the `java.util.logging` (JUL) domain
 events are in fact mapped to the user space domain, thus tracing this
 particular domain is handled by existing user space domain consumer
 daemons.

diff --git a/contents/understanding-lttng/plumbing/overview.md b/contents/understanding-lttng/plumbing/overview.md
index 3a538f57034e93586d11f334d36b992fb87cb0ed..69d31010b6530b83b0c164f3cf5a6b36fb129a68 100644 (file)
--- a/contents/understanding-lttng/plumbing/overview.md
+++ b/contents/understanding-lttng/plumbing/overview.md
@@ -22,8 +22,9 @@ which usable component belongs to which package:
       and `liblttng-ust-dl`)
     * user space tracepoint code generator command line tool
       (`lttng-gen-tp`)
-    * Java Util Logging tracepoint provider (`liblttng-ust-jul-jni`)
-      and JAR file (`liblttng-ust-jul.jar`)
+    * `java.util.logging`/log4j tracepoint providers
+      (`liblttng-ust-jul-jni` and `liblttng-ust-log4j-jni`) and JAR
+      file (`liblttng-ust-agent.jar`)
   * **LTTng-modules**:
     * LTTng Linux kernel tracer module
     * tracing ring buffer kernel modules

diff --git a/contents/using-lttng/controlling-tracing/enabling-disabling-events.md b/contents/using-lttng/controlling-tracing/enabling-disabling-events.md
index fd6a5cd8385b76ec5900dc008f6010c0a9ed6f0f..98828c4e9c1fa108e7ada6cd575a2cd7beebce52 100644 (file)
--- a/contents/using-lttng/controlling-tracing/enabling-disabling-events.md
+++ b/contents/using-lttng/controlling-tracing/enabling-disabling-events.md
@@ -12,7 +12,8 @@ in source code/binary program, logical processor and time capturing
 some payload) being recorded as trace data. This specific condition is
 composed of:
 
-  1. A **domain** (kernel, user space or Java Util Logging) (required).
+  1. A **domain** (kernel, user space, `java.util.loggin`, or log4j)
+     (required).
   2. One or many **instrumentation points** in source code or binary
      program (tracepoint name, address, symbol name, function name,
      logger name, etc.) to be executed (required).
@@ -26,10 +27,10 @@ composed of:
 All conditions are specified using arguments passed to the
 `enable-event` command of the `lttng` tool.
 
-Condition 1 is specified using either `--kernel/-k` (kernel),
-`--userspace/-u` (user space) or `--jul/-j`
-(<abbr title="Java Util Logging">JUL</abbr>). Exactly one of those
-three arguments must be specified.
+Condition 1 is specified using either `--kernel`/`-k` (kernel),
+`--userspace`/`-u` (user space), `--jul`/`-j`
+(<abbr title="java.util.logging">JUL</abbr>), or `--log4j`/`-l` (log4j).
+Exactly one of those four arguments must be specified.
 
 Condition 2 is specified using one of:
 
@@ -86,6 +87,21 @@ the end of the string when specifying a _tracepoint_. Make sure to
 use it between single quotes in your favorite shell to avoid
 undesired shell expansion.
 
+System call events can be enabled individually, too:
+
+<pre class="term">
+lttng enable-event -k --syscall open
+lttng enable-event -k --syscall read
+lttng enable-event -k --syscall fork,chdir,pipe
+</pre>
+
+The complete list of available system call events can be
+obtained using
+
+<pre class="term">
+lttng list --kernel --syscall
+</pre>
+
 You can see a list of events (enabled or disabled) using
 
 <pre class="term">

diff --git a/contents/using-lttng/controlling-tracing/mi.md b/contents/using-lttng/controlling-tracing/mi.md
new file mode 100644 (file)
index 0000000..9557e9b
--- /dev/null
+++ b/contents/using-lttng/controlling-tracing/mi.md
@@ -0,0 +1,25 @@
+---
+id: mi
+---
+
+The `lttng` tool aims at providing a command output as human-readable as
+possible. While this output is easy to parse by a human being, machines
+will have a hard time.
+
+This is why the `lttng` tool provides the general `--mi` option, which
+must specify a machine interface output format. As of the latest
+LTTng stable release, only the `xml` format is supported. A schema
+definition (XSD) is made
+<a href="https://github.com/lttng/lttng-tools/blob/master/src/common/mi_lttng.xsd" class="ext">available</a>
+to ease the integration with external tools as much as possible.
+
+The `--mi` option can be used in conjunction with all `lttng` commands.
+Here are some examples:
+
+<pre class="term">
+lttng --mi xml create some-session
+lttng --mi xml list some-session
+lttng --mi xml list --kernel
+lttng --mi xml enable-event --kernel --syscall open
+lttng --mi xml start
+</pre>

diff --git a/contents/using-lttng/instrumenting/java-application.md b/contents/using-lttng/instrumenting/java-application.md
index 51809807288ac023b700a7c4dc7ea2a02a4e65a4..af516647d114bf7f04ace80e0ac4703b304694ef 100644 (file)
--- a/contents/using-lttng/instrumenting/java-application.md
+++ b/contents/using-lttng/instrumenting/java-application.md
@@ -3,29 +3,42 @@ id: java-application
 ---
 
 LTTng-UST provides a _logging_ back-end for Java applications using
-<a href="http://docs.oracle.com/javase/7/docs/api/java/util/logging/Logger.html" class="ext">Java Util Logging</a> (JUL). This back-end is called the _LTTng-UST JUL agent_ and is
-responsible for communications with an LTTng session daemon.
+either
+<a href="http://docs.oracle.com/javase/7/docs/api/java/util/logging/Logger.html" class="ext"><code>java.util.logging</code></a>
+(JUL), or
+<a href="http://logging.apache.org/log4j/1.2/" class="ext">Apache log4j 1.2</a>.
+This back-end is called the _LTTng-UST Java agent_, and is responsible
+for communications with an LTTng session daemon.
 
-From the user's point of view, once the LTTng-UST JUL agent has been
-initialized, JUL loggers may be created and used as usual. The agent
-adds its own handler to the _root logger_, so that all loggers may
-generate LTTng events with no effort.
+<div class="tip">
+<p>
+    <span class="t">Note:</span>The latest stable version of LTTng
+    does not support Log4j 2.
+</p>
+</div>
 
-Common JUL features are supported using the `lttng` tool
+From the user's point of view, once the LTTng-UST Java agent has been
+initialized, JUL and log4j loggers may be created and used as usual.
+The agent adds its own handler to the _root logger_, so that all
+loggers may generate LTTng events with no effort.
+
+Common JUL/log4j features are supported using the `lttng` tool
 (see [Controlling tracing](#doc-controlling-tracing)):
 
   * listing all logger names
   * enabling/disabling events per logger name
-  * JUL log levels
+  * JUL/log4j log levels
 
-Here's an example:
+Here's an example using **`java.util.logging`**:
 
 ~~~ java
 import java.util.logging.Logger;
-import org.lttng.ust.jul.LTTngAgent;
+import org.lttng.ust.agent.LTTngAgent;
 
 public class Test
 {
+    private static final int answer = 42;
+
     public static void main(String[] argv) throws Exception
     {
         // create a logger
@@ -38,7 +51,7 @@ public class Test
         logger.info("some info");
         logger.warning("some warning");
         Thread.sleep(500);
-        logger.finer("finer information...");
+        logger.finer("finer information; the answer is " + answer);
         Thread.sleep(123);
         logger.severe("error!");
 
@@ -48,26 +61,63 @@ public class Test
 }
 ~~~
 
-The LTTng-UST JUL agent Java classes are packaged in a JAR file named
-`liblttng-ust-jul.jar`. It is typically located in
-`/usr/lib/lttng/java`. To compile the snippet above
+Here's the same example, this time using **log4j**:
+
+~~~ java
+import org.apache.log4j.Logger;
+import org.apache.log4j.BasicConfigurator;
+import org.lttng.ust.agent.LTTngAgent;
+
+public class Test
+{
+    private static final int answer = 42;
+
+    public static void main(String[] argv) throws Exception
+    {
+        // create and configure a logger
+        Logger logger = Logger.getLogger(Test.class);
+        BasicConfigurator.configure();
+
+        // call this as soon as possible (before logging)
+        LTTngAgent lttngAgent = LTTngAgent.getLTTngAgent();
+
+        // log at will!
+        logger.info("some info");
+        logger.warn("some warning");
+        Thread.sleep(500);
+        logger.debug("debug information; the answer is " + answer);
+        Thread.sleep(123);
+        logger.error("error!");
+        logger.fatal("fatal error!");
+
+        // not mandatory, but cleaner
+        lttngAgent.dispose();
+    }
+}
+~~~
+
+The LTTng-UST Java agent classes are packaged in a JAR file named
+`liblttng-ust-agent.jar`. It is typically located in
+`/usr/lib/lttng/java`. To compile the snippets above
 (saved as `Test.java`), do:
 
 <pre class="term">
-javac -cp /usr/lib/lttng/java/liblttng-ust-jul.jar Test.java
+javac -cp /usr/lib/lttng/java/liblttng-ust-agent.jar:$LOG4JCP Test.java
 </pre>
 
-You can run the resulting compiled class:
+where `$LOG4JCP` is the log4j 1.2 JAR file path, if you're using log4j.
+
+You can run the resulting compiled class like this:
 
 <pre class="term">
-java -cp /usr/lib/lttng/java/liblttng-ust-jul.jar:. Test
+java -cp /usr/lib/lttng/java/liblttng-ust-agent.jar:$LOG4JCP:. Test
 </pre>
 
 <div class="tip">
 <p>
     <span class="t">Note:</span><a href="http://openjdk.java.net/" class="ext">OpenJDK</a> 7
     is used for development and continuous integration, thus this
-    version is directly supported. However, the LTTng-UST JUL agent has
+    version is directly supported. However, the LTTng-UST Java agent has
     also been tested with OpenJDK 6.
 </p>
 </div>

diff --git a/images/export/plumbing.svg b/images/export/plumbing.svg
index f8cca3231c54e605aa31462634d715cee3634813..85c3c227a2d53f0fbbb262c6de2ba6c700d765db 100644 (file)
--- a/images/export/plumbing.svg
+++ b/images/export/plumbing.svg
@@ -16,7 +16,7 @@
     <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="1260" y1="-635" x2="1260" y2="-235"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 880,-235 A 5,5 0 0 0 885,-230"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1255,-230 A 5,5 0 0 0 1260,-235"/>
-    <text font-size="12.8" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1070" y="-431.1">
+    <text font-size="12.8" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1070" y="-431.1">
       <tspan x="1070" y="-431.1"></tspan>
     </text>
   </g>
@@ -35,7 +35,7 @@
     <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="1150" y1="-205" x2="1150" y2="-95"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 910,-95 A 5,5 0 0 0 915,-90"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1145,-90 A 5,5 0 0 0 1150,-95"/>
-    <text font-size="12.8" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1030" y="-146.1">
+    <text font-size="12.8" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1030" y="-146.1">
       <tspan x="1030" y="-146.1"></tspan>
     </text>
   </g>
@@ -54,7 +54,7 @@
     <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="990" y1="-595" x2="990" y2="-545"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 890,-545 A 5,5 0 0 0 895,-540"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 985,-540 A 5,5 0 0 0 990,-545"/>
-    <text font-size="12.8" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="940" y="-566.1">
+    <text font-size="12.8" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="940" y="-566.1">
       <tspan x="940" y="-566.1"></tspan>
     </text>
   </g>
@@ -73,12 +73,12 @@
     <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="980" y1="-575" x2="980" y2="-555"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 900,-555 A 5,5 0 0 0 905,-550"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 975,-550 A 5,5 0 0 0 980,-555"/>
-    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="940" y="-562.244">
+    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="940" y="-562.244">
       <tspan x="940" y="-562.244">TP</tspan>
     </text>
   </g>
-  <text font-size="9.03097" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="940" y="-587.007">
-    <tspan x="940" y="-587.007">C/C++ application</tspan>
+  <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="940" y="-586.875">
+    <tspan x="940" y="-586.875">C/C++ application</tspan>
   </text>
   <g>
     <rect style="fill: #d2edd2" x="895" y="-530" width="90" height="30"/>
@@ -95,7 +95,7 @@
     <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="990" y1="-525" x2="990" y2="-505"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 890,-505 A 5,5 0 0 0 895,-500"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 985,-500 A 5,5 0 0 0 990,-505"/>
-    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="940" y="-512.244">
+    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="940" y="-512.244">
       <tspan x="940" y="-512.244">liblttng-ust</tspan>
     </text>
   </g>
@@ -115,7 +115,7 @@
     <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="1110" y1="-595" x2="1110" y2="-575"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1010,-575 A 5,5 0 0 0 1015,-570"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1105,-570 A 5,5 0 0 0 1110,-575"/>
-    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1060" y="-582.244">
+    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1060" y="-582.244">
       <tspan x="1060" y="-582.244">Java application</tspan>
     </text>
   </g>
@@ -134,7 +134,7 @@
     <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="1110" y1="-475" x2="1110" y2="-455"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1010,-455 A 5,5 0 0 0 1015,-450"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1105,-450 A 5,5 0 0 0 1110,-455"/>
-    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1060" y="-462.244">
+    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1060" y="-462.244">
       <tspan x="1060" y="-462.244">liblttng-ust</tspan>
     </text>
   </g>
@@ -154,8 +154,9 @@
     <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="1110" y1="-515" x2="1110" y2="-495"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1010,-495 A 5,5 0 0 0 1015,-490"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1105,-490 A 5,5 0 0 0 1110,-495"/>
-    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1060" y="-502.244">
-      <tspan x="1060" y="-502.244">liblttng-ust-jul-jni</tspan>
+    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1060" y="-507.889">
+      <tspan x="1060" y="-507.889">liblttng-ust-jul-jni</tspan>
+      <tspan x="1060" y="-496.6">liblttng-ust-log4j-jni</tspan>
     </text>
   </g>
   <g>
@@ -173,8 +174,8 @@
     <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="1110" y1="-555" x2="1110" y2="-535"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1010,-535 A 5,5 0 0 0 1015,-530"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1105,-530 A 5,5 0 0 0 1110,-535"/>
-    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1060" y="-542.244">
-      <tspan x="1060" y="-542.244">liblttng-ust-jul.jar</tspan>
+    <text font-size="8.46667" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1060" y="-542.442">
+      <tspan x="1060" y="-542.442">liblttng-ust-agent.jar</tspan>
     </text>
   </g>
   <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="1060" y1="-530" x2="1060" y2="-520"/>
@@ -194,11 +195,11 @@
     <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="1250" y1="-595" x2="1250" y2="-529"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1150,-529 A 5,5 0 0 0 1155,-524"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1245,-524 A 5,5 0 0 0 1250,-529"/>
-    <text font-size="12.8" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1200" y="-558.1">
+    <text font-size="12.8" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1200" y="-558.1">
       <tspan x="1200" y="-558.1"></tspan>
     </text>
   </g>
-  <text font-size="9.03097" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1200" y="-584.875">
+  <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1200" y="-584.875">
     <tspan x="1200" y="-584.875">Linux kernel</tspan>
   </text>
   <g>
@@ -216,7 +217,7 @@
     <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="1240" y1="-571" x2="1240" y2="-551"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1160,-551 A 5,5 0 0 0 1165,-546"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1235,-546 A 5,5 0 0 0 1240,-551"/>
-    <text font-size="9.03111" style="fill: #ffffff;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1200" y="-558.244">
+    <text font-size="9.03111" style="fill: #ffffff;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1200" y="-558.244">
       <tspan x="1200" y="-558.244">LTTng modules</tspan>
     </text>
   </g>
@@ -235,7 +236,7 @@
     <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="1110" y1="-405" x2="1110" y2="-385"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1010,-385 A 5,5 0 0 0 1015,-380"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1105,-380 A 5,5 0 0 0 1110,-385"/>
-    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1060" y="-392.244">
+    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1060" y="-392.244">
       <tspan x="1060" y="-392.244">lttng-sessiond</tspan>
     </text>
   </g>
@@ -275,7 +276,7 @@
     <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="1110" y1="-343" x2="1110" y2="-323"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1010,-323 A 5,5 0 0 0 1015,-318"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1105,-318 A 5,5 0 0 0 1110,-323"/>
-    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1060" y="-330.244">
+    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1060" y="-330.244">
       <tspan x="1060" y="-330.244">lttng-consumerd</tspan>
     </text>
   </g>
@@ -316,7 +317,7 @@
     <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="1250" y1="-265" x2="1250" y2="-245"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1180,-245 A 5,5 0 0 0 1185,-240"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1245,-240 A 5,5 0 0 0 1250,-245"/>
-    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1215" y="-252.244">
+    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1215" y="-252.244">
       <tspan x="1215" y="-252.244">lttng (CLI)</tspan>
     </text>
   </g>
@@ -335,7 +336,7 @@
     <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="1250" y1="-305" x2="1250" y2="-285"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1180,-285 A 5,5 0 0 0 1185,-280"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1245,-280 A 5,5 0 0 0 1250,-285"/>
-    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1215" y="-292.244">
+    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1215" y="-292.244">
       <tspan x="1215" y="-292.244">liblttng-ctl</tspan>
     </text>
   </g>
@@ -354,10 +355,10 @@
     <polygon style="fill: #eb595e" points="1215,-312.236 1211,-320.236 1215,-318.236 1219,-320.236 "/>
     <polygon style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #eb595e" points="1215,-312.236 1211,-320.236 1215,-318.236 1219,-320.236 "/>
   </g>
-  <text font-size="11.2889" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:700" x="1060" y="-616.239">
-    <tspan x="1060" y="-616.239">Target (monitored) system</tspan>
+  <text font-size="11.2889" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:700" x="1060" y="-616.075">
+    <tspan x="1060" y="-616.075">Target (monitored) system</tspan>
   </text>
-  <text font-size="11.2889" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:700" x="1030" y="-116.075">
+  <text font-size="11.2889" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:700" x="1030" y="-116.075">
     <tspan x="1030" y="-116.075">Remote system</tspan>
   </text>
   <g>
@@ -375,7 +376,7 @@
     <line style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x1="1110" y1="-185" x2="1110" y2="-165"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1010,-165 A 5,5 0 0 0 1015,-160"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 1105,-160 A 5,5 0 0 0 1110,-165"/>
-    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1060" y="-172.244">
+    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1060" y="-172.244">
       <tspan x="1060" y="-172.244">lttng-relayd</tspan>
     </text>
   </g>
@@ -388,7 +389,7 @@
     <path style="fill: #ffffff" d="M 920 -290.333 C 928.57,-297.583 932.855,-300 941.425,-300 C 949.995,-300 954.28,-297.583 962.85,-290.333 L 962.85,-251.667 C 954.28,-244.417 949.995,-242 941.425,-242 C 932.855,-242 928.57,-244.417 920,-251.667 L 920,-290.333z"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 920 -290.333 C 928.57,-297.583 932.855,-300 941.425,-300 C 949.995,-300 954.28,-297.583 962.85,-290.333 L 962.85,-251.667 C 954.28,-244.417 949.995,-242 941.425,-242 C 932.855,-242 928.57,-244.417 920,-251.667 L 920,-290.333"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 920 -290.333 C 928.57,-283.083 932.855,-280.667 941.425,-280.667 C 949.995,-280.667 954.28,-283.083 962.85,-290.333"/>
-    <text font-size="9.03097" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="941.425" y="-268.989">
+    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="941.425" y="-268.989">
       <tspan x="941.425" y="-268.989">CTF</tspan>
       <tspan x="941.425" y="-257.7">traces</tspan>
     </text>
@@ -402,12 +403,12 @@
     <path style="fill: #ffffff" d="M 920 -189.652 C 928.57,-196.902 932.855,-199.318 941.425,-199.318 C 949.995,-199.318 954.28,-196.902 962.85,-189.652 L 962.85,-150.985 C 954.28,-143.735 949.995,-141.318 941.425,-141.318 C 932.855,-141.318 928.57,-143.735 920,-150.985 L 920,-189.652z"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 920 -189.652 C 928.57,-196.902 932.855,-199.318 941.425,-199.318 C 949.995,-199.318 954.28,-196.902 962.85,-189.652 L 962.85,-150.985 C 954.28,-143.735 949.995,-141.318 941.425,-141.318 C 932.855,-141.318 928.57,-143.735 920,-150.985 L 920,-189.652"/>
     <path style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" d="M 920 -189.652 C 928.57,-182.402 932.855,-179.985 941.425,-179.985 C 949.995,-179.985 954.28,-182.402 962.85,-189.652"/>
-    <text font-size="9.03097" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="941.425" y="-168.307">
+    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="941.425" y="-168.307">
       <tspan x="941.425" y="-168.307">CTF</tspan>
       <tspan x="941.425" y="-157.018">traces</tspan>
     </text>
   </g>
-  <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1030" y="-106.875">
+  <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1030" y="-106.875">
     <tspan x="1030" y="-106.875">(may be local as well)</tspan>
   </text>
   <g>
@@ -431,17 +432,17 @@
   </g>
   <g>
     <rect style="fill: #f0f0f0" x="1051.62" y="-265.275" width="16.75" height="10.55"/>
-    <text font-size="9.03097" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1060" y="-256.875">
+    <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1060" y="-256.875">
       <tspan x="1060" y="-256.875">TCP</tspan>
     </text>
   </g>
   <g>
     <rect style="fill: #f0f0f0" x="1131.62" y="-265.275" width="16.75" height="10.55"/>
-    <text font-size="9.03097" style="fill: #eb595e;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1140" y="-256.875">
+    <text font-size="9.03111" style="fill: #eb595e;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1140" y="-256.875">
       <tspan x="1140" y="-256.875">TCP</tspan>
     </text>
   </g>
-  <text font-size="9.03097" style="fill: #eb595e;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1220" y="-196.875">
+  <text font-size="9.03111" style="fill: #eb595e;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1220" y="-196.875">
     <tspan x="1220" y="-196.875">Control</tspan>
   </text>
   <g>
@@ -449,7 +450,7 @@
     <polygon style="fill: #000000" points="1257.76,-160 1249.76,-156 1251.76,-160 1249.76,-164 "/>
     <polygon style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" points="1257.76,-160 1249.76,-156 1251.76,-160 1249.76,-164 "/>
   </g>
-  <text font-size="9.03097" style="fill: #000000;text-anchor:middle;font-family: Helvetica, Arial, sans-serif;font-style:normal;font-weight:normal" x="1220" y="-166.875">
+  <text font-size="9.03111" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="1220" y="-166.875">
     <tspan x="1220" y="-166.875">Trace data</tspan>
   </text>
 </svg>

diff --git a/images/src/plumbing b/images/src/plumbing
index d693c9ec15c8863a7d0bcd922165c143484df0c1..9252361b3f31c9c57ebc87c0c27309344d38618c 100644 (file)
Binary files a/images/src/plumbing and b/images/src/plumbing differ

diff --git a/toc/docs.yml b/toc/docs.yml
index e4193abdc7b0db35c2bc56fed9d771e5b2647baf..b7c505cd9b4f99a6dc738e322e872c4047f87205 100644 (file)
--- a/toc/docs.yml
+++ b/toc/docs.yml
@@ -190,6 +190,8 @@ cats:
             title: Viewing events as they arrive
           - id: taking-a-snapshot
             title: Taking a snapshot
+          - id: mi
+            title: Machine interface
   - id: reference
     title: Reference
     cats: