NETWAYS / NETWAYS/check_prometheus

[Feature]: Output Formatting

Open
#85 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
Go
Stars
21
Forks
5
Avg merge
2m
Merged PRs (30d)
1

Description

Describe the feature request

Hi. Our checks use Prometheus queries that return a floating point number. This works, but especially percentages and time values are hard to interpret, see the given examples.

A format flag for the return values would be great to solve this. It does not have to be as complex as in Grafana, but some basics would be nice.

Formats that would be currently useful to us:

  • number (default)
  • percent (0-1)
  • time (seconds)
  • data (bytes [1000 bits])

Examples:
io-usage in percent

Image
certificate expiration in seconds

Image

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how Prometheus query results are handled and how check output is currently rendered. Define the format flag's scope around the requested number, percent, time, and data formats, including the default behavior. Done means the selected format is applied consistently to returned values and the existing number output remains the default.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, prometheus
Domain
cli, observability-sre
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.