Merge slog feature branch by Igor-splunk · Pull Request #1859 · splunk/splunk-operator

Igor-splunk · 2026-04-20T16:58:32Z

Description

What does this PR have in it?

Key Changes

Highlight the updates in specific files

Testing and Verification

How did you test these changes? What automated tests are added?

Related Issues

Jira tickets, GitHub issues, Support tickets...

PR Checklist

Code changes adhere to the project's coding standards.
Relevant unit and integration tests are included.
Documentation has been updated accordingly.
All tests pass locally.
The PR description follows the project's guidelines.

* a * Tests for slog * Use slog in main * Use assertion * black box --------- Co-authored-by: igor.grzankowski <@splunk.com>

* Secrets logs * Get rid of log handle * Differentiate errors

* CSPL-3551 Init IngestorCluster CR implementation * CSPL-3551 Enhancing Ingestor inputs * CSPL-3551 Adding tests * CSPL-3551 Mound defaults and update them with no Splunk restart * CSPL-3551 Fixing code after tests * CSPL-3895-indexercluster (#1562) * Use endpoint to update conf file * CSPL-3895 Matching changes from Ingestor to Indexer --------- Co-authored-by: Kasia Koziol <kkoziol@splunk.com> Co-authored-by: igor.grzankowski <@splunk.com> * CSPL-3551 Applying fixes do Indexer integration * CSPL-3551 Fixes * CSPL-3551 Fixes * CSPL-3560 Initial docs for I&I separation * CSPL-3551 Update documentation to reflect on Grafana * CSPL-3556 Unit tests * CSPL-3972 Addressing TODOs * CSPL-3972 Addressing TODOs * CSPL-3551 Moving default from types to controller code * CSPL-3551 Applying previous changes to IndexerCluster * CSPL-3551 Moving validations to separate function and adding validation for empty values * CSPL-3551 Making sure all inputs are put into status * CSPL-3551 Update of conf files when queue name or type change * CSPL-3551 Unit tests * CSPL-4003 Helm charts support for bus and pipeline configs * CSPL-4003 Docs update * CSPL-4003 Addressing comments * CSPL-3558 Integ tests init * CSPL-3558 Adding extra validation for integraion test * CSPL-3558 Refactoring * CSPL-3558 Adding scenario for update and delete * CSPL-3558 Adding helm test * CSPL-3558 Update of k8s version * CSPL-3558 Fix metrics-server installation issues after k8s version upgrade * CSPL-3558 Adding additional tests * CSPL-3558 Fixing helm tests * CSPL-3558 Fix tests after merge * CSPL-3558 Fix helm tests * CSPL-4022 Remove pipeline config from inputs * CSPL-4022 Remove bus inputs * CSPL-4022 Introduce BusConfiguration CR * CSPL-4022 Update docs and tests * CSPL-4022 Update ns reference for BusConfiguration * CSPL-4022 Fixing tests and adding bus config to ingestor controller * CSPL-4022 Fix update behaviour * CSPL-4022 Docs update * CSPL-4022 Fix failing tests * CSPL-4022 Fix tests * CSPL-4022 Addressing PR comments * CSPL-4022 Address comments * CSPL-4022 Fix helm tests * CSPL-4358 Splitting BusConfiguration into Bus and LargeMessageStore * CSPL-4358 Update docs * CSPL-4358 Addressing comments * CSPL-4358 Adding more validations * CSPL-4360 Secret reference added for Bus CR * CSPL-4360 Fix failing tests * CSPL-4360 Add Splunk restart * CSPL-4360 Fix failing tests * CSPL-4360 Fix failing tests * CSPL-4360 Fix errors with failing validation on status * CSPL-4358 Rename Bus to Queue * CSPL-4358 Rename LargeMessageStore to ObjectStorage * CSPL-4358 Making region authRegion and optional, simplifying endpoint * CSPL-4360 Fixing tests after merge * CSPL-4360 Fix validation that fails for status * CSPL-4360 Fix failing to get k8s secret * CSPL-4360 Fix failing integ and helm tests * CSPL-4360 Fixing failing tests due to incorrect secret ref * CSPL-4360 Addressing comments * CSPL-4360 Addressing secret value change and removing redundant controllers * CSPL-4360 Update of docs, helm tests and validations * CSPL-4360 Add secret watch and fix controller tests * CSPL-4360 Update docs * CSPL-4360 Restart Splunk when SA changed * Addressing comments * Addressing changes from recent PRs * Formatting fix * Addressing PR comments * Address comments * Addressing comments * Fix pipeline issues * Reverting * Refactoring according to comments * CSPL-4513 Refactoring of existing events * CSPL-4513 Adding events and tests for them for Index & Ingestion separation use case * Fix formatting issues * Logs * Fmt fix * CSPL-4513 Extra logs * CSPL-4513 Moving to slog and extra tests * CSPL-4513 Fixing ScaledUp/Down events * CSPL-4002 Update Ansible role to ingestor (from standalone) for IngestorCluster (#1606) * CSPL-4002 Update role for ingestor to ingestor from standalone * CSPL-4212 Address changes from unit tests from develop branch * Addressing comments * Run tests against Splunk 10.2 * Fix * Address changes from develop * CSPL-4002 Revert 10.2 changes * CSPL-4513 Address comments * CSPL-4354 logs for CM and IC * CSPL-4354 Refactoring * CSPL-4513 Addressing Igor's changes * Fix * CSPL-4354 Addressing comments * CSPL-4354 Address comments * Feature/cspl 4354 cluster manager reconciler logging (#1721) * CSPL-4354 logs for CM and IC * CSPL-4354 Refactoring * CSPL-4354 Addressing comments * CSPL-4354 Address comments * CSPL-4354 Address comments * CSPL-4513 Address comments --------- Co-authored-by: Igor Grzankowski <igorg@splunk.com>

kasiakoziol · 2026-04-21T06:45:38Z

 	}

