api/v1: added /status/runtimeinfo #5165

vn-ki · 2019-01-31T16:33:06Z

This does not yet build. I want some pointers before I can go ahead.

Right now, because I have the types in web.go, I am running into a cyclic import.

Is there a file where I can place RuntimeInfo struct and PrometheusVersion struct?

If not, how do I tackle this problem? Is my approach fundamentally wrong?

Ping: @brancz @mxinden

Closes #2467

Signed-off-by: Vishnunarayan K I appukuttancr@gmail.com

mxinden · 2019-02-01T12:16:18Z

Is there a file where I can place RuntimeInfo struct and PrometheusVersion struct?

As these are specific to an API interface and should not break once a different API (web.go) interface changes, I would vote for duplicating the structs in api/v1/api.go, given that they are also quite simple.

I am not a maintainer of Prometheus. What do others think?

brian-brazil · 2019-02-01T12:29:50Z

Hmm, how about factoring that out and providing a warning that the contents of the map may change over time?

vn-ki · 2019-02-01T23:22:52Z

@brian-brazil By factoring out do you mean to place the structs in a different file which both api.go and web.go can import?

brian-brazil · 2019-02-02T09:05:55Z

Yes

…

On Fri 1 Feb 2019, 23:23 Vishnunarayan K I ***@***.*** wrote: @brian-brazil <https://github.com/brian-brazil> By factoring out do you mean to place the structs in a different file which both api.go and web.go can import? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#5165 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AGyTdroGjj8OYL9KZ0Ih2MQcMZ4-pP45ks5vJMxagaJpZM4acrl4> .

vn-ki · 2019-02-02T12:50:43Z

@brian-brazil I factored it out. Can you check the implementation? I'll add the warning and necessary docs after that.

vn-ki · 2019-02-03T11:51:47Z

I have added the documentation of the api (with a warning it might change) and the required tests.

docs/querying/api.md

web/types/types.go

web/web.go

docs/querying/api.md

web/types/types.go

vn-ki · 2019-02-05T20:17:22Z

Resolved all issues

mxinden

I think a consistent API is important. I am sorry for the nit picking.

web/web_types/types.go

vn-ki · 2019-02-07T09:07:27Z

@mxinden All fixed

mxinden

Small nit. Other than that this looks good to me. Are there any thoughts by others left?

web/web_types/types.go

vn-ki · 2019-02-17T14:25:37Z

@mxinden Done

mxinden

Looks good to me, thanks for bearing with us @vn-ki!

Giving @brian-brazil the last vote as a Prometheus maintainer.

juliusv · 2019-02-18T20:29:42Z

web/web_types/types.go

+	CWD                 string             `json:"cwd"`
+	Version             *PrometheusVersion `json:"version"`
+	Alertmanagers       []*url.URL         `json:"alertmanagers"`
+	GoroutineCount      int                `json:"goroutineCNT"`


Is there a particular reason why you specifically abbreviate Count -> CNT here? Seems inconsistent with the other fields, especially the other ...Count fields.

Otherwise this PR looks 👍

brian-brazil · 2019-02-19T11:11:17Z

web/web_types/types.go

+	GOGC                string             `json:"goGC"`
+	CorruptionCount     int64              `json:"corruptionCount"`
+	ChunkCount          int64              `json:"chunkCount"`
+	TimeSeriesCount     int64              `json:"timeSeriesCount"`


Count here still implies a counter, which this isn't. And chunks, goroutines.

I wouldn't have made that association because it's not a metric name, but don't care either way.

On the other hand you might ask if we really need to offer data over this API that we already have on /metrics as well (goroutines, number of time series, etc.).

On the other hand you might ask if we really need to offer data over this API that we already have on /metrics as well (goroutines, number of time series, etc.).

I feel like providing an API makes those a bit more accessible.

Should I remove it?

simonpasquier · 2019-02-22T13:52:27Z

web/web_types/types.go

+	"time"
+)
+
+// RunRuntimeInfo contains runtime info about Prometheus.


RunRuntimeInfo -> RuntimeInfo

simonpasquier · 2019-02-22T13:57:08Z

docs/querying/api.md

