Support for generic annotations and meta for third-party libraries
- 主要言語
- Python
- スター
- 339
- フォーク
- 147
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Hi, we would need to send some annotations (or meta) data along with the data that is sent automatically as a segment or subsegment. Taking into account that this data is grabbed from the context, so this data changes at each request. A good example is the `request_id` that is progressed as a header between all of the services.
We are keen on the Aiohttp user case but might be worth it have a solution that fits all of the integrations.
A possible solution that wouldn't introduce much technical debt would be adding a new method of the `Context` that would be called each time that a segment is closed/sent to add all extra meta/annotations. By default will do nothing, but the developer would have the chance to override this method subclassing the `Context` class and implementing its own logic.
Thoughts, any other ideas?
コントリビューションガイド
調査の方向性
まず Context クラスと segment/subsegment の close および send パスを読み、その後、Aiohttp のユースケースが request context をどのように提供するかを調べます。コンテキストから派生したアノテーションまたはメタデータを付加するための合意済み API を、いつ取得するか、またインテグレーションがどのように使用するかも含めて定義します。完了の条件は、設計が確定し、明記されたインテグレーションのケースについて動作がカバーされていることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- backend-api-design, observability-sre
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100