redpanda-data / redpanda-data/console

Analyze schema from messages in a topic

Open
#100 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

backend feature frontend
Dominant language
TypeScript
Stars
4.3k
Forks
432
Avg merge
3d 6h
Merged PRs (30d)
40

Description

Usecase

The Kafka topics I work with contain JSON encoded messages which follow a certain schema. The possible properties and the value types aren't clear at first glance. However knowing the schema is key to consume a topic and in the end to work with the data. To make this easier Kowl can help us by generating a schema in a best effort fashion from a set of sample messages.

Kowl can fetch the set of samples messages by simply consuming a represantative set of messages.

Challenges / To be clarified:

  • Some topics do not follow a strict schema or single messages may be in conflict with the general schema
  • Schema changes in the course of time are common
  • What is a representative set of sample messages? (number of messages, what offsets etc)
  • What encodings do we want to support and what do we show for unsupported encodings? (JSON, XML, ...)
  • Generating the schema from the set of messages (do libraries exist for that?)
  • In what format do we want to return the recognized schema?

Hints:

This issue complements https://github.com/cloudhut/kowl/issues/49 very well and combining the information from these two solutions should be considered for the best possible user experience.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by resolving the listed questions about sample selection, encodings, schema conflicts, and output format; done criteria are not defined yet.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
data, stream-processing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.