ansible/awx

Prometheus Metrics Best Practices

Open

#7,446 opened on Jun 25, 2020

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Python (3,333 forks)batch import
component:apihelp wanted

Repository metrics

Stars
 (13,071 stars)
PR merge metrics
 (Avg merge 24d 6h) (30 merged PRs in 30d)

Description

ISSUE TYPE
  • Make sure that exported metrics conform with Prometheus best practices
SUMMARY

I have made a PR at Prometheus docs to add AWX as a software exposing Prometheus metrics (https://github.com/prometheus/docs/pull/1685#issuecomment-649323355) and after a quick peek at AWX metrics code from @brian-brazil, he appointed a few things to change. I have see a few others open issues about metrics too, so maybe a check with a guideline or something like that can benefit AWX monitoring.

NOTE: I am not familiar with any of the code bases of the projects, I am simply messenger interested in both projects.

Contributor guide

Research direction
Review the Prometheus best practices for metrics (e.g., naming, labels, types) and compare with AWX's current exported metrics. Identify discrepancies and update the metric definitions accordingly.
Tech stack
pythonprometheus
Domain
backenddevops
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonPrometheus
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70