Skip to content

Add lastCommittedSnapshotId commit metric and document missing metrics #7589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
junmuz wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add lastCommittedSnapshotId commit metric and document missing metrics #7589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0dad710
Add lastCommittedSnapshotId metric and read actual snapshot ID post-c…
junmuz Apr 2, 2026
2ca21e2
Improve commit metrics, remove currentConsumerId, and add missing docs
junmuz Apr 2, 2026
9f0d40a
Responding to the comments and setting the snapshot from the duplicat…
junmuz Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/content/maintenance/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ Below is lists of Paimon built-in metrics. They are summarized into types of sca
<td>Histogram</td>
<td>Distributions of the time taken by the last few scans.</td>
</tr>
<tr>
<td>lastScannedSnapshotId</td>
Copy link
Copy Markdown
Contributor Author

@junmuz junmuz Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This metric has been added previously, but the docs doesn't reference it.

<td>Gauge</td>
<td>The snapshot ID scanned in the last scan. 0 if no scan has occurred.</td>
</tr>
<tr>
<td>lastScannedManifests</td>
<td>Gauge</td>
Expand Down Expand Up @@ -181,6 +186,11 @@ Below is lists of Paimon built-in metrics. They are summarized into types of sca
<td>Gauge</td>
<td>Total size of the output files for the last compaction.</td>
</tr>
<tr>
<td>lastCommittedSnapshotId</td>
<td>Gauge</td>
<td>The snapshot ID created by the last commit. -1 if no commit has occurred.</td>
</tr>
</tbody>
</table>

Expand Down
15 changes: 11 additions & 4 deletions paimon-core/src/main/java/org/apache/paimon/operation/FileStoreCommitImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ public class FileStoreCommitImpl implements FileStoreCommit {
private boolean ignoreEmptyCommit;
private CommitMetrics commitMetrics;
private boolean appendCommitCheckConflict = false;
private long lastCommittedSnapshotId = -1L;

public FileStoreCommitImpl(
SnapshotCommit snapshotCommit,
Expand Down Expand Up @@ -371,7 +372,8 @@ public int commit(ManifestCommittable committable, boolean checkAppendFiles) {
changes.compactChangelog,
commitDuration,
generatedSnapshot,
attempts);
attempts,
lastCommittedSnapshotId);
}
}
return generatedSnapshot;
Expand All @@ -384,7 +386,8 @@ private void reportCommit(
List<ManifestEntry> compactChangelogFiles,
long commitDuration,
int generatedSnapshots,
int attempts) {
int attempts,
long lastCommittedSnapshotId) {
CommitStats commitStats =
new CommitStats(
appendTableFiles,
Expand All @@ -393,7 +396,8 @@ private void reportCommit(
compactChangelogFiles,
commitDuration,
generatedSnapshots,
attempts);
attempts,
lastCommittedSnapshotId);
commitMetrics.reportCommit(commitStats);
}

