prometheus / prometheus/client_python
Improve documentation for Enum and Info classes
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 4.4k
- Fork
- 876
- Merge trung bình
- 8 ngày 4 giờ
- Pull request đã merge (30 ngày)
- 1
Mô tả
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.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu trong phần tài liệu „Instrumenting“ của repository và xem lại cách các lớp metric hiện có được mô tả. Ghi lại cách sử dụng các lớp Info và Enum cũng như các loại metric mà chúng cung cấp; phần này được xem là hoàn chỉnh khi cả hai lớp đều có phần giải thích tương đương với các loại metric khác.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100