-	reqLogger.Info("start", "CR version", instance.GetResourceVersion())
+	logger.InfoContext(ctx, "start", "CR version", instance.GetResourceVersion())


NIT: to keep it consistent across all logs, we could enforce a pattern for key naming and it could be crVersion instead of CR version

kasiakoziol · 2026-04-21T06:45:57Z

 	result, err := ApplyClusterManager(ctx, r.Client, instance, nil)
 	if result.Requeue && result.RequeueAfter != 0 {
-		reqLogger.Info("Requeued", "period(seconds)", int(result.RequeueAfter/time.Second))
+		logger.InfoContext(ctx, "Requeued", "period(seconds)", int(result.RequeueAfter/time.Second))


NIT: to keep it consistent across all logs, we could enforce a pattern for key naming and it could be periodSeconds instead of period(seconds)

kasiakoziol · 2026-04-21T07:40:14Z

 	}

-	scopedLog.Info("AWS Client Config initialization successful.", "region", region, "TLS Version", tlsVersion)
+	scopedLog.InfoContext(ctx, "AWS Client Config initialization successful.", "region", region, "TLS Version", tlsVersion)


NIT: tlsVersion

kasiakoziol · 2026-04-21T07:40:42Z

+	scopedLog := logging.FromContext(ctx).With("func", "GetAppsList")

-	scopedLog.Info("Getting Apps list", "AWS S3 Bucket", awsclient.BucketName)
+	scopedLog.InfoContext(ctx, "Getting Apps list", "AWS S3 Bucket", awsclient.BucketName)


NIT: I won't write it everywhere, but it would be good to make key format consistent in logs.

rlieberman-splunk

Please update the PR description before merging.

rlieberman-splunk · 2026-04-22T18:41:50Z

@@ -0,0 +1,261 @@
+# Logging & Events


Add this to the "Reference" section of the github docs similar to the examples file: https://github.com/splunk/splunk-operator/blob/main/docs/Examples.md?plain=1#L4

rlieberman-splunk · 2026-04-22T18:44:58Z

+| `EventReasonSecretMissing` | `SecretMissing` | Required secret not found |
+| `EventReasonUpgradeCheckFailed` | `UpgradeCheckFailed` | Upgrade path validation errors |
+
+See `event_reasons.go` for the full list.


