feat: emit more data in prom metrics

server/start.go

@@ -221,7 +221,7 @@ func startStandAlone(svrCtx *Context, appCreator types.AppCreator) error {
 		return err
 	}
 
-	if _, err := startTelemetry(config); err != nil {
+	if _, err := startTelemetry(config, home); err != nil {
 		return err
 	}
 
@@ -349,7 +349,7 @@ func startInProcess(svrCtx *Context, clientCtx client.Context, appCreator types.
 		app.RegisterNodeService(clientCtx)
 	}
 
-	metrics, err := startTelemetry(config)
+	metrics, err := startTelemetry(config, home)
 	if err != nil {
 		return err
 	}
@@ -462,12 +462,12 @@ func startInProcess(svrCtx *Context, clientCtx client.Context, appCreator types.
 	return g.Wait()
 }
 
-func startTelemetry(cfg serverconfig.Config) (*telemetry.Metrics, error) {
+func startTelemetry(cfg serverconfig.Config, rootDir string) (*telemetry.Metrics, error) {
 	if !cfg.Telemetry.Enabled {
 		return nil, nil
 	}
 
-	return telemetry.New(cfg.Telemetry)
+	return telemetry.New(cfg.Telemetry, rootDir)
 }
 
 // wrapCPUProfile starts CPU profiling, if enabled, and executes the provided

telemetry/metrics.go

@@ -4,10 +4,14 @@ import (
 	"bytes"
 	"encoding/json"
 	"fmt"
+	"os"
+	"path/filepath"
+	"strconv"
 	"time"
 
 	"github.com/armon/go-metrics"
 	metricsprom "github.com/armon/go-metrics/prometheus"
+	"github.com/cosmos/cosmos-sdk/version"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/common/expfmt"
 )
@@ -71,7 +75,7 @@ type GatherResponse struct {
 }
 
 // New creates a new instance of Metrics
-func New(cfg Config) (_ *Metrics, rerr error) {
+func New(cfg Config, rootDir string) (_ *Metrics, rerr error) {
 	if !cfg.Enabled {
 		return nil, nil
 	}
@@ -84,6 +88,7 @@ func New(cfg Config) (_ *Metrics, rerr error) {
 
 		globalLabels = parsedGlobalLabels
 	}
+	globalLabels = append(globalLabels, getDefaultGlobalLabels(rootDir)...)
 
 	metricsConf := metrics.DefaultConfig(cfg.ServiceName)
 	metricsConf.EnableHostname = cfg.EnableHostname
@@ -176,3 +181,42 @@ func (m *Metrics) gatherGeneric() (GatherResponse, error) {
 
 	return GatherResponse{ContentType: "application/json", Metrics: content}, nil
 }
+
+func getDefaultGlobalLabels(rootDir string) []metrics.Label {
+	var ls []metrics.Label
+
+	versionInfo := version.NewInfo()
+	if len(versionInfo.GoVersion) > 0 {
+		ls = append(ls, NewLabel("go", versionInfo.GoVersion))
+	}
+	if len(versionInfo.CosmosSdkVersion) > 0 {
+		ls = append(ls, NewLabel("version", versionInfo.CosmosSdkVersion))
+	}
+
+	upgradeInfoPath := filepath.Join(rootDir, "data", "upgrade-info.json") // the path is the expected upgrade-info filename created by `x/upgrade/keeper`.
+	if upgradeInfo, err := getUpgradeInfo(upgradeInfoPath); err == nil {
+		ls = append(ls, NewLabel("upgrade_height", strconv.FormatInt(upgradeInfo.Height, 10)))
+	}
+
+	return ls
+}
+
+type plan struct {
+	Name   string `json:"name,omitempty"`
+	Height int64  `json:"height,omitempty"`
+	Info   string `json:"info,omitempty"`
+}
+
+func getUpgradeInfo(path string) (plan, error) {
+	data, err := os.ReadFile(path)
+	if err != nil {
+		return plan{}, err
+	}
+
+	var upgradeInfo plan
+	if err := json.Unmarshal(data, &upgradeInfo); err != nil {
+		return plan{}, err
+	}
+
+	return upgradeInfo, nil
+}

telemetry/metrics_test.go

@@ -7,12 +7,13 @@ import (
 	"time"
 
 	"github.com/armon/go-metrics"
+	"github.com/cosmos/cosmos-sdk/version"
 	"github.com/prometheus/common/expfmt"
 	"github.com/stretchr/testify/require"
 )
 
 func TestMetrics_Disabled(t *testing.T) {
-	m, err := New(Config{Enabled: false})
+	m, err := New(Config{Enabled: false}, "")
 	require.Nil(t, m)
 	require.Nil(t, err)
 }
@@ -22,7 +23,7 @@ func TestMetrics_InMem(t *testing.T) {
 		Enabled:        true,
 		EnableHostname: false,
 		ServiceName:    "test",
-	})
+	}, "")
 	require.NoError(t, err)
 	require.NotNil(t, m)
 
@@ -47,7 +48,7 @@ func TestMetrics_Prom(t *testing.T) {
 		ServiceName:             "test",
 		PrometheusRetentionTime: 60,
 		EnableHostnameLabel:     false,
-	})
+	}, "")
 	require.NoError(t, err)
 	require.NotNil(t, m)
 	require.True(t, m.prometheusEnabled)
