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