Commit | Line | Data |
---|---|---|
47851044 JD |
1 | .TH "LTTNG-RELAYD" "8" "July 15, 2012" "" "" |
2 | ||
3 | .SH "NAME" | |
4 | lttng-relayd \(em LTTng remote trace collection daemon | |
5 | ||
6 | .SH "SYNOPSIS" | |
7 | ||
8 | .PP | |
9 | .nf | |
10 | lttng-relayd [OPTIONS] | |
11 | .fi | |
12 | .SH "DESCRIPTION" | |
13 | ||
14 | .PP | |
15 | The LTTng project aims at providing highly efficient tracing tools for Linux. | |
16 | It's tracers help tracking down performance issues and debugging problems | |
17 | involving multiple concurrent processes and threads. Tracing across multiple | |
18 | systems is also possible. | |
19 | ||
fa91dc52 MD |
20 | The relay daemon listens by default on all network interfaces to gather |
21 | trace data, but only on localhost for viewer connections. This daemon | |
22 | does not require any particular permissions as long as it can write in | |
23 | the output folder and listen on the ports. If a user is within a secured | |
24 | network and/or has proper firewall settings, lttng-relayd can listen to | |
25 | viewer connections from all network interfaces by specifying '-L | |
26 | tcp://0.0.0.0:5344'. | |
27 | ||
28 | Traces can be either viewed "live" (as they are produced) by attaching | |
29 | to the live viewer port using LTTng live protocol, or after tracing has | |
30 | been stopped. Once a trace has been streamed completely, the trace can | |
31 | be processed by any tool that can process a local LTTng CTF trace. | |
47851044 JD |
32 | |
33 | By default, the relayd outputs the traces in : | |
34 | ~/lttng-traces/hostname/session-name/domain-name | |
35 | ||
36 | The prefix (~/lttng-traces) can be configured on the relayd side (see below for | |
37 | the option), the other folders can be configured when creating the trace on the | |
38 | sessiond side. | |
39 | .SH "OPTIONS" | |
40 | ||
41 | .PP | |
42 | This program follow the usual GNU command line syntax with long options starting with | |
43 | two dashes. Below is a summary of the available options. | |
44 | .PP | |
45 | ||
46 | .TP | |
47 | .BR "-h, --help" | |
48 | Show summary of possible options and commands | |
49 | .TP | |
50 | .BR "-v, --verbose" | |
51 | Increase verbosity | |
52 | ||
53 | There is three debugging level which will print on stderr. Maximum verbosity is | |
54 | \fB-vvv\fP. | |
55 | .TP | |
56 | .BR "-d, --daemonize" | |
57 | Start as a daemon | |
58 | .TP | |
b5218ffb MD |
59 | .BR "-b, --background" |
60 | Start as a daemon, keeping console open | |
61 | .TP | |
0210bba2 DG |
62 | .BR "-g, --group NAME" |
63 | Specify the tracing group name. (default: tracing) | |
64 | .TP | |
47851044 | 65 | .BR "-C, --control-port" |
994fa64f | 66 | Control port URL (tcp://0.0.0.0:5342 is the default) |
47851044 JD |
67 | .TP |
68 | .BR "-D, --data-port" | |
994fa64f | 69 | Data port URL (tcp://0.0.0.0:5343 is the default) |
47851044 | 70 | .TP |
8d5c808e | 71 | .BR "-L, --live-port URL" |
fa91dc52 | 72 | Live view port URL (tcp://localhost:5344 is the default). |
8d5c808e | 73 | .TP |
47851044 | 74 | .BR "-o, --output" |
994fa64f | 75 | Output base directory. Must use an absolute path (~/lttng-traces is the default) |
47851044 JD |
76 | .TP |
77 | .BR "-V, --version" | |
78 | Show version number | |
554831e7 MD |
79 | .SH "ENVIRONMENT VARIABLES" |
80 | ||
81 | .PP | |
82 | .IP "LTTNG_NETWORK_SOCKET_TIMEOUT" | |
83 | Control timeout of socket connection, receive and send. Takes an integer | |
84 | parameter: the timeout value, in milliseconds. A value of 0 or -1 uses | |
85 | the timeout of the operating system (this is the default). | |
094fe907 MD |
86 | .IP "LTTNG_RELAYD_HEALTH" |
87 | File path used for relay daemon health check communication. | |
554831e7 MD |
88 | .PP |
89 | ||
47851044 JD |
90 | .SH "SEE ALSO" |
91 | ||
92 | .PP | |
93 | babeltrace(1), lttng-sessiond(8), lttng-ust(3), lttng(1) | |
94 | .PP | |
95 | ||
96 | .SH "LIMITATIONS" | |
97 | ||
98 | .PP | |
99 | For now only TCP is supported on both control and data port. | |
100 | Control will always remain TCP-only since it is low-volume and needs absolutely | |
101 | to be reliable, but eventually the data connection could support UDP. | |
102 | ||
103 | For unprivileged user running lttng-relayd, the maximum number of file | |
104 | descriptors per process is usually 1024. This limits the number of connections | |
105 | and tracefiles opened. This limit can be configured see ulimit(3). | |
106 | .PP | |
107 | ||
108 | .SH "BUGS" | |
109 | ||
110 | .PP | |
111 | No show stopper bugs are known yet in this version. | |
112 | ||
113 | If you encounter any issues or usability problem, please report it on our | |
114 | mailing list <lttng-dev@lists.lttng.org> to help improve this project. | |
115 | .SH "CREDITS" | |
116 | ||
117 | .PP | |
118 | lttng-relayd is distributed under the GNU General Public License version 2. See the | |
119 | file COPYING for details. | |
120 | .PP | |
121 | A Web site is available at http://lttng.org for more information on the LTTng | |
122 | project. | |
123 | .PP | |
124 | You can also find our git tree at http://git.lttng.org. | |
125 | .PP | |
126 | Mailing lists for support and development: <lttng-dev@lists.lttng.org>. | |
127 | .PP | |
128 | You can find us on IRC server irc.oftc.net (OFTC) in #lttng. | |
129 | .PP | |
130 | .SH "AUTHORS" | |
131 | ||
132 | .PP | |
133 | lttng-relay was originally written by Julien Desfossez and | |
134 | David Goulet. More people have since contributed to it. It is currently | |
135 | maintained by Julien Desfossez <jdesfossez@efficios.com>. | |
136 | .PP |