refactor: replace logrus for global slog logger #889

rogercoll · 2025-10-24T09:49:16Z

Adds a new internal package to initialize a global slog logger instance: internal/global/logging.go.

It can be overridden anytime, like when used as a collector receiver, which uses a zap adapter.

The global package provides some adapter functions for minimal changes in the codebase (non-structured logging), we should aim (follow-up PR/issue) to gradually move to a structured logging strategy to benefit from slog.

This changes aligns the formatting when running with the OTel collector:

2025-10-24T12:50:28.987+0200    info    builders/builders.go:26 Development component. May change in the future.        {"resource": {"service.instance.id": "41dcefbf-4790-44e8-9d37-788b20df323a", "service.name": "otelcol-ebpf-profiler", "service.version": "0.137.0"}, "otelcol.component.id": "debug", "otelcol.component.kind": "exporter", "otelcol.signal": "profiles"}
2025-10-24T12:50:28.989+0200    info    [email protected]/service.go:211 Starting otelcol-ebpf-profiler...       {"resource": {"service.instance.id": "41dcefbf-4790-44e8-9d37-788b20df323a", "service.name": "otelcol-ebpf-profiler", "service.version": "0.137.0"}, "Version": "0.137.0", "NumCPU": 20}
2025-10-24T12:50:28.989+0200    info    extensions/extensions.go:41     Starting extensions...  {"resource": {"service.instance.id": "41dcefbf-4790-44e8-9d37-788b20df323a", "service.name": "otelcol-ebpf-profiler", "service.version": "0.137.0"}}
2025-10-24T12:50:28.989+0200    info    Interpreter tracers: perl,php,python,hotspot,ruby,v8,dotnet,go,labels   {"resource": {"service.instance.id": "41dcefbf-4790-44e8-9d37-788b20df323a", "service.name": "otelcol-ebpf-profiler", "service.version": "0.137.0"}, "otelcol.component.id": "profiling", "otelcol.component.kind": "receiver", "otelcol.signal": "profiles"}
2025-10-24T12:50:29.392+0200    info    Found offsets: task stack 0x20, pt_regs 0x3f48, tpbase 0x1640   {"resource": {"service.instance.id": "41dcefbf-4790-44e8-9d37-788b20df323a", "service.name": "otelcol-ebpf-profiler", "service.version": "0.137.0"}, "otelcol.component.id": "profiling", "otelcol.component.kind": "receiver", "otelcol.signal": "profiles"}
2025-10-24T12:50:29.647+0200    info    Supports generic eBPF map batch operations      {"resource": {"service.instance.id": "41dcefbf-4790-44e8-9d37-788b20df323a", "service.name": "otelcol-ebpf-profiler", "service.version": "0.137.0"}, "otelcol.component.id": "profiling", "otelcol.component.kind": "receiver", "otelcol.signal": "profiles"}
2025-10-24T12:50:29.647+0200    info    Supports LPM trie eBPF map batch operations     {"resource": {"service.instance.id": "41dcefbf-4790-44e8-9d37-788b20df323a", "service.name": "otelcol-ebpf-profiler", "service.version": "0.137.0"}, "otelcol.component.id": "profiling", "otelcol.component.kind": "receiver", "otelcol.signal": "profiles"}
2025-10-24T12:50:29.648+0200    info    eBPF tracer loaded      {"resource": {"service.instance.id": "41dcefbf-4790-44e8-9d37-788b20df323a", "service.name": "otelcol-ebpf-profiler", "service.version": "0.137.0"}, "otelcol.component.id": "profiling", "otelcol.component.kind": "receiver", "otelcol.signal": "profiles"}
2025-10-24T12:50:29.671+0200    info    Attached tracer program {"resource": {"service.instance.id": "41dcefbf-4790-44e8-9d37-788b20df323a", "service.name": "otelcol-ebpf-profiler", "service.version": "0.137.0"}, "otelcol.component.id": "profiling", "otelcol.component.kind": "receiver", "otelcol.signal": "profiles"}
2025-10-24T12:50:29.693+0200    info    [email protected]/service.go:234 Everything is ready. Begin running and processing data. {"resource": {"service.instance.id": "41dcefbf-4790-44e8-9d37-788b20df323a", "service.name": "otelcol-ebpf-profiler", "service.version": "0.137.0"}}
^C2025-10-24T12:50:32.118+0200  info    [email protected]/collector.go:358       Received signal from OS {"resource": {"service.instance.id": "41dcefbf-4790-44e8-9d37-788b20df323a", "service.name": "otelcol-ebpf-profiler", "service.version": "0.137.0"}, "signal": "interrupt"}

Fixes #417

internal/log/logging.go

internal/global/logging.go

internal/log/logging.go

Co-authored-by: Florian Lehner <[email protected]>

internal/global/logging.go

internal/controller/controller.go

internal/global/logging.go

main.go

tools/coredump/analyze.go

tracer/tracer.go

Co-authored-by: Christos Kalkanis <[email protected]>

collector/factory.go

florianl · 2025-10-30T13:32:29Z

internal/log/logging.go

+	globalLogger.Store(&l)
+}
+
+// SetDebugLogger configures the global logger to write debug-level logs to stderr.


