CSPL-4513 Events for Index & Ingestion separation

cmd/main.go

@@ -26,14 +26,11 @@ import (
 	"path/filepath"
 	"time"
 
-	"sigs.k8s.io/controller-runtime/pkg/metrics/filters"
-
 	intController "github.com/splunk/splunk-operator/internal/controller"
 	"github.com/splunk/splunk-operator/internal/controller/debug"
 	"github.com/splunk/splunk-operator/pkg/config"
 	"github.com/splunk/splunk-operator/pkg/logging"
 	"github.com/splunk/splunk-operator/pkg/splunk/enterprise/validation"
-	"sigs.k8s.io/controller-runtime/pkg/certwatcher"
 
 	// Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
 	// to ensure that exec-entrypoint and run can make use of them.
@@ -47,14 +44,15 @@ import (
 	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
 	_ "k8s.io/client-go/plugin/pkg/client/auth"
 	ctrl "sigs.k8s.io/controller-runtime"
+	"sigs.k8s.io/controller-runtime/pkg/certwatcher"
 	"sigs.k8s.io/controller-runtime/pkg/healthz"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
+	"sigs.k8s.io/controller-runtime/pkg/metrics/filters"
 	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
 
 	enterpriseApiV3 "github.com/splunk/splunk-operator/api/v3"
 	enterpriseApi "github.com/splunk/splunk-operator/api/v4"
-	"github.com/splunk/splunk-operator/internal/controller"
 	//+kubebuilder:scaffold:imports
 	//extapi "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 )
@@ -299,7 +297,7 @@ func main() {
 		setupLog.Error(err, "unable to create controller", "controller", "Standalone")
 		os.Exit(1)
 	}
-	if err := (&controller.IngestorClusterReconciler{
+	if err := (&intController.IngestorClusterReconciler{
 		Client:   mgr.GetClient(),
 		Scheme:   mgr.GetScheme(),
 		Recorder: mgr.GetEventRecorderFor("ingestorcluster-controller"),

pkg/splunk/client/enterprise.go

@@ -17,17 +17,18 @@ package client
 
 import (
 	"bytes"
+	"context"
 	"crypto/tls"
 	"encoding/json"
 	"fmt"
 	"io"
+	"log/slog"
 	"net/http"
 	"regexp"
 	"strconv"
 	"strings"
 	"time"
 
-	"github.com/go-logr/logr"
 	splcommon "github.com/splunk/splunk-operator/pkg/splunk/common"
 )
 
@@ -1035,23 +1036,22 @@ func (c *SplunkClient) RestartSplunk() error {
 
 // Updates conf files and their properties
 // See https://help.splunk.com/en/splunk-enterprise/leverage-rest-apis/rest-api-reference/10.0/configuration-endpoints/configuration-endpoint-descriptions
-func (c *SplunkClient) UpdateConfFile(scopedLog logr.Logger, fileName, property string, propertyKVList [][]string) error {
+func (c *SplunkClient) UpdateConfFile(ctx context.Context, logger *slog.Logger, fileName, property string, propertyKVList [][]string) error {
 	// Creates an object in a conf file if it doesn't exist
 	endpoint := fmt.Sprintf("%s/servicesNS/nobody/system/configs/conf-%s", c.ManagementURI, fileName)
 	body := fmt.Sprintf("name=%s", property)
 
-	scopedLog.Info("Creating conf file object if it does not exist", "fileName", fileName, "property", property)
+	logger.InfoContext(ctx, "Creating conf file object if it does not exist", "fileName", fileName, "property", property)
 	request, err := http.NewRequest("POST", endpoint, strings.NewReader(body))
 	if err != nil {
-		scopedLog.Error(err, "Failed to create conf file object if it does not exist", "fileName", fileName, "property", property)
+		logger.ErrorContext(ctx, "Failed to create conf file object if it does not exist", "fileName", fileName, "property", property, "error", err.Error())
 		return err
 	}
 
-	scopedLog.Info("Validating conf file object creation", "fileName", fileName, "property", property)
 	expectedStatus := []int{200, 201, 409}
 	err = c.Do(request, expectedStatus, nil)
 	if err != nil {
-		scopedLog.Error(err, fmt.Sprintf("Status not in %v for conf file object creation", expectedStatus), "fileName", fileName, "property", property)
+		logger.ErrorContext(ctx, fmt.Sprintf("Status not in %v for conf file object creation", expectedStatus), "fileName", fileName, "property", property, "error", err.Error())
 		return err
 	}
 
@@ -1065,18 +1065,17 @@ func (c *SplunkClient) UpdateConfFile(scopedLog logr.Logger, fileName, property
 		body = body[:len(body)-1]
 	}
 
-	scopedLog.Info("Updating conf file object", "fileName", fileName, "property", property, "body", body)
+	logger.DebugContext(ctx, "Updating conf file object", "fileName", fileName, "property", property)
 	request, err = http.NewRequest("POST", endpoint, strings.NewReader(body))
 	if err != nil {
-		scopedLog.Error(err, "Failed to update conf file object", "fileName", fileName, "property", property, "body", body)
+		logger.ErrorContext(ctx, "Failed to update conf file object", "fileName", fileName, "property", property, "error", err.Error())
 		return err
 	}
 
-	scopedLog.Info("Validating conf file object update", "fileName", fileName, "property", property)
 	expectedStatus = []int{200, 201}
 	err = c.Do(request, expectedStatus, nil)
 	if err != nil {
-		scopedLog.Error(err, fmt.Sprintf("Status not in %v for conf file object update", expectedStatus), "fileName", fileName, "property", property, "body", body)
+		logger.ErrorContext(ctx, fmt.Sprintf("Status not in %v for conf file object update", expectedStatus), "fileName", fileName, "property", property, "error", err.Error())
 	}
 	return err
 }

pkg/splunk/client/enterprise_test.go

@@ -24,8 +24,8 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/splunk/splunk-operator/pkg/logging"
 	splcommon "github.com/splunk/splunk-operator/pkg/splunk/common"
-	"sigs.k8s.io/controller-runtime/pkg/log"
 
 	spltest "github.com/splunk/splunk-operator/pkg/splunk/test"
 )
@@ -704,8 +704,8 @@ func TestUpdateConfFile(t *testing.T) {
 	value := "myvalue"
 	fileName := "outputs"
 
-	reqLogger := log.FromContext(context.TODO())
-	scopedLog := reqLogger.WithName("TestUpdateConfFile")
+	ctx := context.TODO()
+	logger := logging.FromContext(ctx).With("func", "TestUpdateConfFile", "name", "test", "namespace", "test")
 
 	// First request: create the property (object) if it doesn't exist
 	createBody := strings.NewReader(fmt.Sprintf("name=%s", property))
@@ -722,7 +722,7 @@ func TestUpdateConfFile(t *testing.T) {
 	c := NewSplunkClient("https://localhost:8089", "admin", "p@ssw0rd")
 	c.Client = mockSplunkClient
 
-	err := c.UpdateConfFile(scopedLog, fileName, property, [][]string{{key, value}})
+	err := c.UpdateConfFile(ctx, logger, fileName, property, [][]string{{key, value}})
 	if err != nil {
 		t.Errorf("UpdateConfFile err = %v", err)
 	}
@@ -732,7 +732,7 @@ func TestUpdateConfFile(t *testing.T) {
 	mockSplunkClient = &spltest.MockHTTPClient{}
 	mockSplunkClient.AddHandler(wantCreateRequest, 500, "", nil)
 	c.Client = mockSplunkClient
-	err = c.UpdateConfFile(scopedLog, fileName, property, [][]string{{key, value}})
+	err = c.UpdateConfFile(ctx, logger, fileName, property, [][]string{{key, value}})
 	if err == nil {
 		t.Errorf("UpdateConfFile expected error on create, got nil")
 	}
@@ -742,7 +742,7 @@ func TestUpdateConfFile(t *testing.T) {
 	mockSplunkClient.AddHandler(wantCreateRequest, 201, "", nil)
 	mockSplunkClient.AddHandler(wantUpdateRequest, 500, "", nil)
 	c.Client = mockSplunkClient
-	err = c.UpdateConfFile(scopedLog, fileName, property, [][]string{{key, value}})
+	err = c.UpdateConfFile(ctx, logger, fileName, property, [][]string{{key, value}})
 	if err == nil {
 		t.Errorf("UpdateConfFile expected error on update, got nil")
 	}