+    "corruptionCount": 0,
+    "goGC": "",
+    "goMaxProcs": 4,
+    "goroutineCNT": 29,


Would need to be updated to align with Julius' comment

simonpasquier · 2019-02-22T14:08:00Z

web/web_types/types.go

+	Birth               time.Time          `json:"startTime"`
+	CWD                 string             `json:"cwd"`
+	Version             *PrometheusVersion `json:"version"`
+	Alertmanagers       []*url.URL         `json:"alertmanagers"`


I think it should be a slice of strings instead of url.URL. This is the current API output with 1 configured AlertManager:

{ "status": "success", "data": { ... "alertmanagers": [ { "Scheme": "http", "Opaque": "", "User": null, "Host": "localhost:9093", "Path": "/api/v1/alerts", "RawPath": "", "ForceQuery": false, "RawQuery": "", "Fragment": "" } ], ... } }

@simonpasquier The status.html template uses the Host, Path and Scheme.

https://github.com/prometheus/prometheus/blob/4a0b6aa612daf141b86c49e9207542eea1018ebd/web/ui/templates/status.html#L90

I'm not sure what to do. Any help will be appreciated.

Right, I would be inclined to declare an intermediary Alertmanager struct that would only expose the required fields.

type AlertManager struct { Scheme string `json:"scheme"` Host string `json:"host"` Path string `json:"path"` } type RuntimeInfo struct { ... Alertmanagers []Alertmanager `json:"alertmanagers"` ... }

vn-ki · 2019-03-25T13:35:01Z

@simonpasquier Done and rebased

simonpasquier

The code looks good to me. A few nits on the documentation.

simonpasquier · 2019-03-25T16:07:04Z

docs/querying/api.md

@@ -683,6 +683,46 @@ $ curl http://localhost:9090/api/v1/status/flags

 *New in v2.2*

+###  Runtime Info


Information

simonpasquier · 2019-03-25T16:07:14Z

docs/querying/api.md

@@ -683,6 +683,46 @@ $ curl http://localhost:9090/api/v1/status/flags

 *New in v2.2*

+###  Runtime Info
+
+The following endpoint returns runtime info of the Prometheus server.


s/info/information/ too

simonpasquier · 2019-03-25T16:08:59Z

docs/querying/api.md

