ansible/awx

Make Info Metrics more easy to query

Open

#3,781 opened on Apr 29, 2019

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Python (13,071 stars) (3,333 forks)batch import
Hacktoberfestcomponent:apigood first issue

Description

ISSUE TYPE
  • Bug Report
SUMMARY

Currently awx_system_info and awx_instance_info metrics are returned as labels with values, which makes it difficult to query just the value of one key. As a result, you can't query individual key's for their values in prometheus, for example: awx_system_info{anisble_version}. This has already been fixed for licenses.

We should make the rest of these individual metrics so that they can be individually queried. i.e.: "I am a customer who likes to see my Ansible version and tower version in Dashboard for Tower in Grafana"

ENVIRONMENT
  • AWX version: 4.0.0

Contributor guide

Tech stack
python
Domain
backendobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonPrometheus basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue requests exposing individual metrics like `awx system info{ansible version}` as separate gauge metrics instead of labels. This was already done for license metrics. Look at the current metrics implementation, likely in a file like `awx/main/metrics.py`, and replicate the pattern used for license metrics. Check the comments on the issue for any additional context or progress. Ensure each info metric value is exposed as its own metric with appropriate help text.