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