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 List the recording event rules of a given tracing session
  60 and/or channel with the man:lttng-list(1) command.
  61
  62 Without the option:--all-events option, the `disable-event` command
  63 disables one recording event rule per 'NAME' argument. 'NAME' is the
  64 exact event name condition pattern of the recording event rule to
  65 disable, as listed in the output of `lttng list` (see
  66 man:lttng-list(1)).
  67
  68 You may disable an enabled recording event rule regardless of the
  69 activity (started or stopped) of its tracing session (see
  70 man:lttng-start(1) and man:lttng-stop(1)).
  71
  72
  73 include::common-cmd-options-head.txt[]
  74
  75
  76 Tracing domain
  77 ~~~~~~~~~~~~~~
  78 One of:
  79
  80 option:-j, option:--jul::
  81     Disable recording event rules in the `java.util.logging` (JUL)
  82     domain.
  83
  84 option:-k, option:--kernel::
  85     Disable recording event rules in the Linux kernel domain.
  86
  87 option:-l, option:--log4j::
  88     Disable recording event rules in the Apache log4j domain.
  89
  90 option:-p, option:--python::
  91     Disable recording event rules in the Python domain.
  92
  93 option:-u, option:--userspace::
  94     Disable recording event rules in the user space tracing domain.
  95
  96
  97 Recording target
  98 ~~~~~~~~~~~~~~~~
  99 option:-c 'CHANNEL', option:--channel='CHANNEL'::
 100     Disable recording event rules attached to the channel named
 101     'CHANNEL' instead of `channel0`.
 102
 103 option:-s 'SESSION', option:--session='SESSION'::
 104     Disable recording event rules in the tracing session named 'SESSION'
 105     instead of the current tracing session.
 106
 107
 108 Instrumentation point type condition
 109 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 110 At most one of:
 111
 112 option:--function::
 113     Only disable recording event rules which match Linux kretprobe
 114     events.
 115 +
 116 Only available with the option:--kernel option.
 117
 118 option:--probe::
 119     Only disable recording event rules which match Linux kprobe events.
 120 +
 121 Only available with the option:--kernel option.
 122
 123 option:--syscall::
 124     Only disable recording event rules which match Linux system call
 125     events.
 126 +
 127 Only available with the option:--kernel option.
 128
 129 option:--tracepoint::
 130     Only disable recording event rules which match:
 131 +
 132 --
 133 With the option:--kernel or option:--userspace option:::
 134     LTTng tracepoint events.
 135 With the option:--jul, option:--log4j, or option:--python option:::
 136     Logging events.
 137 --
 138 +
 139 As of LTTng{nbsp}{lttng_version}, this is the default instrumentation
 140 point type condition option, but this may change in the future.
 141
 142
 143 Event name condition
 144 ~~~~~~~~~~~~~~~~~~~~
 145 option:-a, option:--all-events::
 146     Disable recording event rules regardless of their event name
 147     condition.
 148
 149
 150 include::common-cmd-help-options.txt[]
 151
 152
 153 include::common-cmd-footer.txt[]
 154
 155
 156 SEE ALSO
 157 --------
 158 man:lttng(1),
 159 man:lttng-concepts(7),
 160 man:lttng-enable-event(1),
 161 man:lttng-list(1)