Can we add a link to this file from the doc?

kasiakoziol · 2026-04-23T07:02:18Z

 	// so a non-empty stderr does not indicate failure.
 	if stdErr != "" {
-		scopedLog.Info("Post install command stderr output (informational only)", "stdout", stdOut, "stderr", stdErr, "post install command", command)
+		scopedLog.InfoContext(rctx, "Post install command stderr output (informational only)", "stdout", stdOut, "stderr", stdErr, "post install command", command)


*postInstallCommand

kasiakoziol · 2026-04-23T07:07:53Z

 	// log what happens next
 	if err != nil {
-		scopedLog.ErrorContext(ctx, "Reconciliation requeued", "RequeueAfter", result.RequeueAfter, "error", err)
+		scopedLog.ErrorContext(ctx, "reconciliation requeued", "RequeueAfter", result.RequeueAfter, "error", err)


*requeueAfter

kasiakoziol · 2026-04-23T07:07:59Z

 	}
 	if result.Requeue {
-		scopedLog.InfoContext(ctx, "Reconciliation requeued", "RequeueAfter", result.RequeueAfter)
+		scopedLog.InfoContext(ctx, "reconciliation requeued", "RequeueAfter", result.RequeueAfter)


*requeueAfter

kasiakoziol · 2026-04-23T07:22:47Z

Please add PR description.
Do we for sure want to move from capital to small letter logs?
If possible, (nit), I would go through the logs and make it consistent to use specific format of resource names, e.g. Indexer Cluster, not IndexerCluster;indexerCluster;indexer cluster;indexercluster etc. because it is so much different all over different logs.

Igor-splunk and others added 18 commits January 29, 2026 10:12

Draft: CSPL-4347 (#1662)

ab7a57f

* a * Tests for slog * Use slog in main * Use assertion * black box --------- Co-authored-by: igor.grzankowski <@splunk.com>

CSPL-4357: Secrets logs (#1711)

29397cc

* Secrets logs * Get rid of log handle * Differentiate errors

Merge branch 'develop' into feature/slog-as-default-logger

e940ed2

Fixes

4da56b7

Add logs to controllers

e7f00eb

Use slog.default

611d2c7

Remove double logging

beeec17

Add logs (#1755)

b03f446

Refine events (#1751)

81f7810

merge

3586758

Update lefrover calls

f97cd81

Update lefrover calls

168d8b0

Remove build versions from logs

125a85d

remove build info

f2b0c40

Resolve merge conflicts

4f1dd0e

Fix error wraping

db67a94

Remove leftover logs

429ea9a

kasiakoziol reviewed Apr 22, 2026

View reviewed changes

Standardize log messages.

3f82444

rlieberman-splunk reviewed Apr 22, 2026

View reviewed changes

kasiakoziol reviewed Apr 23, 2026

View reviewed changes

Use PascalCase for CRD name in logs

29f342a

kasiakoziol approved these changes Apr 23, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge slog feature branch#1859

Merge slog feature branch#1859
Igor-splunk wants to merge 20 commits intodevelopfrom
feature/slog-as-default-logger

Igor-splunk commented Apr 20, 2026

Uh oh!

kasiakoziol Apr 21, 2026

Uh oh!

kasiakoziol Apr 21, 2026

Uh oh!

kasiakoziol Apr 21, 2026

Uh oh!

kasiakoziol Apr 21, 2026

Uh oh!

rlieberman-splunk left a comment

Uh oh!

rlieberman-splunk Apr 22, 2026

Uh oh!

rlieberman-splunk Apr 22, 2026

Uh oh!

kasiakoziol Apr 23, 2026

Uh oh!

kasiakoziol Apr 23, 2026

Uh oh!

kasiakoziol Apr 23, 2026

Uh oh!

kasiakoziol commented Apr 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Igor-splunk commented Apr 20, 2026

Description

Key Changes

Testing and Verification

Related Issues

PR Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rlieberman-splunk left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kasiakoziol commented Apr 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants