bash completion: add calls to _lttng_complete_sessions
[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
53.BR "-C, --control-port"
994fa64f 54Control port URL (tcp://0.0.0.0:5342 is the default)
47851044
JD
55.TP
56.BR "-D, --data-port"
994fa64f 57Data port URL (tcp://0.0.0.0:5343 is the default)
47851044
JD
58.TP
59.BR "-o, --output"
994fa64f 60Output base directory. Must use an absolute path (~/lttng-traces is the default)
47851044
JD
61.TP
62.BR "-V, --version"
63Show version number
64.SH "SEE ALSO"
65
66.PP
67babeltrace(1), lttng-sessiond(8), lttng-ust(3), lttng(1)
68.PP
69
70.SH "LIMITATIONS"
71
72.PP
73For now only TCP is supported on both control and data port.
74Control will always remain TCP-only since it is low-volume and needs absolutely
75to be reliable, but eventually the data connection could support UDP.
76
77For unprivileged user running lttng-relayd, the maximum number of file
78descriptors per process is usually 1024. This limits the number of connections
79and tracefiles opened. This limit can be configured see ulimit(3).
80.PP
81
82.SH "BUGS"
83
84.PP
85No show stopper bugs are known yet in this version.
86
87If you encounter any issues or usability problem, please report it on our
88mailing list <lttng-dev@lists.lttng.org> to help improve this project.
89.SH "CREDITS"
90
91.PP
92lttng-relayd is distributed under the GNU General Public License version 2. See the
93file COPYING for details.
94.PP
95A Web site is available at http://lttng.org for more information on the LTTng
96project.
97.PP
98You can also find our git tree at http://git.lttng.org.
99.PP
100Mailing lists for support and development: <lttng-dev@lists.lttng.org>.
101.PP
102You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
103.PP
104.SH "AUTHORS"
105
106.PP
107lttng-relay was originally written by Julien Desfossez and
108David Goulet. More people have since contributed to it. It is currently
109maintained by Julien Desfossez <jdesfossez@efficios.com>.
110.PP
This page took 0.039738 seconds and 4 git commands to generate.