doc/man: use specific revision date for each manual page
[lttng-tools.git] / doc / man / lttng-regenerate.1.txt
CommitLineData
eded6438 1lttng-regenerate(1)
4605890e
PP
2===================
3:revdate: 18 January 2018
eded6438
JD
4
5
6NAME
7----
8lttng-regenerate - Manage an LTTng tracing session's data regeneration
9
10
11SYNOPSIS
12--------
dbcf3dd3 13Regenerate the metadata of a session:
eded6438
JD
14
15[verse]
16*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *regenerate metadata* [option:--session='SESSION']
17
dbcf3dd3
JD
18Regenerate the state dump of a session:
19
20[verse]
21*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *regenerate statedump* [option:--session='SESSION']
22
eded6438
JD
23DESCRIPTION
24-----------
dbcf3dd3
JD
25The `lttng regenerate` command regenerates specific data of a tracing session.
26
27As of this version, the `metadata` and `statedump` actions are
28available.
29
30
31Regenerating a tracing session's metadata
32~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33The `lttng regenerate metadata` action can be used to resample the offset
34between the system's monotonic clock and the wall-clock time.
35
36This action is meant to be used to resample the wall-clock time following a
37major link:https://en.wikipedia.org/wiki/Network_Time_Protocol[NTP] correction.
38As such, a system booting with an incorrect wall time can be traced before its
39wall time is NTP-corrected. Regenerating the tracing session's metadata ensures
40that trace viewers can accurately determine the events time relative to Unix
41Epoch.
eded6438 42
980bb5fd
PP
43If you use man:lttng-rotate(1) or man:lttng-enable-rotation(1) to make
44tracing session rotations, this action regenerates the current and
45next trace chunks's metadata files.
46
eded6438 47
dbcf3dd3
JD
48Regenerating a tracing session's state dump
49~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
50The `lttng regenerate statedump` action can be used to collect up-to-date state
51dump information during the tracing session. This is particularly useful in
52snapshot (see man:lttng-snapshot(1)) or trace file rotation (see
53man:lttng-enable-channel(1)) modes where the state dump information may be
54lost.
eded6438
JD
55
56
57include::common-cmd-options-head.txt[]
58
59
59b19c3c 60option:-s 'SESSION', option:--session='SESSION'::
dbcf3dd3 61 Regenerate the data of the tracing session named 'SESSION'
eded6438
JD
62 instead of the current tracing session.
63
64
65include::common-cmd-help-options.txt[]
66
67
68LIMITATIONS
69-----------
70The `lttng regenerate metadata` command can only be used on kernel and
71user space tracing sessions (using per-user buffering), in non-live
72mode.
73
74See man:lttng-enable-channel(1) for more information about
75buffering schemes and man:lttng-create(1) for more information
76about the different tracing session modes.
77
78
79include::common-cmd-footer.txt[]
80
81
82SEE ALSO
83--------
84man:lttng(1)
This page took 0.029708 seconds and 4 git commands to generate.