New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add zap log bridge #5191

Closed

pellared opened this issue Mar 1, 2024 · 3 comments · Fixed by open-telemetry/opentelemetry.io#4845

Labels

Member

pellared commented Mar 1, 2024

Add zapcore.Core log bridge.

The text was updated successfully, but these errors were encountered:

pellared added the enhancement label

pellared mentioned this issue

One Logging Bridge per language - Go open-telemetry/community#1903

Closed

khushijain21 mentioned this issue

Logging bridge for Zap #5279

Closed

khushijain21 mentioned this issue

Log Bridge: Explicit Context Injection for Zapcore #5328

Closed

Member Author

pellared commented Mar 29, 2024

@khushijain21 is working on it.

khushijain21 mentioned this issue

[WIP] Bridge: Logging Bridge for SwiftLog open-telemetry/opentelemetry-swift#535

Closed

pellared mentioned this issue

otelzap: Add skeleton and config options #5449

Merged

Contributor

khushijain21 commented May 7, 2024 •

edited

Loading

Outline of the approach

Skeleteon of zapcore and config for the bridge
Implement Enabled, Check method
Implement zapcore encoder
Implement With and Write method
Add Benchmarks

Member Author

pellared commented May 7, 2024 •

edited

Loading

~~We do not need to implement zapcore.Encoder as we are providing a zapcore.Core~~
You can first implement Write and then With method as separate PRs
You can handle https://pkg.go.dev/go.uber.org/zap/zapcore#NamespaceType as a separate PR
You can handle trace correlation (handling context.Context) as a separate PR
After benchmarks are in place we can add performance improvements. I suggests adding usage of sync.Pool and other improvements after benchmarks are in place and we have required functionality in place.
Go doc comment should be updated after the implementation is done.
A testable example should be added demonstrating how to setup otelzap.
After the release the Go module should be added to https://opentelemetry.io/ecosystem/registry
After the release we could document the bridge also in https://opentelemetry.io/docs/languages/go/

This was referenced May 9, 2024

otelzap: Basic implementation of Core.Write #5539

Merged

otelzap: Skeleton for zap encoder #5566

Merged

This was referenced May 16, 2024

otelzap: Implement Enabled method #5594

Merged

otelzap: Implement methods on objectEncoder #5595

Merged

