otelzap: Add caller and stacktrace to attributes if present by suniastar · Pull Request #6268 · open-telemetry/opentelemetry-go-contrib

suniastar · 2024-10-21T11:17:18Z

Adds caller information to the log.Record if the logger was created with AddCaller().
Adds stack trace to the log.Record if the logger was created with AddStacktrace(level).

linux-foundation-easycla · 2024-10-21T11:17:24Z

The committers listed above are authorized under a signed CLA.

✅ login: suniastar / name: Frederik Enste (2a0d9be, 3f0d61b, 335a4b4, 1bbaa6b, 3545115, 70a4c4f, 253487c, 0951147, f2bc56c, 35d5e27, 54969a4)
✅ login: dmathieu / name: Damien Mathieu (2b13733)
✅ login: pellared / name: Robert Pająk (bf0da84, 59d480b)

pellared

Please add a changelog entry.

pellared

Overall looks good. Can you add a unit test to cover the new functionality?

suniastar · 2024-10-21T12:42:07Z

I have added tests for a zap.Logger created with and without the zap.AddCaller and zap.AddStacktrace(level) options.

dmathieu · 2024-10-22T07:26:04Z

cc @khushijain21 as code owner

codecov · 2024-10-22T07:33:35Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.6%. Comparing base (64d6d83) to head (bf0da84).
Report is 1 commits behind head on main.

Additional details and impacted files

@@          Coverage Diff          @@
##            main   #6268   +/-   ##
=====================================
  Coverage   66.6%   66.6%           
=====================================
  Files        192     192           
  Lines      15525   15535   +10     
=====================================
+ Hits       10351   10361   +10     
  Misses      4883    4883           
  Partials     291     291

Files with missing lines	Coverage Δ
bridges/otelzap/core.go	`97.7% <100.0%> (+0.1%)`	⬆️

pellared

We can simplify the tests.

pellared · 2024-10-22T12:39:10Z

@suniastar thank you for your contribution. I plan to merge it tomorrow unless nobody asks for more changes.

suniastar · 2024-10-22T12:44:10Z

Sound goods 👍🏻 Big thanks for the help everyone!

pellared · 2024-10-22T12:51:30Z

@suniastar, can you check the build result? Sorry, but currently I have no time to look at it.

suniastar · 2024-10-22T13:00:47Z

It fails on Check clean repository within the lint workflow but I am afraid I cannot tell what is meant by that.

pellared · 2024-10-22T13:02:17Z

Run go mod tidy in otelzap directory .

suniastar · 2024-10-22T13:05:18Z

Ah ok thank you. Now the error makes sense 😅

### Added - Add the `WithSource` option to the `go.opentelemetry.io/contrib/bridges/otelslog` log bridge to set the `code.*` attributes in the log record that includes the source location where the record was emitted. (#6253) - Add `ContextWithStartTime` and `StartTimeFromContext` to `go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp`, which allows setting the start time using go context. (#6137) - Set the `code.*` attributes in `go.opentelemetry.io/contrib/bridges/otelzap` if the `zap.Logger` was created with the `AddCaller` or `AddStacktrace` option. (#6268) - Add a `LogProcessor` to `go.opentelemetry.io/contrib/processors/baggagecopy` to copy baggage members to log records. (#6277) - Use `baggagecopy.NewLogProcessor` when configuring a Log Provider. - `NewLogProcessor` accepts a `Filter` function type that selects which baggage members are added to the log record. ### Changed - Transform raw (`slog.KindAny`) attribute values to matching `log.Value` types. For example, `[]string{"foo", "bar"}` attribute value is now transformed to `log.SliceValue(log.StringValue("foo"), log.StringValue("bar"))` instead of `log.String("[foo bar"])`. (#6254) - Upgrade `go.opentelemetry.io/otel/semconv/v1.17.0` to `go.opentelemetry.io/otel/semconv/v1.21.0` in `go.opentelemetry.io/contrib/instrumentation/go.mongodb.org/mongo-driver/mongo/otelmongo`. (#6272) - Resource doesn't merge with defaults if a valid resource is configured in `go.opentelemetry.io/contrib/config`. (#6289) ### Fixed - Transform nil attribute values to `log.Value` zero value instead of panicking in `go.opentelemetry.io/contrib/bridges/otellogrus`. (#6237) - Transform nil attribute values to `log.Value` zero value instead of panicking in `go.opentelemetry.io/contrib/bridges/otelzap`. (#6237) - Transform nil attribute values to `log.Value` zero value instead of `log.StringValue("<nil>")` in `go.opentelemetry.io/contrib/bridges/otelslog`. (#6246) - Fix `NewClientHandler` so that `rpc.client.request.*` metrics measure requests instead of responses and `rpc.client.responses.*` metrics measure responses instead of requests in `go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc`. (#6250) - Fix issue in `go.opentelemetry.io/contrib/config` causing `otelprom.WithResourceAsConstantLabels` configuration to not be respected. (#6260) - `otel.Handle` is no longer called on a successful shutdown of the Prometheus exporter in `go.opentelemetry.io/contrib/config`. (#6299)

