googleapis / googleapis/google-cloud-cpp
Rename options named tracing that do logging
- Langage dominant
- C++
- Étoiles
- 659
- Forks
- 462
- Merge moyen
- 1 j 2 h
- PR mergées (30 j)
- 89
Description
Googlers can see: go/cloud-cxx:s-slash-tracing-logging-options
---
I say we adopt OpenTelemetry’s naming scheme for our telemetry interfaces. This basically means s/Tracing/Logging/ for these types.
We will introduce new types using “Logging” instead of “Tracing”. We will leave using declarations for the old types, for backwards compatibility. We will also mark the old types as deprecated.
This looks like:
- introducing `g::c::LoggingComponentsOption`, to replace `g::c::TracingComponentsOption`.
- introducing `g::c::LoggingFormat`, to replace g::c::TracingOptions.
- introducing `g::c::LoggingFormatOption`, (in common) to replace `g::c::GrpcTracingOptionsOption` and `g::c::RestTracingOptionsOption`.
- introducing `GOOGLE_CLOUD_CPP_ENABLE_LOGGING`, `GOOGLE_CLOUD_CPP_LOGGING_FORMAT` to replace the old ones. We still respect the legacy environment variables for backwards compatibility, but we purge our docs of them.
We will need to do a pass on the public docs referencing the old types / old env vars.
We also need to look into legacy GCS env var: `CLOUD_STORAGE_TRACING`
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Commencez par rechercher dans les déclarations de l'API publique et la documentation les types de Tracing, les variables d'environnement et l'ancien nom CLOUD_STORAGE_TRACING indiqués. Suivez chaque référence avant de planifier le renommage, puis vérifiez que les nouveaux noms de Logging sont documentés, tandis que les anciens noms et variables restent pris en charge et sont marqués comme obsolètes conformément aux spécifications.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- cpp
- Domaine
- api, documentation
- Type d'issue
- Refactorisation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100