Skip to content

Use Slog in controllers #1734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Igor-splunk wants to merge 1 commit into
base: feature/slog-as-default-logger
Choose a base branch
from
Open

Use Slog in controllers #1734

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions cmd/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,6 @@ func main() {
slog.String("log_format", logCfg.Format),
slog.Bool("log_add_source", logCfg.AddSource))

_ = logger // logger is available for future use

// Logging setup (existing zap logger for controller-runtime compatibility)
ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts)))

Expand All @@ -202,6 +200,7 @@ func main() {
if err = (&intController.ClusterManagerReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
Logger: logger,
Copy link
Collaborator

@kubabuczak kubabuczak Feb 27, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we are using the same logger everywhere - why cannot we use the default one? logger := slog.Default()

}).SetupWithManager(mgr); err != nil {
fmt.Printf(" error - %v", err)
setupLog.Error(err, "unable to create controller", "controller", "ClusterManager ")
Expand All @@ -211,48 +210,55 @@ func main() {
if err = (&intController.ClusterMasterReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
Logger: logger,
}).SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "ClusterMaster")
os.Exit(1)
}
if err = (&intController.IndexerClusterReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
Logger: logger,
}).SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "IndexerCluster")
os.Exit(1)
}
if err = (&intController.LicenseMasterReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
Logger: logger,
}).SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "LicenseMaster")
os.Exit(1)
}
if err = (&intController.LicenseManagerReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
Logger: logger,
}).SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "LicenseManager")
os.Exit(1)
}
if err = (&intController.MonitoringConsoleReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
Logger: logger,
}).SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "MonitoringConsole")
os.Exit(1)
}
if err = (&intController.SearchHeadClusterReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
Logger: logger,
}).SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "SearchHeadCluster")
os.Exit(1)
}
if err = (&intController.StandaloneReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
Logger: logger,
}).SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "Standalone")
os.Exit(1)
Expand Down
6 changes: 6 additions & 0 deletions internal/controller/clustermanager_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@ package controller