added caller to record attributes

70a4c4f

suniastar requested review from a team and pellared as code owners October 21, 2024 11:17

suniastar changed the title ~~feat(otelzap): Added Caller to Record Attributes~~ feat(otelzap): added caller to record attributes Oct 21, 2024

pellared reviewed Oct 21, 2024

View reviewed changes

Comment thread bridges/otelzap/core.go Outdated

suniastar added 3 commits October 21, 2024 13:49

added changelog

0951147

adjusted to follow semconv conventions

253487c

added stack trace to log record if persistent in log entry

1bbaa6b

suniastar changed the title ~~feat(otelzap): added caller to record attributes~~ feat(otelzap): added caller and stack trace to record attributes Oct 21, 2024

pellared reviewed Oct 21, 2024

View reviewed changes

Comment thread CHANGELOG.md Outdated

suniastar added 2 commits October 21, 2024 14:05

applied changelog review suggestion

2a0d9be

added tests

335a4b4

reformat code

54969a4

dmathieu reviewed Oct 22, 2024

View reviewed changes

Comment thread bridges/otelzap/core_test.go Outdated

removed debug print statements

35d5e27

applied linting suggestion

3f0d61b

khushijain21 approved these changes Oct 22, 2024

View reviewed changes

dmathieu approved these changes Oct 22, 2024

View reviewed changes

Merge branch 'main' into main

2b13733

pellared reviewed Oct 22, 2024

View reviewed changes

Comment thread bridges/otelzap/core_test.go Outdated

Comment thread bridges/otelzap/core_test.go Outdated

suniastar and others added 2 commits October 22, 2024 14:33

removed unnecessary tests

f2bc56c

Update CHANGELOG.md

59d480b

pellared approved these changes Oct 22, 2024

View reviewed changes

pellared changed the title ~~feat(otelzap): added caller and stack trace to record attributes~~ otelzap: Add caller and stacktrace attributes if present Oct 22, 2024

pellared changed the title ~~otelzap: Add caller and stacktrace attributes if present~~ otelzap: Add caller and stacktrace to attributes if present Oct 22, 2024

This comment was marked as duplicate.

Sign in to view

suniastar and others added 2 commits October 22, 2024 15:06

updated go mod file

3545115

Merge branch 'main' into main

bf0da84

dmathieu merged commit 45bfcef into open-telemetry:main Oct 24, 2024

pellared added this to the v1.32.0 milestone Nov 8, 2024

pellared mentioned this pull request Nov 8, 2024

Release v1.32.0/v0.57.0/v0.26.0/v0.12.0/v0.7.0/v0.5.0/v0.4.0 #6311

Merged

Conversation

suniastar commented Oct 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linux-foundation-easycla Bot commented Oct 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pellared left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pellared left a comment • 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!

suniastar commented Oct 21, 2024

Uh oh!

dmathieu commented Oct 22, 2024

Uh oh!

Uh oh!

codecov Bot commented Oct 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

pellared left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

pellared commented Oct 22, 2024

Uh oh!

suniastar commented Oct 22, 2024

Uh oh!

pellared commented Oct 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as duplicate.

Uh oh!

suniastar commented Oct 22, 2024

Uh oh!

pellared commented Oct 22, 2024

Uh oh!

suniastar commented Oct 22, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

suniastar commented Oct 21, 2024 •

edited

Loading

linux-foundation-easycla Bot commented Oct 21, 2024 •

edited

Loading

pellared left a comment •

edited

Loading

codecov Bot commented Oct 22, 2024 •

edited

Loading

pellared commented Oct 22, 2024 •

edited

Loading