feat: new version metric (#13269)

Signed-off-by: Alan Clucas <[email protected]>
Co-authored-by: Anton Gilgur <[email protected]>

docs/metrics.md

@@ -327,6 +327,21 @@ A gauge of the number of queue items that have not been processed yet.
 
 See [queue adds count](#queue_adds_count) for details.
 
+#### `version`
+
+Build metadata for this Controller.
+
+| attribute        | explanation                                                                                           |
+|------------------|-------------------------------------------------------------------------------------------------------|
+| `version`        | The version of Argo                                                                                   |
+| `platform`       | The [Go platform](https://go.dev/doc/install/source#environment) compiled for. Example: `linux/amd64` |
+| `go_version`     | Version of Go used                                                                                    |
+| `build_date`     | Build date                                                               |
+| `compiler`       | The compiler used. Example: `gc`                                         |
+| `git_commit`     | The full Git SHA1 commit                                                                              |
+| `git_tree_state` | Whether the Git tree was `dirty` or `clean` when built                                                |
+| `git_tag`        | The Git tag or `untagged` if it was not tagged                                                        |
+
 #### `workers_busy_count`
 
 A count of queue workers that are busy.

docs/upgrading.md

@@ -29,6 +29,7 @@ The following are new metrics:
 * `queue_longest_running`
 * `queue_retries`
 * `queue_unfinished_work`
+* `version`
 
 and can be disabled with
 

workflow/metrics/labels.go

@@ -1,6 +1,15 @@
 package metrics
 
 const (
+	labelBuildVersion      string = `version`
+	labelBuildPlatform     string = `platform`
+	labelBuildGoVersion    string = `go_version`
+	labelBuildDate         string = `build_date`
+	labelBuildCompiler     string = `compiler`
+	labelBuildGitCommit    string = `git_commit`
+	labelBuildGitTreeState string = `git_treestate`
+	labelBuildGitTag       string = `git_tag`
+
 	labelErrorCause string = "cause"
 
 	labelLogLevel string = `level`

workflow/metrics/metrics.go

@@ -100,6 +100,7 @@ func New(ctx context.Context, serviceName string, config *Config, callbacks Call
 		addErrorCounter,
 		addLogCounter,
 		addK8sRequests,
+		addVersion,
 		addWorkflowConditionGauge,
 		addWorkQueueMetrics,
 	)

workflow/metrics/version.go

@@ -0,0 +1,33 @@
+package metrics
+
+import (
+	"context"
+
+	"github.com/argoproj/argo-workflows/v3"
+)
+
+func addVersion(ctx context.Context, m *Metrics) error {
+	const nameVersion = `version`
+	err := m.createInstrument(int64Counter,
+		nameVersion,
+		"Build metadata for this Controller",
+		"{unused}",
+		withAsBuiltIn(),
+	)
+	if err != nil {
+		return err
+	}
+
+	version := argo.GetVersion()
+	m.addInt(ctx, nameVersion, 1, instAttribs{
+		{name: labelBuildVersion, value: version.Version},
+		{name: labelBuildPlatform, value: version.Platform},
+		{name: labelBuildGoVersion, value: version.GoVersion},
+		{name: labelBuildDate, value: version.BuildDate},
+		{name: labelBuildCompiler, value: version.Compiler},
+		{name: labelBuildGitCommit, value: version.GitCommit},
+		{name: labelBuildGitTreeState, value: version.GitTreeState},
+		{name: labelBuildGitTag, value: version.GitTag},
+	})
+	return nil
+}

workflow/metrics/version_test.go

@@ -0,0 +1,31 @@
+package metrics
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/otel/attribute"
+
+	"github.com/argoproj/argo-workflows/v3"
+)
+
+func TestVersion(t *testing.T) {
+	_, te, err := CreateDefaultTestMetrics()
+	require.NoError(t, err)
+	assert.NotNil(t, te)
+	version := argo.GetVersion()
+	attribs := attribute.NewSet(
+		attribute.String(labelBuildVersion, version.Version),
+		attribute.String(labelBuildPlatform, version.Platform),
+		attribute.String(labelBuildGoVersion, version.GoVersion),
+		attribute.String(labelBuildDate, version.BuildDate),
+		attribute.String(labelBuildCompiler, version.Compiler),
+		attribute.String(labelBuildGitCommit, version.GitCommit),
+		attribute.String(labelBuildGitTreeState, version.GitTreeState),
+		attribute.String(labelBuildGitTag, version.GitTag),
+	)
+	val, err := te.GetInt64CounterValue(`version`, &attribs)
+	require.NoError(t, err)
+	assert.Equal(t, int64(1), val)
+}