X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng.1;h=f773e61f89b7659ad95a5f2a8d9645d3c1ff0864;hp=9884862febbc42bf5a79c4bf17a87a59ddc841a4;hb=c56509420616421ef4f6fff53e1cf09f3ccd56b7;hpb=fa072eae902cbc001ec8406d52a3a6903eb77441 diff --git a/doc/man/lttng.1 b/doc/man/lttng.1 index 9884862fe..f773e61f8 100644 --- a/doc/man/lttng.1 +++ b/doc/man/lttng.1 @@ -1,7 +1,7 @@ -.TH "LTTNG" "1" "February 9, 2012" "" "" +.TH "LTTNG" "1" "December 3rd, 2012" "" "" .SH "NAME" -lttng \(em LTTng 2.0 tracer control command line tool +lttng \(em LTTng 2.1.x tracer control command line tool .SH "SYNOPSIS" @@ -23,11 +23,18 @@ be done by this tool or by the liblttng-ctl provided with the lttng-tools package. LTTng uses a session daemon (lttng-sessiond(8)), acting as a tracing registry, -which permits you to interact with multiple tracers (kernel and user-space) +which allows you to interact with multiple tracers (kernel and user-space) inside the same container, a tracing session. Traces can be gathered from the kernel and/or instrumented applications (lttng-ust(3)). Aggregating and reading those traces is done using the babeltrace(1) text viewer. +We introduce the notion of \fBtracing domains\fP which is essentially a type of +tracer (kernel or user space for now). In the future, we could see a third +tracer being for instance an hypervisor. For some commands, you'll need to +specify on which domain the command applies (-u or -k). For instance, enabling +a kernel event, you must specify the kernel domain to the command so we know +for which tracer this event is for. + In order to trace the kernel, the session daemon needs to be running as root. LTTng provides the use of a \fBtracing group\fP (default: tracing). Whomever is in that group can interact with the root session daemon and thus trace the @@ -53,7 +60,7 @@ Show summary of possible options and commands. .TP .BR "\-v, \-\-verbose" Increase verbosity. -Three levels of verbosity are available which are triggered by putting additionnal v to +Three levels of verbosity are available which are triggered by putting additional v to the option (\-vv or \-vvv) .TP .BR "\-q, \-\-quiet" @@ -65,7 +72,7 @@ Set unix tracing group name. (default: tracing) .BR "\-n, \-\-no-sessiond" Don't automatically spawn a session daemon. .TP -.BR "\-\-sessiond\-path" +.BR "\-\-sessiond\-path PATH" Set session daemon full binary path. .TP .BR "\-\-list\-options" @@ -80,10 +87,10 @@ Simple listing of lttng commands. .nf Add context to event(s) and/or channel(s). -A context is basically extra information appended to a channel or event. For -instance, you could ask the tracer to add the PID information within the -"sched_switch" kernel event. You can also add performance monitoring unit -counters (perf PMU) using the perf kernel API). +A context is basically extra information appended to a channel. For instance, +you could ask the tracer to add the PID information for all events in a +channel. You can also add performance monitoring unit counters (perf PMU) using +the perf kernel API). For example, this command will add the context information 'prio' and two perf counters (hardware branch misses and cache misses), to all events in the trace @@ -94,9 +101,8 @@ data output: Please take a look at the help (\-h/\-\-help) for a detailed list of available contexts. -If no channel and no event is given (\-c/\-e), the context is added to all -channels (which applies automatically to all events in that channel). Otherwise -the context will be added only to the channel (\-c) and/or event (\-e) indicated. +If no channel is given (\-c), the context is added to all channels. Otherwise +the context will be added only to the given channel (\-c). If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc file. @@ -111,8 +117,6 @@ file. Apply on session name. \-c, \-\-channel NAME Apply on channel name. -\-e, \-\-event NAME - Apply on event name. \-k, \-\-kernel Apply for the kernel tracer \-u, \-\-userspace @@ -195,7 +199,7 @@ prefetch activity) to be accounted for. .IP -.IP "\fBcreate\fP [OPTIONS] [NAME] +.IP "\fBcreate\fP [NAME] [OPTIONS] .nf Create tracing session. @@ -221,6 +225,36 @@ $HOME/lttng-traces. Simple listing of options \-o, \-\-output PATH Specify output path for traces + +Using these options, each API call can be controlled individually. For +instance, \-C does not enable the consumer automatically. You'll need the \-e +option for that. + +\-U, \-\-set-uri=URL + Set URL for the enable-consumer destination. It is persistent for the + session lifetime. Redo the command to change it. This will set both + data and control URL for network. +\-C, \-\-ctrl-url=URL + Set control path URL. (Must use -D also) +\-D, \-\-data-url=URL + Set data path URL. (Must use -C also) + \-\-no-consumer + Don't activate a consumer for this session. + \-\-disable-consumer + Disable consumer for this session. + +See \fBenable-consumer\fP command below for the supported URL format. + +.B EXAMPLES: + +# lttng create -U net://192.168.1.42 +Uses TCP and default ports for the given destination. + +# lttng create -U net6://[fe80::f66d:4ff:fe53:d220] +Uses TCP, default ports and IPv6. + +# lttng create s1 -U net://myhost.com:3229 +Create session s1 and set its consumer to myhost.com on port 3229 for control. .fi .IP @@ -239,6 +273,8 @@ If NAME is omitted, the session name is taken from the .lttngrc file. .nf \-h, \-\-help Show summary of possible options and commands. +\-a, \-\-all + Destroy all sessions \-\-list-options Simple listing of options .fi @@ -249,6 +285,8 @@ If NAME is omitted, the session name is taken from the .lttngrc file. .nf Enable tracing channel +To enable event, you must first enable a channel which contains event(s). + If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc file. .fi @@ -260,7 +298,7 @@ file. Show this help \-\-list-options Simple listing of options -\-s, \-\-session +\-s, \-\-session NAME Apply on session name \-k, \-\-kernel Apply to the kernel tracer @@ -271,20 +309,96 @@ file. Discard event when subbuffers are full (default) \-\-overwrite Flight recorder mode : overwrites events when subbuffers are full -\-\-subbuf-size +\-\-subbuf-size SIZE Subbuffer size in bytes (default: 4096, kernel default: 262144) -\-\-num-subbuf - Number of subbufers (default: 4) +\-\-num-subbuf NUM + Number of subbuffers (default: 4) Needs to be a power of 2 for kernel and ust tracers -\-\-switch-timer +\-\-switch-timer USEC Switch subbuffer timer interval in usec (default: 0) Needs to be a power of 2 for kernel and ust tracers -\-\-read-timer +\-\-read-timer USEC Read timer interval in usec (default: 200) +\-\-output TYPE + Channel output type. Possible values: mmap, splice .fi .IP +.IP "\fBenable-consumer\fP [-u|-k] [URL] [OPTIONS]" +.nf +Enable a consumer for the tracing session and domain. + +By default, every tracing session has a consumer attached to it using the local +filesystem as output. The trace is written in $HOME/lttng-traces. This command +allows the user to specify a specific URL after the session was created for a +specific domain. If no domain is specified, the consumer is applied on all +domains. + +Without options, the behavior is to enable a consumer to the current URL. The +default URL is the local filesystem at the path of the session mentioned above. + +The enable-consumer feature supports both local and network transport. You must +have a running \fBlttng-relayd(8)\fP for network transmission or any other daemon +that can understand the streaming protocol of LTTng. +.fi + +.B OPTIONS: + +.nf +\-h, \-\-help + Show summary of possible options and commands. +\-\-list-options + Simple listing of options +\-s, \-\-session NAME + Apply on session name +\-k, \-\-kernel + Apply for the kernel tracer +\-u, \-\-userspace + Apply for the user-space tracer + +Using these options, each API call can be controlled individually. For +instance, \-C does not enable the consumer automatically. You'll need the \-e +option for that. + +\-U, \-\-set-uri=URL + Set URL for the enable-consumer destination. It is persistent for the + session lifetime. Redo the command to change it. This will set both + data and control URL for network. +\-C, \-\-ctrl-url=URL + Set control path URL. (Must use -D also) +\-D, \-\-data-url=URL + Set data path URL. (Must use -C also) +\-e, \-\-enable + Enable consumer + +.B URL FORMAT: + +proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH] + +Supported protocols are (proto): +> file://... + Local filesystem full path. + +> net://... + This will use the default network transport layer which is TCP for both + control (PORT1) and data port (PORT2). The default ports are + respectively 5342 and 5343. Note that net[6]:// is not yet supported. + +> tcp[6]://... + Can only be used with -C and -D together + +NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732) + +.B EXAMPLES: + +$ lttng enable-consumer -u net://192.168.1.42 + +Uses TCP and default ports for user space tracing (-u) where the IP address +above is the destination machine where the traces will be streamed and a +\fBlttng-relayd(8)\fP is listening. +.fi + .IP "\fBenable-event\fP NAME[,NAME2,...] [-k|-u] [OPTIONS]" .nf Enable tracing event @@ -305,12 +419,13 @@ file. Show summary of possible options and commands. \-\-list-options Simple listing of options -\-s, \-\-session +\-s, \-\-session NAME Apply on session name -\-c, \-\-channel +\-c, \-\-channel NAME Apply on channel name \-a, \-\-all - Enable all tracepoints and syscalls + Enable all tracepoints and syscalls. This actually enable a single + wildcard event "*". \-k, \-\-kernel Apply for the kernel tracer \-u, \-\-userspace @@ -323,8 +438,13 @@ file. e.g.: "*" "app_component:na*" -\-\-loglevel - Tracepoint loglevel +\-\-loglevel NAME + Tracepoint loglevel range from 0 to loglevel. Listed in the help (\-h). +\-\-loglevel-only NAME + Tracepoint loglevel (only this loglevel). + + The loglevel or loglevel-only options should be combined with a + tracepoint name or tracepoint wildcard. \-\-probe [addr | symbol | symbol+offset] Dynamic probe. Addr and offset can be octal (0NNN...), decimal (NNN...) or hexadecimal (0xNNN...) @@ -332,10 +452,29 @@ file. Dynamic function entry/return probe. Addr and offset can be octal (0NNN...), decimal (NNN...) or hexadecimal (0xNNN...) \-\-syscall - System call event - Enabling syscalls tracing (kernel tracer), you will not be able to disable them - with disable-event. This is a known limitation. You can disable the entire - channel to do the trick. + System call event. Enabling syscalls tracing (kernel tracer), you will + not be able to disable them with disable-event. This is a known + limitation. You can disable the entire channel to do the trick. + +\-\-filter 'expression' + Set a filter on a newly enabled event. Filter expression on event + fields, event recording depends on evaluation. Only specify on first + activation of a given event within a session. Filter only allowed when + enabling events within a session before tracing is started. If the + filter fails to link with the event within the traced domain, the event + will be discarded. Currently, filter is only implemented for the + user-space tracer. + + Expression examples: + + 'intfield > 500 && intfield < 503' + '(stringfield == "test" || intfield != 10) && intfield > 33' + 'doublefield > 1.1 && intfield < 5.3' + + Wildcards are allowed at the end of strings: + 'seqfield1 == "te*"' + In string literals, the escape character is a '\\'. Use '\\*' for + the '*' character, and '\\\\' for the '\\' character. .fi .IP "\fBdisable-channel\fP NAME[,NAME2,...] [\-k|\-u] [OPTIONS]" @@ -356,7 +495,29 @@ file. Show summary of possible options and commands. \-\-list-options Simple listing of options -\-s, \-\-session +\-s, \-\-session NAME + Apply on session name +\-k, \-\-kernel + Apply for the kernel tracer +\-u, \-\-userspace + Apply for the user-space tracer +.fi + +.IP "\fBdisable-consumer\fP [\-k|\-u] [OPTIONS]" +.nf +Disable the consumer of a tracing session. + +This call MUST be done BEFORE tracing has started. +.fi + +.B OPTIONS: + +.nf +\-h, \-\-help + Show summary of possible options and commands. +\-\-list-options + Simple listing of options +\-s, \-\-session NAME Apply on session name \-k, \-\-kernel Apply for the kernel tracer @@ -382,8 +543,11 @@ file. Show summary of possible options and commands. \-\-list-options Simple listing of options -\-s, \-\-session +\-s, \-\-session NAME Apply on session name +\-a, \-\-all-events + Disable all events. This does NOT disable "*" but rather + every known events of the session. \-k, \-\-kernel Apply for the kernel tracer \-u, \-\-userspace @@ -398,7 +562,7 @@ With no arguments, it will list available tracing session(s). With the session name, it will display the details of the session including the trace file path, the associated channels and their state (activated -and deactivated), the activated events and more. +and deactivated), the activated events and more. With \-k alone, it will list all available kernel events (except the system calls events). @@ -421,11 +585,12 @@ You can now enable any event listed by using the name : \-\-list-options Simple listing of options \-k, \-\-kernel - Select kernel domain (FIXME : apparition de la notion de "domain" ici) + Select kernel domain \-u, \-\-userspace Select user-space domain. -Session options: +.B SESSION OPTIONS: + \-c, \-\-channel NAME List details of a channel \-d, \-\-domain @@ -450,7 +615,7 @@ Will change the session name in the .lttngrc file. .IP -.IP "\fBstart\fP [OPTIONS] [NAME]" +.IP "\fBstart\fP [NAME] [OPTIONS]" .nf Start tracing @@ -470,11 +635,14 @@ If NAME is omitted, the session name is taken from the .lttngrc file. .IP -.IP "\fBstop\fP [OPTIONS] [NAME]" +.IP "\fBstop\fP [NAME] [OPTIONS]" .nf Stop tracing -It will stop tracing for all tracers for a specific tracing session. +It will stop tracing for all tracers for a specific tracing session. Before +returning, the command checks for data availability meaning that it will wait +until the trace is readable for the session. Use \-\-no-wait to avoid this +behavior. If NAME is omitted, the session name is taken from the .lttngrc file. .fi @@ -486,6 +654,8 @@ If NAME is omitted, the session name is taken from the .lttngrc file. Show summary of possible options and commands. \-\-list-options Simple listing of options +\-\-no-wait + Don't wait for data availability. .fi .IP @@ -533,6 +703,17 @@ If SESSION_NAME is omitted, the session name is taken from the .lttngrc file. to the arguments .fi +.SH "EXIT VALUES" +On success 0 is returned and a positive value on error. Value of 1 means a command +error, 2 an undefined command, 3 a fatal error and 4 a command warning meaning that +something went wrong during the command. + +Any other value above 10, please refer to +.BR +for a detailed list or use lttng_strerror() to get a human readable string of +the error code. + +.PP .SH "ENVIRONMENT VARIABLES" .PP @@ -540,21 +721,20 @@ Note that all command line options override environment variables. .PP .PP -.IP "LTTNG_SESSIOND_PATH_ENV" +.IP "LTTNG_SESSIOND_PATH" Allows one to specify the full session daemon binary path to lttng command line tool. You can also use \-\-sessiond-path option having the same effect. .SH "SEE ALSO" - -.PP -babeltrace(1), lttng-ust(3), lttng-sessiond(8) -.PP +.BR babeltrace(1), +.BR lttng-ust(3), +.BR lttng-sessiond(8), +.BR lttng-relayd(8), +.BR lttng-health-check(3) .SH "BUGS" -.PP -No show stopper bugs are known yet in this version. - If you encounter any issues or usability problem, please report it on our -mailing list to help improve this project. +mailing list to help improve this project or +at https://bugs.lttng.org which is a bugtracker. .SH "CREDITS" .PP