Skip to content

refactor: remove package-level loggers, thread via struct fields and context - #29

Merged
maansaake merged 3 commits into
mainfrom
refactor/remove-package-level-loggers
May 24, 2026
Merged

refactor: remove package-level loggers, thread via struct fields and context#29
maansaake merged 3 commits into
mainfrom
refactor/remove-package-level-loggers

Conversation

@maansaake

Copy link
Copy Markdown
Owner

Summary

Removes all package-level logger variables from the arbiter repository and replaces them with explicit logger passing.

Changes

  • Delete internal/log — the abtrlog package (global logger + GetLogger()) is removed entirely. Its setup logic is inlined into a new setupLoggers() helper in arbiter.go.

  • arbiter.go

    • var logger logr.Logger removed
    • logger logr.Logger added as a field on the abtr struct, populated in Run()
    • startModules() converted from a package-level function to a method on abtr
    • setupReporter() updated to return (report.Reporter, error) and passes a.logger to the yaml reporter
    • Bug fix: defaultOpts() was setting InfoLogPath twice and never setting ErrorLogPath
  • pkg/report/yaml/yaml.go

    • var logger logr.Logger removed
    • Logger logr.Logger added to Opts and the internal reporter struct
    • New() now returns (report.Reporter, error) and returns an error when opts.Logger.GetSink() == nil (logger not provided)
  • internal/otel/instrument.go

    • zerologr.Info() (implicit global) replaced with logr.FromContextOrDiscard(ctx).Info() — the function already carried ctx context.Context

Notes

In logr v1.4.3, logr.Discard() returns a nil-sink Logger (same as the zero value), so the zero-value guard works correctly. Test code should use funcr.New(...) or testr.New(t) instead of logr.Discard().

GitHub Copilot and others added 2 commits May 24, 2026 05:12
…context

- Delete internal/log package (abtrlog); inline setup logic into
  arbiter.go as a setupLoggers() helper function
- Add logger logr.Logger field to abtr struct; populate from Run()
- Convert standalone startModules() to method on abtr
- Change setupReporter() to return (report.Reporter, error) and pass
  a.logger to the yaml reporter
- Fix defaultOpts() bug: was setting InfoLogPath twice, never ErrorLogPath
- yamlreport.New() now returns (report.Reporter, error); errors when
  opts.Logger.GetSink() == nil (zero-value / not provided)
- Add Logger logr.Logger field to yamlreport.Opts and reporter struct
- Replace zerologr.Info() global call in internal/otel with
  logr.FromContextOrDiscard(ctx).Info() (context transport)
- Update yaml_test.go to supply an explicit logger via funcr

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Logger is passed by value, not a pointer, so a zero-value logger is
always 'provided' — validating the sink is not meaningful. Revert
New() to returning report.Reporter directly.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@maansaake
maansaake force-pushed the refactor/remove-package-level-loggers branch from 4d43917 to ac1d833 Compare May 24, 2026 03:12
Comment thread pkg/report/yaml/yaml.go Fixed
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@maansaake
maansaake merged commit 6166a42 into main May 24, 2026
14 checks passed
@maansaake
maansaake deleted the refactor/remove-package-level-loggers branch May 24, 2026 03:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants