Deprecate lttng-health-check.3 man page

[lttng-tools.git] / doc / man / lttng-sessiond.8

diff --git a/doc/man/lttng-sessiond.8 b/doc/man/lttng-sessiond.8
index 00656d21a45a9b66a3af5a5cee8e7788f79276ea..347bffcaa3ed980e8fdb920582654945bf45b3c9 100644 (file)
--- a/doc/man/lttng-sessiond.8
+++ b/doc/man/lttng-sessiond.8
@@ -1,7 +1,7 @@
 .TH "LTTNG-SESSIOND" "8" "January 31, 2012" "" ""
 
 .SH "NAME"
 .TH "LTTNG-SESSIOND" "8" "January 31, 2012" "" ""
 
 .SH "NAME"

-lttng-sessiond \(em LTTng 2.0 central tracing registry session daemon.
+lttng-sessiond \(em LTTng 2.x central tracing registry session daemon.

 
 .SH "SYNOPSIS"
 
 
 .SH "SYNOPSIS"
 


@@ -20,7 +20,7 @@ systems is also possible.
 The session daemon, acting as a tracing registry, allow you to interact with
 multiple tracers (kernel and user-space) inside the same container, a tracing
 session. Trace can be gathered from the kernel and/or instrumented applications
 The session daemon, acting as a tracing registry, allow you to interact with
 multiple tracers (kernel and user-space) inside the same container, a tracing
 session. Trace can be gathered from the kernel and/or instrumented applications

-(lttng-ust(3)). Aggregating those traces is done using a viewer, like the 
+(lttng-ust(3)). Aggregating those traces is done using a viewer, like the

 babeltrace(1) text viewer.
 
 In order to trace the kernel, the session daemon needs to be running as root.
 babeltrace(1) text viewer.
 
 In order to trace the kernel, the session daemon needs to be running as root.


@@ -132,11 +132,34 @@ Specifiy the 32-bit library path containing libconsumer.so.
 .IP "LTTNG_DEBUG_NOCLONE"
 Debug-mode disabling use of clone/fork. Insecure, but required to allow
 debuggers to work with sessiond on some operating systems.
 .IP "LTTNG_DEBUG_NOCLONE"
 Debug-mode disabling use of clone/fork. Insecure, but required to allow
 debuggers to work with sessiond on some operating systems.

+.IP "LTTNG_APP_SOCKET_TIMEOUT"
+Control the timeout of application's socket when sending and receiving
+commands. Takes an integer parameter: the timeout value, in seconds.
+After this period of time, the application is unregistered by the
+session daemon. A value of 0 or -1 means an infinite timeout. Default
+value is 5 seconds.
+.IP "LTTNG_NETWORK_SOCKET_TIMEOUT"
+Control timeout of socket connection, receive and send. Takes an integer
+parameter: the timeout value, in milliseconds. A value of 0 or -1 uses
+the timeout of the operating system (this is the default).

 .SH "SEE ALSO"
 
 .PP
 babeltrace(1), lttng-ust(3), lttng(1)
 .PP
 .SH "SEE ALSO"
 
 .PP
 babeltrace(1), lttng-ust(3), lttng(1)
 .PP

+
+.SH "LIMITATIONS"
+
+.PP
+For unprivileged user running lttng-sessiond, the maximum number of file
+descriptors per process is usually 1024. This limits the number of traceable
+applications since for each instrumented application there is two file
+descriptors per-CPU and one more socktet for bidirectional communication.
+
+For the root user, the limit is bumped to 65535. Future version will deal with
+this limitation.
+.PP
+

 .SH "BUGS"
 
 .PP
 .SH "BUGS"
 
 .PP


@@ -163,8 +186,8 @@ You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
 
 .PP
 Thanks to Yannick Brosseau without whom this project would never have been so
 
 .PP
 Thanks to Yannick Brosseau without whom this project would never have been so

-lean and mean! Also thanks to the Ericsson teams working on tracing which 
-helped us greatly with detailed bug reports and unusual test cases.
+lean and mean! Also thanks to the Ericsson teams working on tracing which helped
+us greatly with detailed bug reports and unusual test cases.

 
 Thanks to our beloved packager Alexandre Montplaisir-Goncalves (Ubuntu and PPA
 maintainer) and Jon Bernard for our Debian packages.
 
 Thanks to our beloved packager Alexandre Montplaisir-Goncalves (Ubuntu and PPA
 maintainer) and Jon Bernard for our Debian packages.