Skip to content

Commit

Permalink
[FLINK-34199] Add documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
@StefanRRichter
StefanRRichter committed Feb 12, 2024
1 parent fc4c962 commit 6d84dec
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 6 deletions.
14 changes: 11 additions & 3 deletions docs/content.zh/docs/ops/traces.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Flink reports a single span trace for the whole checkpoint and job initializatio
</thead>
<tbody>
<tr>
<th rowspan="16">org.apache.flink.</br>runtime.checkpoint.</br>CheckpointStatsTracker</th>
<th rowspan="18">org.apache.flink.</br>runtime.checkpoint.</br>CheckpointStatsTracker</th>
<th rowspan="6"><strong>Checkpoint</strong></th>
<td>startTs</td>
<td>Timestamp when the checkpoint has started.</td>
Expand All @@ -123,7 +123,7 @@ Flink reports a single span trace for the whole checkpoint and job initializatio
<td>What was the state of this checkpoint: FAILED or COMPLETED.</td>
</tr>
<tr>
<th rowspan="10"><strong>JobInitialization</strong></th>
<th rowspan="12"><strong>JobInitialization</strong></th>
<td>startTs</td>
<td>Timestamp when the job initialization has started.</td>
</tr>
Expand Down Expand Up @@ -157,7 +157,11 @@ Flink reports a single span trace for the whole checkpoint and job initializatio
</tr>
<tr>
<td>(Max/Sum)DownloadStateDurationMs<br><br>(optional - currently only supported by RocksDB Incremental)</td>
<td>The aggregated (max and sum) across all subtasks duration of downloading state files from the DFS.</td>
<td>The aggregated (max and sum) duration across all subtasks of downloading state files from the DFS.</td>
</tr>
<tr>
<td>(Max/Sum)RestoreStateDurationMs<br><br>(optional - currently only supported by RocksDB Incremental)</td>
<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>
</tr>
<tr>
<td>(Max/Sum)RestoredStateSizeBytes.[location]</td>
Expand All @@ -167,6 +171,10 @@ Flink reports a single span trace for the whole checkpoint and job initializatio
REMOTE,
UNKNOWN.</td>
</tr>
<tr>
<td>(Max/Sum)RestoreAsyncCompactionDurationMs<br><br>(optional - currently only supported by RocksDB Incremental)</td>
<td>The aggregated (max and sum) duration across all subtasks for async compaction after incremental restore.</td>
</tr>
</tbody>
</table>
Expand Down
14 changes: 11 additions & 3 deletions docs/content/docs/ops/traces.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Flink reports a single span trace for the whole checkpoint and job initializatio
</thead>
<tbody>
<tr>
<th rowspan="16">org.apache.flink.</br>runtime.checkpoint.</br>CheckpointStatsTracker</th>
<th rowspan="18">org.apache.flink.</br>runtime.checkpoint.</br>CheckpointStatsTracker</th>
<th rowspan="6"><strong>Checkpoint</strong></th>
<td>startTs</td>
<td>Timestamp when the checkpoint has started.</td>
Expand All @@ -123,7 +123,7 @@ Flink reports a single span trace for the whole checkpoint and job initializatio
<td>What was the state of this checkpoint: FAILED or COMPLETED.</td>
</tr>
<tr>
<th rowspan="10"><strong>JobInitialization</strong></th>
<th rowspan="12"><strong>JobInitialization</strong></th>
<td>startTs</td>
<td>Timestamp when the job initialization has started.</td>
</tr>
Expand Down Expand Up @@ -157,7 +157,11 @@ Flink reports a single span trace for the whole checkpoint and job initializatio
</tr>
<tr>
<td>(Max/Sum)DownloadStateDurationMs<br><br>(optional - currently only supported by RocksDB Incremental)</td>
<td>The aggregated (max and sum) across all subtasks duration of downloading state files from the DFS.</td>
<td>The aggregated (max and sum) duration across all subtasks of downloading state files from the DFS.</td>
</tr>
<tr>
<td>(Max/Sum)RestoreStateDurationMs<br><br>(optional - currently only supported by RocksDB Incremental)</td>
<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>
</tr>
<tr>
<td>(Max/Sum)RestoredStateSizeBytes.[location]</td>
Expand All @@ -167,6 +171,10 @@ Flink reports a single span trace for the whole checkpoint and job initializatio
REMOTE,
UNKNOWN.</td>
</tr>
<tr>
<td>(Max/Sum)RestoreAsyncCompactionDurationMs<br><br>(optional - currently only supported by RocksDB Incremental)</td>
<td>The aggregated (max and sum) duration across all subtasks for async compaction after incremental restore.</td>
</tr>
</tbody>
</table>
Expand Down

0 comments on commit 6d84dec

Please sign in to comment.