Commit | Line | Data |
---|---|---|
eded6438 | 1 | lttng-regenerate(1) |
4605890e | 2 | =================== |
e9711845 | 3 | :revdate: 14 June 2021 |
eded6438 JD |
4 | |
5 | ||
6 | NAME | |
7 | ---- | |
e9711845 | 8 | lttng-regenerate - Regenerate specific data of an LTTng recording session |
eded6438 JD |
9 | |
10 | ||
11 | SYNOPSIS | |
12 | -------- | |
e9711845 | 13 | Regenerate the metadata of a recording session: |
eded6438 JD |
14 | |
15 | [verse] | |
16 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *regenerate metadata* [option:--session='SESSION'] | |
17 | ||
e9711845 | 18 | Regenerate the state dump event records of a recording session: |
dbcf3dd3 JD |
19 | |
20 | [verse] | |
21 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *regenerate statedump* [option:--session='SESSION'] | |
22 | ||
26f0c779 | 23 | |
eded6438 JD |
24 | DESCRIPTION |
25 | ----------- | |
26f0c779 | 26 | The `lttng regenerate` command regenerates specific data of: |
dbcf3dd3 | 27 | |
26f0c779 | 28 | With the option:--session='SESSION' option:: |
e9711845 | 29 | The recording session named 'SESSION'. |
dbcf3dd3 | 30 | |
26f0c779 | 31 | Without the option:--session option:: |
e9711845 PP |
32 | The current recording session (see man:lttng-concepts(7) to learn |
33 | more about the current recording session). | |
dbcf3dd3 | 34 | |
e9711845 | 35 | See man:lttng-concepts(7) to learn more about recording sessions. |
eded6438 | 36 | |
26f0c779 PP |
37 | As of this version, the `metadata` and `statedump` targets are |
38 | available. | |
980bb5fd | 39 | |
da39b67c | 40 | See the ``<<examples,EXAMPLES>>'' section below for usage examples. |
d098bfda | 41 | |
eded6438 | 42 | |
e9711845 PP |
43 | Regenerate the metadata of a recording session |
44 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
26f0c779 PP |
45 | Use the `metadata` target to resample the offset between the monotonic |
46 | clock and the wall time of the system, and then regenerate the metadata | |
47 | stream files. | |
48 | ||
e9711845 PP |
49 | More specifically, you may want to resample the wall time following a |
50 | major link:https://en.wikipedia.org/wiki/Network_Time_Protocol[NTP] | |
26f0c779 PP |
51 | correction. As such, LTTng can trace a system booting with an incorrect |
52 | wall time before its wall time is NTP-corrected. Regenerating the | |
e9711845 PP |
53 | metadata of the selected recording session ensures that trace readers |
54 | can accurately determine the event record timestamps relative to the | |
26f0c779 PP |
55 | Unix epoch. |
56 | ||
57 | Note that if you plan to rotate (see man:lttng-concepts(7) to learn | |
e9711845 | 58 | more) the selected recording session, this target only regenerates the |
26f0c779 PP |
59 | metadata stream files of the current and next trace chunks. |
60 | ||
61 | [IMPORTANT] | |
62 | ==== | |
63 | You can only use the `metadata` target when the selected | |
e9711845 | 64 | recording session: |
26f0c779 PP |
65 | |
66 | * Is not in live mode (nloption:--live option of | |
67 | man:lttng-create(1)). | |
68 | ||
69 | * If it has user space channels, they're configured to use a | |
70 | per-user buffering scheme (nloption:--buffers-uid option of | |
71 | man:lttng-enable-channel(1)). | |
72 | + | |
73 | See man:lttng-concepts(7) to learn more about channels. | |
74 | ==== | |
75 | ||
76 | ||
e9711845 PP |
77 | Regenerate the state dump event records of a recording session |
78 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
26f0c779 PP |
79 | Use the `statedump` target to collect up-to-date state dump information |
80 | and create corresponding event records. | |
81 | ||
e9711845 | 82 | This is particularly useful if the selected recording session is in |
26f0c779 PP |
83 | snapshot mode (nloption:--snapshot option of the man:lttng-create(1) |
84 | command) or if LTTng rotates trace files for one of its channels (see | |
85 | man:lttng-concepts(7)): in both cases, the state dump information may be | |
dbcf3dd3 | 86 | lost. |
eded6438 JD |
87 | |
88 | ||
f5511eea | 89 | include::common-lttng-cmd-options-head.txt[] |
eded6438 JD |
90 | |
91 | ||
59b19c3c | 92 | option:-s 'SESSION', option:--session='SESSION':: |
e9711845 PP |
93 | Regenerate specific data of the recording session named 'SESSION' |
94 | instead of the current recording session. | |
eded6438 JD |
95 | |
96 | ||
f5511eea | 97 | include::common-lttng-cmd-help-options.txt[] |
eded6438 JD |
98 | |
99 | ||
f5511eea PP |
100 | include::common-lttng-cmd-after-options.txt[] |
101 | ||
102 | ||
d098bfda PP |
103 | [[examples]] |
104 | EXAMPLES | |
105 | -------- | |
e9711845 | 106 | .Regenerate the metadata of the current recording session. |
d098bfda PP |
107 | ==== |
108 | [role="term"] | |
109 | ---- | |
110 | $ lttng regenerate metadata | |
111 | ---- | |
112 | ==== | |
113 | ||
e9711845 | 114 | .Regenerate the state dump event records of a specific recording session. |
d098bfda PP |
115 | ==== |
116 | See the option:--session option. | |
117 | ||
118 | [role="term"] | |
119 | ---- | |
120 | $ lttng regenerate statedump --session=my-session | |
121 | ---- | |
122 | ==== | |
123 | ||
124 | ||
f5511eea | 125 | include::common-footer.txt[] |
eded6438 JD |
126 | |
127 | ||
128 | SEE ALSO | |
129 | -------- | |
26f0c779 PP |
130 | man:lttng(1), |
131 | man:lttng-concepts(7) |