@@ -74,3 +75,84 @@ func emitMetrics() {
 		}
 	}
 }
+
+func TestMetrics_getDefaultGlobalLabels(t *testing.T) {
+	type args struct {
+		rootDir string
+	}
+	tests := []struct {
+		name        string
+		args        args
+		versionInfo version.Info
+		want        []metrics.Label
+	}{
+		{
+			name: "happy path",
+			args: args{
+				rootDir: "./testdata/valid",
+			},
+			versionInfo: version.Info{
+				GoVersion:        "go version go1.14 linux/amd64",
+				CosmosSdkVersion: "0.42.5",
+			},
+			want: []metrics.Label{
+				NewLabel("go", "go version go1.14 linux/amd64"),
+				NewLabel("version", "0.42.5"),
+				NewLabel("upgrade_height", "123"),
+			},
+		},
+		{
+			name: "empty versionInfo",
+			args: args{
+				rootDir: "./testdata/valid",
+			},
+			want: []metrics.Label{
+				NewLabel("upgrade_height", "123"),
+			},
+		},
+		{
+			name: "upgrade-info.json is not available",
+			args: args{
+				rootDir: "./home",
+			},
+			versionInfo: version.Info{
+				GoVersion:        "go version go1.14 linux/amd64",
+				CosmosSdkVersion: "0.42.5",
+			},
+			want: []metrics.Label{
+				NewLabel("go", "go version go1.14 linux/amd64"),
+				NewLabel("version", "0.42.5"),
+			},
+		},
+		{
+			name: "upgrade-info.json unmarshal failed",
+			args: args{
+				rootDir: "./testdata/invalid",
+			},
+			versionInfo: version.Info{
+				GoVersion:        "go version go1.14 linux/amd64",
+				CosmosSdkVersion: "0.42.5",
+			},
+			want: []metrics.Label{
+				NewLabel("go", "go version go1.14 linux/amd64"),
+				NewLabel("version", "0.42.5"),
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			mockVersionNewInfo(t, tt.versionInfo)
+			require.ElementsMatch(t, tt.want, getDefaultGlobalLabels(tt.args.rootDir))
+		})
+	}
+}
+
+func mockVersionNewInfo(t *testing.T, newInfo version.Info) {
+	oriNewInfo := version.NewInfo
+	version.NewInfo = func() version.Info {
+		return newInfo
+	}
+	t.Cleanup(func() {
+		version.NewInfo = oriNewInfo
+	})
+}

telemetry/testdata/valid/data/upgrade-info.json

@@ -0,0 +1 @@
+{"name": "upgrade1", "info": "some info", "height": 123}

version/version.go

@@ -63,7 +63,7 @@ type Info struct {
 	CosmosSdkVersion string     `json:"cosmos_sdk_version" yaml:"cosmos_sdk_version"`
 }
 
-func NewInfo() Info {
+var NewInfo = func() Info {
 	sdkVersion := getSDKVersion()
 	return Info{
 		Name:             Name,