Skip to content

KAFKA-20712: Fix transaction state name in log decoder output#22615

Open
fvaleri wants to merge 1 commit into
apache:trunkfrom
fvaleri:fix-txn-dec
Open

KAFKA-20712: Fix transaction state name in log decoder output#22615
fvaleri wants to merge 1 commit into
apache:trunkfrom
fvaleri:fix-txn-dec

Conversation

@fvaleri

@fvaleri fvaleri commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

The TransactionLogMessageParser and TransactionLogMessageFormatter
output the numeric transactionStatus (e.g. 4) instead of the human
readable state name (e.g. CompleteCommit). This was caused by the
migration to auto generated CoordinatorRecordJsonConverters which
serialize the int8 field as is. Resolve the byte to the state name via
TransactionState.fromId() in both the dump log and consumer formatter
code paths.

The TransactionLogMessageParser and TransactionLogMessageFormatter
output the numeric transactionStatus (e.g. 4) instead of the human
readable state name (e.g. CompleteCommit). This was caused by the
migration to auto generated CoordinatorRecordJsonConverters which
serialize the int8 field as is. Resolve the byte to the state name
via TransactionState.fromId() in both the dump log and consumer
formatter code paths.

Signed-off-by: Federico Valeri <fedevaleri@gmail.com>
@github-actions github-actions Bot added tools triage PRs from the community small Small PRs labels Jun 18, 2026
@fvaleri

fvaleri commented Jun 18, 2026

Copy link
Copy Markdown
Contributor Author

I also ran the following manual tests:

# DECODER
$ bin/kafka-dump-log.sh --transaction-log-decoder \
  --files build/test/server3/data/__transaction_state-30/00000000000000000000.log
Dumping build/test/server3/data/__transaction_state-30/00000000000000000000.log
Log starting offset: 0
baseOffset: 0 lastOffset: 0 count: 1 baseSequence: -1 lastSequence: -1 producerId: -1 producerEpoch: -1 partitionLeaderEpoch: 0 isTransactional: false isControl: false deleteHorizonMs: OptionalLong.empty position: 0 CreateTime: 1781778768196 size: 129 magic: 2 compresscodec: none crc: 326836132 isvalid: true
| offset: 0 CreateTime: 1781778768196 keySize: 15 valueSize: 45 sequence: -1 headerKeys: [] key: {"type":"0","data":{"transactionalId":"kafka-txn-0"}} payload: {"version":"1","data":{"producerId":0,"previousProducerId":0,"producerEpoch":0,"transactionTimeoutMs":60000,"transactionStatus":"Empty","transactionPartitions":null,"transactionLastUpdateTimestampMs":1781778768194,"transactionStartTimestampMs":-1}}
baseOffset: 1 lastOffset: 1 count: 1 baseSequence: -1 lastSequence: -1 producerId: -1 producerEpoch: -1 partitionLeaderEpoch: 0 isTransactional: false isControl: false deleteHorizonMs: OptionalLong.empty position: 129 CreateTime: 1781778790949 size: 159 magic: 2 compresscodec: none crc: 3923950402 isvalid: true
| offset: 1 CreateTime: 1781778790949 keySize: 15 valueSize: 74 sequence: -1 headerKeys: [] key: {"type":"0","data":{"transactionalId":"kafka-txn-0"}} payload: {"version":"1","data":{"producerId":0,"previousProducerId":0,"producerEpoch":0,"transactionTimeoutMs":60000,"transactionStatus":"Ongoing","transactionPartitions":[{"topic":"__consumer_offsets","partitionIds":[12]}],"transactionLastUpdateTimestampMs":1781778790949,"transactionStartTimestampMs":1781778790949,"clientTransactionVersion":2}}
baseOffset: 2 lastOffset: 2 count: 1 baseSequence: -1 lastSequence: -1 producerId: -1 producerEpoch: -1 partitionLeaderEpoch: 0 isTransactional: false isControl: false deleteHorizonMs: OptionalLong.empty position: 288 CreateTime: 1781778790976 size: 178 magic: 2 compresscodec: none crc: 2885873356 isvalid: true
| offset: 2 CreateTime: 1781778790976 keySize: 15 valueSize: 93 sequence: -1 headerKeys: [] key: {"type":"0","data":{"transactionalId":"kafka-txn-0"}} payload: {"version":"1","data":{"producerId":0,"previousProducerId":0,"producerEpoch":0,"transactionTimeoutMs":60000,"transactionStatus":"Ongoing","transactionPartitions":[{"topic":"output-topic","partitionIds":[0]},{"topic":"__consumer_offsets","partitionIds":[12]}],"transactionLastUpdateTimestampMs":1781778790976,"transactionStartTimestampMs":1781778790949,"clientTransactionVersion":2}}
baseOffset: 3 lastOffset: 3 count: 1 baseSequence: -1 lastSequence: -1 producerId: -1 producerEpoch: -1 partitionLeaderEpoch: 0 isTransactional: false isControl: false deleteHorizonMs: OptionalLong.empty position: 466 CreateTime: 1781778791003 size: 178 magic: 2 compresscodec: none crc: 2328565620 isvalid: true
| offset: 3 CreateTime: 1781778791003 keySize: 15 valueSize: 93 sequence: -1 headerKeys: [] key: {"type":"0","data":{"transactionalId":"kafka-txn-0"}} payload: {"version":"1","data":{"producerId":0,"previousProducerId":0,"producerEpoch":1,"transactionTimeoutMs":60000,"transactionStatus":"PrepareCommit","transactionPartitions":[{"topic":"output-topic","partitionIds":[0]},{"topic":"__consumer_offsets","partitionIds":[12]}],"transactionLastUpdateTimestampMs":1781778791003,"transactionStartTimestampMs":1781778790949,"clientTransactionVersion":2}}
baseOffset: 4 lastOffset: 4 count: 1 baseSequence: -1 lastSequence: -1 producerId: -1 producerEpoch: -1 partitionLeaderEpoch: 0 isTransactional: false isControl: false deleteHorizonMs: OptionalLong.empty position: 644 CreateTime: 1781778791028 size: 133 magic: 2 compresscodec: none crc: 3554341315 isvalid: true
| offset: 4 CreateTime: 1781778791028 keySize: 15 valueSize: 49 sequence: -1 headerKeys: [] key: {"type":"0","data":{"transactionalId":"kafka-txn-0"}} payload: {"version":"1","data":{"producerId":0,"previousProducerId":0,"producerEpoch":1,"transactionTimeoutMs":60000,"transactionStatus":"CompleteCommit","transactionPartitions":[],"transactionLastUpdateTimestampMs":1781778791008,"transactionStartTimestampMs":1781778790949,"clientTransactionVersion":2}}

