Add initial draft of flag options

Author: bjee19

cmd/gateway/commands.go

@@ -215,6 +215,7 @@ func createStaticModeCommand() *cobra.Command {
 				Version:              version,
 				ExperimentalFeatures: gwExperimentalFeatures,
 				ImageSource:          imageSource,
+				Flags:                cmd.Flags(),
 			}
 
 			if err := static.StartManager(conf); err != nil {

go.mod

@@ -17,6 +17,7 @@ require (
 	github.com/prometheus/client_golang v1.18.0
 	github.com/prometheus/common v0.48.0
 	github.com/spf13/cobra v1.8.0
+	github.com/spf13/pflag v1.0.5
 	github.com/tsenart/vegeta/v12 v12.11.1
 	go.uber.org/zap v1.27.0
 	k8s.io/api v0.29.2
@@ -71,7 +72,6 @@ require (
 	github.com/prometheus/client_model v0.5.0 // indirect
 	github.com/prometheus/procfs v0.12.0 // indirect
 	github.com/rs/dnscache v0.0.0-20211102005908-e0241e321417 // indirect
-	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/stretchr/testify v1.8.4 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
 	golang.org/x/exp v0.0.0-20231006140011-7918f672742d // indirect

internal/mode/static/config/config.go

@@ -4,6 +4,7 @@ import (
 	"time"
 
 	"github.com/go-logr/logr"
+	"github.com/spf13/pflag"
 	"go.uber.org/zap"
 	"k8s.io/apimachinery/pkg/types"
 )
@@ -15,6 +16,8 @@ type Config struct {
 	ImageSource string
 	// AtomicLevel is an atomically changeable, dynamic logging level.
 	AtomicLevel zap.AtomicLevel
+	// Flags are all the NGF flags.
+	Flags *pflag.FlagSet
 	// GatewayNsName is the namespaced name of a Gateway resource that the Gateway will use.
 	// The Gateway will ignore all other Gateway resources.
 	GatewayNsName *types.NamespacedName

internal/mode/static/manager.go

@@ -253,6 +253,7 @@ func StartManager(cfg config.Config) error {
 				Name:      cfg.GatewayPodConfig.Name,
 			},
 			ImageSource: cfg.ImageSource,
+			Flags:       cfg.Flags,
 		})
 		if err = mgr.Add(createTelemetryJob(cfg, dataCollector, nginxChecker.getReadyCh())); err != nil {
 			return fmt.Errorf("cannot register telemetry job: %w", err)

internal/mode/static/telemetry/collector.go

@@ -5,7 +5,9 @@ import (
 	"errors"
 	"fmt"
 	"runtime"
+	"strconv"
 
+	"github.com/spf13/pflag"
 	appsv1 "k8s.io/api/apps/v1"
 	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -47,17 +49,49 @@ type ProjectMetadata struct {
 	Version string
 }
 
+//type DeploymentFlagOptions struct {
+//	GatewayClass string
+//	GatewayCtlrName string
+//	Gateway                string
+//	Config                 string
+//	Service                string
+//	UpdateGCStatus         bool
+//	MetricsDisable         bool
+//	MetricsSecure          bool
+//	MetricsPort            string
+//	HealthDisable          bool
+//	HealthPort             string
+//	LeaderElectionDisable  bool
+//	LeaderElectionLockName string
+//	Plus                   bool
+//}
+
+type DeploymentFlagOptions struct {
+	NonBooleanFlags []NonBooleanFlag
+	BooleanFlags    []BooleanFlag
+}
+
+type BooleanFlag struct {
+	Name  string
+	Value bool
+}
+type NonBooleanFlag struct {
+	Name  string
+	Value string
+}
+
 // Data is telemetry data.
 // Note: this type might change once https://github.com/nginxinc/nginx-gateway-fabric/issues/1318 is implemented.
 type Data struct {
-	ProjectMetadata   ProjectMetadata
-	ClusterID         string
-	Arch              string
-	DeploymentID      string
-	ImageSource       string
-	NGFResourceCounts NGFResourceCounts
-	NodeCount         int
-	NGFReplicaCount   int
+	ProjectMetadata       ProjectMetadata
+	ClusterID             string
+	Arch                  string
+	DeploymentID          string
+	ImageSource           string
+	NGFResourceCounts     NGFResourceCounts
+	NodeCount             int
+	NGFReplicaCount       int
+	DeploymentFlagOptions DeploymentFlagOptions
 }
 
 // DataCollectorConfig holds configuration parameters for DataCollectorImpl.
@@ -68,6 +102,8 @@ type DataCollectorConfig struct {
 	GraphGetter GraphGetter
 	// ConfigurationGetter allows us to get the Configuration.
 	ConfigurationGetter ConfigurationGetter
+	// Flags are all the NGF flags.
+	Flags *pflag.FlagSet
 	// Version is the NGF version.
 	Version string
 	// PodNSName is the NamespacedName of the NGF Pod.
@@ -111,6 +147,7 @@ func (c DataCollectorImpl) Collect(ctx context.Context) (Data, error) {
 	if err != nil {
 		return Data{}, fmt.Errorf("failed to collect NGF replica count: %w", err)
 	}
+	deploymentFlagOptions := collectDeploymentFlagOptions(c.cfg.Flags)
 
 	deploymentID, err := getDeploymentID(replicaSet)
 	if err != nil {
@@ -129,11 +166,12 @@ func (c DataCollectorImpl) Collect(ctx context.Context) (Data, error) {
 			Name:    "NGF",
 			Version: c.cfg.Version,
 		},
-		NGFReplicaCount: replicaCount,
-		ClusterID:       clusterID,
-		ImageSource:     c.cfg.ImageSource,
-		Arch:            runtime.GOARCH,
-		DeploymentID:    deploymentID,
+		NGFReplicaCount:       replicaCount,
+		ClusterID:             clusterID,
+		ImageSource:           c.cfg.ImageSource,
+		Arch:                  runtime.GOARCH,
+		DeploymentID:          deploymentID,
+		DeploymentFlagOptions: deploymentFlagOptions,
 	}
 
 	return data, nil
@@ -258,3 +296,40 @@ func CollectClusterID(ctx context.Context, k8sClient client.Reader) (string, err
 	}
 	return string(kubeNamespace.GetUID()), nil
 }
+
+func collectDeploymentFlagOptions(flags *pflag.FlagSet) DeploymentFlagOptions {
+	deploymentFlagOptions := DeploymentFlagOptions{
+		NonBooleanFlags: []NonBooleanFlag{},
+		BooleanFlags:    []BooleanFlag{},
+	}
+	flags.Visit(
+		func(flag *pflag.Flag) {
+			switch flag.Value.Type() {
+			case "bool":
+				val, err := strconv.ParseBool(flag.Value.String())
+				if err != nil {
+					return
+				}
+				deploymentFlagOptions.BooleanFlags = append(deploymentFlagOptions.BooleanFlags, BooleanFlag{
+					Name:  flag.Name,
+					Value: val,
+				})
+
+			default:
+				var val string
+				if flag.Value.String() == flag.DefValue {
+					val = "default"
+				} else {
+					val = "user-defined"
+				}
+
+				deploymentFlagOptions.NonBooleanFlags = append(deploymentFlagOptions.NonBooleanFlags, NonBooleanFlag{
+					Name:  flag.Name,
+					Value: val,
+				})
+			}
+		},
+	)
+
+	return deploymentFlagOptions
+}