kafbat/kafka-ui

Serde: Support `__transaction_state` topic

Open

#407 opened on May 22, 2024

View on GitHubContributor guide
 (6 comments) (0 reactions) (1 assignee)TypeScript (363 forks)auto 404
area/serdegood first issuehacktoberfestscope/backendstatus/triage/completedtype/enhancement

Repository metrics

Stars
 (2,554 stars)
PR merge metrics
 (PR metrics pending)

Description

Issue submitter TODO list

  • I've searched for an already existing issues here
  • I'm running a supported version of the application which is listed here and the feature is not present there

Is your proposal related to a problem?

I would like to be able to show content of the Kafka internal topics.

Describe the feature you're interested in

To get a better insight into the internal Kafka transactions topic __transaction_state it would be great to be able to show the key/value in a readable format. The necessary serdes/formatters should be available in the Kafka distribution/clients.

Describe alternatives you've considered

We are currently using the kafka-console-consumer.sh with the formatter for transactions.

$ kafka-console-consumer.sh --formatter "kafka.coordinator.transaction.TransactionLog\$TransactionLogMessageFormatter" --bootstrap-server localhost:29092 --topic __transaction_state --from-beginning

Version you're running

2956664 v1.0.0

Additional context

No response

Contributor guide

Research direction
Investigate how Kafka topic message Serdes are implemented in the backend. Look for existing Serde classes and see how to register a new one. Explore using the built in TransactionLogMessageFormatter from Kafka's clients for the transaction state topic. Determine where to add the formatter logic and how to enable it for internal topics.
Tech stack
java
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaKafka
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70