Add K8s version and ARCH to telemetry data

internal/telemetry/cluster.go

@@ -25,3 +25,13 @@ func (c *Collector) ClusterID(ctx context.Context) (string, error) {
 	}
 	return string(cluster.UID), nil
 }
+
+// K8sVersion returns a string respresenting the K8s version.
+// It returns an error if the underlying k8s API client errors.
+func (c *Collector) K8sVersion() (string, error) {
+	sv, err := c.Config.K8sClientReader.Discovery().ServerVersion()
+	if err != nil {
+		return "", err
+	}
+	return sv.String(), nil
+}

internal/telemetry/cluster_test.go

@@ -8,7 +8,6 @@ import (
 	apiCoreV1 "k8s.io/api/core/v1"
 	metaV1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
-	testClient "k8s.io/client-go/kubernetes/fake"
 )
 
 func TestNodeCountInAClusterWithThreeNodes(t *testing.T) {
@@ -66,6 +65,21 @@ func TestClusterIDErrorsOnNotExistingService(t *testing.T) {
 	}
 }
 
+func TestK8sVersionRetrievesClusterVersion(t *testing.T) {
+	t.Parallel()
+
+	c := newTestCollectorForClusterWithNodes(t, node1)
+	got, err := c.K8sVersion()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	want := "v1.29.2"
+	if want != got {
+		t.Errorf("want %s, got %s", want, got)
+	}
+}
+
 // newTestCollectorForClusterWithNodes returns a telemetry collector configured
 // to simulate collecting data on a cluser with provided nodes.
 func newTestCollectorForClusterWithNodes(t *testing.T, nodes ...runtime.Object) *telemetry.Collector {
@@ -77,7 +91,7 @@ func newTestCollectorForClusterWithNodes(t *testing.T, nodes ...runtime.Object)
 	if err != nil {
 		t.Fatal(err)
 	}
-	c.Config.K8sClientReader = testClient.NewSimpleClientset(nodes...)
+	c.Config.K8sClientReader = newTestClientset(nodes...)
 	return c
 }
 

internal/telemetry/collector.go

