Discrepancy between metrics names in prometheus and metadata
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 40/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- prometheus, python
调研方向
首先跟踪 Counter 名称如何被规范化,以及 metadata 如何通过 /api/v1/metadata 暴露,并使用 issue 中的两个示例作为复现。比较 Prometheus exposition name 与 metadata key,并添加回归覆盖,展示使用和不使用 _total 后缀创建的 Counter 的命名一致性。
由索引模型根据 Issue 内容生成。
描述
Hello,
When creating a Counter metric with client_python 0.4.0 - 0.16.0:
my_metric_count = Counter(name='my_metric_count',
documentation='My helpful description',
registry=MY_REGISTRY)
The metric will show in prometheus as my_metric_count_total. This is absolutely fine with the world however that same metric will show under http://prometheus:9090/api/v1/metadata as the original name:
"my_metric_count": [
{
"type": "counter",
"help": "My helpful description",
"unit": ""
}
],
If one creates the metric with '_total' suffix:
my_metric_count = Counter(name='my_metric_count_total',
documentation='My helpful description',
registry=MY_REGISTRY)
It will show in prometheus as that exact name my_metric_count_total but the name in the /api/v1/metadata will now be truncated.
"my_metric_count": [
{
"type": "counter",
"help": "My helpful description",
"unit": ""
}
],
This breaks certain input plugins with telegraf that rely on the prometheus metadata and remote write to fetch the metric type. Version of this library starting with 0.4.0 exhibit this behavior which is when metrics names began to be munged with '_total' for compatibility with OpenMetrics.
Thank you.
- 主要语言
- Python
- 星标
- 4.4k
- 派生
- 876
- 平均合并
- 8 天 4 小时
- 30 天内合并 PR
- 1
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
prometheus/client_python 的其他 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 70/100
prometheus/client_python#1177 · 1 条评论 ·
-
难度 4/5 3-5 天 新手友好度 45/100
prometheus/client_python#1210 ·
-
难度 2/5 1-3 小时 新手友好度 58/100
prometheus/client_python#1199 · 1 个 reaction ·
-
难度 5/5 一周以上 新手友好度 35/100
prometheus/client_python#1176 ·
-
难度 1/5 1-3 小时 新手友好度 52/100
prometheus/client_python#1126 · 2 条评论 ·
查看 prometheus/client_python 的全部 Issue
相似的 Issue
-
agent-ready documentation needs-triage
难度 1/5 1-3 小时 新手友好度 88/100
-
documentation
难度 1/5 1 小时以内 新手友好度 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" 未关闭
难度 1/5 1 小时以内 新手友好度 92/100
-
instance instance add
难度 1/5 1 小时以内 新手友好度 72/100
searxng/searx-instances#939 · 1 条评论 ·
-
area-deployment area-integrations triage:bot-seen
难度 2/5 半天 新手友好度 86/100