Return build info under /loki/api/v1/status/buildinfo.
#3972
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kavirajk
approved these changes
Jul 8, 2021
docs/sources/api/_index.md
Outdated
| @@ -823,6 +824,12 @@ and the current are returned. A value of `defaults` returns the default configur | |||
|
|
|||
| In microservices mode, the `/config` endpoint is exposed by all components. | |||
|
|
|||
| ## `GET /version` | |||
|
|
|||
| `/version` exposes the build information in a JSON object. The fields are `version`, `revision ``build_date`, `build_user`, and `revision`. | |||
There was a problem hiding this comment.
Revision is repeated twice!
owen-d
approved these changes
Jul 8, 2021
There was a problem hiding this comment.
Looks good, but can we mimic the same path that Prometheus uses (GET /loki/api/v1/status/buildinfo in our case)?
https://prometheus.io/docs/prometheus/latest/querying/api/#build-information
Nit: we can probably use the same version struct Prometheus uses.
jeschkies
changed the title
/version./loki/api/v1/status/buildinfo.
jeschkies
commented
Jul 8, 2021
pkg/util/build/build.go
Outdated
| @@ -20,4 +21,5 @@ func init() { | |||
| version.Branch = Branch | |||
| version.BuildUser = BuildUser | |||
| version.BuildDate = BuildDate | |||
| version.GoVersion = "???" | |||
There was a problem hiding this comment.
How can I access the Go version?
There was a problem hiding this comment.
You can use the runtime package: https://golang.org/pkg/runtime/#Version
There was a problem hiding this comment.
That's how Prometheus does it as well: https://github.com/prometheus/common/blob/main/version/info.go#L33
KMiller-Grafana
approved these changes
Jul 8, 2021
What this PR does / why we need it:
This changes introduces the
/versionendpoint for all components. It returns the build info in JSON. This should ease debugging.Which issue(s) this PR fixes:
Fixes #3221
Checklist