OpenShift Support: Product Telemetry (#4038)

Author: shaun-nx

build/Dockerfile

@@ -17,6 +17,7 @@ COPY --from=ca-certs-provider --link /etc/ssl/certs/ca-certificates.crt /etc/ssl
 USER 101:1001
 ARG BUILD_AGENT
 ENV BUILD_AGENT=${BUILD_AGENT}
+ENV BUILD_OS=alpine
 ENTRYPOINT [ "/usr/bin/gateway" ]
 
 FROM common AS container

build/ubi/Dockerfile

@@ -17,6 +17,7 @@ COPY --from=ca-certs-provider --link /etc/ssl/certs/ca-certificates.crt /etc/ssl
 USER 101:1001
 ARG BUILD_AGENT
 ENV BUILD_AGENT=${BUILD_AGENT}
+ENV BUILD_OS=ubi
 
 LABEL name="F5 NGINX Gateway Fabric NGINX Plus" \
 	maintainer="[email protected]" \

internal/controller/telemetry/collector.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"os"
 	"runtime"
 	"sort"
 	"strings"
@@ -40,7 +41,7 @@ type ConfigurationGetter interface {
 // Data is telemetry data.
 //
 //go:generate go run -tags generator github.com/nginx/telemetry-exporter/cmd/generator -type=Data -scheme -scheme-protocol=NGFProductTelemetry -scheme-df-datatype=ngf-product-telemetry
-type Data struct {
+type Data struct { //nolint //required to skip golangci-lint-full fieldalignment
 	// ImageSource tells whether the image was built by GitHub or locally (values are 'gha', 'local', or 'unknown')
 	ImageSource string
 	tel.Data    // embedding is required by the generator.
@@ -68,6 +69,8 @@ type Data struct {
 	NginxOneConnectionEnabled bool
 	// InferencePoolCount is the number of InferencePools that are referenced by at least one Route.
 	InferencePoolCount int64
+	// BuildOS is the base operating system the control plane was built on (e.g. alpine, ubi).
+	BuildOS string
 }
 
 // NGFResourceCounts stores the counts of all relevant resources that NGF processes and generates configuration from.
@@ -123,6 +126,8 @@ type DataCollectorConfig struct {
 	Version string
 	// ImageSource is the source of the NGF image.
 	ImageSource string
+	// BuildOS is the base operating system the control plane was built on (e.g. alpine, ubi).
+	BuildOS string
 	// Flags contains the command-line NGF flag keys and values.
 	Flags config.Flags
 	// NginxOneConsoleConnection is a boolean that indicates whether the connection to the Nginx One Console is enabled.
@@ -176,6 +181,10 @@ func (c DataCollectorImpl) Collect(ctx context.Context) (Data, error) {
 
 	nginxPodCount := getNginxPodCount(g, clusterInfo.NodeCount)
 
+	buildOs := os.Getenv("BUILD_OS")
+	if buildOs == "" {
+		buildOs = "alpine"
+	}
 	inferencePoolCount := int64(len(g.ReferencedInferencePools))
 
 	data := Data{
@@ -191,6 +200,7 @@ func (c DataCollectorImpl) Collect(ctx context.Context) (Data, error) {
 		},
 		NGFResourceCounts:              graphResourceCount,
 		ImageSource:                    c.cfg.ImageSource,
+		BuildOS:                        buildOs,
 		FlagNames:                      c.cfg.Flags.Names,
 		FlagValues:                     c.cfg.Flags.Values,
 		SnippetsFiltersDirectives:      snippetsFiltersDirectives,

internal/controller/telemetry/collector_test.go

@@ -172,6 +172,7 @@ var _ = Describe("Collector", Ordered, func() {
 			NGFResourceCounts:              telemetry.NGFResourceCounts{},
 			ControlPlanePodCount:           1,
 			ImageSource:                    "local",
+			BuildOS:                        "alpine",
 			FlagNames:                      flags.Names,
 			FlagValues:                     flags.Values,
 			SnippetsFiltersDirectives:      []string{},
@@ -193,6 +194,7 @@ var _ = Describe("Collector", Ordered, func() {
 			Version:                   version,
 			PodNSName:                 podNSName,
 			ImageSource:               "local",
+			BuildOS:                   "alpine",
 			Flags:                     flags,
 			NginxOneConsoleConnection: true,
 		})
@@ -524,6 +526,7 @@ var _ = Describe("Collector", Ordered, func() {
 				expData.NginxPodCount = int64(8)
 				expData.ControlPlanePodCount = int64(2)
 				expData.NginxOneConnectionEnabled = true
+				expData.BuildOS = "alpine"
 
 				expData.InferencePoolCount = 3
 

internal/controller/telemetry/data.avdl

@@ -117,5 +117,8 @@ attached at the Gateway level. */
 		/** InferencePoolCount is the number of InferencePools that are referenced by at least one Route. */
 		long? InferencePoolCount = null;
 
+		/** BuildOS is the base operating system the control plane was built on (e.g. alpine, ubi). */
+		string? BuildOS = null;
+		
 	}
 }

internal/controller/telemetry/data_attributes_generated.go

@@ -24,6 +24,7 @@ func (d *Data) Attributes() []attribute.KeyValue {
 	attrs = append(attrs, attribute.Int64("ControlPlanePodCount", d.ControlPlanePodCount))
 	attrs = append(attrs, attribute.Bool("NginxOneConnectionEnabled", d.NginxOneConnectionEnabled))
 	attrs = append(attrs, attribute.Int64("InferencePoolCount", d.InferencePoolCount))
+	attrs = append(attrs, attribute.String("BuildOS", d.BuildOS))
 
 	return attrs
 }

internal/controller/telemetry/data_test.go

@@ -88,6 +88,7 @@ func TestDataAttributes(t *testing.T) {
 		attribute.Int64("ControlPlanePodCount", 3),
 		attribute.Bool("NginxOneConnectionEnabled", true),
 		attribute.Int64("InferencePoolCount", 16),
+		attribute.String("BuildOS", ""),
 	}
 
 	result := data.Attributes()
@@ -135,6 +136,7 @@ func TestDataAttributesWithEmptyData(t *testing.T) {
 		attribute.Int64("ControlPlanePodCount", 0),
 		attribute.Bool("NginxOneConnectionEnabled", false),
 		attribute.Int64("InferencePoolCount", 0),
+		attribute.String("BuildOS", ""),
 	}
 
 	result := data.Attributes()

tests/suite/telemetry_test.go

@@ -97,6 +97,7 @@ var _ = Describe("Telemetry test with OTel collector", Label("telemetry"), func(
 				"ControlPlanePodCount: Int(1)",
 				"NginxOneConnectionEnabled: Bool(false)",
 				"InferencePoolCount: Int(0)",
+				"BuildOS:",
 			},
 		)
 	})