Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dhth/kplay
Inspect messages in a Kafka topic in a simple and deliberate manner
https://github.com/dhth/kplay
bubbletea kafka tui
Last synced: 3 months ago
JSON representation
Inspect messages in a Kafka topic in a simple and deliberate manner
- Host: GitHub
- URL: https://github.com/dhth/kplay
- Owner: dhth
- License: mit
- Created: 2024-03-03T00:01:31.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-07-08T20:16:13.000Z (4 months ago)
- Last Synced: 2024-07-09T01:28:37.469Z (4 months ago)
- Topics: bubbletea, kafka, tui
- Language: Go
- Homepage: https://tools.dhruvs.space/kplay
- Size: 1.43 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- charm-in-the-wild - kplay - Inspect messages in a Kafka topic. (_built with Bubble Tea_) (Applications / Cloud and DevOps)
README
# kplay
✨ Overview
---
`kplay` lets you inspect messages in a Kafka topic in a simple and deliberate
manner. Using it, you can pull one or more records on demand, peruse through
them in a list, and, if needed, persist them to your local filesystem.
Install
---
**homebrew**:
```sh
brew install dhth/tap/kplay
```
**go**:
```sh
go install github.com/dhth/kplay@latest
```
⚡️ Usage
---
### Consuming JSON messages
As a binary, kplay only supports consuming JSON messages.
```bash
kplay \
-brokers='' \
-topic='' \
-group=''
```
### Consuming protobuf messages
Protobuf messages can be consumed, but that will need some tweaks to the source
code.
Place your protobuf files under `./proto`. Using the protoc compiler, run:
```bash
protoc --go_out=. proto/.proto
```
Change the generated struct reference in `./ui/model/utils.go`.
Compile, and run.
### Authentication
By default, `kplay` operates under the assumption that brokers do not
authenticate requests. Besides this, it also supports [AWS IAM
authentication][2] (turned on via `-auth='msk_iam_auth'`).
TODO
---
- [ ] Add ability to only save records that match a chosen set of keys
Acknowledgements
---
`kplay` is built using the awesome TUI framework [bubbletea][1].
[1]: https://github.com/charmbracelet/bubbletea
[2]: https://docs.aws.amazon.com/msk/latest/developerguide/iam-access-control.html