# FORMATTER
$ bin/kafka-console-consumer.sh --bootstrap-server localhost:9092 --topic __transaction_state --from-beginning \  
  --formatter org.apache.kafka.tools.consumer.TransactionLogMessageFormatter 2>/dev/null
{"key":{"type":0,"data":{"transactionalId":"kafka-txn-0"}},"value":{"version":1,"data":{"producerId":0,"previousProducerId":0,"producerEpoch":0,"transactionTimeoutMs":60000,"transactionStatus":"Empty","transactionPartitions":null,"transactionLastUpdateTimestampMs":1781779953988,"transactionStartTimestampMs":-1}}}{"key":{"type":0,"data":{"transactionalId":"kafka-txn-0"}},"value":{"version":1,"data":{"producerId":0,"previousProducerId":0,"producerEpoch":0,"transactionTimeoutMs":60000,"transactionStatus":"Ongoing","transactionPartitions":[{"topic":"__consumer_offsets","partitionIds":[12]}],"transactionLastUpdateTimestampMs":1781779965937,"transactionStartTimestampMs":1781779965937,"clientTransactionVersion":2}}}{"key":{"type":0,"data":{"transactionalId":"kafka-txn-0"}},"value":{"version":1,"data":{"producerId":0,"previousProducerId":0,"producerEpoch":0,"transactionTimeoutMs":60000,"transactionStatus":"Ongoing","transactionPartitions":[{"topic":"output-topic","partitionIds":[1]},{"topic":"__consumer_offsets","partitionIds":[12]}],"transactionLastUpdateTimestampMs":1781779965967,"transactionStartTimestampMs":1781779965937,"clientTransactionVersion":2}}}{"key":{"type":0,"data":{"transactionalId":"kafka-txn-0"}},"value":{"version":1,"data":{"producerId":0,"previousProducerId":0,"producerEpoch":1,"transactionTimeoutMs":60000,"transactionStatus":"PrepareCommit","transactionPartitions":[{"topic":"output-topic","partitionIds":[1]},{"topic":"__consumer_offsets","partitionIds":[12]}],"transactionLastUpdateTimestampMs":1781779965993,"transactionStartTimestampMs":1781779965937,"clientTransactionVersion":2}}}{"key":{"type":0,"data":{"transactionalId":"kafka-txn-0"}},"value":{"version":1,"data":{"producerId":0,"previousProducerId":0,"producerEpoch":1,"transactionTimeoutMs":60000,"transactionStatus":"CompleteCommit","transactionPartitions":[],"transactionLastUpdateTimestampMs":1781779966000,"transactionStartTimestampMs":1781779965937,"clientTransactionVersion":2}}}

@fvaleri

fvaleri commented Jun 18, 2026

Copy link
Copy Markdown
Contributor Author

@chia7712 @dajac @jolshan fyi

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci-approved small Small PRs tools triage PRs from the community

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants