googleapis / googleapis/google-cloud-cpp
Rename options named tracing that do logging
- Lenguaje dominante
- C++
- Estrellas
- 659
- Forks
- 462
- Merge medio
- 1 d 2 h
- PR fusionados (30 d)
- 89
Descripción
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`
Guía de contribución
Línea de trabajo
Empieza buscando en las declaraciones de la API pública y en la documentación los tipos de Tracing, las variables de entorno y el nombre heredado CLOUD_STORAGE_TRACING indicados. Rastrea cada referencia antes de planificar el cambio de nombre y, después, verifica que los nuevos nombres de Logging estén documentados, mientras que los nombres y las variables heredados sigan siendo compatibles y estén marcados como obsoletos según lo especificado.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- cpp
- Área
- api, documentation
- Tipo de issue
- Refactorización
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100