Refactor AgentLabels to be a map

Author: bjee19

internal/controller/provisioner/objects.go

@@ -25,7 +25,6 @@ import (
 	"github.com/nginx/nginx-gateway-fabric/v2/internal/controller/config"
 	"github.com/nginx/nginx-gateway-fabric/v2/internal/controller/state/dataplane"
 	"github.com/nginx/nginx-gateway-fabric/v2/internal/controller/state/graph"
-	"github.com/nginx/nginx-gateway-fabric/v2/internal/controller/telemetry"
 	"github.com/nginx/nginx-gateway-fabric/v2/internal/framework/controller"
 	"github.com/nginx/nginx-gateway-fabric/v2/internal/framework/helpers"
 )
@@ -409,7 +408,7 @@ func (p *NginxProvisioner) buildNginxConfigMaps(
 		"Namespace":     p.cfg.GatewayPodConfig.Namespace,
 		"EnableMetrics": enableMetrics,
 		"MetricsPort":   metricsPort,
-		"AgentLabels":   telemetry.AgentLabelsToMap(p.cfg.AgentLabels),
+		"AgentLabels":   p.cfg.AgentLabels,
 	}
 
 	if logging != nil && logging.AgentLevel != nil {

internal/controller/provisioner/provisioner.go

@@ -49,7 +49,7 @@ type Config struct {
 	PlusUsageConfig                *config.UsageReportConfig
 	StatusQueue                    *status.Queue
 	GatewayPodConfig               *config.GatewayPodConfig
-	AgentLabels                    telemetry.AgentLabels
+	AgentLabels                    map[string]string
 	Logger                         logr.Logger
 	NGINXSCCName                   string
 	GCName                         string
@@ -90,7 +90,7 @@ func defaultLabelCollectorFactory(mgr manager.Manager, cfg Config) AgentLabelCol
 }
 
 type AgentLabelCollector interface {
-	Collect(ctx context.Context) (telemetry.AgentLabels, error)
+	Collect(ctx context.Context) (map[string]string, error)
 }
 
 // NewNginxProvisioner returns a new instance of a Provisioner that will deploy nginx resources.

internal/controller/provisioner/provisioner_test.go

@@ -24,7 +24,6 @@ import (
 	"github.com/nginx/nginx-gateway-fabric/v2/internal/controller/nginx/agent/agentfakes"
 	"github.com/nginx/nginx-gateway-fabric/v2/internal/controller/provisioner/openshift/openshiftfakes"
 	"github.com/nginx/nginx-gateway-fabric/v2/internal/controller/state/graph"
-	"github.com/nginx/nginx-gateway-fabric/v2/internal/controller/telemetry"
 	"github.com/nginx/nginx-gateway-fabric/v2/internal/framework/controller"
 	"github.com/nginx/nginx-gateway-fabric/v2/internal/framework/helpers"
 )
@@ -190,13 +189,13 @@ func defaultNginxProvisioner(
 				EndpointPort:           443,
 				EndpointTLSSkipVerify:  false,
 			},
-			AgentLabels: telemetry.AgentLabels{
-				ProductType:      "ngf",
-				ProductVersion:   "ngf-version",
-				ClusterID:        "my-cluster-id",
-				ControlName:      "my-control-plane-name",
-				ControlID:        "my-control-plane-id",
-				ControlNamespace: "my-control-plane-namespace",
+			AgentLabels: map[string]string{
+				"product-type":      "ngf",
+				"product-version":   "ngf-version",
+				"cluster-id":        "my-cluster-id",
+				"control-name":      "my-control-plane-name",
+				"control-id":        "my-control-plane-id",
+				"control-namespace": "my-control-plane-namespace",
 			},
 		},
 		leader: true,
@@ -205,8 +204,8 @@ func defaultNginxProvisioner(
 
 type fakeLabelCollector struct{}
 
-func (f *fakeLabelCollector) Collect(_ context.Context) (telemetry.AgentLabels, error) {
-	return telemetry.AgentLabels{ProductType: "fake"}, nil
+func (f *fakeLabelCollector) Collect(_ context.Context) (map[string]string, error) {
+	return map[string]string{"product-type": "fake"}, nil
 }
 
 func TestNewNginxProvisioner(t *testing.T) {

internal/controller/telemetry/agent_labels.go

@@ -8,16 +8,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
-// AgentLabels contains the metadata information needed for reporting to Agent v3.
-type AgentLabels struct {
-	ProductType      string `json:"product-type"`
-	ProductVersion   string `json:"product-version"`
-	ClusterID        string `json:"cluster-id"`
-	ControlName      string `json:"control-name"`
-	ControlID        string `json:"control-id"`
-	ControlNamespace string `json:"control-namespace"`
-}
-
 // LabelCollectorConfig holds configuration parameters for LabelCollector.
 type LabelCollectorConfig struct {
 	// K8sClientReader is a Kubernetes API client Reader.
@@ -42,41 +32,31 @@ func NewLabelCollector(
 	}
 }
 
-func (l *LabelCollector) Collect(ctx context.Context) (AgentLabels, error) {
+// Collect gathers metadata labels needed for reporting to Agent v3.
+func (l *LabelCollector) Collect(ctx context.Context) (map[string]string, error) {
+	agentLabels := make(map[string]string)
+
 	clusterID, err := collectClusterID(ctx, l.cfg.K8sClientReader)
 	if err != nil {
-		return AgentLabels{}, fmt.Errorf("failed to collect cluster information: %w", err)
+		return nil, fmt.Errorf("failed to collect cluster information: %w", err)
 	}
 
 	replicaSet, err := getPodReplicaSet(ctx, l.cfg.K8sClientReader, l.cfg.PodNSName)
 	if err != nil {
-		return AgentLabels{}, fmt.Errorf("failed to get replica set for pod %v: %w", l.cfg.PodNSName, err)
+		return nil, fmt.Errorf("failed to get replica set for pod %v: %w", l.cfg.PodNSName, err)
 	}
 
 	deploymentID, err := getDeploymentID(replicaSet)
 	if err != nil {
-		return AgentLabels{}, fmt.Errorf("failed to get NGF deploymentID: %w", err)
+		return nil, fmt.Errorf("failed to get NGF deploymentID: %w", err)
 	}
 
-	agentLabels := AgentLabels{
-		ProductType:      "ngf",
-		ProductVersion:   l.cfg.Version,
-		ClusterID:        clusterID,
-		ControlName:      l.cfg.PodNSName.Name,
-		ControlNamespace: l.cfg.PodNSName.Namespace,
-		ControlID:        deploymentID,
-	}
+	agentLabels["product-type"] = "ngf"
+	agentLabels["product-version"] = l.cfg.Version
+	agentLabels["cluster-id"] = clusterID
+	agentLabels["control-name"] = l.cfg.PodNSName.Name
+	agentLabels["control-namespace"] = l.cfg.PodNSName.Namespace
+	agentLabels["control-id"] = deploymentID
 
 	return agentLabels, nil
 }
-
-func AgentLabelsToMap(labels AgentLabels) map[string]string {
-	return map[string]string{
-		"product-type":      labels.ProductType,
-		"product-version":   labels.ProductVersion,
-		"cluster-id":        labels.ClusterID,
-		"control-name":      labels.ControlName,
-		"control-namespace": labels.ControlNamespace,
-		"control-id":        labels.ControlID,
-	}
-}