INFOPLAT-1035: logger implement otelzap #1359

kirqz23 · 2025-07-09T12:34:35Z

This PR introduces OtelZapCore, a custom zapcore.Core implementation that emits structured logs to OpenTelemetry using the OTLP protocol.

It also integrates this core into the existing logger package, allowing all logs to be exported via OTEL while preserving existing logging interfaces.

github-actions · 2025-07-09T12:34:59Z

👋 kirqz23, thanks for creating this pull request!

To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team.

Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks!

krehermann · 2025-07-09T14:07:54Z

pkg/logger/zap_otel.go

+
+// NewOtelCore initializes an OpenTelemetry Core for exporting logs in OTLP format
+func NewOtelZapCore(loggerProvider otellog.LoggerProvider, opts ...Option) zapcore.Core {
+	logger := loggerProvider.Logger(instrumentationLibName)


what does this do and is this correct?

iiuc it implies that all logs will refer to github.com/smartcontractkit/chainlink-common as opposed to the actual caller

totally agree, we should make it configurable for the logging app

instrumentationLibName should be configurable

pkg/logger/zap_otel.go

Co-authored-by: Pavel <[email protected]>

pkcll · 2025-07-09T14:24:33Z

pkg/logger/zap_otel.go

+type Option func(c *OtelZapCore)
+
+// NewOtelCore initializes an OpenTelemetry Core for exporting logs in OTLP format
+func NewOtelZapCore(loggerProvider otellog.LoggerProvider, opts ...Option) zapcore.Core {


Lets pass logger interface here to avoid indirect dependency

Suggested change

func NewOtelZapCore(loggerProvider otellog.LoggerProvider, opts ...Option) zapcore.Core {

func NewOtelZapCore(logger otellog.Logger, opts ...Option) zapcore.Core {

pkcll · 2025-07-09T14:35:44Z

pkg/logger/logger.go

@@ -102,6 +104,11 @@ func NewWithSync(w io.Writer) Logger {
 	return &logger{zap.New(core).Sugar()}
 }

+// NewWithOtelZapCore returns a new Logger using an OpenTelemetry Zap Core.
+func NewWithOtelZapCore(loggerProvider otellog.LoggerProvider) Logger {


Suggested change

func NewWithOtelZapCore(loggerProvider otellog.LoggerProvider) Logger {

func NewWithOtelProvider(loggerProvider otellog.LoggerProvider, loggerName string) Logger {

pkcll · 2025-07-09T14:51:12Z

pkg/logger/logger.go

@@ -102,6 +104,11 @@ func NewWithSync(w io.Writer) Logger {
 	return &logger{zap.New(core).Sugar()}
 }

+// NewWithOtelZapCore returns a new Logger using an OpenTelemetry Zap Core.
+func NewWithOtelZapCore(loggerProvider otellog.LoggerProvider) Logger {
+	return &logger{zap.New(NewOtelZapCore(loggerProvider)).Sugar()}


Suggested change

return &logger{zap.New(NewOtelZapCore(loggerProvider)).Sugar()}

return &logger{zap.New(NewOtelZapCore(loggerProvider.Logger(loggerName))).Sugar()}

pkcll · 2025-07-14T04:27:32Z

pkg/logger/otellogger/zap_otel.go

nit: maybe worth using the same name for the file and the package, otelzap seems concise and clear
Consider renaming pkg/logger/otellogger/zap_otel.go to pkg/logger/otelzap/otelzap.go

jmank88 · 2025-07-14T12:25:25Z

pkg/logger/otelzap/otelzap.go

+
+// NOTE: [beholder.SetGlobalOtelProviders](https://github.com/smartcontractkit/chainlink-common/blob/27faefc9ce454c8aa2b1b7484e377ea3e8996bba/pkg/beholder/global.go#L50)
+// must be called before using `NewOtelLogger` otherwise otelglobal.GetLoggerProvider() returns noop provider
+func NewOtelLogger(name string) otellog.Logger {


What is the expected use of this function? We did a very deliberate conversion away from global logging a long time ago, and we shouldn't encourage that pattern.

pkg/logger/otelzap/otelzap.go

pkg/logger/logger.go

Co-authored-by: Jordan Krage <[email protected]>

pkcll · 2025-07-28T15:13:52Z

pkg/logger/logger.go

@@ -102,6 +102,12 @@ func NewWithSync(w io.Writer) Logger {
 	return &logger{zap.New(core).Sugar()}
 }

+// NewWithCores returns a new Logger with one or more zapcore.Core.
+// If multiple cores are provided, they are combined using zapcore.NewTee.
+func NewWithCores(cores ...zapcore.Core) Logger {


Would be good to add some tests for it.

What do we want to test here? This function just returns the logger with zapcore tee functionality

engnke and others added 4 commits June 23, 2025 20:57

wip

0259a03

Add Write function implementation

e17ee3a

Implement Write() function

ff4051c

Add tests

d5fb5bb

kirqz23 requested a review from a team as a code owner July 9, 2025 12:34

kirqz23 requested a review from krehermann July 9, 2025 12:34

kirqz23 marked this pull request as draft July 9, 2025 12:34

kirqz23 had a problem deploying to integration July 9, 2025 12:34 — with GitHub Actions Error

Merge branch 'main' into feature/INFOPLAT-1035-logger-implement-otelzap

d317261

kirqz23 had a problem deploying to integration July 9, 2025 12:35 — with GitHub Actions Failure

kirqz23 temporarily deployed to integration July 9, 2025 12:35 — with GitHub Actions Inactive

krehermann reviewed Jul 9, 2025

View reviewed changes

kirqz23 marked this pull request as ready for review July 9, 2025 14:08

Merge branch 'main' into feature/INFOPLAT-1035-logger-implement-otelzap

f681031

kirqz23 temporarily deployed to integration July 9, 2025 14:08 — with GitHub Actions Inactive

kirqz23 had a problem deploying to integration July 9, 2025 14:08 — with GitHub Actions Failure

pkcll reviewed Jul 9, 2025

View reviewed changes

pkg/logger/zap_otel.go Outdated Show resolved Hide resolved

Update pkg/logger/zap_otel.go

9173c4a

Co-authored-by: Pavel <[email protected]>

kirqz23 had a problem deploying to integration July 9, 2025 14:24 — with GitHub Actions Failure

pkcll reviewed Jul 9, 2025

View reviewed changes

Add WithScopeName and default to beholder

7160a95

pkcll reviewed Jul 14, 2025

View reviewed changes

pkcll previously approved these changes Jul 14, 2025

View reviewed changes

Change the package name to otelzap

051722f

kirqz23 dismissed pkcll’s stale review via 051722f July 14, 2025 11:30

kirqz23 had a problem deploying to integration July 14, 2025 11:30 — with GitHub Actions Failure

kirqz23 temporarily deployed to integration July 14, 2025 11:30 — with GitHub Actions Inactive

kirqz23 had a problem deploying to integration July 14, 2025 11:30 — with GitHub Actions Failure

jmank88 requested changes Jul 14, 2025

View reviewed changes

Update pkg/logger/logger.go

19b7ec9

Co-authored-by: Jordan Krage <[email protected]>

kirqz23 had a problem deploying to integration July 28, 2025 12:42 — with GitHub Actions Error

Update pkg/logger/otelzap/otelzap.go

4547d57

Co-authored-by: Jordan Krage <[email protected]>

kirqz23 had a problem deploying to integration July 28, 2025 12:43 — with GitHub Actions Error

kirqz23 had a problem deploying to integration July 28, 2025 12:43 — with GitHub Actions Failure

kirqz23 temporarily deployed to integration July 28, 2025 12:43 — with GitHub Actions Inactive

Merge branch 'main' into feature/INFOPLAT-1035-logger-implement-otelzap

e205c53

kirqz23 temporarily deployed to integration July 28, 2025 12:48 — with GitHub Actions Inactive

kirqz23 had a problem deploying to integration July 28, 2025 12:48 — with GitHub Actions Failure

pkcll reviewed Jul 28, 2025

View reviewed changes

Remove NewOtelLogger function

3b9806b

kirqz23 had a problem deploying to integration July 28, 2025 17:10 — with GitHub Actions Failure

kirqz23 temporarily deployed to integration July 28, 2025 17:10 — with GitHub Actions Inactive

pkcll approved these changes Jul 28, 2025

View reviewed changes

kirqz23 requested a review from jmank88 July 28, 2025 17:41

jmank88 approved these changes Jul 28, 2025

View reviewed changes

jmank88 merged commit 7331df7 into main Jul 28, 2025
15 of 18 checks passed

jmank88 deleted the feature/INFOPLAT-1035-logger-implement-otelzap branch July 28, 2025 18:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

INFOPLAT-1035: logger implement otelzap #1359

INFOPLAT-1035: logger implement otelzap #1359

Uh oh!

kirqz23 commented Jul 9, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 9, 2025

Uh oh!

krehermann Jul 9, 2025

Uh oh!

kirqz23 Jul 9, 2025

Uh oh!

pkcll Jul 9, 2025 •

edited

Loading

Uh oh!

Uh oh!

pkcll Jul 9, 2025

Uh oh!

pkcll Jul 9, 2025 •

edited

Loading

Uh oh!

pkcll Jul 9, 2025

Uh oh!

pkcll Jul 14, 2025 •

edited

Loading

Uh oh!

kirqz23 Jul 28, 2025

Uh oh!

jmank88 Jul 14, 2025

Uh oh!

kirqz23 Jul 28, 2025

Uh oh!

Uh oh!

Uh oh!

pkcll Jul 28, 2025

Uh oh!

kirqz23 Jul 28, 2025

Uh oh!

Uh oh!

Uh oh!

	func NewOtelZapCore(loggerProvider otellog.LoggerProvider, opts ...Option) zapcore.Core {
	func NewOtelZapCore(logger otellog.Logger, opts ...Option) zapcore.Core {

	func NewWithOtelZapCore(loggerProvider otellog.LoggerProvider) Logger {
	func NewWithOtelProvider(loggerProvider otellog.LoggerProvider, loggerName string) Logger {

	return &logger{zap.New(NewOtelZapCore(loggerProvider)).Sugar()}
	return &logger{zap.New(NewOtelZapCore(loggerProvider.Logger(loggerName))).Sugar()}

INFOPLAT-1035: logger implement otelzap #1359

INFOPLAT-1035: logger implement otelzap #1359

Uh oh!

Conversation

kirqz23 commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 9, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pkcll Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pkcll Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pkcll Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kirqz23 commented Jul 9, 2025 •

edited

Loading

pkcll Jul 9, 2025 •

edited

Loading

pkcll Jul 9, 2025 •

edited

Loading

pkcll Jul 14, 2025 •

edited

Loading