small fixes on streaming-howto
authorJulien Desfossez <jdesfossez@efficios.com>
Fri, 20 Jul 2012 12:16:07 +0000 (08:16 -0400)
committerDavid Goulet <dgoulet@efficios.com>
Fri, 20 Jul 2012 14:21:20 +0000 (10:21 -0400)
Signed-off-by: Julien Desfossez <jdesfossez@efficios.com>
doc/streaming-howto.txt

index 86ea30e4361377163907ebf66cd3e170d6db28c2..a89a2c80c747953c6b15e45f525d4b29891fb444 100644 (file)
@@ -3,7 +3,7 @@ STREAMING
 
 [Last updated: 2012-07-17 by David Goulet]
 
-This is a brief howto for network streaming< feature of lttng 2.0 toolchain.
+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.
@@ -17,13 +17,13 @@ Terminology:
 
 Basics:
 
-Here are the basics concept of the new streaming component. We use two network
+Here are the basic concepts 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.
+stream is considered to be the reliable and priority transport channel. The
+data port is the stream which transports 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
@@ -35,8 +35,10 @@ target.
 [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)
+[remote] $ lttng-relayd -C tcp://0.0.0.0:1234 -D tcp://0.0.0.0:5678
+(control port set to TCP/1234 and data port to TCP/5678 on all IP addresses)
+
+For now, only TCP is supported on IPv4/IPv6.
 
 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.
@@ -66,11 +68,14 @@ specified domain. This session will contain, in our example, syscall events.
   (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:
+By default on the relay side, the trace will be written to the lttng-traces/
+directory of the relayd user in:
 
   hostname/session-name/kernel/*
 
+The -o option of lttng-relayd allows the user to override the default output
+path.
+
 Just run babeltrace or lttng view -t PATH with the previous path.
 
 Example 2:
@@ -94,7 +99,7 @@ network streaming yet.
 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>
+  # lttng enable-consumer -k -C tcp://<remote_addr> -D tcp://<remote_addr>
 
 3) Enable the consumer previously setup with the relayd URIs.
 
@@ -110,7 +115,7 @@ is ready to stream once tracing is started.
   (wait and get coffee)
   # lttng stop
 
-Again, run babeltrace as mention in the previous example on the relayd side.
+Again, run babeltrace as mentioned 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)
This page took 0.035403 seconds and 4 git commands to generate.