doc/man/lttng-disable-event.1.txt

   1 lttng-disable-event(1)
   2 ======================
   3 :revdate: 3 May 2021
   4
   5
   6 NAME
   7 ----
   8 lttng-disable-event - Disable LTTng recording event rules
   9
  10
  11 SYNOPSIS
  12 --------
  13 Disable one or more recording event rules matching Linux kernel
  14 events:
  15
  16 [verse]
  17 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *disable-event* option:--kernel
  18       [option:--tracepoint | option:--syscall | option:--probe | option:--function]
  19       (option:--all-events | 'NAME'[,'NAME']...)
  20       [option:--session='SESSION'] [option:--channel='CHANNEL']
  21
  22 Disable one or more recording event rules matching user space
  23 tracepoint or Java/Python logging events:
  24
  25 [verse]
  26 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *disable-event*
  27       (option:--userspace | option:--jul | option:--log4j | option:--python) [option:--tracepoint]
  28       (option:--all-events | 'NAME'[,'NAME']...)
  29       [option:--session='SESSION'] [option:--channel='CHANNEL']
  30
  31
  32 DESCRIPTION
  33 -----------
  34 The `lttng disable-event` command disables one or more enabled recording
  35 event rules previously created with the man:lttng-enable-event(1)
  36 command which belong to:
  37
  38 With the option:--session='SESSION' option::
  39     The tracing session named 'SESSION'.
  40
  41 Without the option:--session option::
  42     The current tracing session (see man:lttng-concepts(7) to learn more
  43     about the current tracing session).
  44
  45 With the option:--channel='CHANNEL' option::
  46     The channel named 'CHANNEL'.
  47
  48 Without the option:--channel option::
  49     The channel named `channel0`.
  50
  51 See man:lttng-concepts(7) to learn more about recording event rules.
  52
  53 As of LTTng{nbsp}{lttng_version}, the `disable-event` command can only
  54 find recording event rules to disable by their instrumentation point
  55 type and event name conditions. Therefore, you cannot disable recording
  56 event rules having a specific instrumentation point log level condition,
  57 for example.
  58
  59 With the option:--kernel option and no instrumentation point type
  60 condition option, the `disable-event` command disables one or more Linux
  61 kernel recording event rules regardless of their instrumentation point
  62 type.
  63
  64 List the recording event rules of a given tracing session
  65 and/or channel with the man:lttng-list(1) command.
  66
  67 Without the option:--all-events option, the `disable-event` command
  68 disables one recording event rule per 'NAME' argument. 'NAME' is the
  69 exact event name condition pattern of the recording event rule to
  70 disable, as listed in the output of `lttng list` (see
  71 man:lttng-list(1)).
  72
  73 You may disable an enabled recording event rule regardless of the
  74 activity (started or stopped) of its tracing session (see
  75 man:lttng-start(1) and man:lttng-stop(1)).
  76
  77
  78 include::common-lttng-cmd-options-head.txt[]
  79
  80
  81 Tracing domain
  82 ~~~~~~~~~~~~~~
  83 One of:
  84
  85 option:-j, option:--jul::
  86     Disable recording event rules in the `java.util.logging` (JUL)
  87     domain.
  88
  89 option:-k, option:--kernel::
  90     Disable recording event rules in the Linux kernel domain.
  91
  92 option:-l, option:--log4j::
  93     Disable recording event rules in the Apache log4j domain.
  94
  95 option:-p, option:--python::
  96     Disable recording event rules in the Python domain.
  97
  98 option:-u, option:--userspace::
  99     Disable recording event rules in the user space tracing domain.
 100
 101
 102 Recording target
 103 ~~~~~~~~~~~~~~~~
 104 option:-c 'CHANNEL', option:--channel='CHANNEL'::
 105     Disable recording event rules attached to the channel named
 106     'CHANNEL' instead of `channel0`.
 107
 108 option:-s 'SESSION', option:--session='SESSION'::
 109     Disable recording event rules in the tracing session named 'SESSION'
 110     instead of the current tracing session.
 111
 112
 113 Instrumentation point type condition
 114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 115 At most one of:
 116
 117 option:--function::
 118     Only disable recording event rules which match Linux kretprobe
 119     events.
 120 +
 121 Only available with the option:--kernel option.
 122
 123 option:--probe::
 124     Only disable recording event rules which match Linux kprobe events.
 125 +
 126 Only available with the option:--kernel option.
 127
 128 option:--syscall::
 129     Only disable recording event rules which match Linux system call
 130     events.
 131 +
 132 Only available with the option:--kernel option.
 133
 134 option:--tracepoint::
 135     Only disable recording event rules which match:
 136 +
 137 --
 138 With the option:--kernel or option:--userspace option:::
 139     LTTng tracepoint events.
 140 With the option:--jul, option:--log4j, or option:--python option:::
 141     Logging events.
 142 --
 143
 144
 145 Event name condition
 146 ~~~~~~~~~~~~~~~~~~~~
 147 option:-a, option:--all-events::
 148     Disable recording event rules regardless of their event name
 149     condition.
 150
 151
 152 include::common-lttng-cmd-help-options.txt[]
 153
 154
 155 include::common-lttng-cmd-after-options.txt[]
 156
 157
 158 include::common-footer.txt[]
 159
 160
 161 SEE ALSO
 162 --------
 163 man:lttng(1),
 164 man:lttng-enable-event(1),
 165 man:lttng-list(1),
 166 man:lttng-concepts(7)