projects
/
lttng-tools.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
format-cpp: run clang-format in parallel
[lttng-tools.git]
/
doc
/
streaming-howto.txt
diff --git
a/doc/streaming-howto.txt
b/doc/streaming-howto.txt
index 86ea30e4361377163907ebf66cd3e170d6db28c2..a864dc70235027d521755fc4385dcf7f2330d2b2 100644
(file)
--- a/
doc/streaming-howto.txt
+++ b/
doc/streaming-howto.txt
@@
-3,9
+3,9
@@
STREAMING
[Last updated: 2012-07-17 by David Goulet]
[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
+See the README
.adoc
file for installation procedure or use the various Linux
distribution packages.
Terminology:
distribution packages.
Terminology:
@@
-17,13
+17,13
@@
Terminology:
Basics:
Basics:
-Here are the basic
s 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
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 priorit
ize
transport channel. The
-data port is the stream w
ith all
the tracing raw data.
+stream is considered to be the reliable and priorit
y
transport channel. The
+data port is the stream w
hich 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
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 -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.
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.
@@
-46,7
+48,7
@@
Example 1:
Simple and quick network streaming.
Simple and quick network streaming.
-1) Create a
trac
ing session that will be streamed over the network for the
+1) Create a
record
ing 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
specified domain. This session will contain, in our example, syscall events.
# lttng create syscall-session
@@
-66,11
+68,14
@@
specified domain. This session will contain, in our example, syscall events.
(wait and get coffee)
# lttng stop
(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/*
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:
Just run babeltrace or lttng view -t PATH with the previous path.
Example 2:
@@
-78,12
+83,12
@@
Example 2:
This example uses all possible options to fine grained control the streaming.
This example uses all possible options to fine grained control the streaming.
-1) Again, create a
trac
ing session that will be streamed over the network for
+1) Again, create a
record
ing session that will be streamed over the network for
the specified domain.
# lttng create syscall-session
the specified domain.
# lttng create syscall-session
-2) Set relayd URIs for the
trac
ing session and kernel domain.
+2) Set relayd URIs for the
record
ing 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
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
@@
-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:
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.
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
(wait and get coffee)
# lttng stop
-Again, run babeltrace as mention in the previous example on the relayd side.
+Again, run babeltrace as mention
ed
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)
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.024505 seconds
and
4
git commands to generate.