cleanup

- constify conext shutdonw timeout
- restore header
- remove unnecessary metric attribute on exporter setup
- restore test coverage from rebase conflict

Author: tiffanny29631

cmd/hydration-controller/main.go

@@ -19,7 +19,6 @@ import (
 	"flag"
 	"os"
 	"strings"
-	"time"
 
 	"github.com/GoogleContainerTools/config-sync/pkg/api/configsync"
 	"github.com/GoogleContainerTools/config-sync/pkg/hydrate"
@@ -93,7 +92,7 @@ func main() {
 	}
 
 	defer func() {
-		shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
+		shutdownCtx, cancel := context.WithTimeout(context.Background(), kmetrics.ShutdownTimeout)
 		defer cancel()
 		if err := oce.Shutdown(shutdownCtx); err != nil {
 			klog.Fatalf("Unable to stop the OC Agent exporter: %v", err)

cmd/reconciler-manager/main.go

@@ -20,7 +20,6 @@ import (
 	"fmt"
 	"net/http"
 	"os"
-	"time"
 
 	traceapi "cloud.google.com/go/trace/apiv2"
 	"github.com/GoogleContainerTools/config-sync/pkg/api/configsync"
@@ -197,7 +196,7 @@ func main() {
 	}
 
 	defer func() {
-		shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
+		shutdownCtx, cancel := context.WithTimeout(context.Background(), metrics.ShutdownTimeout)
 		defer cancel()
 		if err := oce.Shutdown(shutdownCtx); err != nil {
 			setupLog.Error(err, "failed to stop the OC Agent exporter")
@@ -210,7 +209,7 @@ func main() {
 	if err := mgr.Start(ctrl.SetupSignalHandler()); err != nil {
 		setupLog.Error(err, "problem running manager")
 		// os.Exit(1) does not run deferred functions so explicitly stopping the OC Agent exporter.
-		shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
+		shutdownCtx, cancel := context.WithTimeout(context.Background(), metrics.ShutdownTimeout)
 		defer cancel()
 		if err := oce.Shutdown(shutdownCtx); err != nil {
 			setupLog.Error(err, "failed to stop the OC Agent exporter")

cmd/reconciler/main.go

@@ -20,7 +20,6 @@ import (
 	"fmt"
 	"os"
 	"strings"
-	"time"
 
 	"github.com/GoogleContainerTools/config-sync/pkg/api/configsync"
 	"github.com/GoogleContainerTools/config-sync/pkg/declared"
@@ -155,7 +154,7 @@ func main() {
 	}
 
 	defer func() {
-		shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
+		shutdownCtx, cancel := context.WithTimeout(context.Background(), ocmetrics.ShutdownTimeout)
 		defer cancel()
 		if err := oce.Shutdown(shutdownCtx); err != nil {
 			klog.Fatalf("Unable to stop the OC Agent exporter: %v", err)

pkg/kmetrics/record.go

@@ -1,18 +1,16 @@
-/*
-Copyright 2021 Google LLC.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 
 package kmetrics
 

pkg/kmetrics/register.go

@@ -17,12 +17,17 @@ package kmetrics
 import (
 	"context"
 	"os"
+	"time"
 
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc"
 	"go.opentelemetry.io/otel/sdk/metric"
 	"go.opentelemetry.io/otel/sdk/resource"
-	semconv "go.opentelemetry.io/otel/semconv/v1.21.0"
+)
+
+const (
+	// ShutdownTimeout is the timeout for shutting down the Otel exporter
+	ShutdownTimeout = 5 * time.Second
 )
 
 // RegisterOTelExporter creates the OTLP metrics exporter.
@@ -38,10 +43,6 @@ func RegisterOTelExporter(ctx context.Context, containerName string) (*otlpmetri
 	res, err := resource.New(
 		ctx,
 		resource.WithFromEnv(),
-		resource.WithAttributes(
-			semconv.ServiceNameKey.String("config-sync-kmetric"),
-			semconv.ServiceVersionKey.String("1.0.0"),
-		),
 	)
 	if err != nil {
 		return nil, err

pkg/metrics/register.go

@@ -17,15 +17,20 @@ package metrics
 import (
 	"context"
 	"os"
+	"time"
 
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc"
 	"go.opentelemetry.io/otel/sdk/metric"
 	"go.opentelemetry.io/otel/sdk/resource"
-	semconv "go.opentelemetry.io/otel/semconv/v1.21.0"
 	"k8s.io/klog/v2"
 )
 
+const (
+	// ShutdownTimeout is the timeout for shutting down the Otel exporter
+	ShutdownTimeout = 5 * time.Second
+)
+
 // RegisterOTelExporter creates the OTLP metrics exporter.
 func RegisterOTelExporter(ctx context.Context, containerName string) (*otlpmetricgrpc.Exporter, error) {
 
@@ -40,10 +45,6 @@ func RegisterOTelExporter(ctx context.Context, containerName string) (*otlpmetri
 	res, err := resource.New(
 		ctx,
 		resource.WithFromEnv(),
-		resource.WithAttributes(
-			semconv.ServiceNameKey.String("config-sync"),
-			semconv.ServiceVersionKey.String("1.0.0"),
-		),
 	)
 	if err != nil {
 		klog.V(5).ErrorS(err, "METRIC DEBUG: Failed to create resource")

pkg/resourcegroup/controllers/metrics/register.go

@@ -22,7 +22,6 @@ import (
 	"go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc"
 	"go.opentelemetry.io/otel/sdk/metric"
 	"go.opentelemetry.io/otel/sdk/resource"
-	semconv "go.opentelemetry.io/otel/semconv/v1.21.0"
 )
 
 // RegisterOTelExporter creates the OTLP metrics exporter.
@@ -38,10 +37,6 @@ func RegisterOTelExporter(ctx context.Context) (*otlpmetricgrpc.Exporter, error)
 	res, err := resource.New(
 		ctx,
 		resource.WithFromEnv(),
-		resource.WithAttributes(
-			semconv.ServiceNameKey.String("config-sync-resourcegroup"),
-			semconv.ServiceVersionKey.String("1.0.0"),
-		),
 	)
 	if err != nil {
 		return nil, err

pkg/resourcegroup/controllers/resourcemap/update_metrics_test.go

@@ -252,6 +252,11 @@ func TestResourceMapUpdateMetrics(t *testing.T) {
 			if diff := exporter.ValidateMetrics(expected); diff != "" {
 				t.Errorf("Unexpected metrics recorded: %v", diff)
 			}
+
+			// Verify the resource map state
+			if len(m.resgroupToResources) != tc.expectedResourceGroups {
+				t.Errorf("Expected %d resource groups in map, got %d", tc.expectedResourceGroups, len(m.resgroupToResources))
+			}
 		})
 	}
 }