redpanda-data / redpanda-data/redpanda

controller: Add INFO log-level log when a topic configuration was changed

Open
#7,885 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/controller kind/enhance supportability
Dominant language
C++
Stars
12.6k
Forks
792
PR merge metrics
No merged PRs in 30d

Description

Who is this for and what problem do they have today?

This is for Redpanda users who need to troubleshoot and check when a configuration was changed.

What are the success criteria?

INFO level to log when a topic configuration was changed and record the previous value and the newly updated value. If possible, add who(client IP and user) changed the configuration

Why is solving this problem impactful?

Currently, we have INFO-level logs when a new topic is created. The log includes default configuration values. However, there are no logs to check when a configuration was changed. As a result, we always have to need run rpk command to check current configuration values. But, the rpk command cannot tell when the configuration was updated. Sometimes rpk command fails when a cluster is not stable. For example, the nodes are repeatedly restarted as a bug, it is almost impossible to check the configurations.

Additional notes

N/A

JIRA Link: CORE-1115

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

Start by locating the existing INFO log for topic creation and the code path that updates topic configuration. Check whether the update path exposes the previous and new values and client identity, then add logging and tests showing the change is recorded at INFO level.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
backend, observability, stream-processing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.