Skip to content

Commit 6d68d32

Browse files
[FLINK-34199] Add documentation.
1 parent fc4c962 commit 6d68d32

File tree

3 files changed

+283
-144
lines changed

3 files changed

+283
-144
lines changed

docs/content.zh/docs/ops/traces.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Flink reports a single span trace for the whole checkpoint and job initializatio
9797
</thead>
9898
<tbody>
9999
<tr>
100-
<th rowspan="16">org.apache.flink.</br>runtime.checkpoint.</br>CheckpointStatsTracker</th>
100+
<th rowspan="18">org.apache.flink.</br>runtime.checkpoint.</br>CheckpointStatsTracker</th>
101101
<th rowspan="6"><strong>Checkpoint</strong></th>
102102
<td>startTs</td>
103103
<td>Timestamp when the checkpoint has started.</td>
@@ -123,7 +123,7 @@ Flink reports a single span trace for the whole checkpoint and job initializatio
123123
<td>What was the state of this checkpoint: FAILED or COMPLETED.</td>
124124
</tr>
125125
<tr>
126-
<th rowspan="10"><strong>JobInitialization</strong></th>
126+
<th rowspan="12"><strong>JobInitialization</strong></th>
127127
<td>startTs</td>
128128
<td>Timestamp when the job initialization has started.</td>
129129
</tr>
@@ -157,7 +157,11 @@ Flink reports a single span trace for the whole checkpoint and job initializatio
157157
</tr>
158158
<tr>
159159
<td>(Max/Sum)DownloadStateDurationMs<br><br>(optional - currently only supported by RocksDB Incremental)</td>
160-
<td>The aggregated (max and sum) across all subtasks duration of downloading state files from the DFS.</td>
160+
<td>The aggregated (max and sum) duration across all subtasks of downloading state files from the DFS.</td>
161+
</tr>
162+
<tr>
163+
<td>(Max/Sum)RestoreStateDurationMs<br><br>(optional - currently only supported by RocksDB Incremental)</td>
164+
<td>The aggregated (max and sum) duration across all subtasks of restoring the state backend from fully localized state, i.e. after all remote state was downloaded.</td>
161165
</tr>
162166
<tr>
163167
<td>(Max/Sum)RestoredStateSizeBytes.[location]</td>
@@ -167,6 +171,10 @@ Flink reports a single span trace for the whole checkpoint and job initializatio
167171
REMOTE,
168172
UNKNOWN.</td>
169173
</tr>
174+
<tr>
175+
<td>(Max/Sum)RestoreAsyncCompactionDurationMs<br><br>(optional - currently only supported by RocksDB Incremental)</td>
176+
<td>The aggregated (max and sum) duration across all subtasks for async compaction after incremental restore.</td>
177+
</tr>
170178
</tbody>
171179
</table>
172180

docs/content/docs/ops/traces.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Flink reports a single span trace for the whole checkpoint and job initializatio
9797
</thead>
9898
<tbody>
9999
<tr>
100-
<th rowspan="16">org.apache.flink.</br>runtime.checkpoint.</br>CheckpointStatsTracker</th>
100+
<th rowspan="18">org.apache.flink.</br>runtime.checkpoint.</br>CheckpointStatsTracker</th>
101101
<th rowspan="6"><strong>Checkpoint</strong></th>
102102
<td>startTs</td>
103103
<td>Timestamp when the checkpoint has started.</td>
@@ -123,7 +123,7 @@ Flink reports a single span trace for the whole checkpoint and job initializatio
123123
<td>What was the state of this checkpoint: FAILED or COMPLETED.</td>
124124
</tr>
125125
<tr>
126-
<th rowspan="10"><strong>JobInitialization</strong></th>
126+
<th rowspan="12"><strong>JobInitialization</strong></th>
127127
<td>startTs</td>
128128
<td>Timestamp when the job initialization has started.</td>
129129
</tr>
@@ -157,7 +157,11 @@ Flink reports a single span trace for the whole checkpoint and job initializatio
157157
</tr>
158158
<tr>
159159
<td>(Max/Sum)DownloadStateDurationMs<br><br>(optional - currently only supported by RocksDB Incremental)</td>
160-
<td>The aggregated (max and sum) across all subtasks duration of downloading state files from the DFS.</td>
160+
<td>The aggregated (max and sum) duration across all subtasks of downloading state files from the DFS.</td>
161+
</tr>
162+
<tr>
163+
<td>(Max/Sum)RestoreStateDurationMs<br><br>(optional - currently only supported by RocksDB Incremental)</td>
164+
<td>The aggregated (max and sum) duration across all subtasks of restoring the state backend from fully localized state, i.e. after all remote state was downloaded.</td>
161165
</tr>
162166
<tr>
163167
<td>(Max/Sum)RestoredStateSizeBytes.[location]</td>
@@ -167,6 +171,10 @@ Flink reports a single span trace for the whole checkpoint and job initializatio
167171
REMOTE,
168172
UNKNOWN.</td>
169173
</tr>
174+
<tr>
175+
<td>(Max/Sum)RestoreAsyncCompactionDurationMs<br><br>(optional - currently only supported by RocksDB Incremental)</td>
176+
<td>The aggregated (max and sum) duration across all subtasks for async compaction after incremental restore.</td>
177+
</tr>
170178
</tbody>
171179
</table>
172180

0 commit comments

Comments
 (0)