Adding version information to metrics in Go

Autometrics makes it easy to spot versions and commits that introduce errors or latency.

It produces a build_info metric and uses labels to expose the version, commit and branch information of your app to Prometheus.

Example:

build_info{branch="main",commit="5cc2aa5447907fbf0a7ddd",version="1.0.0",service_name="Billing",repository_url="",repository_provider=""} 1

Usage

To add version information to your metrics, simply add the relevant option parameters to the autometrics.Init() call:

autometrics.Init(
    autometrics.WithService("<service_name_here>"),
    autometrics.WithVersion("<version_here>"),
    autometrics.WithCommit("<git_commit_hash_here>"),
    autometrics.WithBranch("<git_branch_here>"),
)

All With... initialization settings are optional, and not setting them will leave the label empty like repository_url and repository_provider in the example above.

autometrics.With... options accept most fields as strings which you can set as you wish or use something like ldflags to set them at build time. Check the documentation on pkg.go.dev (for Prometheus version (opens in a new tab) or Open Telemetry version (opens in a new tab)) for more details about the initialization settings (all functions returning autometrics.Option).

Using ldflags to add version information at build time

var (
    Version = "development"
    Commit  = "n/a"
    Branch  string
)

autometrics.Init(
    autometrics.WithService("Billing"),
    autometrics.WithVersion(Version),
    autometrics.WithCommit(Commit),
    autometrics.WithBranch(Branch),
)

go build -ldflags "-X main.Version=$(git describe --tags) -X main.Commit=$(git rev-parse HEAD) -X main.Branch=$(git rev-parse --abbrev-ref HEAD)"