lttng-disable-event(1)
======================
-:revdate: 28 November 2016
+:revdate: 14 June 2021
NAME
----
-lttng-disable-event - Disable LTTng event rules
+lttng-disable-event - Disable LTTng recording event rules
SYNOPSIS
--------
+Disable one or more recording event rules matching Linux kernel
+events:
+
+[verse]
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *disable-event* option:--kernel
+ [option:--tracepoint | option:--syscall | option:--probe | option:--function]
+ (option:--all-events | 'NAME'[,'NAME']...)
+ [option:--session='SESSION'] [option:--channel='CHANNEL']
+
+Disable one or more recording event rules matching user space
+tracepoint or Java/Python logging events:
+
[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *disable-event*
- (option:--kernel [option:--probe | option:--function | option:--syscall] |
- option:--userspace | option:--jul | option:--log4j | option:--python)
+ (option:--userspace | option:--jul | option:--log4j | option:--python) [option:--tracepoint]
+ (option:--all-events | 'NAME'[,'NAME']...)
[option:--session='SESSION'] [option:--channel='CHANNEL']
- (option:--all-events | 'EVENT'[,'EVENT']...)
+
DESCRIPTION
-----------
-The `lttng disable-event` command disables one or more event rules
-previously enabled by the man:lttng-enable-event(1) command.
+The `lttng disable-event` command disables one or more enabled recording
+event rules previously created with the man:lttng-enable-event(1)
+command which belong to:
+
+With the option:--session='SESSION' option::
+ The recording session named 'SESSION'.
+
+Without the option:--session option::
+ 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'.
-Event rules are always assigned to a channel when they are created. If
-the option:--channel option is omitted, the default channel named
-`channel0` is used.
+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.
-If the option:--session option is omitted, the chosen channel is picked
-from the current tracing session.
+See man:lttng-concepts(7) to learn more about recording event rules.
-If the option:--all-events option is used, all the existing event rules
-of the chosen domain are disabled. Otherwise, at least one event rule
-to disable named 'EVENT' must be specified.
+As of LTTng{nbsp}{lttng_version}, the `disable-event` command can only
+find recording event rules to disable by their instrumentation point
+type and event name conditions. Therefore, you cannot disable recording
+event rules having a specific instrumentation point log level condition,
+for example.
-With the option:--kernel option, the event source type can be specified
-using one of the option:--tracepoint, option:--probe,
-option:--function, or option:--syscall options. See
-man:lttng-enable-event(1) for more details about event source
-types.
+With the option:--kernel option and no instrumentation point type
+condition option, the `disable-event` command disables one or more Linux
+kernel recording event rules regardless of their instrumentation point
+type.
-Events can be disabled while tracing is active
-(use man:lttng-start(1) to make a tracing session active).
+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
+disables one recording event rule per 'NAME' argument. 'NAME' is the
+exact event name condition pattern of the recording event rule to
+disable, as listed in the output of `lttng list` (see
+man:lttng-list(1)).
-include::common-cmd-options-head.txt[]
+You may disable an enabled recording event rule regardless of the
+activity (started or stopped) of its recording session (see
+man:lttng-start(1) and man:lttng-stop(1)).
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
-Domain
-~~~~~~
+
+include::common-lttng-cmd-options-head.txt[]
+
+
+Tracing domain
+~~~~~~~~~~~~~~
One of:
option:-j, option:--jul::
- Disable event rules in the `java.util.logging` (JUL) domain.
+ Disable recording event rules in the `java.util.logging` (JUL)
+ domain.
option:-k, option:--kernel::
- Disable event rules in the Linux kernel domain.
+ Disable recording event rules in the Linux kernel domain.
option:-l, option:--log4j::
- Disable event rules in the Apache log4j domain.
+ Disable recording event rules in the Apache log4j domain.
option:-p, option:--python::
- Disable event rules in the Python domain.
+ Disable recording event rules in the Python domain.
option:-u, option:--userspace::
- Disable event rules in the user space domain.
+ Disable recording event rules in the user space tracing domain.
-Target
-~~~~~~
+Recording target
+~~~~~~~~~~~~~~~~
option:-c 'CHANNEL', option:--channel='CHANNEL'::
- Disable event rules in the channel named 'CHANNEL' instead
- of the default channel name `channel0`.
+ Disable recording event rules attached to the channel named
+ 'CHANNEL' instead of `channel0`.
option:-s 'SESSION', option:--session='SESSION'::
- Disable 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.
-Event source type
-~~~~~~~~~~~~~~~~~
-One of:
+Instrumentation point type condition
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+At most one of:
option:--function::
- Linux kernel kretprobe. Only available with the option:--kernel
- domain option.
+ Only disable recording event rules which match Linux kretprobe
+ events.
++
+Only available with the option:--kernel option.
option:--probe::
- Linux kernel kprobe. Only available with the option:--kernel
- domain option.
+ Only disable recording event rules which match Linux kprobe events.
++
+Only available with the option:--kernel option.
option:--syscall::
- Linux kernel system call. Only available with the option:--kernel
- domain option.
+ Only disable recording event rules which match Linux system call
+ events.
++
+Only available with the option:--kernel option.
option:--tracepoint::
- Linux kernel or application tracepoint. Only available
- with the option:--kernel domain option (default Linux kernel
- domain event source type).
+ Only disable recording event rules which match:
++
+--
+With the option:--kernel or option:--userspace option:::
+ LTTng tracepoint events.
+With the option:--jul, option:--log4j, or option:--python option:::
+ Logging events.
+--
+
+
+Event name condition
+~~~~~~~~~~~~~~~~~~~~
+option:-a, option:--all-events::
+ Disable recording event rules regardless of their event name
+ condition.
-Disabling
-~~~~~~~~~
-option:-a, option:--all-events::
- Disable all enabled event rules in the chosen tracing session,
- tracing domain, and channel.
+include::common-lttng-cmd-help-options.txt[]
+
+
+include::common-lttng-cmd-after-options.txt[]
-include::common-cmd-help-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-cmd-footer.txt[]
+include::common-footer.txt[]
SEE ALSO
--------
+man:lttng(1),
man:lttng-enable-event(1),
-man:lttng(1)
+man:lttng-list(1),
+man:lttng-concepts(7)
projects / lttng-tools.git / blobdiff