Extend OpenMetrics by a stability data type
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
調査の方向性
ここでは実装ファイルやテストが指定されていないため、まず OpenMetrics 仕様と関連する OpenObservability の issue #189 を読んでください。ライフサイクルフィールド、構文、セマンティクス、互換性への影響について合意し、それらが仕様に反映された時点で作業は完了です。
索引モデルが issue の本文から書いたものです。
説明
In order to improve metrics experience, I would like to propose two fields to be added to the spec.
Stability
Stability is a string that is used to describe the maturity of the MetricFamily. If it is unset, the MetricFamily is considered stable
Recommended values for lifecycle:
* Alpha for metrics that might be renamed or are unstable in terms of other features (e.g. units or dimensions).
* Beta for metrics that will be considered stable soon.
* Stable This is the default and what consumers can assume if the Stability string is not set.
* Deprecated for metrics that should not be used anymore.
StabilityHint
StabilityHint is string that is used to provide a human-readable hint for the MetricFamily. This can include e.g. a replacement for the MetricFamily.
As an example:
# TYPE process_cpu_microseconds_total counter
# UNIT process_cpu_microseconds_total seconds
# HELP process_cpu_microseconds_total Total user and system CPU time spent in seconds.
# STABILITY process_cpu_microseconds_total Deprecated
# STABILITYHINT process_cpu_microseconds_total This metric going to be replaced by process_cpu_seconds_total.
process_cpu_microseconds_total 4.20072246e+06
This could allow consumers to warn when an unstable metric is used and improve metrics lifecycle. We currently see issues where e.g. grafana dashboards use a deprecated metric and users only figure out when the metric is gone on the consumer side.
This is similar to https://github.com/OpenObservability/OpenMetrics/issues/189 but with a clearer focus on lifecycle.
- 主要言語
- Go
- スター
- 2.5k
- フォーク
- 175
- 平均マージ
- 1日 22時間
- マージ済み PR(30日)
- 1
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
prometheus/OpenMetrics のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
prometheus/OpenMetrics#323 ·
-
OM 2.0
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
prometheus/OpenMetrics#312 · コメント 13 件 ·
-
OM 2.0
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
prometheus/OpenMetrics#310 · コメント 4 件 · リアクション 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
prometheus/OpenMetrics#304 · コメント 1 件 ·
-
RFC next stepsオープン
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
prometheus/OpenMetrics#301 ·
prometheus/OpenMetrics の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
txn2/mcp-data-platform#2728 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
blinklabs-io/dingo#6504 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
SocialGouv/iterion#3413 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
orion-belt-dev/orion-belt#181 ·
メンテナーはふだん 1 日以内に返信
-
documentation good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 79/100
kubesmarts/logic-operator#105 ·
メンテナーはふだん 1 日以内に返信