googleapis / googleapis/google-cloud-cpp
Rename options named tracing that do logging
- 主要言語
- C++
- スター
- 659
- フォーク
- 462
- 平均マージ
- 1日 2時間
- マージ済み PR(30日)
- 89
説明
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`
コントリビューションガイド
調査の方向性
まず、公開 API 宣言とドキュメントで、一覧にある Tracing 型、環境変数、レガシー名 CLOUD_STORAGE_TRACING を検索します。名前変更を計画する前に各参照を追跡し、その後、新しい Logging 名がドキュメント化されている一方で、レガシー名と変数が指定どおり引き続きサポートされ、非推奨になっていることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- cpp
- 領域
- api, documentation
- issue の種類
- リファクタリング
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100