prometheus / prometheus/client_python

Improve documentation for Enum and Info classes

未关闭
#499 5 条评论 7 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Python
星标
4.4k
派生
876
平均合并
8 天 4 小时
30 天内合并 PR
1

描述

In Instrumenting section of documentation (https://github.com/prometheus/client_python#instrumenting) there is written:

Four types of metric are offered: Counter, Gauge, Summary and Histogram.

Classes for exposing these metrics are then described and in addition there are mentioned also Info and Enum classes without explanation how these classes should be used and what type of metrics they expose. These should be documented in more detail.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从仓库的“Instrumenting”文档部分开始,检查其中如何描述现有的指标类。记录 Info 和 Enum 类的使用方式,以及它们提供的指标类型;当这两个类都有与其他指标类型相当的说明时,该部分即完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。