otelslog: Add WithSource option #6253

Jesse0Michael · 2024-10-15T04:07:20Z

Add an slogbridge option to include the source file location in the log attributes.

Resolves #6244

linux-foundation-easycla · 2024-10-15T04:07:26Z

The committers listed above are authorized under a signed CLA.

✅ login: Jesse0Michael / name: Jesse Michael (5afea32, cc919e0, 9eeb939, 870a16d, 066b5a3, c7fc7dc, 8c8de99)
✅ login: pellared / name: Robert Pająk (9193d4e, 35441db, a61c093, d8404fc)

bridges/otelslog/handler_test.go

CHANGELOG.md

pellared · 2024-10-15T19:44:55Z

Side note from CONTRIBUTING.mD:

Avoid rebasing and force-pushing to your branch to facilitate reviewing the pull request. Rewriting Git history makes it difficult to keep track of iterations during code review. All pull requests are squashed to a single commit upon merge to main.

Add a slogbridge option to include the source file location in the log attributes

Jesse0Michael · 2024-10-16T01:45:37Z

@pellared Sorry about the rebase/push! And thanks for pointing me to the `recorder. I have a better understanding on how it's tested now.

I updated the test to be a new testCase in TestSLogHandler

To do that I made it possible to specify options in the test case to apply to Handler.

It also requires some expected values to be created at the top of the test to be used in the checks.

If those changes are not ideal, let me know and I'll move it back to its own test using the recorder

codecov · 2024-10-16T05:29:09Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.2%. Comparing base (13536dd) to head (066b5a3).
Report is 1 commits behind head on main.

Additional details and impacted files

@@          Coverage Diff          @@
##            main   #6253   +/-   ##
=====================================
  Coverage   67.2%   67.2%           
=====================================
  Files        191     191           
  Lines      12642   12657   +15     
=====================================
+ Hits        8497    8510   +13     
- Misses      3855    3856    +1     
- Partials     290     291    +1

Files with missing lines	Coverage Δ
bridges/otelslog/handler.go	`96.7% <100.0%> (+0.2%)`	⬆️

... and 1 file with indirect coverage changes

pellared · 2024-10-16T06:17:12Z

@Jesse0Michael, no worries. I find this PR very good and helpful. Thanks a lot for your contribution.

bridges/otelslog/handler.go

pellared

#6253 (comment) needs being addressed

CHANGELOG.md

Co-authored-by: Robert Pająk <[email protected]>

pellared · 2024-10-16T14:28:22Z

@dmathieu PTAL

pellared · 2024-10-17T04:58:14Z

I plan to merge it tomorrow morning. I want others to give at least one more day to review.

### 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)

Follow semantic conventions more strictly. See the following thread: open-telemetry/semantic-conventions#1624 (comment) Follows #6253 There is no noticeable performance overhead: ``` goos: linux goarch: amd64 pkg: go.opentelemetry.io/contrib/bridges/otelslog cpu: Intel(R) Core(TM) i9-10885H CPU @ 2.40GHz │ old.txt │ new.txt │ │ sec/op │ sec/op vs base │ Handler/(WithSource).Handle-16 260.4n ± 21% 234.0n ± 5% -10.14% (p=0.035 n=10) │ old.txt │ new.txt │ │ B/op │ B/op vs base │ Handler/(WithSource).Handle-16 248.0 ± 0% 248.0 ± 0% ~ (p=1.000 n=10) ¹ ¹ all samples are equal │ old.txt │ new.txt │ │ allocs/op │ allocs/op vs base │ Handler/(WithSource).Handle-16 2.000 ± 0% 2.000 ± 0% ~ (p=1.000 n=10) ¹ ¹ all samples are equal ```

Jesse0Michael requested review from MrAlias, pellared and a team as code owners October 15, 2024 04:07

Jesse0Michael force-pushed the slogbridge-withsource branch from 04e5ef5 to 59da517 Compare October 15, 2024 04:10

pellared reviewed Oct 15, 2024

View reviewed changes

bridges/otelslog/handler_test.go Outdated Show resolved Hide resolved

bridges/otelslog/handler_test.go Outdated Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

Jesse0Michael force-pushed the slogbridge-withsource branch from 1633a8f to 869f1e3 Compare October 15, 2024 16:30

Jesse0Michael added 3 commits October 15, 2024 18:38

feat(otelslog): add WithSource option

5afea32

Add a slogbridge option to include the source file location in the log attributes

docs(changelog): update changelog.md

c7fc7dc

test: test WithSource handler with recorder

9eeb939

Jesse0Michael force-pushed the slogbridge-withsource branch from 043070b to 9eeb939 Compare October 16, 2024 01:39

pellared added 2 commits October 16, 2024 08:12

Update CHANGELOG.md

9193d4e

Merge branch 'main' into slogbridge-withsource

a61c093

pellared reviewed Oct 16, 2024

View reviewed changes

bridges/otelslog/handler.go Outdated Show resolved Hide resolved

Update bridges/otelslog/handler.go

d8404fc

pellared approved these changes Oct 16, 2024

View reviewed changes

pellared added this to the v1.32.0 milestone Oct 16, 2024

pellared added bridge: slog Related to the slog bridge enhancement New feature or request labels Oct 16, 2024

pellared changed the title ~~feat(otelslog): add WithSource option~~ otelslog: Add WithSource option Oct 16, 2024

dmathieu reviewed Oct 16, 2024

View reviewed changes

bridges/otelslog/handler.go Outdated Show resolved Hide resolved

pellared requested changes Oct 16, 2024

View reviewed changes

fix: use semconv keys for source attributes

870a16d

pellared reviewed Oct 16, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Update CHANGELOG.md

8c8de99

Co-authored-by: Robert Pająk <[email protected]>

pellared approved these changes Oct 16, 2024

View reviewed changes

dmathieu approved these changes Oct 16, 2024

View reviewed changes

pellared mentioned this pull request Oct 16, 2024

Add EmitEvent to Logs API open-telemetry/opentelemetry-specification#4259

Merged

Jesse0Michael and others added 2 commits October 16, 2024 13:30

Merge branch 'main' into slogbridge-withsource

cc919e0

Merge branch 'main' into slogbridge-withsource

35441db

Merge branch 'main' into slogbridge-withsource

066b5a3

MrAlias approved these changes Oct 17, 2024

View reviewed changes

pellared merged commit 1c56a7c into open-telemetry:main Oct 18, 2024
25 checks passed

Jesse0Michael deleted the slogbridge-withsource branch October 18, 2024 15:02

pellared mentioned this pull request Oct 21, 2024

otelzap: Add caller and stacktrace to attributes if present #6268

Merged

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

pellared mentioned this pull request Dec 10, 2024

otelslog: Split code attributes #6415

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

otelslog: Add WithSource option #6253

otelslog: Add WithSource option #6253

Jesse0Michael commented Oct 15, 2024 •

edited by MrAlias

Loading

linux-foundation-easycla bot commented Oct 15, 2024 •

edited

Loading

pellared commented Oct 15, 2024

Jesse0Michael commented Oct 16, 2024 •

edited

Loading

codecov bot commented Oct 16, 2024 •

edited

Loading

pellared commented Oct 16, 2024

pellared left a comment

pellared commented Oct 16, 2024

pellared commented Oct 17, 2024

otelslog: Add WithSource option #6253

otelslog: Add WithSource option #6253

Conversation

Jesse0Michael commented Oct 15, 2024 • edited by MrAlias Loading

linux-foundation-easycla bot commented Oct 15, 2024 • edited Loading

pellared commented Oct 15, 2024

Jesse0Michael commented Oct 16, 2024 • edited Loading

codecov bot commented Oct 16, 2024 • edited Loading

Codecov Report

pellared commented Oct 16, 2024

pellared left a comment

Choose a reason for hiding this comment

pellared commented Oct 16, 2024

pellared commented Oct 17, 2024

Jesse0Michael commented Oct 15, 2024 •

edited by MrAlias

Loading

linux-foundation-easycla bot commented Oct 15, 2024 •

edited

Loading

Jesse0Michael commented Oct 16, 2024 •

edited

Loading

codecov bot commented Oct 16, 2024 •

edited

Loading