@@ -4,6 +4,7 @@ package telemetry
 import (
 	"context"
 	"io"
+	"runtime"
 	"time"
 
 	"github.com/nginxinc/kubernetes-ingress/internal/configs"
@@ -92,7 +93,9 @@ func (c *Collector) Collect(ctx context.Context) {
 
 // BuildReport takes context and builds report from gathered telemetry data.
 func (c *Collector) BuildReport(ctx context.Context) (Data, error) {
-	d := Data{}
+	d := Data{
+		Arch: runtime.GOARCH,
+	}
 	var err error
 
 	if c.Config.Configurator != nil {
@@ -110,5 +113,11 @@ func (c *Collector) BuildReport(ctx context.Context) (Data, error) {
 		glog.Errorf("Error collecting telemetry data: ClusterID: %v", err)
 	}
 	d.ClusterID = cID
+
+	k8s, err := c.K8sVersion()
+	if err != nil {
+		glog.Errorf("Error collecting telemetry data: K8s Version: %v", err)
+	}
+	d.K8sVersion = k8s
 	return d, err
 }

internal/telemetry/collector_test.go

@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"context"
 	"fmt"
+	"runtime"
 	"testing"
 	"time"
 
@@ -16,6 +17,9 @@ import (
 	"github.com/nginxinc/kubernetes-ingress/internal/telemetry"
 	conf_v1 "github.com/nginxinc/kubernetes-ingress/pkg/apis/configuration/v1"
 	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	k8sruntime "k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/version"
+	fakediscovery "k8s.io/client-go/discovery/fake"
 	testClient "k8s.io/client-go/kubernetes/fake"
 )
 
@@ -44,19 +48,21 @@ func TestCreateNewCollectorWithCustomExporter(t *testing.T) {
 
 	buf := &bytes.Buffer{}
 	exp := &telemetry.StdoutExporter{Endpoint: buf}
-	td := telemetry.Data{}
 
 	cfg := telemetry.CollectorConfig{
-		K8sClientReader: testClient.NewSimpleClientset(),
+		K8sClientReader: newTestClientset(),
 		Configurator:    newConfigurator(t),
 	}
-
 	c, err := telemetry.NewCollector(cfg, telemetry.WithExporter(exp))
 	if err != nil {
 		t.Fatal(err)
 	}
 	c.Collect(context.Background())
 
+	td := telemetry.Data{
+		K8sVersion: "v1.29.2",
+		Arch:       runtime.GOARCH,
+	}
 	want := fmt.Sprintf("%+v", td)
 	got := buf.String()
 	if !cmp.Equal(want, got) {
@@ -71,7 +77,7 @@ func TestCollectNodeCountInClusterWithOneNode(t *testing.T) {
 	exp := &telemetry.StdoutExporter{Endpoint: buf}
 	cfg := telemetry.CollectorConfig{
 		Configurator:    newConfigurator(t),
-		K8sClientReader: testClient.NewSimpleClientset(node1),
+		K8sClientReader: newTestClientset(node1),
 	}
 
 	c, err := telemetry.NewCollector(cfg, telemetry.WithExporter(exp))
@@ -90,7 +96,9 @@ func TestCollectNodeCountInClusterWithOneNode(t *testing.T) {
 			VirtualServerRoutes: 0,
 			TransportServers:    0,
 		},
-		NodeCount: 1,
+		NodeCount:  1,
+		K8sVersion: "v1.29.2",
+		Arch:       runtime.GOARCH,
 	}
 	want := fmt.Sprintf("%+v", td)
 	got := buf.String()
@@ -106,7 +114,7 @@ func TestCollectNodeCountInClusterWithThreeNodes(t *testing.T) {
 	exp := &telemetry.StdoutExporter{Endpoint: buf}
 	cfg := telemetry.CollectorConfig{
 		Configurator:    newConfigurator(t),
-		K8sClientReader: testClient.NewSimpleClientset(node1, node2, node3),
+		K8sClientReader: newTestClientset(node1, node2, node3),
 	}
 
 	c, err := telemetry.NewCollector(cfg, telemetry.WithExporter(exp))
@@ -125,7 +133,9 @@ func TestCollectNodeCountInClusterWithThreeNodes(t *testing.T) {
 			VirtualServerRoutes: 0,
 			TransportServers:    0,
 		},
-		NodeCount: 3,
+		NodeCount:  3,
+		K8sVersion: "v1.29.2",
+		Arch:       runtime.GOARCH,
 	}
 	want := fmt.Sprintf("%+v", td)
 	got := buf.String()
@@ -141,7 +151,45 @@ func TestCollectClusterIDInClusterWithOneNode(t *testing.T) {
 	exp := &telemetry.StdoutExporter{Endpoint: buf}
 	cfg := telemetry.CollectorConfig{
 		Configurator:    newConfigurator(t),
-		K8sClientReader: testClient.NewSimpleClientset(node1, kubeNS),
+		K8sClientReader: newTestClientset(node1, kubeNS),
+	}
+
+	c, err := telemetry.NewCollector(cfg, telemetry.WithExporter(exp))
+	if err != nil {
+		t.Fatal(err)
+	}
+	c.Collect(context.Background())
+
+	td := telemetry.Data{
+		ProjectMeta: telemetry.ProjectMeta{
+			Name:    "",
+			Version: "",
+		},
+		NICResourceCounts: telemetry.NICResourceCounts{
+			VirtualServers:      0,
+			VirtualServerRoutes: 0,
+			TransportServers:    0,
+		},
+		NodeCount:  1,
+		ClusterID:  "329766ff-5d78-4c9e-8736-7faad1f2e937",
+		K8sVersion: "v1.29.2",
+		Arch:       runtime.GOARCH,
+	}
+	want := fmt.Sprintf("%+v", td)
+	got := buf.String()
+	if !cmp.Equal(want, got) {
+		t.Error(cmp.Diff(want, got))
+	}
+}
+
+func TestCollectK8sVersion(t *testing.T) {
+	t.Parallel()
+
+	buf := &bytes.Buffer{}
+	exp := &telemetry.StdoutExporter{Endpoint: buf}
+	cfg := telemetry.CollectorConfig{
+		Configurator:    newConfigurator(t),
+		K8sClientReader: newTestClientset(node1, kubeNS),
 	}
 
 	c, err := telemetry.NewCollector(cfg, telemetry.WithExporter(exp))
@@ -160,8 +208,10 @@ func TestCollectClusterIDInClusterWithOneNode(t *testing.T) {
 			VirtualServerRoutes: 0,
 			TransportServers:    0,
 		},
-		NodeCount: 1,
-		ClusterID: "329766ff-5d78-4c9e-8736-7faad1f2e937",
+		NodeCount:  1,
+		ClusterID:  "329766ff-5d78-4c9e-8736-7faad1f2e937",
+		K8sVersion: "v1.29.2",
+		Arch:       runtime.GOARCH,
 	}
 	want := fmt.Sprintf("%+v", td)
 	got := buf.String()
@@ -186,11 +236,15 @@ func TestCountVirtualServers(t *testing.T) {
 				NICResourceCounts: telemetry.NICResourceCounts{
 					VirtualServers: 1,
 				},
+				K8sVersion: "v1.29.2",
+				Arch:       runtime.GOARCH,
 			},
 			expectedTraceDataOnDelete: telemetry.Data{
 				NICResourceCounts: telemetry.NICResourceCounts{
 					VirtualServers: 0,
 				},
+				K8sVersion: "v1.29.2",
+				Arch:       runtime.GOARCH,
 			},
 			virtualServers: []*configs.VirtualServerEx{
 				{
@@ -211,11 +265,15 @@ func TestCountVirtualServers(t *testing.T) {
 				NICResourceCounts: telemetry.NICResourceCounts{
 					VirtualServers: 2,
 				},
+				K8sVersion: "v1.29.2",
+				Arch:       runtime.GOARCH,
 			},
 			expectedTraceDataOnDelete: telemetry.Data{
 				NICResourceCounts: telemetry.NICResourceCounts{
 					VirtualServers: 0,
 				},
+				K8sVersion: "v1.29.2",
+				Arch:       runtime.GOARCH,
 			},
 			virtualServers: []*configs.VirtualServerEx{
 				{
@@ -245,11 +303,15 @@ func TestCountVirtualServers(t *testing.T) {
 				NICResourceCounts: telemetry.NICResourceCounts{
 					VirtualServers: 2,
 				},
+				K8sVersion: "v1.29.2",
+				Arch:       runtime.GOARCH,
 			},
 			expectedTraceDataOnDelete: telemetry.Data{
 				NICResourceCounts: telemetry.NICResourceCounts{
 					VirtualServers: 1,
 				},
+				K8sVersion: "v1.29.2",
+				Arch:       runtime.GOARCH,
 			},
 			virtualServers: []*configs.VirtualServerEx{
 				{
@@ -279,7 +341,7 @@ func TestCountVirtualServers(t *testing.T) {
 		configurator := newConfigurator(t)
 
 		c, err := telemetry.NewCollector(telemetry.CollectorConfig{
-			K8sClientReader: testClient.NewSimpleClientset(dummyKubeNS),
+			K8sClientReader: newTestClientset(dummyKubeNS),
 			Configurator:    configurator,
 		})
 		if err != nil {
@@ -338,11 +400,15 @@ func TestCountTransportServers(t *testing.T) {
 				NICResourceCounts: telemetry.NICResourceCounts{
 					TransportServers: 1,
 				},
+				K8sVersion: "v1.29.2",
+				Arch:       runtime.GOARCH,
 			},
 			expectedTraceDataOnDelete: telemetry.Data{
 				NICResourceCounts: telemetry.NICResourceCounts{
 					TransportServers: 0,
 				},
+				K8sVersion: "v1.29.2",
+				Arch:       runtime.GOARCH,
 			},
 			transportServers: []*configs.TransportServerEx{
 				{
@@ -367,11 +433,15 @@ func TestCountTransportServers(t *testing.T) {
 				NICResourceCounts: telemetry.NICResourceCounts{
 					TransportServers: 2,
 				},
+				K8sVersion: "v1.29.2",
+				Arch:       runtime.GOARCH,
 			},
 			expectedTraceDataOnDelete: telemetry.Data{
 				NICResourceCounts: telemetry.NICResourceCounts{
 					TransportServers: 0,
 				},
+				K8sVersion: "v1.29.2",
+				Arch:       runtime.GOARCH,
 			},
 			transportServers: []*configs.TransportServerEx{
 				{
@@ -409,11 +479,15 @@ func TestCountTransportServers(t *testing.T) {
 				NICResourceCounts: telemetry.NICResourceCounts{
 					TransportServers: 2,
 				},
+				K8sVersion: "v1.29.2",
+				Arch:       runtime.GOARCH,
 			},
 			expectedTraceDataOnDelete: telemetry.Data{
 				NICResourceCounts: telemetry.NICResourceCounts{
 					TransportServers: 1,
 				},
+				K8sVersion: "v1.29.2",
+				Arch:       runtime.GOARCH,
 			},
 			transportServers: []*configs.TransportServerEx{
 				{
@@ -451,7 +525,7 @@ func TestCountTransportServers(t *testing.T) {
 		configurator := newConfigurator(t)
 
 		c, err := telemetry.NewCollector(telemetry.CollectorConfig{
-			K8sClientReader: testClient.NewSimpleClientset(dummyKubeNS),
+			K8sClientReader: newTestClientset(dummyKubeNS),
 			Configurator:    configurator,
 		})
 		if err != nil {
@@ -536,6 +610,31 @@ func newConfigurator(t *testing.T) *configs.Configurator {
 	return cnf
 }
 
+// newTestClientset takes k8s runtime objects and returns a k8s fake clientset.
+// The clientset is configured to return kubernetes version v1.29.2.
+// (call to Discovery().ServerVersion())
+//
+// version.Info struct can hold more information about K8s platform, for example:
+//
+//	type Info struct {
+//	  Major        string
+//	  Minor        string
+//	  GitVersion   string
+//	  GitCommit    string
+//	  GitTreeState string
+//	  BuildDate    string
+//	  GoVersion    string
+//	  Compiler     string
+//	  Platform     string
+//	}
+func newTestClientset(objects ...k8sruntime.Object) *testClient.Clientset {
+	testClient := testClient.NewSimpleClientset(objects...)
+	testClient.Discovery().(*fakediscovery.FakeDiscovery).FakedServerVersion = &version.Info{
+		GitVersion: "v1.29.2",
+	}
+	return testClient
+}
+
 const (
 	mainTemplatePath            = "../configs/version1/nginx-plus.tmpl"
 	ingressTemplatePath         = "../configs/version1/nginx-plus.ingress.tmpl"

internal/telemetry/exporter.go

@@ -31,6 +31,8 @@ type Data struct {
 	NICResourceCounts NICResourceCounts
 	NodeCount         int
 	ClusterID         string
+	K8sVersion        string
+	Arch              string
 }
 
 // ProjectMeta holds metadata for the project.