pellared pushed a commit that referenced this issue


          otelzap: Implement methods on objectEncoder (#5595)

6d343e9

Part of #5191
---------
Co-authored-by: Robert Pająk <[email protected]>

khushijain21 mentioned this issue

otelzap: Implement methods on objectEncoder #5602

Merged

pellared pushed a commit that referenced this issue


          otelzap: Implement Enabled method (#5594)

Part of #5191
---------
Co-authored-by: Robert Pająk <[email protected]>

khushijain21 mentioned this issue

otelzap: remove dependency on logs sdk #5604

Merged

MrAlias added a commit that referenced this issue


          otelzap: remove dependency on logs sdk (#5604)

a481b61

Part of
#5191
and #5586

Pre-work
#5279

---------

Co-authored-by: Tyler Yahn <[email protected]>

khushijain21 mentioned this issue

otelzap: Implement Uint methods on encoder #5609

Merged

pellared added a commit that referenced this issue


          otelzap: Implement methods on objectEncoder (#5602)

8c03dfa

Part of #5191

---------

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

khushijain21 mentioned this issue

otelzap: Add skeleton for array encoder #5611

Merged

zailic pushed a commit to zailic/opentelemetry-go-contrib that referenced this issue


          otelzap: Implement methods on objectEncoder (open-telemetry#5595)

2399ae2

Part of open-telemetry#5191
---------
Co-authored-by: Robert Pająk <[email protected]>

zailic pushed a commit to zailic/opentelemetry-go-contrib that referenced this issue


          otelzap: Implement Enabled method (open-telemetry#5594)

2837d87

Part of open-telemetry#5191
---------
Co-authored-by: Robert Pająk <[email protected]>

zailic pushed a commit to zailic/opentelemetry-go-contrib that referenced this issue


          otelzap: remove dependency on logs sdk (open-telemetry#5604)

3d53190

Part of
open-telemetry#5191
and open-telemetry#5586

Pre-work
open-telemetry#5279

---------

Co-authored-by: Tyler Yahn <[email protected]>

zailic pushed a commit to zailic/opentelemetry-go-contrib that referenced this issue


          otelzap: Implement methods on objectEncoder (open-telemetry#5602)

Part of open-telemetry#5191

---------

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

khushijain21 mentioned this issue

otelzap: Implement Write method #5620

Merged

pellared added a commit that referenced this issue


          otelzap: Implement Uint methods on encoder (#5609)

52ee3c4

Part of
#5191

Pre-work
#5279

This PR implements `uInt` methods `objectEncoder`

---------

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

pellared pushed a commit that referenced this issue


          otelzap: Add skeleton for array encoder (#5611)

e6f7c8e

Part of
#5191

Pre-work
#5279

This PR adds skeleton for arrayEncoder

khushijain21 mentioned this issue

otelzap: Implement methods on arrayEncoder #5632

Merged

khushijain21 added a commit to khushijain21/opentelemetry-go-contrib that referenced this issue


          otelzap: Implement Uint methods on encoder (open-telemetry#5609)

bb0a7e1

Part of
open-telemetry#5191

Pre-work
open-telemetry#5279

This PR implements `uInt` methods `objectEncoder`

---------

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

thomasgouveia added a commit to thomasgouveia/opentelemetry-go-contrib that referenced this issue


          docs(bridges/otelzap): add testable example (open-telemetry#5191)

d27f29b

This commit adds a simple example to demonstrate how to use the OpenTelemetry Zap bridge to send logs emitted by Zap to an OTEL endpoint.

Signed-off-by: thomasgouveia <[email protected]>

thomasgouveia added a commit to thomasgouveia/opentelemetry-go-contrib that referenced this issue


          docs(bridges/otelzap): add testable example (open-telemetry#5191)

8adc8af

This commit adds a simple example to demonstrate how to use the OpenTelemetry Zap bridge to send logs emitted by Zap to an OTEL endpoint.

Signed-off-by: thomasgouveia <[email protected]>

thomasgouveia added a commit to thomasgouveia/opentelemetry-go-contrib that referenced this issue


          docs(bridges/otelzap): add testable example (open-telemetry#5191)

038cbd2

This commit adds a simple example to demonstrate how to use the OpenTelemetry Zap bridge to send logs emitted by Zap to an OTEL endpoint.

Signed-off-by: thomasgouveia <[email protected]>

thomasgouveia added a commit to thomasgouveia/opentelemetry-go-contrib that referenced this issue


          docs(bridges/otelzap): add README (open-telemetry#5191)

ff42f72

Signed-off-by: thomasgouveia <[email protected]>

pellared added a commit that referenced this issue


          otelzap: Add Benchmarks (#5784)

ff65757

Part of #5191

Pre-work #5279

```
goos: linux
goarch: amd64
pkg: go.opentelemetry.io/contrib/bridges/otelzap
cpu: 12th Gen Intel(R) Core(TM) i5-1245U
BenchmarkCoreWrite/10_fields-12         	 1000000	      1116 ns/op	     978 B/op	      13 allocs/op
BenchmarkCoreWrite/20_fields-12         	  407290	      2615 ns/op	    2180 B/op	      22 allocs/op
BenchmarkCoreWrite/Namespace-12         	  725268	      1671 ns/op	    1760 B/op	      16 allocs/op
BenchmarkCoreWrite/With10_fields-12     	 4964038	       260.2 ns/op	     208 B/op	       1 allocs/op
BenchmarkCoreWrite/With20_fields-12     	 2004085	       628.7 ns/op	     640 B/op	       1 allocs/op
BenchmarkCoreWrite/WithNamespace-12     	100000000	        16.95 ns/op	       0 B/op	       0 allocs/op
PASS
ok  	go.opentelemetry.io/contrib/bridges/otelzap	8.619s
```

---------

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

thomasgouveia added a commit to thomasgouveia/opentelemetry-go-contrib that referenced this issue


          docs(bridges/otelzap): add README (open-telemetry#5191)

4e113df

Signed-off-by: thomasgouveia <[email protected]>

thomasgouveia added a commit to thomasgouveia/opentelemetry-go-contrib that referenced this issue


          docs(bridges/otelzap): add README (open-telemetry#5191)

eeb1b96

Signed-off-by: thomasgouveia <[email protected]>

thomasgouveia added a commit to thomasgouveia/opentelemetry-go-contrib that referenced this issue


          docs(bridges/otelzap): add testable example (open-telemetry#5191)

d342fff

This commit adds a simple example to demonstrate how to use the OpenTelemetry Zap bridge to send logs emitted by Zap to an OTEL endpoint.

Signed-off-by: thomasgouveia <[email protected]>

thomasgouveia added a commit to thomasgouveia/opentelemetry-go-contrib that referenced this issue


          docs(bridges/otelzap): add README (open-telemetry#5191)

7821d36

Signed-off-by: thomasgouveia <[email protected]>

thomasgouveia added a commit to thomasgouveia/opentelemetry-go-contrib that referenced this issue


          docs(bridges/otelzap): add testable example (open-telemetry#5191)

1078ee1

This commit adds a simple example to demonstrate how to use the OpenTelemetry Zap bridge to send logs emitted by Zap to an OTEL endpoint.

Signed-off-by: thomasgouveia <[email protected]>

thomasgouveia added a commit to thomasgouveia/opentelemetry-go-contrib that referenced this issue


          docs(bridges/otelzap): add README (open-telemetry#5191)

579e7ea

Signed-off-by: thomasgouveia <[email protected]>

thomasgouveia added a commit to thomasgouveia/opentelemetry-go-contrib that referenced this issue


          docs(bridges/otelzap): add testable example (open-telemetry#5191)

713469c

This commit adds a simple example to demonstrate how to use the OpenTelemetry Zap bridge to send logs emitted by Zap to an OTEL endpoint.

Signed-off-by: thomasgouveia <[email protected]>

thomasgouveia added a commit to thomasgouveia/opentelemetry-go-contrib that referenced this issue


          docs(bridges/otelzap): add README (open-telemetry#5191)

0b4b724

Signed-off-by: thomasgouveia <[email protected]>

thomasgouveia added a commit to thomasgouveia/opentelemetry-go-contrib that referenced this issue


          docs(bridges/otelzap): add testable example (open-telemetry#5191)

d3aa247

This commit adds a simple example to demonstrate how to use the OpenTelemetry Zap bridge to send logs emitted by Zap to an OTEL endpoint.

Signed-off-by: thomasgouveia <[email protected]>

thomasgouveia added a commit to thomasgouveia/opentelemetry-go-contrib that referenced this issue


          docs(bridges/otelzap): add README (open-telemetry#5191)

25d9b21

Signed-off-by: thomasgouveia <[email protected]>

pellared pushed a commit that referenced this issue


          otelzap: add testable example and package documentation (#5805)

ba4c2bb

Part of #5191

This was referenced Jul 11, 2024

otelzap: remove TODO comments for using pooled objects #5895

Merged

otelzap: Add test for passing context #5897

Merged

pellared pushed a commit that referenced this issue


          otelzap: Add test for passing context (#5897)

202d387

Part of #5191

Pre-work #5279

pellared added a commit that referenced this issue


          otelzap: remove TODO comments for using pooled objects (#5895)

19abe08

Part of #5191

Pre-work #5279

---------

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

khushijain21 mentioned this issue

otelzap: Add otelzap under experimental bridge #5907

Merged

dmathieu added a commit that referenced this issue


          otelzap: Add otelzap under experimental bridge (#5907)

62e857b

Completes #5191 

Can we also request for a review from zap maintainers?

---------

Co-authored-by: Damien Mathieu <[email protected]>

pellared mentioned this issue

[Go] Add zap log bridge open-telemetry/opentelemetry.io#4845

Merged

svrnm closed this as completed in open-telemetry/opentelemetry.io#4845

luca-filipponi pushed a commit to luca-filipponi/opentelemetry-go-contrib that referenced this issue


          otelzap: Add otelzap under experimental bridge (open-telemetry#5907)

c41c024

Completes open-telemetry#5191

Can we also request for a review from zap maintainers?

---------

Co-authored-by: Damien Mathieu <[email protected]>

luca-filipponi pushed a commit to luca-filipponi/opentelemetry-go-contrib that referenced this issue


          otelzap: Add otelzap under experimental bridge (open-telemetry#5907)

61d3673

Completes open-telemetry#5191

Can we also request for a review from zap maintainers?

---------

Co-authored-by: Damien Mathieu <[email protected]>

luca-filipponi pushed a commit to luca-filipponi/opentelemetry-go-contrib that referenced this issue


          otelzap: Add otelzap under experimental bridge (open-telemetry#5907)

59ad452

Completes open-telemetry#5191

Can we also request for a review from zap maintainers?

---------

Co-authored-by: Damien Mathieu <[email protected]>

luca-filipponi pushed a commit to luca-filipponi/opentelemetry-go-contrib that referenced this issue


          otelzap: Add otelzap under experimental bridge (open-telemetry#5907)

986f8bd

Completes open-telemetry#5191

Can we also request for a review from zap maintainers?

---------

Co-authored-by: Damien Mathieu <[email protected]>

MrAlias mentioned this issue

Release v1.29.0/v0.54.0/v0.23.0/v0.9.0/v0.4.0/v0.2.0/v0.1.0 #6042

Merged

MrAlias added a commit that referenced this issue


          Release v1.29.0/v0.54.0/v0.23.0/v0.9.0/v0.4.0/v0.2.0/v0.1.0 (#6042)

fc25f67

This release is the last to support [Go 1.21]. The next release will
require at least [Go 1.22].

### Added

- Add the `WithSpanAttributes` and `WithMetricAttributes` methods to set
custom attributes to the stats handler in
`go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc`.
(#5133)
- The `go.opentelemetry.io/contrib/bridges/otelzap` module. This module
provides an OpenTelemetry logging bridge for `go.uber.org/zap`. (#5191)
- Support for the `OTEL_HTTP_CLIENT_COMPATIBILITY_MODE=http/dup`
environment variable in
`go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp` to emit
attributes for both the v1.20.0 and v1.26.0 semantic conventions.
(#5401)
- The `go.opentelemetry.io/contrib/bridges/otelzerolog` module. This
module provides an OpenTelemetry logging bridge for
`github.com/rs/zerolog`. (#5405)
- Add `WithGinFilter` filter parameter in
`go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin`
to allow filtering requests with `*gin.Context`. (#5743)
- Support for stdoutlog exporter in
`go.opentelemetry.io/contrib/config`. (#5850)
- Add macOS ARM64 platform to the compatibility testing suite. (#5868)
- Add new runtime metrics to
`go.opentelemetry.io/contrib/instrumentation/runtime`, which are still
disabled by default. (#5870)
- Add the `WithMetricsAttributesFn` option to allow setting dynamic,
per-request metric attributes in
`go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp`. (#5876)
- The `go.opentelemetry.io/contrib/config` package supports configuring
`with_resource_constant_labels` for the prometheus exporter. (#5890)
- Support [Go 1.23]. (#6017)

### Removed

- The deprecated `go.opentelemetry.io/contrib/processors/baggagecopy`
package is removed. (#5853)

### Fixed

- Race condition when reading the HTTP body and writing the response in
`go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp`. (#5916)

[Go 1.23]: https://go.dev/doc/go1.23
[Go 1.22]: https://go.dev/doc/go1.22
[Go 1.21]: https://go.dev/doc/go1.21

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment