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.

Sign up for GitHub

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

Jump to bottom

go118: Get VCS info from debug.BuildInfo #374

Merged
merged 1 commit into from Dec 8, 2022
Merged

go118: Get VCS info from debug.BuildInfo #374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions version/info.go
View file
Open in desktop
Expand Up @@ -46,7 +46,7 @@ func NewCollector(program string) prometheus.Collector {
),
ConstLabels: prometheus.Labels{
"version": Version,
"revision": Revision,
"revision": getRevision(),
"branch": Branch,
"goversion": GoVersion,
},
Expand All @@ -69,7 +69,7 @@ func Print(program string) string {
m := map[string]string{
"program": program,
"version": Version,
"revision": Revision,
"revision": getRevision(),
"branch": Branch,
"buildUser": BuildUser,
"buildDate": BuildDate,
Expand All @@ -87,7 +87,7 @@ func Print(program string) string {

// Info returns version, branch and revision information.
func Info() string {
return fmt.Sprintf("(version=%s, branch=%s, revision=%s)", Version, Branch, Revision)
return fmt.Sprintf("(version=%s, branch=%s, revision=%s)", Version, Branch, getRevision())
}

// BuildContext returns goVersion, buildUser and buildDate information.
Expand Down
21 changes: 21 additions & 0 deletions version/info_default.go
View file
Open in desktop
@@ -0,0 +1,21 @@
// Copyright 2022 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//go:build !go1.18
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this future proof for >= 1.19?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like it is. I tested this by adding a test_go118.go to an existing project:

//go:build go1.18

package main

import "log"

func init() {
        log.Println("1.18")
}

Running this with Go 1.19 printed the line. Flipping it to //go:build !go1.18 made it go away when compiled/run with Go 1.19.

// +build !go1.18

package version

func getRevision() string {
return Revision
}
58 changes: 58 additions & 0 deletions version/info_go118.go
View file
Open in desktop
@@ -0,0 +1,58 @@
// Copyright 2022 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//go:build go1.18
// +build go1.18

package version

import "runtime/debug"

var computedRevision string

func getRevision() string {
if Revision != "" {
return Revision
}
return computedRevision
SuperQ marked this conversation as resolved.
Show resolved Hide resolved
}

func init() {
computedRevision = computeRevision()
}

func computeRevision() string {
var (
rev = "unknown"
modified bool
)

buildInfo, ok := debug.ReadBuildInfo()
if !ok {
return rev
}
for _, v := range buildInfo.Settings {
if v.Key == "vcs.revision" {
rev = v.Value
}
if v.Key == "vcs.modified" {
if v.Value == "true" {
modified = true
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be possible to add vcs.modified?

}
if modified {
return rev + "-modified"
}
Comment on lines +54 to +56
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've seen this returned as a separate parameter, this is basically checking if git was in a dirty state at the time of build.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changing the API is out of scope here I'd say, as we see revision as one. it should still be pretty easy to parse as modified is not a valid git hash

return rev
}