prometheus / prometheus/client_python
Provide APIs to help application developers test their Histogram-using code
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 4.4k
- 派生
- 876
- 平均合并
- 8 天 4 小时
- 30 天内合并 PR
- 1
描述
I have an application that uses Histogram. I want to write some tests that assert that my application is putting values into the right buckets of that histogram.
To read values out of the Histogram it seems that need to either:
- look at the Histogram's private
_bucketsattribute, or - call
Histogram.collectand look at the resultingMetricobjects which are documented as "intended only for internal use" and then look at itsSampleswhich aren't documented at all.
Neither of these seems particularly satisfactory. It would be very helpful if client_python provided some way to read bucket counts and the total sum from a Histogram, using documented APIs clearly marked as intended for external use (perhaps only in test suites).
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先检查 Python 客户端的 Histogram 实现,尤其是其 _buckets 属性和 collect 方法,以及它返回的 Metric 和 Samples 对象。定义并测试一个有文档说明的外部 API,用于读取 bucket 计数和总和,并添加覆盖率以表明应用程序测试可以在不使用私有对象或仅供内部使用的对象的情况下断言值。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- observability
- Issue 类型
- 功能
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100