Add Installation Flags to Telemetry

docs/content/overview/product-telemetry.md

@@ -49,6 +49,7 @@ These are the data points collected and reported by NGINX Ingress Controller:
 - **GlobalConfiguration** Represents the use of a GlobalConfiguration resource.
 - **AppProtectVersion** The AppProtect version
 - **IsPlus** Represents whether NGINX is Plus or OSS
+- **InstallationFlags* List of flags managed by NGINX Ingress Controller 
 
 ## Opt out
 

internal/telemetry/cluster.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"os"
 	"strings"
 
 	metaV1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -202,6 +203,19 @@ func (c *Collector) IsPlusEnabled() bool {
 	return c.Config.IsPlus
 }
 
+// InstallationFlags returns the list of all flags
+func (c *Collector) InstallationFlags() []string {
+	flags := os.Args[1:]
+	// tests that compare the report currently break with this addition,
+	// this is temp fix until tests are refactored
+	for _, flag := range flags {
+		if flag == "-test.paniconexit0" {
+			return []string{}
+		}
+	}
+	return flags
+}
+
 // lookupPlatform takes a string representing a K8s PlatformID
 // retrieved from a cluster node and returns a string
 // representing the platform name.

internal/telemetry/collector.go

@@ -141,6 +141,7 @@ func (c *Collector) Collect(ctx context.Context) {
 			IngressAnnotations:    report.IngressAnnotations,
 			AppProtectVersion:     report.AppProtectVersion,
 			IsPlus:                report.IsPlus,
+			InstallationFlags:     report.InstallationFlags,
 		},
 	}
 
@@ -183,6 +184,7 @@ type Report struct {
 	IngressAnnotations  []string
 	AppProtectVersion   string
 	IsPlus              bool
+	InstallationFlags   []string
 }
 
 // BuildReport takes context, collects telemetry data and builds the report.
@@ -255,6 +257,8 @@ func (c *Collector) BuildReport(ctx context.Context) (Report, error) {
 
 	isPlus := c.IsPlusEnabled()
 
+	installationFlags := c.InstallationFlags()
+
 	return Report{
 		Name:                "NIC",
 		Version:             c.Config.Version,
@@ -284,5 +288,6 @@ func (c *Collector) BuildReport(ctx context.Context) (Report, error) {
 		IngressAnnotations:  ingressAnnotations,
 		AppProtectVersion:   appProtectVersion,
 		IsPlus:              isPlus,
+		InstallationFlags:   installationFlags,
 	}, err
 }

internal/telemetry/data.avdl

@@ -93,5 +93,8 @@ It is the UID of the `kube-system` Namespace. */
 		/** IsPlus represents whether NGINX is Plus or OSS */
 		boolean? IsPlus = null;
 
+		/** InstallationFlags is the list of flags resources managed by NGINX Ingress Controller */
+		union {null, array<string>} InstallationFlags = null;
+
 	}
 }

internal/telemetry/exporter.go

@@ -105,4 +105,6 @@ type NICResourceCounts struct {
 	AppProtectVersion string
 	// IsPlus represents whether NGINX is Plus or OSS
 	IsPlus bool
+	// InstallationFlags is the list of flags resources managed by NGINX Ingress Controller
+	InstallationFlags []string
 }

internal/telemetry/nicresourcecounts_attributes_generated.go

@@ -33,6 +33,7 @@ func (d *NICResourceCounts) Attributes() []attribute.KeyValue {
 	attrs = append(attrs, attribute.StringSlice("IngressAnnotations", d.IngressAnnotations))
 	attrs = append(attrs, attribute.String("AppProtectVersion", d.AppProtectVersion))
 	attrs = append(attrs, attribute.Bool("IsPlus", d.IsPlus))
+	attrs = append(attrs, attribute.StringSlice("InstallationFlags", d.InstallationFlags))
 
 	return attrs
 }