Add streaming howto

Signed-off-by: David Goulet <dgoulet@efficios.com>

diff --git a/README b/README
index f65836344cd3179d06d2ec875e202f84ecbf4f86..033679b7fc3f9147bfd326c57d19ff0dc0f04d46 100644 (file)
--- a/README
+++ b/README
@@ -68,6 +68,9 @@ Please see doc/quickstart.txt to help you start tracing. You can also use the
 -h/--help command on 'lttng' and all other commands offered in this tool (Ex:
 lttng enable-event -h).
 
+A network streaming HOWTO can be found in doc/streaming-howto.txt which quickly
+helps you understand how to stream a LTTng 2.0 trace.
+
 PACKAGE CONTENTS:
 
     This package contains the following elements:

diff --git a/doc/streaming-howto.txt b/doc/streaming-howto.txt
new file mode 100644 (file)
index 0000000..86ea30e
--- /dev/null
+++ b/doc/streaming-howto.txt
@@ -0,0 +1,116 @@
+STREAMING
+----------------
+
+[Last updated: 2012-07-17 by David Goulet]
+
+This is a brief howto for network streaming< feature of lttng 2.0 toolchain.
+
+See the README file for installation procedure or use the various Linux
+distribution packages.
+
+Terminology:
+
+       * The "target" is the traced machine (either UST or/and kernel tracer)
+
+       * The "remote" is the machine that receives the traces over network
+       streaming transport layer.
+
+Basics:
+
+Here are the basics concept of the new streaming component. We use two network
+ports for that called _control_ and _data_ respectively defined by default to
+5342 and 5343.
+
+The control port is where the commands AND metadata data are sent since this
+stream is considered to be the reliable and prioritize transport channel. The
+data port is the stream with all the tracing raw data.
+
+In order to gather traces from the network, the remote machine MUST have a
+lttng-relayd running on it bound to network interfaces remotely reachable by the
+target.
+
+[remote] $ lttng-relayd -d
+(to daemonize)
+
+[remote] $ lttng-relayd -vvv
+(foreground with debug output)
+
+[remote] $ lttng-relayd -C 1234 -D 5678
+(control port set to 1234 and data port to 5678)
+
+Once done, the following examples shows you how to start streaming from the
+target machine to the remote host where we just started a lttng relay.
+
+Example 1:
+----------------
+
+Simple and quick network streaming.
+
+1) Create a tracing session that will be streamed over the network for the
+specified domain. This session will contain, in our example, syscall events.
+
+  # lttng create syscall-session
+
+2) Enable the consumer to send data over the network for the kernel domain.
+
+  # lttng enable-consumer --kernel net://<remote_addr>
+
+  You can also skip this step and directly use the lttng create command like so:
+
+  # lttng create -U net://<remote_addr> syscall-session
+
+3) Set and start the tracing. Nothing new here.
+
+  # lttng enable-event -a --syscall -k
+  # lttng start
+  (wait and get coffee)
+  # lttng stop
+
+On the relay side, the trace will be written to the lttng-traces/ directory of
+the relayd user in:
+
+  hostname/session-name/kernel/*
+
+Just run babeltrace or lttng view -t PATH with the previous path.
+
+Example 2:
+----------------
+
+This example uses all possible options to fine grained control the streaming.
+
+1) Again, create a tracing session that will be streamed over the network for
+the specified domain.
+
+  # lttng create syscall-session
+
+2) Set relayd URIs for the tracing session and kernel domain.
+
+ONLY set the remote relayd URIs (both control and data at the same destination
+and using default ports) on the consumer but does not enable the consumer to use
+network streaming yet.
+
+  # lttng enable-consumer -k -U net://<remote_addr>
+
+You can also set both control and data URIs using -C and -D respectively for
+that like so:
+
+  # lttng enable-consumer -k -C tcp://<remote_addr>-D tcp://<remote_addr>
+
+3) Enable the consumer previously setup with the relayd URIs.
+
+This enables the previous network destination. From this point on, the consumer
+is ready to stream once tracing is started.
+
+  # lttng enable-consumer -k --enable
+
+4) Set and start the tracing. Nothing new here.
+
+  # lttng enable-event -a --syscall -k
+  # lttng start
+  (wait and get coffee)
+  # lttng stop
+
+Again, run babeltrace as mention in the previous example on the relayd side.
+
+For more information, please read the --help options of each command or the man
+pages lttng(1) and the lttng-relayd(8)