X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng.1;h=7aef3d57a4cd88e5adfafecc637243a042e190ea;hb=10b56aefc3e1de5cee607994f64c3b8a7d85c391;hp=25e16d934af1de8489903f791c01f799f53695c1;hpb=c695a7bb3fb1e13c36e13c2bcc31fda86ff5223d;p=lttng-tools.git diff --git a/doc/man/lttng.1 b/doc/man/lttng.1 index 25e16d934..7aef3d57a 100644 --- a/doc/man/lttng.1 +++ b/doc/man/lttng.1 @@ -590,11 +590,7 @@ Dynamic function entry/return probe. Addr and offset can be octal (0NNN...), decimal (NNN...) or hexadecimal (0xNNN...) .TP .BR "\-\-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. Also note -that per-syscall selection is not supported yet. Use with "-a" to enable -all syscalls. +System call event. .TP .BR "\-\-filter 'expression'" Set a filter on a newly enabled event. Filter expression on event @@ -611,6 +607,7 @@ Expression examples: 'intfield > 500 && intfield < 503' '(strfield == "test" || intfield != 10) && intfield > 33' 'doublefield > 1.1 && intfield < 5.3' + 'enumfield == 1234' .fi Wildcards are allowed at the end of strings: @@ -618,7 +615,8 @@ Wildcards are allowed at the end of strings: In string literals, the escape character is a '\\'. Use '\\*' for the '*' character, and '\\\\' for the '\\' character sequence. Wildcard matches any sequence of characters, including an empty sub-string -(matches 0 or more characters). +(matches 0 or more characters). Enumeration fields can currently only be +compared as integers. Context information can be used for filtering. The examples below shows usage of context filtering on the process name (using a wildcard), process ID @@ -681,7 +679,7 @@ Apply for the user-space tracer .PP .PP -\fBdisable-event\fP NAME[,NAME2,...] (\-k | \-u) [OPTIONS] +\fBdisable-event\fP NAME[,NAME2,...] (\-k | \-u | \-j | \-l | \-p) [TYPE] [OPTIONS] .RS Disable tracing event @@ -711,8 +709,8 @@ Apply on session name Apply on channel name .TP .BR "\-a, \-\-all-events" -Disable all events. This does NOT disable "*" but rather every known -events of the session. +Disable all events. This does NOT ONLY disable "*" but rather every known +events of the session .TP .BR "\-k, \-\-kernel" Apply for the kernel tracer @@ -727,7 +725,26 @@ Apply for Java application using Java Util Logging interface (JUL) Apply for Java application using LOG4J .TP .BR "\-p, \-\-python" -Apply for Python application using the logging module. +Apply for Python application using the logging module + +.TP +.B TYPE (kernel domain only): + +.TP +.BR "\-\-all" +Disable event of all type +.TP +.BR "\-\-tracepoint" +Disable event of type tracepoint +.TP +.BR "\-\-syscall" +Disable event of type syscall +.TP +.BR "\-\-probe" +Disable event of type probe +.TP +.BR "\-\-function" +Disable event of type function .RE .PP @@ -1088,6 +1105,82 @@ Simple listing of options .RE .PP +.PP +\fBuntrack\fP (-k | -u) --pid [PID1[,PID2[,...]]] [OPTIONS] +.RS +Removes one or more entries from a tracker + +See the \fBtrack\fP command's documentation to learn more about LTTng +trackers. + +The \fBuntrack\fP command removes specific resources from a tracker. The +resources to remove must have been precedently added by the +\fBtrack\fP command. It is also possible to remove all the resources +from the whitelist using the \fB\-\-all\fR option. + +As of this version, the only available tracker is the \fBPID tracker\fP. + +One common operation is to create a tracing session, remove all the entries +from the PID tracker whitelist, start tracing, and then manually track PIDs +while tracing is active. + +Assume the maximum PID is 7 for the following examples: + +.nf + $ lttng create + + Initial whitelist: [0] [1] [2] [3] [4] [5] [6] [7] + + $ lttng untrack --userspace --pid --all + + Whitelist: [ ] [ ] [ ] [ ] [ ] [ ] [ ] [ ] + + $ lttng enable-event --userspace ... + $ lttng start + ... + $ lttng track --userspace --pid 3,5 + + Whitelist: [ ] [ ] [ ] [3] [ ] [5] [ ] [ ] + + $ lttng track --userspace --pid 2 + + Whitelist: [ ] [ ] [2] [3] [ ] [5] [ ] [ ] +.fi + +See the \fBtrack\fR command's documentation for more details about +adding entries. + +.B OPTIONS: + +.TP +.BR "\-s, \-\-session NAME" +Apply to session name. +.TP +.BR "\-k, \-\-kernel" +Apply to the kernel tracer. +.TP +.BR "\-u, \-\-userspace" +Apply to the user space tracer. +.TP +.BR "\-p, \-\-pid [PIDS]" +Stop tracking process IDs PIDS (remove from whitelist). + +PIDS is a comma-separated list of PIDs to remove from the PID tracker. + +The PIDS argument must be omitted when also using the \fB\-\-all\fP option. +.TP +.BR "\-a, \-\-all" +Used in conjunction with an empty \fB\-\-pid\fP option: stop tracking all +process IDs (remove all entries from whitelist). +.TP +.BR "\-h, \-\-help" +Show summary of possible options and commands. +.TP +.BR "\-\-list-options" +Simple listing of options +.RE +.PP + .PP \fBversion\fP .RS