pingcap / pingcap/ticdc

[P2][Logs] Standardize log messages and verb choices for searchability

Open
#4,740 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type/enhancement
Dominant language
Go
Stars
56
Forks
63
Avg merge
2d 20h
Merged PRs (30d)
34

Description

Parent issue: #4691

Intent

Log messages currently use inconsistent verbs, grammar, and message templates. That makes keyword search, grouping, and dashboards less reliable. This task standardizes message wording so similar incidents use stable, searchable text.

Modification points

  • Replace low-information templates such as start to, just ignore, and this should not happen with a stable subject + action + result + reason pattern.
  • Normalize verb choices for common actions such as start, stop, reset, retry, drop, and ignore.
  • Remove grammar issues and repeated wording that do not add meaning.

Entry points

  • coordinator/operator/operator_move.go:65
  • coordinator/operator/operator_move.go:116
  • coordinator/operator/operator_move.go:157
  • downstreamadapter/dispatcherorchestrator/dispatcher_orchestrator.go:289
  • downstreamadapter/dispatcherorchestrator/dispatcher_orchestrator.go:295
  • server/module_election.go:90

Done criteria

  • Similar incidents can be found by stable keywords instead of fuzzy free-text matching.
  • Message text no longer depends on source code context to be understood.
  • Low-information templates and inconsistent verbs are removed from the targeted paths.

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 inspecting the listed log statements in coordinator/operator/operator_move.go at lines 65, 116, and 157, downstreamadapter/dispatcherorchestrator/dispatcher_orchestrator.go at lines 289 and 295, and server/module_election.go at line 90. Compare their verbs, grammar, templates, and available context, then standardize the targeted messages so similar incidents use stable keywords, express subject, action, result, and reason, and no longer rely on source context.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
observability-sre
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
74/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.