Man page fixes: missing --version option and typo
[lttng-tools.git] / doc / man / lttng-relayd.8
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
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.
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 follows the usual GNU command line syntax with long options starting
43 with 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, \-\-version"
51 Show version.
52 .TP
53 .BR "-v, --verbose"
54 Increase verbosity
55
56 There is three debugging level which will print on stderr. Maximum verbosity is
57 \fB-vvv\fP.
58 .TP
59 .BR "-d, --daemonize"
60 Start as a daemon
61 .TP
62 .BR "-b, --background"
63 Start as a daemon, keeping console open
64 .TP
65 .BR "-g, --group NAME"
66 Specify the tracing group name. (default: tracing)
67 .TP
68 .BR "-C, --control-port"
69 Control port URL (tcp://0.0.0.0:5342 is the default)
70 .TP
71 .BR "-D, --data-port"
72 Data port URL (tcp://0.0.0.0:5343 is the default)
73 .TP
74 .BR "-L, --live-port URL"
75 Live view port URL (tcp://localhost:5344 is the default).
76 .TP
77 .BR "-o, --output"
78 Output base directory. Must use an absolute path (~/lttng-traces is the default)
79 .TP
80 .BR "-V, --version"
81 Show version number
82 .SH "ENVIRONMENT VARIABLES"
83
84 .PP
85 .IP "LTTNG_NETWORK_SOCKET_TIMEOUT"
86 Control timeout of socket connection, receive and send. Takes an integer
87 parameter: the timeout value, in milliseconds. A value of 0 or -1 uses
88 the timeout of the operating system (this is the default).
89 .IP "LTTNG_RELAYD_HEALTH"
90 File path used for relay daemon health check communication.
91 .PP
92
93 .SH "SEE ALSO"
94
95 .PP
96 babeltrace(1), lttng-sessiond(8), lttng-ust(3), lttng(1)
97 .PP
98
99 .SH "LIMITATIONS"
100
101 .PP
102 For now only TCP is supported on both control and data port.
103 Control will always remain TCP-only since it is low-volume and needs absolutely
104 to be reliable, but eventually the data connection could support UDP.
105
106 For unprivileged user running lttng-relayd, the maximum number of file
107 descriptors per process is usually 1024. This limits the number of connections
108 and tracefiles opened. This limit can be configured see ulimit(3).
109 .PP
110
111 .SH "BUGS"
112
113 .PP
114 No show stopper bugs are known yet in this version.
115
116 If you encounter any issues or usability problem, please report it on our
117 mailing list <lttng-dev@lists.lttng.org> to help improve this project.
118 .SH "CREDITS"
119
120 .PP
121 lttng-relayd is distributed under the GNU General Public License version 2. See the
122 file COPYING for details.
123 .PP
124 A Web site is available at http://lttng.org for more information on the LTTng
125 project.
126 .PP
127 You can also find our git tree at http://git.lttng.org.
128 .PP
129 Mailing lists for support and development: <lttng-dev@lists.lttng.org>.
130 .PP
131 You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
132 .PP
133 .SH "AUTHORS"
134
135 .PP
136 lttng-relay was originally written by Julien Desfossez and
137 David Goulet. More people have since contributed to it. It is currently
138 maintained by Julien Desfossez <jdesfossez@efficios.com>.
139 .PP
This page took 0.044272 seconds and 4 git commands to generate.