Expand Down Expand Up @@ -535,7 +539,8 @@ public int overwritePartition(
emptyList(),
commitDuration,
generatedSnapshot,
attempts);
attempts,
lastCommittedSnapshotId);
}
}
return generatedSnapshot;
Expand Down Expand Up @@ -801,6 +806,7 @@ CommitResult tryCommitOnce(
if (snapshot.commitUser().equals(commitUser)
&& snapshot.commitIdentifier() == identifier
&& snapshot.commitKind() == commitKind) {
lastCommittedSnapshotId = snapshot.id();
return new SuccessCommitResult();
}
}
Expand Down Expand Up @@ -1045,6 +1051,7 @@ CommitResult tryCommitOnce(
if (strictModeChecker != null) {
strictModeChecker.update(newSnapshotId);
}
lastCommittedSnapshotId = newSnapshotId;
Copy link
Copy Markdown
Contributor

@XiaoHongbo-Hope XiaoHongbo-Hope Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This misses the duplicate-success retry path. In false-success retry, the earlier duplicate-check branch returns before this assignment, so the gauge can stay -1.Should we also set lastCommittedSnapshotId = snapshot.id() there?

Copy link
Copy Markdown
Contributor Author

@junmuz junmuz Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, I have made changes to handle that.

CommitCallback.Context context =
new CommitCallback.Context(
finalBaseFiles, finalDeltaFiles, indexFiles, newSnapshot, identifier);
Expand Down
4 changes: 4 additions & 0 deletions paimon-core/src/main/java/org/apache/paimon/operation/metrics/CommitMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ public MetricGroup getMetricGroup() {

public static final String LAST_COMPACTION_INPUT_FILE_SIZE = "lastCompactionInputFileSize";
public static final String LAST_COMPACTION_OUTPUT_FILE_SIZE = "lastCompactionOutputFileSize";
public static final String LAST_COMMITTED_SNAPSHOT_ID = "lastCommittedSnapshotId";

private void registerGenericCommitMetrics() {
metricGroup.gauge(
Expand Down Expand Up @@ -126,6 +127,9 @@ private void registerGenericCommitMetrics() {
metricGroup.gauge(
LAST_COMPACTION_OUTPUT_FILE_SIZE,
() -> latestCommit == null ? 0L : latestCommit.getCompactionOutputFileSize());
metricGroup.gauge(
LAST_COMMITTED_SNAPSHOT_ID,
() -> latestCommit == null ? -1L : latestCommit.getLastCommittedSnapshotId());
}

public void reportCommit(CommitStats commitStats) {
Expand Down
10 changes: 9 additions & 1 deletion paimon-core/src/main/java/org/apache/paimon/operation/metrics/CommitStats.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ public class CommitStats {
private final long generatedSnapshots;
private final long numPartitionsWritten;
private final long numBucketsWritten;
private final long lastCommittedSnapshotId;

public CommitStats(
List<ManifestEntry> appendTableFiles,
Expand All @@ -61,7 +62,8 @@ public CommitStats(
List<ManifestEntry> compactChangelogFiles,
long commitDuration,
int generatedSnapshots,
int attempts) {
int attempts,
long lastCommittedSnapshotId) {
List<ManifestEntry> addedTableFiles =
appendTableFiles.stream()
.filter(f -> FileKind.ADD.equals(f.kind()))
Expand Down Expand Up @@ -110,6 +112,7 @@ public CommitStats(
this.duration = commitDuration;
this.generatedSnapshots = generatedSnapshots;
this.attempts = attempts;
this.lastCommittedSnapshotId = lastCommittedSnapshotId;
}

@VisibleForTesting
Expand Down Expand Up @@ -236,4 +239,9 @@ public long getCompactionInputFileSize() {
public long getCompactionOutputFileSize() {
return compactionOutputFileSize;
}

@VisibleForTesting
protected long getLastCommittedSnapshotId() {
return lastCommittedSnapshotId;
}
}
13 changes: 11 additions & 2 deletions paimon-core/src/test/java/org/apache/paimon/operation/metrics/CommitMetricsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,10 @@ public void testMetricsAreUpdated() {
registeredGenericMetrics.get(
CommitMetrics.LAST_CHANGELOG_RECORDS_COMMIT_COMPACTED);

Gauge<Long> lastCommittedSnapshotId =
(Gauge<Long>)
registeredGenericMetrics.get(CommitMetrics.LAST_COMMITTED_SNAPSHOT_ID);

assertThat(lastCommitDuration.getValue()).isEqualTo(0);
assertThat(commitDuration.getCount()).isEqualTo(0);
assertThat(commitDuration.getStatistics().size()).isEqualTo(0);
Expand All @@ -117,6 +121,7 @@ public void testMetricsAreUpdated() {
assertThat(lastChangelogRecordsAppended.getValue()).isEqualTo(0);
assertThat(lastDeltaRecordsCompacted.getValue()).isEqualTo(0);
assertThat(lastChangelogRecordsCompacted.getValue()).isEqualTo(0);
assertThat(lastCommittedSnapshotId.getValue()).isEqualTo(-1);

// report once
reportOnce(commitMetrics);
Expand Down Expand Up @@ -145,6 +150,7 @@ public void testMetricsAreUpdated() {
assertThat(lastChangelogRecordsAppended.getValue()).isEqualTo(503);
assertThat(lastDeltaRecordsCompacted.getValue()).isEqualTo(613);
assertThat(lastChangelogRecordsCompacted.getValue()).isEqualTo(512);
assertThat(lastCommittedSnapshotId.getValue()).isEqualTo(42);

// report again
reportAgain(commitMetrics);
Expand Down Expand Up @@ -173,6 +179,7 @@ public void testMetricsAreUpdated() {
assertThat(lastChangelogRecordsAppended.getValue()).isEqualTo(213);
assertThat(lastDeltaRecordsCompacted.getValue()).isEqualTo(506);
assertThat(lastChangelogRecordsCompacted.getValue()).isEqualTo(601);
assertThat(lastCommittedSnapshotId.getValue()).isEqualTo(99);
}

private void reportOnce(CommitMetrics commitMetrics) {
Expand All @@ -199,7 +206,8 @@ private void reportOnce(CommitMetrics commitMetrics) {
compactChangelogFiles,
200,
2,
1);
1,
42L);

commitMetrics.reportCommit(commitStats);
}
Expand Down Expand Up @@ -228,7 +236,8 @@ private void reportAgain(CommitMetrics commitMetrics) {
compactChangelogFiles,
500,
1,
2);
2,
99L);

commitMetrics.reportCommit(commitStats);
}
Expand Down
12 changes: 9 additions & 3 deletions paimon-core/src/test/java/org/apache/paimon/operation/metrics/CommitStatsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@ public void testFailedAppendSnapshot() {
Collections.emptyList(),
0,
0,
1);
1,
-1L);
assertThat(commitStats.getTableFilesAdded()).isEqualTo(0);
assertThat(commitStats.getTableFilesDeleted()).isEqualTo(0);
assertThat(commitStats.getTableFilesAppended()).isEqualTo(0);
Expand All @@ -94,6 +95,7 @@ public void testFailedAppendSnapshot() {
assertThat(commitStats.getNumBucketsWritten()).isEqualTo(0);
assertThat(commitStats.getDuration()).isEqualTo(0);
assertThat(commitStats.getAttempts()).isEqualTo(1);
assertThat(commitStats.getLastCommittedSnapshotId()).isEqualTo(-1);
}

@Test
Expand All @@ -106,7 +108,8 @@ public void testFailedCompactSnapshot() {
Collections.emptyList(),
3000,
1,
2);
2,
5L);
assertThat(commitStats.getTableFilesAdded()).isEqualTo(2);
assertThat(commitStats.getTableFilesDeleted()).isEqualTo(0);
assertThat(commitStats.getTableFilesAppended()).isEqualTo(2);
Expand All @@ -122,6 +125,7 @@ public void testFailedCompactSnapshot() {
assertThat(commitStats.getNumBucketsWritten()).isEqualTo(2);
assertThat(commitStats.getDuration()).isEqualTo(3000);
assertThat(commitStats.getAttempts()).isEqualTo(2);
assertThat(commitStats.getLastCommittedSnapshotId()).isEqualTo(5);
}

@Test
Expand All @@ -134,7 +138,8 @@ public void testSucceedAllSnapshot() {
compactChangelogFiles,
3000,
2,
2);
2,
10L);
assertThat(commitStats.getTableFilesAdded()).isEqualTo(4);
assertThat(commitStats.getTableFilesDeleted()).isEqualTo(1);
assertThat(commitStats.getTableFilesAppended()).isEqualTo(2);
Expand All @@ -150,5 +155,6 @@ public void testSucceedAllSnapshot() {
assertThat(commitStats.getNumBucketsWritten()).isEqualTo(3);
assertThat(commitStats.getDuration()).isEqualTo(3000);
assertThat(commitStats.getAttempts()).isEqualTo(2);
assertThat(commitStats.getLastCommittedSnapshotId()).isEqualTo(10);
}
}
1 change: 0 additions & 1 deletion ...on/src/main/java/org/apache/paimon/flink/source/metrics/FileStoreSourceReaderMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ public class FileStoreSourceReaderMetrics {

private long latestFileCreationTime = UNDEFINED;
private long lastSplitUpdateTime = UNDEFINED;

public static final long UNDEFINED = -1L;
public static final long ACTIVE = Long.MAX_VALUE;

Expand Down
Loading