Update the remaining manual pages for LTTng-tools 2.13
[lttng-tools.git] / doc / man / lttng-regenerate.1.txt
... / ...
CommitLineData
1lttng-regenerate(1)
2===================
3:revdate: 30 April 2021
4
5
6NAME
7----
8lttng-regenerate - Regenerate specific data of an LTTng tracing session
9
10
11SYNOPSIS
12--------
13Regenerate the metadata of a tracing session:
14
15[verse]
16*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *regenerate metadata* [option:--session='SESSION']
17
18Regenerate the state dump event records of a tracing session:
19
20[verse]
21*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *regenerate statedump* [option:--session='SESSION']
22
23
24DESCRIPTION
25-----------
26The `lttng regenerate` command regenerates specific data of:
27
28With the option:--session='SESSION' option::
29 The tracing session named 'SESSION'.
30
31Without the option:--session option::
32 The current tracing session (see man:lttng-concepts(7) to learn more
33 about the current tracing session).
34
35See man:lttng-concepts(7) to learn more about tracing sessions.
36
37As of this version, the `metadata` and `statedump` targets are
38available.
39
40
41Regenerate the metadata of a tracing session
42~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
43Use the `metadata` target to resample the offset between the monotonic
44clock and the wall time of the system, and then regenerate the metadata
45stream files.
46
47More specifically, you may want to resample the wall time
48following a major
49link:https://en.wikipedia.org/wiki/Network_Time_Protocol[NTP]
50correction. As such, LTTng can trace a system booting with an incorrect
51wall time before its wall time is NTP-corrected. Regenerating the
52metadata of the selected tracing session ensures that trace readers can
53accurately determine the event record timestamps relative to the
54Unix epoch.
55
56Note that if you plan to rotate (see man:lttng-concepts(7) to learn
57more) the selected tracing session, this target only regenerates the
58metadata stream files of the current and next trace chunks.
59
60[IMPORTANT]
61====
62You can only use the `metadata` target when the selected
63tracing session:
64
65* Is not in live mode (nloption:--live option of
66 man:lttng-create(1)).
67
68* If it has user space channels, they're configured to use a
69 per-user buffering scheme (nloption:--buffers-uid option of
70 man:lttng-enable-channel(1)).
71+
72See man:lttng-concepts(7) to learn more about channels.
73====
74
75
76Regenerate the state dump event records of a tracing session
77~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
78Use the `statedump` target to collect up-to-date state dump information
79and create corresponding event records.
80
81This is particularly useful if the selected tracing session is in
82snapshot mode (nloption:--snapshot option of the man:lttng-create(1)
83command) or if LTTng rotates trace files for one of its channels (see
84man:lttng-concepts(7)): in both cases, the state dump information may be
85lost.
86
87
88include::common-cmd-options-head.txt[]
89
90
91option:-s 'SESSION', option:--session='SESSION'::
92 Regenerate specific data of the tracing session named 'SESSION'
93 instead of the current tracing session.
94
95
96include::common-cmd-help-options.txt[]
97
98
99include::common-cmd-footer.txt[]
100
101
102SEE ALSO
103--------
104man:lttng(1),
105man:lttng-concepts(7)
This page took 0.025024 seconds and 5 git commands to generate.