Key::
The long name of a command-line option to set (see the
- <<options,OPTIONS>> section below).
+ ``<<options,OPTIONS>>'' section below).
Value::
The selected command-line option accepts an argument:::
to be recorded to the event records of a given channel once its tracing
session has been started (see man:lttng-start(1)) at least once.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
include::common-lttng-cmd-options-head.txt[]
specifiers>>. The order of the action specifiers is significant: LTTng
attempts to execute the actions of a firing trigger in this order.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
List the triggers of your Unix user, or of all users if your
Unix user is `root`, with the man:lttng-list-triggers(1) command.
('ERSPEC' part).
+
Capture event record and context fields with one or more
-nloption:--capture options (see the <<capture-descr,Capture descriptor>>
-section below to learn more). When an `event-rule-matches` condition
-with capture descriptors is satisfied, the captured field values are
-available in the evaluation object of the condition using the
-liblttng-ctl C{nbsp}API.
+nloption:--capture options (see the ``<<capture-descr,Capture
+descriptor>>'' section below to learn more). When an
+`event-rule-matches` condition with capture descriptors is satisfied,
+the captured field values are available in the evaluation object of the
+condition using the liblttng-ctl C{nbsp}API.
+
IMPORTANT: Make sure to **single-quote** 'CDESCR' when you run the
`add-trigger` command from a shell, as capture descriptors can include
option:--condition='CONDTYPE'::
Introductory option for a condition specifier of type 'CONDTYPE'.
+
-See the <<cond-spec,Condition specifier>> section above to learn more.
+See the ``<<cond-spec,Condition specifier>>'' section above to learn
+more.
option:--action='ACTTYPE'::
Introductory option for an action specifier of type 'ACTTYPE'.
+
-See the <<action-spec,Action specifier>> section above to learn more.
+See the ``<<action-spec,Action specifier>>'' section above to learn
+more.
include::common-lttng-cmd-help-options.txt[]
sends tracing data over the network for the selected tracing session(s)
to an LTTng relay daemon configured as such, the `clear` command fails.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
include::common-lttng-cmd-options-head.txt[]
which, when executed, creates an LTTng _event_.
LTTng offers various types of instrumentation; see the
-<<inst-point-types,Instrumentation point types>> section below to learn
-about them.
+``<<inst-point-types,Instrumentation point types>>'' section below to
+learn about them.
An _event rule_ is a set of conditions to match a set of events.
evaluate the arguments of the instrumentation point.
In practice, LTTng implements various optimizations for the Linux kernel
-and user space tracing domains (see the <<domain,{sect-domain}>> section
-below) to avoid actually creating an event
-when the tracer knows, thanks to properties which are independent from
-the event payload and current context, that it would never emit such an
-event. Those properties are:
+and user space tracing domains (see the ``<<domain,{sect-domain}>>''
+section below) to avoid actually creating an event when the tracer
+knows, thanks to properties which are independent from the event payload
+and current context, that it would never emit such an event. Those
+properties are:
* The instrumentation point type (see the
- <<inst-point-types,Instrumentation point types>> section below).
+ ``<<inst-point-types,Instrumentation point types>>'' section below).
* The instrumentation point name.
* The instrumentation point log level.
* For a recording event rule (see the
- <<recording-event-rule,{sect-recording-event-rule}>> section
+ ``<<recording-event-rule,{sect-recording-event-rule}>>'' section
below):
** The status of the rule itself.
-** The status of the channel (see the <<channel,{sect-channel}>> section
- below).
+** The status of the channel (see the ``<<channel,{sect-channel}>>''
+ section below).
** The activity of the tracing session (started or stopped; see
- the <<session,{sect-session}>> section below).
+ the ``<<session,{sect-session}>>'' section below).
** Whether or not the process for which LTTng would create the event is
allowed to record events (see man:lttng-track(1)).
A specific type of event rule of which the action is to record the
matched event as an event record.
+
-See the <<recording-event-rule,{sect-recording-event-rule}>> section
+See the ``<<recording-event-rule,{sect-recording-event-rule}>>'' section
below.
+
Create or enable a recording event rule with the
* The instrumentation point from which LTTng creates{nbsp}__E__ has a
specific type.
+
-See the <<inst-point-types,Instrumentation point types>> section below.
+See the ``<<inst-point-types,Instrumentation point types>>'' section
+below.
* A pattern matches the name of{nbsp}__E__ while another pattern
doesn't.
satisfy a filter expression.
A recording event rule has additional, implicit conditions to satisfy.
-See the <<recording-event-rule,{sect-recording-event-rule}>> section
+See the ``<<recording-event-rule,{sect-recording-event-rule}>>'' section
below to learn more.
~~~~~~~~~~~~~~~~~~~~~~~~~~~
As of LTTng{nbsp}{lttng_version}, the available instrumentation point
types are, depending on the tracing domain (see the
-<<domain,{sect-domain}>> section below):
+``<<domain,{sect-domain}>>'' section below):
Linux kernel::
LTTng tracepoint:::
Conditions::
+
* The consumed buffer size of a given tracing
- session (see the <<session,{sect-session}>> section below)
+ session (see the ``<<session,{sect-session}>>'' section below)
becomes greater than some value.
* The buffer usage of a given channel (see the
- <<channel,{sect-channel}>> section below) becomes greater than some
- value.
+ ``<<channel,{sect-channel}>>'' section below) becomes greater than
+ some value.
* The buffer usage of a given channel becomes less than some value.
* There's an ongoing tracing session rotation (see the
- <<rotation,Tracing session rotation>> section below).
+ ``<<rotation,Tracing session rotation>>'' section below).
* A tracing session rotation becomes completed.
* Has its own state of activity (started or stopped).
+
An active tracing session is an implicit recording event rule condition
-(see the <<recording-event-rule,{sect-recording-event-rule}>> section
-below).
+(see the ``<<recording-event-rule,{sect-recording-event-rule}>>''
+section below).
* Has its own mode (local, network streaming, snapshot, or live).
+
-See the <<session-modes,Tracing session modes>> section below to learn
-more.
+See the ``<<session-modes,Tracing session modes>>'' section below to
+learn more.
-* Has its own channels (see the <<channel,{sect-channel}>> section
+* Has its own channels (see the ``<<channel,{sect-channel}>>'' section
below) to which are attached their own recording event rules.
* Has its own process attribute inclusion sets (see man:lttng-track(1)).
listening relay daemon (man:lttng-relayd(8)) when LTTng takes a
snapshot.
+
-LTTng forces all the channels (see the <<channel,{sect-channel}>>
+LTTng forces all the channels (see the ``<<channel,{sect-channel}>>''
section below) to be created to be configured to be snapshot-ready.
+
LTTng takes a snapshot of such a tracing session when:
* You run the man:lttng-snapshot(1) command.
* LTTng executes a `snapshot-session` trigger action (see the
- <<trigger,TRIGGER>> section above).
+ ``<<trigger,TRIGGER>>'' section above).
--
Live mode::
An _archived trace chunk_ is a collection of metadata and data stream
files which form a self-contained LTTng trace. See the
-<<trace-chunk-naming,Trace chunk naming>> section below to learn how
+``<<trace-chunk-naming,Trace chunk naming>>'' section below to learn how
LTTng names a trace chunk archive directory.
The _current trace chunk_ of a given tracing session includes:
** The first time the tracing session was started, either with the
man:lttng-start(1) command or with a `start-session` trigger action
- (see the <<trigger,TRIGGER>> section above).
+ (see the ``<<trigger,TRIGGER>>'' section above).
** The last rotation, performed with:
man:lttng-enable-rotation(1).
*** An executed `rotate-session` trigger action (see the
- <<trigger,TRIGGER>> section above).
+ ``<<trigger,TRIGGER>>'' section above).
* The content of all the non-flushed sub-buffers of the channels of the
tracing session.
using some man:lttng(1) commands to avoid ambiguity. For example,
because the Linux kernel and user space tracing domains support named
tracepoints as instrumentation points (see the
-<<"event-rule","{sect-event-rule}">> section above), you need to specify
-a tracing domain when you create an event rule because both tracing
-domains could have tracepoints sharing the same name.
+``<<"event-rule","{sect-event-rule}">>'' section above), you need to
+specify a tracing domain when you create an event rule because both
+tracing domains could have tracepoints sharing the same name.
-You can create channels (see the <<channel,{sect-channel}>> section
+You can create channels (see the ``<<channel,{sect-channel}>>'' section
below) in the Linux kernel and user space tracing domains. The other
tracing domains have a single, default channel.
Each ring buffer is divided into multiple _sub-buffers_. When a
recording event rule (see the
-<<recording-event-rule,{sect-recording-event-rule} section below)
+``<<recording-event-rule,{sect-recording-event-rule}>>'' section below)
matches an event, LTTng can record it to one or more sub-buffers of one
or more channels.
* Its buffering scheme.
+
-See the <<channel-buf-scheme,Buffering scheme>> section below.
+See the ``<<channel-buf-scheme,Buffering scheme>>'' section below.
* What to do when there's no
space left for a new event record because all sub-buffers are full.
+
-See the <<channel-er-loss-mode,Event record loss mode>> section below.
+See the ``<<channel-er-loss-mode,Event record loss mode>>'' section
+below.
* The size of each ring buffer and how many sub-buffers a ring buffer
has.
+
-See the <<channel-sub-buf-size-count,Sub-buffer size and count>> section
-below.
+See the ``<<channel-sub-buf-size-count,Sub-buffer size and count>>''
+section below.
* The size of each trace file LTTng writes for this channel and the
maximum count of trace files.
+
-See the <<channel-max-trace-file-size-count,Maximum trace file size and
-count>> section below.
+See the ``<<channel-max-trace-file-size-count,Maximum trace file size
+and count>>'' section below.
* The periods of its read, switch, and monitor timers.
+
-See the <<channel-timers,Timers>> section below.
+See the ``<<channel-timers,Timers>>'' section below.
* For a Linux kernel channel: its output type (man:mmap(2) or
man:splice(2)).
provided tracing domain.
A channel is always associated to a tracing domain (see the
-<<domain,{sect-domain}>> section below). The `java.util.logging` (JUL),
-log4j, and Python tracing domains each have a default channel which you
-can't configure.
+``<<domain,{sect-domain}>>'' section below). The `java.util.logging`
+(JUL), log4j, and Python tracing domains each have a default channel
+which you can't configure.
A channel owns recording event rules.
+
Since LTTng{nbsp}2.8, with this mode, LTTng writes to a given sub-buffer
its sequence number within its data stream. With a local, network
-streaming, or live tracing session (see the <<session-modes,Tracing
-session modes>> section above), a trace reader can use such sequence
+streaming, or live tracing session (see the ``<<session-modes,Tracing
+session modes>>'' section above), a trace reader can use such sequence
numbers to report lost packets. A trace reader can use the saved
discarded sub-buffer (packet) count of the trace to decide whether or
not to perform some analysis even if trace data is known to be missing.
command.
There are a few ways to decrease your probability of losing event
-records. The <<channel-sub-buf-size-count,Sub-buffer size and count>>
-section below shows how to fine-tune the sub-buffer size and count of a
-channel to virtually stop losing event records, though at the cost of
-greater memory usage.
+records. The ``<<channel-sub-buf-size-count,Sub-buffer size and
+count>>'' section below shows how to fine-tune the sub-buffer size and
+count of a channel to virtually stop losing event records, though at the
+cost of greater memory usage.
[[channel-sub-buf-size-count]]
~~~~~~~~~~~~~~~~~~~~~~~~~
A channel has one or more ring buffer for each CPU of the target system.
-See the <<channel-buf-scheme,Buffering scheme>> section above to learn
-how many ring buffers of a given channel are dedicated to each CPU
+See the ``<<channel-buf-scheme,Buffering scheme>>'' section above to
+learn how many ring buffers of a given channel are dedicated to each CPU
depending on its buffering scheme.
Set the size of each sub-buffer the ring buffers of a channel contain
event records.
+
Having larger sub-buffers also ensures a lower sub-buffer switching
-frequency (see the <<channel-timers,Timers>> section below).
+frequency (see the ``<<channel-timers,Timers>>'' section below).
+
The sub-buffer count is only meaningful if you create the channel in
-overwrite mode (see the <<channel-er-loss-mode,Event record loss mode>>
-section above): in this case, if LTTng overwrites a sub-buffer, then the
-other sub-buffers are left unaltered.
+overwrite mode (see the ``<<channel-er-loss-mode,Event record loss
+mode>>'' section above): in this case, if LTTng overwrites a sub-buffer,
+then the other sub-buffers are left unaltered.
Low event throughput::
In general, prefer smaller sub-buffers since the risk of losing
The only way to obtain an unmanaged, self-contained LTTng trace before
you destroy the tracing session is with the tracing session rotation
-feature (see the <<rotation,Tracing session rotation>> section above),
-which is available since LTTng{nbsp}2.11.
+feature (see the ``<<rotation,Tracing session rotation>>'' section
+above), which is available since LTTng{nbsp}2.11.
====
periodically in case of a low event throughput.
+
Such a timer is also convenient when you use large sub-buffers (see the
-<<channel-sub-buf-size-count,Sub-buffer size and count>> section above)
-to cope with a sporadic high event throughput, even if the throughput is
-otherwise low.
+``<<channel-sub-buf-size-count,Sub-buffer size and count>>'' section
+above) to cope with a sporadic high event throughput, even if the
+throughput is otherwise low.
+
Set the period of the switch timer of a channel, or disable the timer
altogether, with the nloption:--switch-timer option of the
for{nbsp}__C__ will never be satisfied.
--
+
-See the <<trigger,TRIGGER>> section above to learn more about triggers.
+See the ``<<trigger,TRIGGER>>'' section above to learn more about
+triggers.
+
Set the period of the monitor timer of a channel, or disable the timer
altogether, with the nloption:--monitor-timer option of the
{sect-recording-event-rule}
---------------------------
A _recording event rule_ is a specific type of event rule (see the
-<<"event-rule","{sect-event-rule}">> section above) of which the action is
-to serialize and record the matched event as an _event record_.
+``<<"event-rule","{sect-event-rule}">>'' section above) of which the
+action is to serialize and record the matched event as an _event
+record_.
Set the explicit conditions of a recording event rule when you create it
with the man:lttng-enable-event(1) command. A recording event rule also
+
A channel is enabled on creation.
+
-See the <<channel,{sect-channel}>> section above.
+See the ``<<channel,{sect-channel}>>'' section above.
* The tracing session of the recording event rule is active (started).
+
A tracing session is inactive (stopped) on creation.
+
-See the <<session,{sect-session}>> section above.
+See the ``<<session,{sect-session}>>'' section above.
* The process for which LTTng creates an event to match is allowed to
record events.
On success, the `create` command sets the current tracing session (see
man:lttng-concepts(7) to learn more) to the created tracing session.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
Show the status of the current tracing session with the
man:lttng-status(1) command.
+
Set the trace output destination with the option:--set-url option, or
with the option:--ctrl-url and option:--data-url options (see the
-<<url-format,URL format>> section below).
+``<<url-format,URL format>>'' section below).
[[snapshot-mode]]Snapshot mode (option:--snapshot option)::
Only write the trace data to the local file system or send it to a
+
Set the trace output destination with the option:--set-url='URL' option,
or with the option:--ctrl-url='URL' and option:--data-url='URL' options
-(see the <<url-format,URL format>> section below). 'URL' may :not: start
-with `file://`.
+(see the ``<<url-format,URL format>>'' section below). 'URL' may :not:
+start with `file://`.
[[url-format]]
+
The `file://` protocol targets the *local file system*: you may only use
such an URL with the option:--set-url option when you create the tracing
-session in local or snapshot mode (see the <<modes,Tracing session
-modes>> section above).
+session in local or snapshot mode (see the ``<<modes,Tracing session
+modes>>'' section above).
+
'TRACEDIR':::
Absolute path to the directory containing the trace data on the
+
This format is only available when you create the tracing session in
network streaming, snapshot (option:--snapshot), or live (option:--live)
-mode (see the <<modes,Tracing session modes>> section above).
+mode (see the ``<<modes,Tracing session modes>>'' section above).
+
'NETPROTO':::
Network protocol, amongst:
Mode selection
~~~~~~~~~~~~~~
-See the <<modes,Tracing session modes>> section above.
+See the ``<<modes,Tracing session modes>>'' section above.
At most one of:
Output
~~~~~~
option:--no-output::
- Depending on the tracing session mode (see the <<modes,Tracing
- session modes>> section above):
+ Depending on the tracing session mode (see the ``<<modes,Tracing
+ session modes>>'' section above):
+
Local mode:::
Disable the file system output.
URL
~~~
-See the <<url-format,URL format>> section above to learn more about the
-syntax of the 'URL' argument of the following options.
+See the ``<<url-format,URL format>>'' section above to learn more about
+the syntax of the 'URL' argument of the following options.
option:-C 'URL', option:--ctrl-url='URL'::
Set the control path URL to 'URL'.
+
You must also use the option:--data-url option.
+
-Not available in local mode (see the <<modes,Tracing session modes>>
+Not available in local mode (see the ``<<modes,Tracing session modes>>''
section above).
+
In snapshot mode, this is equivalent to using the nloption:--ctrl-url
+
You must also use the option:--ctrl-url option.
+
-Not available in local mode (see the <<modes,Tracing session modes>>
+Not available in local mode (see the ``<<modes,Tracing session modes>>''
section above).
+
In snapshot mode, this is equivalent to using the nloption:--data-url
+
This URL remains unchanged as long as the tracing session exists.
+
-Depending on the tracing session mode (see the <<modes,Tracing session
-modes>> section above):
+Depending on the tracing session mode (see the ``<<modes,Tracing session
+modes>>'' section above):
+
Local mode:::
'URL' must start with `file://`, followed with the destination
command exits. In other words, it's safe to read them, modify them, move
them, or remove then.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
include::common-lttng-cmd-options-head.txt[]
channel once its tracing session has been started (see
man:lttng-start(1)) at least once.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
include::common-lttng-cmd-options-head.txt[]
activity (started or stopped) of its tracing session (see
man:lttng-start(1) and man:lttng-stop(1)).
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
include::common-lttng-cmd-options-head.txt[]
See man:lttng-concepts(7) to learn more about the tracing session
rotation and trace chunk concepts.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
include::common-lttng-cmd-options-head.txt[]
NOTE: The man:lttng-enable-event(1) command can automatically create a
default channel when no channel exists for the provided tracing domain.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
List the channels of a given tracing session with the
man:lttng-list(1) and man:lttng-status(1) commands.
* Enable one or more disabled recording event rules.
+
-See the <<enable,Enable a disabled recording event rule>> section
+See the ``<<enable,Enable a disabled recording event rule>>'' section
below.
See man:lttng-concepts(7) to learn more about instrumentation points,
which isn't named `channel0`, the `enable-event` command fails.
Otherwise, it automatically creates it.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
List the recording event rules of a specific tracing session
and/or channel with the man:lttng-list(1) and man:lttng-status(1)
* The instrumentation point type from which LTTng creates{nbsp}__E__
has a specific type.
+
-See the <<inst-point-type-cond,Instrumentation point type condition>>
-section below.
+See the ``<<inst-point-type-cond,Instrumentation point type
+condition>>'' section below.
* A pattern matches the name of{nbsp}__E__ while another pattern
doesn't.
+
-See the <<event-name-cond,Event name condition>> section below.
+See the ``<<event-name-cond,Event name condition>>'' section below.
* The log level of the instrumentation point from which LTTng
creates{nbsp}__E__ is at least as severe as some value, or is exactly
some value.
+
-See the <<inst-point-log-level-cond,Instrumentation point log level condition>>
-section below.
+See the ``<<inst-point-log-level-cond,Instrumentation point log level
+condition>>'' section below.
* The fields of the payload of{nbsp}__E__ and the current context fields
satisfy a filter expression.
+
-See the <<filter-cond,Event payload and context filter condition>>
+See the ``<<filter-cond,Event payload and context filter condition>>''
section below.
--
The argument of the option:--probe option is the location of the
kprobe to insert, either a symbol or a
memory address, while 'RECORDNAME' is the name of the record
-of{nbsp}__E__ (see the <<er-name,Event record name>> section below).
+of{nbsp}__E__ (see the ``<<er-name,Event record name>>'' section below).
+
The payload of a Linux kprobe event is empty.
--
+
'RECORDNAME' is the name of the record of{nbsp}__E__ (see the
-<<er-name,Event record name>> section below).
+``<<er-name,Event record name>>'' section below).
+
The payload of a Linux user space probe event is empty.
The argument of the option:--function option is the location of the
Linux kretprobe to insert, either a symbol or
a memory address, while 'RECORDNAME' is the name of the record
-of{nbsp}__E__ (see the <<er-name,Event record name>> section below).
+of{nbsp}__E__ (see the ``<<er-name,Event record name>>'' section below).
+
The payload of a Linux kretprobe event is empty.
* You specify the option:--all option or, depending on the
instrumentation type condition (see the
- <<inst-point-type-cond,Instrumentation point type condition>> section
- above) of{nbsp}__ER__, 'NAME' matches:
+ ``<<inst-point-type-cond,Instrumentation point type condition>>''
+ section above) of{nbsp}__ER__, 'NAME' matches:
+
--
LTTng tracepoint::
~~~~~~~~~~~~~~~~~
When LTTng records an event{nbsp}__E__, the resulting event record has a
name which depends on the instrumentation point type condition (see the
-<<inst-point-type-cond,Instrumentation point type condition>> section
-above) of the recording event rule which matched{nbsp}__E__:
+``<<inst-point-type-cond,Instrumentation point type condition>>''
+section above) of the recording event rule which matched{nbsp}__E__:
LTTng tracepoint (option:--kernel/option:--userspace and option:--tracepoint options)::
Full name of the tracepoint from which LTTng creates{nbsp}__E__.
Instrumentation point type condition
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-See the <<inst-point-type-cond,Instrumentation point type condition>>
-section above.
+See the ``<<inst-point-type-cond,Instrumentation point type
+condition>>'' section above.
At most one of:
--
+
You must specify the event record name with 'RECORDNAME'. See the
-<<er-name,Event record name>> section above to learn more.
+``<<er-name,Event record name>>'' section above to learn more.
option:--probe='LOC'::
Only match Linux kprobe events.
--
+
You must specify the event record name with 'RECORDNAME'. See the
-<<er-name,Event record name>> section above to learn more.
+``<<er-name,Event record name>>'' section above to learn more.
option:--userspace-probe='LOC'::
Only match Linux user space probe events.
--
+
You must specify the event record name with 'RECORDNAME'. See the
-<<er-name,Event record name>> section above to learn more.
+``<<er-name,Event record name>>'' section above to learn more.
option:--syscall::
Only match Linux system call events.
Event name condition
~~~~~~~~~~~~~~~~~~~~
-See the <<event-name-cond,Event name condition>> section above.
+See the ``<<event-name-cond,Event name condition>>'' section above.
option:-a, option:--all::
Equivalent to a single 'NAME' argument (LTTng tracepoint or logger
Instrumentation point log level condition
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-See the <<inst-point-log-level-cond,Instrumentation point log level
-condition>> section above.
+See the ``<<inst-point-log-level-cond,Instrumentation point log level
+condition>>'' section above.
At most one of:
Event payload and context filter condition
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-See the <<filter-cond,Event payload and context filter condition>>
+See the ``<<filter-cond,Event payload and context filter condition>>''
section above.
option:-f 'EXPR', option:--filter='EXPR'::
====
The recording event rule below matches the entry of `usb_disconnect()`
Linux kernel function calls. The records of such events are named `usbd`
-(see the <<er-name,Event record name>> section above).
+(see the ``<<er-name,Event record name>>'' section above).
See the option:--probe option.
See the man:lttng-concepts(7) to learn how LTTng names a trace chunk
archive directory.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
Unset a tracing session rotation schedule with the
man:lttng-disable-rotation(1) command.
* The instrumentation point from which LTTng creates{nbsp}__E__ has a
specific type.
+
-See the <<inst-point-type-cond,Instrumentation point type condition>>
-section below.
+See the ``<<inst-point-type-cond,Instrumentation point type
+condition>>'' section below.
* A pattern matches the name of{nbsp}__E__ while another pattern
doesn't.
+
-See the <<event-name-cond,Event name condition>> section below.
+See the ``<<event-name-cond,Event name condition>>'' section below.
* The log level of the instrumentation point from which LTTng
creates{nbsp}__E__ is at least as severe as some value, or is exactly
some value.
+
-See the <<inst-point-log-level-cond,Instrumentation point log level
-condition>> section below.
+See the ``<<inst-point-log-level-cond,Instrumentation point log level
+condition>>'' section below.
* The fields of the payload of{nbsp}__E__ and the current context fields
satisfy a filter expression.
+
-See the <<filter-cond,Event payload and context filter condition>>
+See the ``<<filter-cond,Event payload and context filter condition>>''
section below.
The dedicated command-line options of most conditions are optional: if
* You don't specify the option:--name='NAME' option or, depending on the
instrumentation type condition (see the
- <<inst-point-type-cond,Instrumentation point type condition>> section
- above) of{nbsp}__ER__, 'NAME' matches:
+ ``<<inst-point-type-cond,Instrumentation point type condition>>''
+ section above) of{nbsp}__ER__, 'NAME' matches:
+
--
`kernel:tracepoint`::
-------
Instrumentation point type condition
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-See the <<inst-point-type-cond,Instrumentation point type condition>>
-section above.
+See the ``<<inst-point-type-cond,Instrumentation point type
+condition>>'' section above.
option:-E 'NAME', option:--event-name='NAME'::
With the option:--type=++kernel:kprobe++ or
Event name condition
~~~~~~~~~~~~~~~~~~~~
-See the <<event-name-cond,Event name condition>> section above.
+See the ``<<event-name-cond,Event name condition>>'' section above.
option:-n 'NAME', option:--name='NAME'::
Only match events of which 'NAME' matches, depending on the
Instrumentation point log level condition
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-See the <<inst-point-log-level-cond,Instrumentation point log level
-condition>> section above.
+See the ``<<inst-point-log-level-cond,Instrumentation point log level
+condition>>'' section above.
option:-l 'LOGLEVELSPEC', option:--log-level='LOGLEVELSPEC'::
Only match events of which the log level of the LTTng tracepoint or
Event payload and context filter condition
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-See the <<filter-cond,Event payload and context filter condition>>
+See the ``<<filter-cond,Event payload and context filter condition>>''
section above.
option:-f 'EXPR', option:--filter='EXPR'::
See man:lttng-concept(7) to learn more about tracing sessions, tracing
domains, channels, recording event rules, and instrumentation points.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
List the channels and recording event rules of the current tracing
session (see man:lttng-concept(7) to learn more) with the
sessions: the command fails. Allow the `load` command to overwrite
existing tracing sessions with the option:--force option.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
include::common-lttng-cmd-options-head.txt[]
As of this version, the `metadata` and `statedump` targets are
available.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
Regenerate the metadata of a tracing session
By default, a relay daemon listens on all network interfaces to receive
trace data, but only on `localhost` for LTTng live connections. Override
the listening URLs with the option:--control-port, option:--data-port,
-and option:--live-port options (see the <<url-format,URL format>>
+and option:--live-port options (see the ``<<url-format,URL format>>''
section below). For example, use the
option:--live-port=+tcp://0.0.0.0:{default_network_viewer_port}+ option
to make a relay daemon listen to LTTng live connections on all network
* Its configuration.
+
-See the <<cfg,Daemon configuration>> section above.
+See the ``<<cfg,Daemon configuration>>'' section above.
* The tracing session configuration of the connected peer.
* The LTTng session daemon (see man:lttng-sessiond(8)) version
addition to the default configuration files and the command-line
options.
+
-See the <<cfg,Daemon configuration>> section above.
+See the ``<<cfg,Daemon configuration>>'' section above.
option:-d, option:--daemonize::
Start as a Unix daemon and close file descriptors (console).
Output
~~~~~~
-See the <<output-directory,Output directory>> section above to learn
+See the ``<<output-directory,Output directory>>'' section above to learn
more.
option:-p, option:--group-output-by-host::
Ports
~~~~~
-See the <<url-format,URL format>> section above to learn more about the
-syntax of the 'URL' argument of the following options.
+See the ``<<url-format,URL format>>'' section above to learn more about
+the syntax of the 'URL' argument of the following options.
option:-C 'URL', option:--control-port='URL'::
Listen to control data on URL 'URL'.
user. If your Unix user is `root`, you can remove the trigger of another
user with the option:--owner-uid option.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
OPTIONS
A `rotate-session` trigger action can also rotate a tracing session (see
man:lttng-add-trigger(1)).
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
[IMPORTANT]
====
to overwrite existing tracing session configuration files with the
option:--force option.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
include::common-lttng-cmd-options-head.txt[]
addition to the default configuration files and the command-line
options.
+
-See the <<cfg,Daemon configuration>> section above.
+See the ``<<cfg,Daemon configuration>>'' section above.
option:-d, option:--daemonize::
Start as a Unix daemon and close file descriptors (console).
or a file, instead of loading them from the default search
directories.
+
-See the <<load,Tracing session configuration loading>> section above.
+See the ``<<load,Tracing session configuration loading>>'' section
+above.
option:-S, option:--sig-parent::
Send the `USR1` signal to the parent process to notify readiness.
Directory from which `lttng-sessiond` loads Unix user tracing
session configurations when starting.
+
-See the <<load,Tracing session configuration loading>> section above to
-learn more.
+See the ``<<load,Tracing session configuration loading>>'' section above
+to learn more.
+{system_sessions_auto_dir}+::
Directory from which `lttng-sessiond` loads system-wide tracing
session configurations when starting.
+
-See the <<load,Tracing session configuration loading>> section above to
-learn more.
+See the ``<<load,Tracing session configuration loading>>'' section above
+to learn more.
`$LTTNG_HOME/.lttng/lttng.conf`::
Unix user's LTTng daemon INI configuration file.
+
-See the <<cfg,Daemon configuration>> section above to learn more.
+See the ``<<cfg,Daemon configuration>>'' section above to learn more.
+{system_lttng_conf}+::
System-wide LTTng daemon INI configuration file.
+
-See the <<cfg,Daemon configuration>> section above to learn more.
+See the ``<<cfg,Daemon configuration>>'' section above to learn more.
NOTE: `$LTTNG_HOME` defaults to `$HOME`.
When LTTng takes a snapshot, it sends the sub-buffer dump of the
selected tracing session to the local file system or over the network to
a listening relay daemon (man:lttng-relayd(8)). See the
-<<output,Snapshot output>> section below to learn more.
+``<<output,Snapshot output>>'' section below to learn more.
When LTTng takes a snapshot, it does :not: clear the sub-buffers of the
selected tracing session. In other words, different snapshots of the
A `snapshot-session` trigger action can also take a tracing session
snapshot (see man:lttng-add-trigger(1)).
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
If you want, instead, to keep all the trace data, but divide it into
archived chunks which are then, like snapshots, ready to be processed,
Output
~~~~~~
-See the <<output,Snapshot output>> section above.
+See the ``<<output,Snapshot output>>'' section above.
option:-C 'URL', option:--ctrl-url='URL'::
Set the control path URL to 'URL'.
A `start-session` trigger action can also start a tracing session
(see man:lttng-add-trigger(1)).
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
Stop an active tracing session with the man:lttng-stop(1) command.
the tracing session with man:lttng-destroy(1) or perform a rotation with
man:lttng-rotate(1) to archive it.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
include::common-lttng-cmd-options-head.txt[]
$ lttng start
----
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
Remove values from an inclusion set with the man:lttng-untrack(1)
command.
The `untrack` command removes values from _inclusion sets_ of process
attributes. See man:lttng-track(1) to learn more about inclusion sets.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
Inclusion set example
if it's not available, man:babeltrace(1). Override which trace reader to
launch with the option:--viewer option.
-See the <<examples,EXAMPLES>> section below for usage examples.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
include::common-lttng-cmd-options-head.txt[]
of LTTng.
The `lttng` tool offers a subcommand-based command-line interface. The
-<<commands,COMMANDS>> section below lists the available commands.
+``<<commands,COMMANDS>>'' section below lists the available commands.
Session daemon connection
<xsl:template match="*[local-name() = 'ulink']">
<xsl:apply-templates/><xsl:text> <</xsl:text><xsl:value-of select="@url"/><xsl:text>></xsl:text>
</xsl:template>
- <xsl:template match="*[local-name() = 'link']">
- <xsl:text>\fI</xsl:text><xsl:apply-templates/><xsl:text>\fR</xsl:text>
- </xsl:template>
<!-- Literal -->
<xsl:template match="*[local-name() = 'literal']">
projects / lttng-tools.git / commitdiff