import (
"context"
"log/slog"
"time"

enterpriseApi "github.com/splunk/splunk-operator/api/v4"
"github.com/splunk/splunk-operator/internal/controller/common"
"github.com/splunk/splunk-operator/pkg/logging"

"github.com/pkg/errors"
metrics "github.com/splunk/splunk-operator/pkg/splunk/client/metrics"
Expand All @@ -43,6 +45,7 @@ import (
type ClusterManagerReconciler struct {
client.Client
Scheme *runtime.Scheme
Logger *slog.Logger
}

//+kubebuilder:rbac:groups=enterprise.splunk.com,resources=clustermanagers,verbs=get;list;watch;create;update;patch;delete
Expand Down Expand Up @@ -75,6 +78,8 @@ func (r *ClusterManagerReconciler) Reconcile(ctx context.Context, req ctrl.Reque
metrics.ReconcileCounters.With(metrics.GetPrometheusLabels(req, "ClusterManager")).Inc()
defer recordInstrumentionData(time.Now(), req, "controller", "ClusterManager")

ctx = logging.WithLogger(ctx, r.Logger.With("name", req.Name, "namespace", req.Namespace))

reqLogger := log.FromContext(ctx)
reqLogger = reqLogger.WithValues("clustermanager", req.NamespacedName)

Expand Down Expand Up @@ -117,6 +122,7 @@ var ApplyClusterManager = func(ctx context.Context, client client.Client, instan
}

func (r *ClusterManagerReconciler) SetupWithManager(mgr ctrl.Manager) error {
r.Logger = r.Logger.With("controller", "ClusterManager")
return ctrl.NewControllerManagedBy(mgr).
For(&enterpriseApi.ClusterManager{}).
WithEventFilter(predicate.Or(
Expand Down
6 changes: 6 additions & 0 deletions internal/controller/clustermaster_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@ package controller

import (
"context"
"log/slog"
"time"

enterpriseApi "github.com/splunk/splunk-operator/api/v4"
"github.com/splunk/splunk-operator/internal/controller/common"
"github.com/splunk/splunk-operator/pkg/logging"

"github.com/pkg/errors"
enterpriseApiV3 "github.com/splunk/splunk-operator/api/v3"
Expand All @@ -44,6 +46,7 @@ import (
type ClusterMasterReconciler struct {
client.Client
Scheme *runtime.Scheme
Logger *slog.Logger
}

//+kubebuilder:rbac:groups=enterprise.splunk.com,resources=clustermasters,verbs=get;list;watch;create;update;patch;delete
Expand Down Expand Up @@ -76,6 +79,8 @@ func (r *ClusterMasterReconciler) Reconcile(ctx context.Context, req ctrl.Reques
metrics.ReconcileCounters.With(metrics.GetPrometheusLabels(req, "ClusterMaster")).Inc()
defer recordInstrumentionData(time.Now(), req, "controller", "ClusterMaster")

ctx = logging.WithLogger(ctx, r.Logger.With("name", req.Name, "namespace", req.Namespace))

reqLogger := log.FromContext(ctx)
reqLogger = reqLogger.WithValues("clustermaster", req.NamespacedName)

Expand Down Expand Up @@ -119,6 +124,7 @@ var ApplyClusterMaster = func(ctx context.Context, client client.Client, instanc

// SetupWithManager sets up the controller with the Manager.
func (r *ClusterMasterReconciler) SetupWithManager(mgr ctrl.Manager) error {
r.Logger = r.Logger.With("controller", "ClusterMaster")
return ctrl.NewControllerManagedBy(mgr).
For(&enterpriseApiV3.ClusterMaster{}).
WithEventFilter(predicate.Or(
Expand Down
6 changes: 6 additions & 0 deletions internal/controller/indexercluster_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@ package controller

import (
"context"
"log/slog"
"time"

enterpriseApi "github.com/splunk/splunk-operator/api/v4"
"github.com/splunk/splunk-operator/internal/controller/common"
"github.com/splunk/splunk-operator/pkg/logging"

"github.com/pkg/errors"
enterpriseApiV3 "github.com/splunk/splunk-operator/api/v3"
Expand All @@ -44,6 +46,7 @@ import (
type IndexerClusterReconciler struct {
client.Client
Scheme *runtime.Scheme
Logger *slog.Logger
}

//+kubebuilder:rbac:groups=enterprise.splunk.com,resources=indexerclusters,verbs=get;list;watch;create;update;patch;delete
Expand Down Expand Up @@ -75,6 +78,8 @@ func (r *IndexerClusterReconciler) Reconcile(ctx context.Context, req ctrl.Reque
metrics.ReconcileCounters.With(metrics.GetPrometheusLabels(req, "IndexerCluster")).Inc()
defer recordInstrumentionData(time.Now(), req, "controller", "IndexerCluster")

ctx = logging.WithLogger(ctx, r.Logger.With("name", req.Name, "namespace", req.Namespace))

reqLogger := log.FromContext(ctx)
reqLogger = reqLogger.WithValues("indexercluster", req.NamespacedName)

Expand Down Expand Up @@ -122,6 +127,7 @@ var ApplyIndexerCluster = func(ctx context.Context, client client.Client, instan

// SetupWithManager sets up the controller with the Manager.
func (r *IndexerClusterReconciler) SetupWithManager(mgr ctrl.Manager) error {
r.Logger = r.Logger.With("controller", "IndexerCluster")
return ctrl.NewControllerManagedBy(mgr).
For(&enterpriseApi.IndexerCluster{}).
WithEventFilter(predicate.Or(
Expand Down
6 changes: 6 additions & 0 deletions internal/controller/licensemanager_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@ package controller

import (
"context"
"log/slog"
"time"

enterpriseApi "github.com/splunk/splunk-operator/api/v4"
"github.com/splunk/splunk-operator/internal/controller/common"
"github.com/splunk/splunk-operator/pkg/logging"

"github.com/pkg/errors"
metrics "github.com/splunk/splunk-operator/pkg/splunk/client/metrics"
Expand All @@ -43,6 +45,7 @@ import (
type LicenseManagerReconciler struct {
client.Client
Scheme *runtime.Scheme
Logger *slog.Logger
}

//+kubebuilder:rbac:groups=enterprise.splunk.com,resources=licensemanagers,verbs=get;list;watch;create;update;patch;delete
Expand Down Expand Up @@ -74,6 +77,8 @@ func (r *LicenseManagerReconciler) Reconcile(ctx context.Context, req ctrl.Reque
metrics.ReconcileCounters.With(metrics.GetPrometheusLabels(req, "LicenseManager")).Inc()
defer recordInstrumentionData(time.Now(), req, "controller", "LicenseManager")

ctx = logging.WithLogger(ctx, r.Logger.With("name", req.Name, "namespace", req.Namespace))

reqLogger := log.FromContext(ctx)
reqLogger = reqLogger.WithValues("licensemanager", req.NamespacedName)

Expand Down Expand Up @@ -117,6 +122,7 @@ var ApplyLicenseManager = func(ctx context.Context, client client.Client, instan

// SetupWithManager sets up the controller with the Manager.
func (r *LicenseManagerReconciler) SetupWithManager(mgr ctrl.Manager) error {
r.Logger = r.Logger.With("controller", "LicenseManager")
return ctrl.NewControllerManagedBy(mgr).
For(&enterpriseApi.LicenseManager{}).
WithEventFilter(predicate.Or(
Expand Down
6 changes: 6 additions & 0 deletions internal/controller/licensemaster_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ package controller

import (
"context"
"log/slog"
"time"

"github.com/splunk/splunk-operator/internal/controller/common"
"github.com/splunk/splunk-operator/pkg/logging"

"github.com/pkg/errors"
enterpriseApiV3 "github.com/splunk/splunk-operator/api/v3"
Expand All @@ -44,6 +46,7 @@ import (
type LicenseMasterReconciler struct {
client.Client
Scheme *runtime.Scheme
Logger *slog.Logger
}

//+kubebuilder:rbac:groups=enterprise.splunk.com,resources=licensemasters,verbs=get;list;watch;create;update;patch;delete
Expand Down Expand Up @@ -75,6 +78,8 @@ func (r *LicenseMasterReconciler) Reconcile(ctx context.Context, req ctrl.Reques
metrics.ReconcileCounters.With(metrics.GetPrometheusLabels(req, "LicenseMaster")).Inc()
defer recordInstrumentionData(time.Now(), req, "controller", "LicenseMaster")

ctx = logging.WithLogger(ctx, r.Logger.With("name", req.Name, "namespace", req.Namespace))

reqLogger := log.FromContext(ctx)
reqLogger = reqLogger.WithValues("licensemaster", req.NamespacedName)

Expand Down Expand Up @@ -118,6 +123,7 @@ var ApplyLicenseMaster = func(ctx context.Context, client client.Client, instanc

// SetupWithManager sets up the controller with the Manager.
func (r *LicenseMasterReconciler) SetupWithManager(mgr ctrl.Manager) error {
r.Logger = r.Logger.With("controller", "LicenseMaster")
return ctrl.NewControllerManagedBy(mgr).
For(&enterpriseApiV3.LicenseMaster{}).
WithEventFilter(predicate.Or(
Expand Down
7 changes: 7 additions & 0 deletions internal/controller/monitoringconsole_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@ package controller

import (
"context"
"log/slog"
"time"

enterpriseApi "github.com/splunk/splunk-operator/api/v4"
"github.com/splunk/splunk-operator/internal/controller/common"
"github.com/splunk/splunk-operator/pkg/logging"

"github.com/pkg/errors"
enterpriseApiV3 "github.com/splunk/splunk-operator/api/v3"
Expand All @@ -44,6 +46,7 @@ import (
type MonitoringConsoleReconciler struct {
client.Client
Scheme *runtime.Scheme
Logger *slog.Logger
}

//+kubebuilder:rbac:groups=enterprise.splunk.com,resources=monitoringconsoles,verbs=get;list;watch;create;update;patch;delete
Expand Down Expand Up @@ -74,6 +77,9 @@ type MonitoringConsoleReconciler struct {
func (r *MonitoringConsoleReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
metrics.ReconcileCounters.With(metrics.GetPrometheusLabels(req, "MonitoringConsole")).Inc()
defer recordInstrumentionData(time.Now(), req, "controller", "MonitoringConsole")

ctx = logging.WithLogger(ctx, r.Logger.With("name", req.Name, "namespace", req.Namespace))

reqLogger := log.FromContext(ctx)
reqLogger = reqLogger.WithValues("monitoringconsole", req.NamespacedName)

Expand Down Expand Up @@ -117,6 +123,7 @@ var ApplyMonitoringConsole = func(ctx context.Context, client client.Client, ins

// SetupWithManager sets up the controller with the Manager.
func (r *MonitoringConsoleReconciler) SetupWithManager(mgr ctrl.Manager) error {
r.Logger = r.Logger.With("controller", "MonitoringConsole")
return ctrl.NewControllerManagedBy(mgr).
For(&enterpriseApi.MonitoringConsole{}).
WithEventFilter(predicate.Or(
Expand Down
6 changes: 6 additions & 0 deletions internal/controller/searchheadcluster_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@ package controller

import (
"context"
"log/slog"
"time"

enterpriseApi "github.com/splunk/splunk-operator/api/v4"
"github.com/splunk/splunk-operator/internal/controller/common"
"github.com/splunk/splunk-operator/pkg/logging"

"github.com/pkg/errors"
metrics "github.com/splunk/splunk-operator/pkg/splunk/client/metrics"
Expand All @@ -43,6 +45,7 @@ import (
type SearchHeadClusterReconciler struct {
client.Client
Scheme *runtime.Scheme
Logger *slog.Logger
}

//+kubebuilder:rbac:groups=enterprise.splunk.com,resources=searchheadclusters,verbs=get;list;watch;create;update;patch;delete
Expand Down Expand Up @@ -74,6 +77,8 @@ func (r *SearchHeadClusterReconciler) Reconcile(ctx context.Context, req ctrl.Re
metrics.ReconcileCounters.With(metrics.GetPrometheusLabels(req, "SearchHeadCluster")).Inc()
defer recordInstrumentionData(time.Now(), req, "controller", "SearchHeadCluster")

ctx = logging.WithLogger(ctx, r.Logger.With("name", req.Name, "namespace", req.Namespace))

reqLogger := log.FromContext(ctx)
reqLogger = reqLogger.WithValues("searchheadcluster", req.NamespacedName)

Expand Down Expand Up @@ -117,6 +122,7 @@ var ApplySearchHeadCluster = func(ctx context.Context, client client.Client, ins

// SetupWithManager sets up the controller with the Manager.
func (r *SearchHeadClusterReconciler) SetupWithManager(mgr ctrl.Manager) error {
r.Logger = r.Logger.With("controller", "SearchHeadCluster")
return ctrl.NewControllerManagedBy(mgr).
For(&enterpriseApi.SearchHeadCluster{}).
WithEventFilter(predicate.Or(
Expand Down
6 changes: 6 additions & 0 deletions internal/controller/standalone_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@ package controller

import (
"context"
"log/slog"
"time"

enterpriseApi "github.com/splunk/splunk-operator/api/v4"
"github.com/splunk/splunk-operator/internal/controller/common"
"github.com/splunk/splunk-operator/pkg/logging"

appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
Expand All @@ -48,6 +50,7 @@ const (
type StandaloneReconciler struct {
client.Client
Scheme *runtime.Scheme
Logger *slog.Logger
}

//+kubebuilder:rbac:groups=enterprise.splunk.com,resources=standalones,verbs=get;list;watch;create;update;patch;delete
Expand Down Expand Up @@ -79,6 +82,8 @@ func (r *StandaloneReconciler) Reconcile(ctx context.Context, req ctrl.Request)
metrics.ReconcileCounters.With(metrics.GetPrometheusLabels(req, "Standalone")).Inc()
defer recordInstrumentionData(time.Now(), req, "controller", "Standalone")

ctx = logging.WithLogger(ctx, r.Logger.With("name", req.Name, "namespace", req.Namespace))

reqLogger := log.FromContext(ctx)
reqLogger = reqLogger.WithValues("standalone", req.NamespacedName)

Expand Down Expand Up @@ -122,6 +127,7 @@ var ApplyStandalone = func(ctx context.Context, client client.Client, instance *

// SetupWithManager sets up the controller with the Manager.
func (r *StandaloneReconciler) SetupWithManager(mgr ctrl.Manager) error {
r.Logger = r.Logger.With("controller", "Standalone")
return ctrl.NewControllerManagedBy(mgr).
For(&enterpriseApi.Standalone{}).
WithEventFilter(predicate.Or(
Expand Down
Loading
Loading