+{
+  "status": "success",
+  "data": {
+    "alertmanagers": null,


It would be nice to add a non-null value.

... "alertmanagers": [ { "scheme": "http", "host": "localhost:9093", "path": "/api/v1/alerts" } ], ...

Signed-off-by: Vishnunarayan K I <appukuttancr@gmail.com>

vn-ki · 2019-03-25T20:01:08Z

@simonpasquier Done

simonpasquier · 2019-03-26T09:21:11Z

@vn-ki you have conflicts to resolve.

codesome · 2020-07-27T14:59:37Z

We have this upstream already in the React UI (https://prometheus.demo.do.prometheus.io/api/v1/status/runtimeinfo). Thanks for working on this btw!

vn-ki force-pushed the api-ui-data branch 3 times, most recently from 1326c57 to 3f93820 Compare February 2, 2019 10:39

vn-ki force-pushed the api-ui-data branch from 3f93820 to f11f5f4 Compare February 3, 2019 11:50

vn-ki changed the title ~~[WIP] api/v1: added /status/runtimeinfo~~ api/v1: added /status/runtimeinfo Feb 3, 2019

brian-brazil reviewed Feb 4, 2019

View reviewed changes

docs/querying/api.md Outdated Show resolved Hide resolved

web/types/types.go Outdated Show resolved Hide resolved

web/types/types.go Outdated Show resolved Hide resolved

web/types/types.go Outdated Show resolved Hide resolved

web/web.go Outdated Show resolved Hide resolved

SuperQ reviewed Feb 4, 2019

View reviewed changes

docs/querying/api.md Outdated Show resolved Hide resolved

mxinden reviewed Feb 5, 2019

View reviewed changes

vn-ki force-pushed the api-ui-data branch 4 times, most recently from 289c745 to 3d504e6 Compare February 5, 2019 20:13

mxinden reviewed Feb 6, 2019

View reviewed changes

web/web_types/types.go Outdated Show resolved Hide resolved

web/web_types/types.go Outdated Show resolved Hide resolved

web/web_types/types.go Outdated Show resolved Hide resolved

vn-ki force-pushed the api-ui-data branch from 3d504e6 to fb0ff64 Compare February 6, 2019 13:10

mxinden reviewed Feb 11, 2019

View reviewed changes

web/web_types/types.go Outdated Show resolved Hide resolved

web/web_types/types.go Show resolved Hide resolved

vn-ki force-pushed the api-ui-data branch from fb0ff64 to 4a0b6aa Compare February 11, 2019 09:52

mxinden approved these changes Feb 18, 2019

View reviewed changes

juliusv reviewed Feb 18, 2019

View reviewed changes

brian-brazil reviewed Feb 19, 2019

View reviewed changes

simonpasquier reviewed Feb 22, 2019

View reviewed changes

vn-ki force-pushed the api-ui-data branch from 4a0b6aa to 00ec749 Compare February 25, 2019 21:26

vn-ki force-pushed the api-ui-data branch 2 times, most recently from 302f32d to 19eaa6d Compare March 25, 2019 13:34

vn-ki force-pushed the api-ui-data branch from 19eaa6d to 597d581 Compare March 25, 2019 13:52

simonpasquier reviewed Mar 25, 2019

View reviewed changes

api/v1: added /status/runtimeinfo

a147662

Signed-off-by: Vishnunarayan K I <appukuttancr@gmail.com>

vn-ki force-pushed the api-ui-data branch from 597d581 to a147662 Compare March 25, 2019 17:25

codesome mentioned this pull request Dec 17, 2019

Data accessible via API #2467

Closed

stale bot added the stale label Feb 19, 2020

codesome closed this Jul 27, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

api/v1: added /status/runtimeinfo #5165

api/v1: added /status/runtimeinfo #5165

vn-ki commented Jan 31, 2019 •

edited

mxinden commented Feb 1, 2019

brian-brazil commented Feb 1, 2019

vn-ki commented Feb 1, 2019

brian-brazil commented Feb 2, 2019 via email

vn-ki commented Feb 2, 2019

vn-ki commented Feb 3, 2019

vn-ki commented Feb 5, 2019 •

edited

mxinden left a comment

vn-ki commented Feb 7, 2019

mxinden left a comment

vn-ki commented Feb 17, 2019

mxinden left a comment

juliusv Feb 18, 2019

brian-brazil Feb 19, 2019

juliusv Feb 19, 2019

vn-ki Feb 19, 2019

simonpasquier Feb 22, 2019

simonpasquier Feb 22, 2019

simonpasquier Feb 22, 2019

vn-ki Feb 25, 2019

simonpasquier Feb 26, 2019

vn-ki commented Mar 25, 2019

simonpasquier left a comment

simonpasquier Mar 25, 2019

simonpasquier Mar 25, 2019

simonpasquier Mar 25, 2019

vn-ki commented Mar 25, 2019

simonpasquier commented Mar 26, 2019

codesome commented Jul 27, 2020

		@@ -683,6 +683,46 @@ $ curl http://localhost:9090/api/v1/status/flags

		New in v2.2

		### Runtime Info

api/v1: added /status/runtimeinfo #5165

api/v1: added /status/runtimeinfo #5165

Conversation

vn-ki commented Jan 31, 2019 • edited

mxinden commented Feb 1, 2019

brian-brazil commented Feb 1, 2019

vn-ki commented Feb 1, 2019

brian-brazil commented Feb 2, 2019 via email

vn-ki commented Feb 2, 2019

vn-ki commented Feb 3, 2019

vn-ki commented Feb 5, 2019 • edited

mxinden left a comment

Choose a reason for hiding this comment

vn-ki commented Feb 7, 2019

mxinden left a comment

Choose a reason for hiding this comment

vn-ki commented Feb 17, 2019

mxinden left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vn-ki commented Mar 25, 2019

simonpasquier left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vn-ki commented Mar 25, 2019

simonpasquier commented Mar 26, 2019

codesome commented Jul 27, 2020

vn-ki commented Jan 31, 2019 •

edited

vn-ki commented Feb 5, 2019 •

edited