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

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