pingcap/tidb

Add units to the numeric options in the configuration file

Open

#17 847 ouverte le 8 juin 2020

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Go (6 186 forks)batch import
component/configfeature/acceptedhelp wantedtype/feature-requesttype/usability

Métriques du dépôt

Stars
 (40 090 stars)
Métriques de merge PR
 (Merge moyen 14j 4h) (346 PRs mergées en 30 j)

Description

Feature Request

Is your feature request related to a problem? Please describe:

Most of the numeric configs lack unit. It is easy to confuse users. For example,

https://github.com/pingcap/tidb/blob/b05327509cb3584881815c2605a7537bbc24a8f0/config/config.toml.example#L243

104857600 should be 104857600B and 10737418240 should be 10737418240B or 10G.

Here is another example causing problems: #17434. https://github.com/pingcap/tidb/issues/17434#issuecomment-640209382

Describe the feature you'd like:

  • Add units to the numeric options in the configuration file.
  • Forbid numeric options without units.

Describe alternatives you've considered:

  • Explain the units in documents
  • Explain the units in the configuration file comments

Both of these solutions are not easy to use enough.

Teachability, Documentation, Adoption, Migration Strategy:

Change how the configuration file is parsed.

Guide contributeur

Direction de recherche
Examinez comment TiDB analyse les fichiers de configuration, en particulier les options numériques. Examinez les bibliothèques d'analyse d'unités existantes ou les modèles dans la base de code et proposez une manière d'ajouter la prise en charge des unités qui soit rétrocompatible pour les valeurs lisibles tout en imposant des unités pour les nouvelles configurations.
Stack technique
go
Domaine
backendinfrastructure
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Goconfiguration parsing
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40