Instead of SetDebugLogger an API should be provided to set the log level.

The slog Handler does not provide any mechanism to change the log level in runtime, a new logger needs to be created instead. Any suggestion on the naming?

Also, keep in mind that this will be removed once we transition to just having the otel receiver (verbosity will be defined from the collector's configuration)

In the example provided with slog.SetLogLoggerLevel, changing the severity level after setting the logger just works.

That function only works in case we were using the default slog.Logger instance, in this case we created a new non default logger.

internal/global/log/logging.go

Co-authored-by: Florian Lehner <[email protected]>

rogercoll · 2025-11-04T15:50:06Z

@open-telemetry/ebpf-profiler-maintainers Anything left to be addressed?

fabled · 2025-11-06T18:46:11Z

interpreter/dotnet/instance.go

-	lowAddress, highAddress, mapBase libpf.Address, stubTypeOrHdrMap uint64) {
+	lowAddress, highAddress, mapBase libpf.Address, stubTypeOrHdrMap uint64,
+) {


This PR has a ton of these unrelated stylistic changes. This makes rebasing other PRs really painful.
Please stop changing code unnecessarily.

Sorry about that. Would it be fine for you if I create a specific PR to format all the Go code? Something like what we did in OpAMP-go and all other OpenTelemetry Go projects: open-telemetry/opamp-go#356

Most IDEs or editors configurations auto-format on save.

rogercoll added 8 commits October 24, 2025 11:44

refactor: replace logrus for global slog logger

851e42f

Merge branch 'main' into set_global_logger

7a0d52f

set default info level and remove file source

0c99916

remove logrus license

b98c85b

Merge branch 'main' into set_global_logger

530d0ce

fix: ebpf amd blog

586fdee

fix: coredump logger usage

49353b6

fix non constant strings

2facbb6

rogercoll marked this pull request as ready for review October 24, 2025 10:57

rogercoll requested review from a team as code owners October 24, 2025 10:57

florianl reviewed Oct 24, 2025

View reviewed changes

internal/log/logging.go Show resolved Hide resolved

florianl reviewed Oct 24, 2025

View reviewed changes

internal/global/logging.go Outdated Show resolved Hide resolved

rogercoll mentioned this pull request Oct 24, 2025

Adopt structured logging across all log statements #891

Open

florianl reviewed Oct 24, 2025

View reviewed changes

internal/log/logging.go Show resolved Hide resolved

Update internal/global/logging.go

fc2c5f6

Co-authored-by: Florian Lehner <[email protected]>

rogercoll force-pushed the set_global_logger branch from 1161c8b to fc2c5f6 Compare October 24, 2025 15:11

christos68k reviewed Oct 27, 2025

View reviewed changes

rogercoll and others added 5 commits October 28, 2025 09:48

Update internal/global/logging.go

4eadd9f

Co-authored-by: Christos Kalkanis <[email protected]>

Update internal/global/logging.go

b2c88d2

Co-authored-by: Christos Kalkanis <[email protected]>

add helper function to set Debug global logger

7f23a13

map log.Printf statements to Info level

82d98d5

Merge branch 'main' into set_global_logger

1064fd2

rogercoll requested review from christos68k and florianl October 28, 2025 09:17

rogercoll added 2 commits October 28, 2025 10:27

fix non-constant string

49405a2

refactor: move global package to log

6c29f67

christos68k approved these changes Oct 29, 2025

View reviewed changes

Merge branch 'main' into set_global_logger

2ce403c

christos68k mentioned this pull request Oct 29, 2025

Improve logging in the codebase #417

Open

Merge branch 'main' into set_global_logger

1a5537f

florianl reviewed Oct 30, 2025

View reviewed changes

rogercoll and others added 2 commits October 30, 2025 15:18

Update collector/factory.go

74824b3

Co-authored-by: Florian Lehner <[email protected]>

Update internal/global/log/logging.go

64f9b21

Co-authored-by: Florian Lehner <[email protected]>

rogercoll force-pushed the set_global_logger branch from abcba37 to 64f9b21 Compare October 30, 2025 14:54

remove global level path

1236b9c

florianl approved these changes Oct 31, 2025

View reviewed changes

rogercoll added 3 commits November 3, 2025 09:21

Merge branch 'main' into set_global_logger

6861c47

Merge branch 'main' into set_global_logger

853ae6e

fix: integration tests debug log

2e0ed68

christos68k merged commit 5443dd2 into open-telemetry:main Nov 4, 2025
26 checks passed

rogercoll deleted the set_global_logger branch November 4, 2025 15:57

fabled reviewed Nov 6, 2025

View reviewed changes

rogercoll mentioned this pull request Nov 10, 2025

chore: add Go formatting #949

Open

refactor: replace logrus for global slog logger #889

refactor: replace logrus for global slog logger #889

Uh oh!

Conversation

rogercoll commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

florianl Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

rogercoll Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

florianl Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

rogercoll Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rogercoll commented Nov 4, 2025

Uh oh!

Uh oh!

fabled Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

rogercoll Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rogercoll commented Oct 24, 2025 •

edited

Loading