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