lttng-add-trigger(1)
====================
-:revdate: 6 May 2021
+:revdate: 14 June 2021
NAME
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
+
See below for the nloption:--rate-policy option.
-Start a tracing session::
+Start a recording session::
Synopsis:
+
[verse]
option:--action=**start-session** 'SESSION' [nloption:--rate-policy='POLICY']
{nbsp}
+
-Starts the tracing session named 'SESSION' like man:lttng-start(1)
+Starts the recording session named 'SESSION' like man:lttng-start(1)
would.
+
-If no tracing session has the name 'SESSION' when LTTng is ready to
+If no recording session has the name 'SESSION' when LTTng is ready to
execute the action, LTTng does nothing.
+
See below for the nloption:--rate-policy option.
-Stop a tracing session::
+Stop a recording session::
Synopsis:
+
[verse]
option:--action=**stop-session** 'SESSION' [nloption:--rate-policy='POLICY']
{nbsp}
+
-Stops the tracing session named 'SESSION' like man:lttng-stop(1) would.
+Stops the recording session named 'SESSION' like man:lttng-stop(1)
+would.
+
-If no tracing session has the name 'SESSION' when LTTng is ready to
+If no recording session has the name 'SESSION' when LTTng is ready to
execute the action, LTTng does nothing.
+
See below for the nloption:--rate-policy option.
-Rotate a tracing session::
+Rotate a recording session::
Synopsis:
+
[verse]
option:--action=**rotate-session** 'SESSION' [nloption:--rate-policy='POLICY']
{nbsp}
+
-Archives the current trace chunk of the tracing session named 'SESSION'
-like man:lttng-rotate(1) would.
+Archives the current trace chunk of the recording session named
+'SESSION' like man:lttng-rotate(1) would.
+
-If no tracing session has the name 'SESSION' when LTTng is ready to
+If no recording session has the name 'SESSION' when LTTng is ready to
execute the action, LTTng does nothing.
+
See below for the nloption:--rate-policy option.
-Take a tracing session snapshot::
+Take a recording session snapshot::
Synopsis:
+
[verse]
option:--action=**snapshot-session** 'SESSION' [nloption:--rate-policy='POLICY']
{nbsp}
+
-Takes a snapshot of the tracing session named 'SESSION' like
+Takes a snapshot of the recording session named 'SESSION' like
man:lttng-snapshot(1) would.
+
-When the condition of the trigger is satisfied, the tracing session
-named 'SESSION', if any, must be a snapshot-mode tracing session
+When the condition of the trigger is satisfied, the recording session
+named 'SESSION', if any, must be a snapshot-mode recording session
(see man:lttng-create(1)).
+
-If no tracing session has the name 'SESSION' when LTTng is ready to
+If no recording session has the name 'SESSION' when LTTng is ready to
execute the action, LTTng does nothing.
+
See below for the nloption:--rate-policy option.
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[]
[role="term"]
----
$ lttng add-trigger --condition=event-rule-matches \
- --domain=kernel --type=syscall:entry \
+ --type=syscall:entry \
--name='exec*' --action=notify
----
====
-.Add an ``event rule matches'' trigger of which the action is to stop a tracing session and then rotate it.
+.Add an ``event rule matches'' trigger of which the action is to stop a recording session and then rotate it.
====
The `event-rule-matches` trigger condition below specifies an event rule
which matches any user space tracepoint event with a name starting with
[role="term"]
----
$ lttng add-trigger --condition=event-rule-matches \
- --domain=user --name='my_app:*' \
+ --type=user --name='my_app:*' \
--log-level=TRACE_WARNING.. \
--action=stop-session my-session \
--action=rotate-session my-session
----
-See man:lttng-concepts(7) to learn more about tracing sessions and
+See man:lttng-concepts(7) to learn more about recording sessions and
rotations.
====
----
$ lttng add-trigger --name=my-trigger \
--condition=event-rule-matches \
- --domain=python --name=my-logger \
+ --type=python --name=my-logger \
--action=snapshot-session my-session
----
====
----
# lttng add-trigger --owner-uid=$(id --user mireille) \
--condition=event-rule-matches \
- --domain=kernel --name='sched*' \
+ --type=kernel --name='sched*' \
--action=notify
----
====
[role="term"]
----
$ lttng add-trigger --condition=event-rule-matches \
- --domain=user --action=notify \
+ --type=user --action=notify \
--rate-policy=every:10
----
====
-.Add an ``event rule matches'' trigger with a tracing session starting action to be executed a single time after 40{nbsp}times.
+.Add an ``event rule matches'' trigger with a recording session starting action to be executed a single time after 40{nbsp}times.
====
The `event-rule-matches` trigger condition below specifies an event rule
which matches any Linux system call event (entry and exit) of which the
[role="term"]
----
$ lttng add-trigger --condition=event-rule-matches \
- --domain=kernel --type=syscall \
- --filter='fd < 3' \
+ --type=syscall --filter='fd < 3' \
--action=start-session my-session \
--rate-policy=once-after:40
----
projects / lttng-tools.git / blobdiff