tikv/tikv

Suggestion: make config item names more readable

Open

#3503 opened on Aug 23, 2018

View on GitHub
 (1 comment) (2 reactions) (0 assignees)Rust (15,922 stars) (2,189 forks)batch import
difficulty/easyhelp wantedtype/enhancement

Description

Feature Request

For commonly used configurations, it's name should be easy to understand by users (i.e. obvious) with as less as technical details as possible. If its meaning can be understood without comments, it is the best.

Some negative examples:

  • TiDB's token-limit

    For users, what is token? Why should I limit token?

    However, names like "max-sessions" is much more obvious.

  • TiKV's readpool

    For users, what is read pool? Shouldn't TiKV contains storage / coprocessor / mvcc etc?

  • TiKV's end-point-xxx

    For users, what is endpoint?

Some positive examples:

  • TiKV's storage.data-dir

    The data directory. Easy to understand.

  • TiKV's server.label

    The label for this server. Easy to understand.

However for advanced configurations (those that we rarely change), the change might be not necessary.

Contributor guide

Tech stack
rust
Domain
backenddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
familiarity with TiKV config systemRust basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
The issue suggests renaming config items for readability. Start by examining the config definition files in TiKV, likely in `src/config.rs` or similar. Identify commonly used config keys that are unclear, such as those mentioned (token limit, readpool, end point xxx). Propose new names that are intuitive. Ensure any changes do not break existing configurations consider backward compatibility or deprecation warnings. Update documentation accordingly. Also check if there is any ongoing work in linked issues or PRs.