PIP-251: Add snapshot stats in TransactionBufferStats

[liangyepianzhou]

Motivation

As the multiple-snapshot introduced by PIP-196, the mechanism of Transaction Buffer Snapshot becomes more complex. We need more information to sense the status of the Transaction Buffer Snapshot.
Because the Transaction Buffer Snapshot is part of the Transaction Buffer, we plan to add an internal class in TransactionBufferStats to record the stats of the transaction snapshot.

Goal

Add an internal class in TransactionBufferStats to record the stats of the transaction snapshot. Let users can use the admin tool to get enough information about the transaction buffer snapshot.

API Changes

This PIP will change the result of admin.transactions().getTransactionBufferStats(yourTopicName);.

Implementation

• The previous results are as follows:

public class TransactionBufferStats {

   /** The state of this transaction buffer. */
   public String state;

   /** The max read position of this transaction buffer. */
   public String maxReadPosition;

   /** The last snapshot timestamps of this transaction buffer. */
   public long lastSnapshotTimestamps;
}

• The expected results are as follows:

public class TransactionBufferStats {
  /** The state of this transaction buffer. */
   public String state;

   /** The max read position of this transaction buffer. */
   public String maxReadPosition;

   /** The last snapshot timestamps of this transaction buffer.*/
   public long lastSnapshotTimestamps;
   /** The stats of snapshots that only exist when enabling multiple snapshot segments. */
   public SnapshotStats snapshotStats;
       
   public static class SnapshotStats {
        public long segmentsSize;

        public long unsealedAbortTxnIDs;
   }
}

Alternatives

No response

Anything else?

Compatibility

This modification will not break the previous usage of the admin tool.
In the previous usages, the snapshotStats will be ignored and other member variables have not changed.
In the new implementations, the users who enable the transaction buffer snapshot segment can get the snapshot segment stats from TransactionBufferStats.snapshotStats.

[michaeljmarshall]

@liangyepianzhou - I updated the PIP number since I already submitted PIP 250 just a few hours earlier.

[congbobo184]

   /** The stats of snapshots that only exist when enabling multiple snapshot segments. */
   public SnapshotStats snapshotStats;
       
   public static class SnapshotStats {
        public long segmentsSize;

        public long unsealedAbortTxnIDs;
   }

I suggest change snapshotStats to MultiSnapshotStats. it will include one snapshot segment detail and index detail.

detail include, time, abortTxns, snapshot postion eg.

[github-actions]

The issue had no activity for 30 days, mark with Stale label.