[lttng-tools.git] / doc / man / lttng-start.1.txt

lttng-start(1)
==============
:revdate: 21 April 2021


NAME
----
lttng-start - Start an LTTng tracing session


SYNOPSIS
--------
[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *start* ['SESSION']


DESCRIPTION
-----------
The `lttng start` command starts a tracing session, that is, it
activates the LTTng tracers for:

With the 'SESSION' argument::
    The tracing session named 'SESSION'.

Without the 'SESSION' argument::
    The current tracing session (see man:lttng-create(1) and
    man:lttng-set-session(1) to learn more about the current tracing
    session).

The selected tracing session must be inactive (stopped). A tracing
session is inactive on creation (see man:lttng-create(1)).

An active tracing session is an implicit recording event rule condition
(see man:lttng-enable-event(1)). In other words, a recording event rule
cannot match an event when its tracing session is inactive.

A `start-session` trigger action can also start a tracing session
(see man:lttng-add-trigger(1)).

Stop an active tracing session with the man:lttng-stop(1) command.


include::common-cmd-options-head.txt[]


include::common-cmd-help-options.txt[]


include::common-cmd-footer.txt[]


SEE ALSO
--------
man:lttng(1),
man:lttng-add-trigger(1),
man:lttng-create(1),
man:lttng-enable-event(1),
man:lttng-stop(1)
Commit	Line	Data
	1	lttng-start(1)
	2	==============
	3	:revdate: 21 April 2021
	4
	5
	6	NAME
	7	----
	8	lttng-start - Start an LTTng tracing session
	9
	10
	11	SYNOPSIS
	12	--------
	13	[verse]
	14	lttng ['linkgenoptions:(GENERAL OPTIONS)'] start ['SESSION']
	15
	16
	17	DESCRIPTION
	18	-----------
	19	The `lttng start` command starts a tracing session, that is, it
	20	activates the LTTng tracers for:
	21
	22	With the 'SESSION' argument::
	23	The tracing session named 'SESSION'.
	24
	25	Without the 'SESSION' argument::
	26	The current tracing session (see man:lttng-create(1) and
	27	man:lttng-set-session(1) to learn more about the current tracing
	28	session).
	29
	30	The selected tracing session must be inactive (stopped). A tracing
	31	session is inactive on creation (see man:lttng-create(1)).
	32
	33	An active tracing session is an implicit recording event rule condition
	34	(see man:lttng-enable-event(1)). In other words, a recording event rule
	35	cannot match an event when its tracing session is inactive.
	36
	37	A `start-session` trigger action can also start a tracing session
	38	(see man:lttng-add-trigger(1)).
	39
	40	Stop an active tracing session with the man:lttng-stop(1) command.
	41
	42
	43	include::common-cmd-options-head.txt[]
	44
	45
	46	include::common-cmd-help-options.txt[]
	47
	48
	49	include::common-cmd-footer.txt[]
	50
	51
	52	SEE ALSO
	53	--------
	54	man:lttng(1),
	55	man:lttng-add-trigger(1),
	56	man:lttng-create(1),
	57	man:lttng-enable-event(1),
	58	man:lttng-stop(1)