Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Store metrics docstrings and allow to query them #2747

Closed
AlekSi opened this Issue May 19, 2017 · 4 comments

Comments

Projects
None yet
4 participants
@AlekSi
Copy link
Contributor

AlekSi commented May 19, 2017

Prometheus doesn't currently store metrics docstrings (#HELP lines in text format). They could be useful for a user in various UIs and dashboards.

I think they can be stored as simple non-versioned metainformation. If some metric has different docstrings in various jobs, then log a warning and overwrite it (the last write wins).

Obviously, they also should be exposed via API.

@aweiteka

This comment has been minimized.

Copy link

aweiteka commented Dec 18, 2017

+1. Here's a specific use case:

As a query developer creating queries for dashboards and alerts, I would like to enable "help mode" in the prometheus web UI so I can understand exactly what data is being returned so I have confidence the data I am getting is what I want. This might be implemented as a mouseover tooltip in the query bar or as a function, e.g. help(<metric_name>)

@gouthamve

This comment has been minimized.

Copy link
Member

gouthamve commented Jan 18, 2018

Related: #376

@brian-brazil

This comment has been minimized.

Copy link
Member

brian-brazil commented Jun 13, 2018

#4183 added this.

@lock

This comment has been minimized.

Copy link

lock bot commented Mar 22, 2019

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot locked and limited conversation to collaborators Mar 22, 2019

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
You can’t perform that action at this time.