fix: add missing logging to metrics collector (#1587)

Co-authored-by: Copilot <[email protected]>

Author: erikgb

go.mod

@@ -4,6 +4,7 @@ go 1.25.0
 
 require (
 	github.com/distribution/reference v0.6.0
+	github.com/go-logr/logr v1.4.3
 	github.com/go-viper/mapstructure/v2 v2.4.0
 	github.com/gohugoio/hashstructure v0.6.0
 	github.com/onsi/ginkgo/v2 v2.26.0
@@ -42,7 +43,6 @@ require (
 	github.com/fsnotify/fsnotify v1.9.0 // indirect
 	github.com/fxamacker/cbor/v2 v2.9.0 // indirect
 	github.com/go-errors/errors v1.5.1 // indirect
-	github.com/go-logr/logr v1.4.3 // indirect
 	github.com/go-logr/zapr v1.3.0 // indirect
 	github.com/go-openapi/jsonpointer v0.22.0 // indirect
 	github.com/go-openapi/jsonreference v0.21.1 // indirect

internal/metrics/collector.go

@@ -5,6 +5,7 @@ import (
 	"regexp"
 	"strings"
 
+	"github.com/go-logr/logr"
 	openreportsv1alpha1 "github.com/openreports/reports-api/apis/openreports.io/v1alpha1"
 	"github.com/prometheus/client_golang/prometheus"
 	"k8s.io/apimachinery/pkg/api/meta"
@@ -21,6 +22,9 @@ import (
 const (
 	Namespace = "image_scanner"
 	Subsystem = "container_image"
+
+	// LoggerName is the name used for the metrics collector logger.
+	LoggerName = "metrics-collector"
 )
 
 var (
@@ -47,6 +51,10 @@ type ImageMetricsCollector struct {
 	client.Reader
 	config.Config
 
+	// Log is the logger used for logging within the ImageMetricsCollector.
+	// If unset, it defaults to a discard logger, disabling all logging output.
+	Log logr.Logger
+
 	cisLabels       cisLabels
 	successDesc     *prometheus.Desc
 	issuesDesc      *prometheus.Desc
@@ -59,6 +67,10 @@ type Manager interface {
 }
 
 func (c *ImageMetricsCollector) SetupWithManager(mgr Manager) error {
+	if c.Log.GetSink() == nil {
+		c.Log = logr.Discard()
+	}
+
 	labels := make(cisLabels, 0, len(c.MetricsLabels)+len(cisResourceLabels)+1)
 
 	if len(c.MetricsLabels) > 0 {
@@ -132,7 +144,7 @@ func (c ImageMetricsCollector) Collect(metrics chan<- prometheus.Metric) {
 
 	cisList := &stasv1alpha1.ContainerImageScanList{}
 	if err := c.List(ctx, cisList, client.InNamespace("")); err != nil {
-		// TODO: Log
+		c.Log.Error(err, "Failed to list all ContainerImageScans")
 		return
 	}
 
@@ -159,7 +171,7 @@ func (c ImageMetricsCollector) Collect(metrics chan<- prometheus.Metric) {
 		if config.DefaultMutableFeatureGate.Enabled(feature.PolicyReport) {
 			report := openreportsv1alpha1.Report{}
 			if err := c.Get(ctx, client.ObjectKeyFromObject(&cis), &report); err != nil {
-				// TODO: Log
+				c.Log.Error(err, "Failed to get Report", "namespace", cis.Namespace, "name", cis.Name)
 				continue
 			}
 

internal/metrics/collector_test.go

@@ -25,6 +25,7 @@ var _ = Describe("ContainerImageScan Collector", func() {
 		imageMetricsCollector = &ImageMetricsCollector{
 			Reader: c,
 			Config: config.Config{MetricsLabels: []string{"system.statnett.no/name", "app.kubernetes.io/name"}},
+			Log:    GinkgoLogr.WithName(LoggerName),
 		}
 		mgr := &MockManager{}
 		mgr.EXPECT().Add(mock.Anything).Call.Return(nil)

internal/operator/operator.go

@@ -265,6 +265,7 @@ func (o Operator) Start(cfg config.Config) error {
 	if err = (&metrics.ImageMetricsCollector{
 		Reader: mgr.GetCache(),
 		Config: cfg,
+		Log:    ctrl.Log.WithName(metrics.LoggerName),
 	}).SetupWithManager(mgr); err != nil {
 		return fmt.Errorf("unable to set up image metrics collector: %w", err)
 	}