X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-disable-event.1.txt;h=da6eb2d21e4a606abe381f82cf4d181f5f7865a8;hb=e971184584781f70bbbfc52bbede8b9abf0436e5;hp=1fdeba1988c76e7c16fb599c1c79cc92f48b3531;hpb=d6b9e598b6552b2c855cae2fe734aa457e56cbed;p=lttng-tools.git diff --git a/doc/man/lttng-disable-event.1.txt b/doc/man/lttng-disable-event.1.txt index 1fdeba198..da6eb2d21 100644 --- a/doc/man/lttng-disable-event.1.txt +++ b/doc/man/lttng-disable-event.1.txt @@ -1,6 +1,6 @@ lttng-disable-event(1) ====================== -:revdate: 3 May 2021 +:revdate: 14 June 2021 NAME @@ -36,17 +36,20 @@ event rules previously created with the man:lttng-enable-event(1) command which belong to: With the option:--session='SESSION' option:: - The tracing session named 'SESSION'. + The recording session named 'SESSION'. Without the option:--session option:: - The current tracing session (see man:lttng-concepts(7) to learn more - about the current tracing session). + The current recording session (see man:lttng-concepts(7) to learn + more about the current recording session). With the option:--channel='CHANNEL' option:: The channel named 'CHANNEL'. Without the option:--channel option:: The channel named `channel0`. ++ +If there's more than one channel for the selected recording session and +domain, the `disable-event` command fails. See man:lttng-concepts(7) to learn more about recording event rules. @@ -61,7 +64,7 @@ condition option, the `disable-event` command disables one or more Linux kernel recording event rules regardless of their instrumentation point type. -List the recording event rules of a given tracing session +List the recording event rules of a given recording session and/or channel with the man:lttng-list(1) command. Without the option:--all-events option, the `disable-event` command @@ -71,9 +74,11 @@ disable, as listed in the output of `lttng list` (see man:lttng-list(1)). You may disable an enabled recording event rule regardless of the -activity (started or stopped) of its tracing session (see +activity (started or stopped) of its recording session (see man:lttng-start(1) and man:lttng-stop(1)). +See the ``<>'' section below for usage examples. + include::common-lttng-cmd-options-head.txt[] @@ -106,8 +111,8 @@ option:-c 'CHANNEL', option:--channel='CHANNEL':: 'CHANNEL' instead of `channel0`. option:-s 'SESSION', option:--session='SESSION':: - Disable recording event rules in the tracing session named 'SESSION' - instead of the current tracing session. + Disable recording event rules in the recording session named + 'SESSION' instead of the current recording session. Instrumentation point type condition @@ -155,6 +160,50 @@ include::common-lttng-cmd-help-options.txt[] include::common-lttng-cmd-after-options.txt[] +[[examples]] +EXAMPLES +-------- +.Disable all Linux kernel tracepoint recording event rules in the default channel of the current recording session. +==== +See the option:--all-events option. + +[role="term"] +---- +$ lttng disable-event --kernel --tracepoint --all-events +---- +==== + +.Disable specific Apache log4j recording event rules in the default channel of a specific recording session. +==== +See the option:--session option. + +[role="term"] +---- +$ lttng disable-event --session=my-session --log4j \ + MySingleton,MyProxy,MyFacade +---- +==== + +.Disable all user space recording event rules in a specific channel of the current recording session. +==== +See the option:--channel option. + +[role="term"] +---- +$ lttng disable-event --channel=my-channel --userspace \ + --all-events +---- +==== + +.Disable specific Linux kernel system call recording event rules in the default channel of the current recording session. +==== +[role="term"] +---- +$ lttng disable-event --kernel --syscall pipe2,eventfd +---- +==== + + include::common-footer.txt[]