googleapis / googleapis/google-cloud-cpp

Rename options named tracing that do logging

Offen
#14,269 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
type: cleanup
Vorherrschende Sprache
C++
Sterne
659
Forks
462
Ø Merge
1 T. 2 Std.
Gemergte PRs (30 T.)
89

Beschreibung

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`

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Start by searching the public API declarations and documentation for the listed Tracing types, environment variables, and the legacy CLOUD_STORAGE_TRACING name. Trace each reference before planning the rename, then verify that the new Logging names are documented while legacy names and variables remain supported and deprecated as specified.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
cpp
Bereich
api, documentation
Issue-Typ
Refactoring
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.