pingcap / pingcap/ticdc

[P4][Logs] Standardize structured field names and remove duplicate keys

Open
#4,754 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

Field naming is currently inconsistent across modules, and some logs even reuse the same key for different values. That makes aggregation and search harder than necessary. This task standardizes field names and removes duplicate-key cases so log platforms can query on stable dimensions.

Modification points

  • Define consistent field names for core identifiers such as changefeed, dispatcher, node, subscription, region, event service, operator, and mode.
  • Remove duplicate keys inside a single log entry and align equivalent concepts to the same key name across modules.
  • Prefer structured field consistency over free-text parsing in message bodies.

Entry points

  • maintainer/operator/operator_controller.go:268
  • server/server.go:422
  • downstreamadapter/dispatcherorchestrator/dispatcher_orchestrator.go:247

Done criteria

  • Equivalent identifiers use the same field names across the targeted paths.
  • No targeted log entry contains duplicate keys with ambiguous overwrite behavior.
  • Aggregation and filtering can rely on structured fields rather than message parsing.

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

Review the targeted log paths in maintainer/operator/operator_controller.go:268, server/server.go:422, and downstreamadapter/dispatcherorchestrator/dispatcher_orchestrator.go:247. Compare structured fields for equivalent identifiers and identify duplicate keys within each log entry. Done means consistent names across the targeted paths, no ambiguous duplicate keys, and fields usable for aggregation without parsing message text.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
observability
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.