Merge branch 'main' into runtime_histogram

.github/ISSUE_TEMPLATE/owner.md

@@ -18,7 +18,7 @@ Module: [e.g. go.opentelemetry.io/contrib/zpages]
 - [ ] I understand I will be responsible for the stability and versioning compliance of the module
 - [ ] I understand I will be responsible for deciding any additional Code Owners of the module
 
-[member of the OpenTelemetry organization]: https://github.com/open-telemetry/community/blob/main/community-membership.md#member
+[member of the OpenTelemetry organization]: https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#member
 
 ### Relevant experience
 

.golangci.yml

@@ -10,6 +10,8 @@ linters:
  disable-all: true
  # Specifically enable linters we want to use.
  enable:
+ - asasalint
+ - bodyclose
  - depguard
  - errcheck
  - errorlint

CHANGELOG.md

@@ -16,13 +16,19 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
  This module provides an OpenTelemetry logging bridge for `go.uber.org/zap`. (#5191)
 - The `go.opentelemetry.io/contrib/config` package supports configuring `with_resource_constant_labels` for the prometheus exporter. (#5890)
 - Add new runtime metrics to `go.opentelemetry.io/contrib/instrumentation/runtime`, which are still disabled by default. (#5870)
-- 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.24.0 semantic conventions. (#5401)
+- 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 `NewProducer` to `go.opentelemetry.io/contrib/instrumentation/runtime`, which allows collecting the `go.schedule.duration` histogram metric from the Go runtime. (#5991)
 
 ### 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)
+
 <!-- Released section -->
 <!-- Don't change this section unless doing release -->
 

CODEOWNERS

@@ -5,7 +5,7 @@
 #####################################################
 #
 # Learn about membership in OpenTelemetry community:
-# https://github.com/open-telemetry/community/blob/main/community-membership.md
+# https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#member
 #
 # Learn about Code Owners policy in OpenTelemetry Go Contrib:
 # https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/CONTRIBUTING.md#code-owners

CONTRIBUTING.md

@@ -32,7 +32,7 @@ How much interaction with the module is required before becoming a Code Owner is
 Code Ownership is ultimately up to the judgement of the existing Code Owners and Maintainers of this repository.
 Meeting the above requirements is not a guarantee to be granted Code Ownership.
 
-[member of the OpenTelemetry organization]: https://github.com/open-telemetry/community/blob/main/community-membership.md#member
+[member of the OpenTelemetry organization]: https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#member
 
 ### Responsibilities
 
@@ -55,7 +55,7 @@ It is at the discretion of the repository Maintainers and fellow Code Owners to
 If a Code Owner is determined to be unable to perform their duty, a repository Maintainer will remove their ownership.
 
 Inactivity greater than 5 months, during which time there are active Issues or Pull Requests to address, is deemed an automatic disqualification from being a Code Owner.
-A repository Maintainer may remove an Code Owner inactive for this length. 
+A repository Maintainer may remove an Code Owner inactive for this length.
 
 ## Filing Issues
 
@@ -146,4 +146,4 @@ Emeritus:
 ### Become an Approver or a Maintainer
 
 See the [community membership document in OpenTelemetry community
-repo](https://github.com/open-telemetry/community/blob/main/community-membership.md).
+repo](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md).

bridges/otellogrus/go.mod

@@ -16,6 +16,6 @@ require (
  go.opentelemetry.io/otel v1.28.0 // indirect
  go.opentelemetry.io/otel/metric v1.28.0 // indirect
  go.opentelemetry.io/otel/trace v1.28.0 // indirect
- golang.org/x/sys v0.22.0 // indirect
+ golang.org/x/sys v0.23.0 // indirect
  gopkg.in/yaml.v3 v3.0.1 // indirect
 )

bridges/otellogrus/go.sum

@@ -25,8 +25,8 @@ go.opentelemetry.io/otel/metric v1.28.0/go.mod h1:Fb1eVBFZmLVTMb6PPohq3TO9IIhUis
 go.opentelemetry.io/otel/trace v1.28.0 h1:GhQ9cUuQGmNDd5BTCP2dAvv75RdMxEfTmYejp+lkx9g=
 go.opentelemetry.io/otel/trace v1.28.0/go.mod h1:jPyXzNPg6da9+38HEwElrQiHlVMTnVfM3/yv2OlIHaI=
 golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI=
-golang.org/x/sys v0.22.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.23.0 h1:YfKFowiIMvtgl1UERQoTPPToxltDeZfbj4H7dVUCwmM=
+golang.org/x/sys v0.23.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

bridges/otellogrus/hook.go

@@ -19,12 +19,12 @@
 // The Level is transformed by using the static offset to the OpenTelemetry
 // Severity types. For example:
 //
-// - [slog.LevelDebug] is transformed to [log.SeverityDebug]
-// - [slog.LevelInfo] is transformed to [log.SeverityInfo]
-// - [slog.LevelWarn] is transformed to [log.SeverityWarn]
-// - [slog.LevelError] is transformed to [log.SeverityError]
+// - [logrus.DebugLevel] is transformed to [log.SeverityDebug]
+// - [logrus.InfoLevel] is transformed to [log.SeverityTrace4]
+// - [logrus.WarnLevel] is transformed to [log.SeverityTrace3]
+// - [logrus.ErrorLevel] is transformed to [log.SeverityTrace2]
 //
-// Attribute values are transformed based on their type into log attributes, or
+// Field values are transformed based on their type into log attributes, or
 // into a string value if there is no matching type.
 //
 // [OpenTelemetry]: https://opentelemetry.io/docs/concepts/signals/logs/

bridges/otelzap/core.go

@@ -2,7 +2,34 @@
 // SPDX-License-Identifier: Apache-2.0
 
 // Package otelzap provides a bridge between the [go.uber.org/zap] and
-// OpenTelemetry logging.
+// [OpenTelemetry].
+//
+// # Record Conversion
+//
+// The [zapcore.Entry] and [zapcore.Field] are converted to OpenTelemetry [log.Record] in the following
+// way:
+//
+// - Time is set as the Timestamp.
+// - Message is set as the Body using a [log.StringValue].
+// - Level is transformed and set as the Severity. The SeverityText is also
+// set.
+// - Fields are transformed and set as the Attributes.
+// - Field value of type [context.Context] is used as context when emitting log records.
+// - For named loggers, LoggerName is used to access [log.Logger] from [log.LoggerProvider]
+//
+// The Level is transformed to the OpenTelemetry Severity types in the following way.
+//
+// - [zapcore.DebugLevel] is transformed to [log.SeverityDebug]
+// - [zapcore.InfoLevel] is transformed to [log.SeverityInfo]
+// - [zapcore.WarnLevel] is transformed to [log.SeverityWarn]
+// - [zapcore.ErrorLevel] is transformed to [log.SeverityError]
+// - [zapcore.DPanicLevel] is transformed to [log.SeverityFatal1]
+// - [zapcore.PanicLevel] is transformed to [log.SeverityFatal2]
+// - [zapcore.FatalLevel] is transformed to [log.SeverityFatal3]
+//
+// Fields are transformed based on their type into log attributes, or into a string value if there is no matching type.
+//
+// [OpenTelemetry]: https://opentelemetry.io/docs/concepts/signals/logs/
 package otelzap // import "go.opentelemetry.io/contrib/bridges/otelzap"
 
 import (

bridges/otelzap/example_test.go

@@ -4,6 +4,7 @@
 package otelzap_test
 
 import (
+ "context"
  "os"
 
  "go.opentelemetry.io/contrib/bridges/otelzap"
@@ -24,6 +25,10 @@ func Example() {
 
  // You can now use your logger in your code.
  logger.Info("something really cool")
+
+ // You can set context for trace correlation using zap.Any or zap.Reflect
+ ctx := context.Background()
+ logger.Info("setting context", zap.Any("context", ctx))
 }
 
 func Example_multiple() {

bridges/otelzerolog/go.mod

@@ -18,6 +18,6 @@ require (
  go.opentelemetry.io/otel v1.28.0 // indirect
  go.opentelemetry.io/otel/metric v1.28.0 // indirect
  go.opentelemetry.io/otel/trace v1.28.0 // indirect
- golang.org/x/sys v0.22.0 // indirect
+ golang.org/x/sys v0.23.0 // indirect
  gopkg.in/yaml.v3 v3.0.1 // indirect
 )

bridges/otelzerolog/go.sum

@@ -34,8 +34,8 @@ go.opentelemetry.io/otel/trace v1.28.0/go.mod h1:jPyXzNPg6da9+38HEwElrQiHlVMTnVf
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI=
-golang.org/x/sys v0.22.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.23.0 h1:YfKFowiIMvtgl1UERQoTPPToxltDeZfbj4H7dVUCwmM=
+golang.org/x/sys v0.23.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

bridges/otelzerolog/hook.go

@@ -3,6 +3,27 @@
 
 // Package otelzerolog provides a [Hook], a [zerolog.Hook] implementation that
 // can be used to bridge between the [zerolog] API and [OpenTelemetry].
+//
+// # Record Conversion
+//
+// The [zerolog.Event] records are converted to OpenTelemetry [log.Record] in
+// the following way:
+//
+// - Message is set as the Body using a [log.StringValue].
+// - Level is transformed and set as the Severity. The SeverityText is also
+// set.
+//
+// The Level is transformed to the OpenTelemetry Severity types in the following way.
+//
+// - [zerolog.DebugLevel] is transformed to [log.SeverityDebug]
+// - [zerolog.InfoLevel] is transformed to [log.SeverityInfo]
+// - [zerolog.WarnLevel] is transformed to [log.SeverityWarn]
+// - [zerolog.ErrorLevel] is transformed to [log.SeverityError]
+// - [zerolog.PanicLevel] is transformed to [log.SeverityFatal1]
+// - [zerolog.FatalLevel] is transformed to [log.SeverityFatal2]
+//
+// NOTE: Fields are not transformed because of https://github.com/rs/zerolog/issues/493.
+//
 // [OpenTelemetry]: https://opentelemetry.io/docs/concepts/signals/logs/
 package otelzerolog // import "go.opentelemetry.io/contrib/bridges/otelzerolog"
 
@@ -100,5 +121,33 @@ func NewHook(name string, options ...Option) *Hook {
 
 // Run handles the passed record, and sends it to OpenTelemetry.
 func (h Hook) Run(e *zerolog.Event, level zerolog.Level, msg string) {
- // TODO
+ r := log.Record{}
+ r.SetSeverity(convertLevel(level))
+ r.SetBody(log.StringValue(msg))
+ r.SetSeverityText(level.String())
+
+ // TODO: add support for attributes
+ // This is limited by zerolog's inability to retrieve fields.
+ // https://github.com/rs/zerolog/issues/493
+
+ h.logger.Emit(e.GetCtx(), r)
+}
+
+func convertLevel(level zerolog.Level) log.Severity {
+ switch level {
+ case zerolog.DebugLevel:
+ return log.SeverityDebug
+ case zerolog.InfoLevel:
+ return log.SeverityInfo
+ case zerolog.WarnLevel:
+ return log.SeverityWarn
+ case zerolog.ErrorLevel:
+ return log.SeverityError
+ case zerolog.PanicLevel:
+ return log.SeverityFatal1
+ case zerolog.FatalLevel:
+ return log.SeverityFatal2
+ default:
+ return log.SeverityUndefined
+ }
 }

bridges/otelzerolog/hook_test.go

@@ -3,13 +3,17 @@
 package otelzerolog
 
 import (
+ "os"
  "testing"
 
+ "github.com/rs/zerolog"
  "github.com/stretchr/testify/assert"
+ "github.com/stretchr/testify/require"
 
  "go.opentelemetry.io/otel/log"
  "go.opentelemetry.io/otel/log/embedded"
  "go.opentelemetry.io/otel/log/global"
+ "go.opentelemetry.io/otel/log/logtest"
 )
 
 type mockLoggerProvider struct {
@@ -103,3 +107,97 @@ func TestNewHook(t *testing.T) {
  })
  }
 }
+
+var (
+ testMessage = "log message"
+ loggerName = "name"
+ testKey = "key"
+ testValue = "value"
+ testEntry = zerolog.InfoLevel
+)
+
+func TestHookRun(t *testing.T) {
+ rec := logtest.NewRecorder()
+ hook := NewHook(loggerName, WithLoggerProvider(rec))
+
+ logger := zerolog.New(os.Stderr).Hook(hook)
+
+ t.Run("Run", func(t *testing.T) {
+ // Create an event and run the hook
+ event := logger.Info().Str(testKey, testValue)
+ hook.Run(event, testEntry, testMessage)
+
+ // Check the results
+ require.Len(t, rec.Result(), 1)
+ require.Len(t, rec.Result()[0].Records, 1)
+ got := rec.Result()[0].Records[0]
+ assert.Equal(t, testMessage, got.Body().AsString())
+ assert.Equal(t, log.SeverityInfo, got.Severity())
+ assert.Equal(t, zerolog.InfoLevel.String(), got.SeverityText())
+ })
+}
+
+func TestConvertLevel(t *testing.T) {
+ tests := []struct {
+ name string
+ zerologLevel zerolog.Level
+ expected log.Severity
+ }{
+ {
+ name: "DebugLevel",
+ zerologLevel: zerolog.DebugLevel,
+ expected: log.SeverityDebug,
+ },
+ {
+ name: "InfoLevel",
+ zerologLevel: zerolog.InfoLevel,
+ expected: log.SeverityInfo,
+ },
+ {
+ name: "WarnLevel",
+ zerologLevel: zerolog.WarnLevel,
+ expected: log.SeverityWarn,
+ },
+ {
+ name: "ErrorLevel",
+ zerologLevel: zerolog.ErrorLevel,
+ expected: log.SeverityError,
+ },
+ {
+ name: "PanicLevel",
+ zerologLevel: zerolog.PanicLevel,
+ expected: log.SeverityFatal1,
+ },
+ {
+ name: "FatalLevel",
+ zerologLevel: zerolog.FatalLevel,
+ expected: log.SeverityFatal2,
+ },
+ {
+ name: "UnknownLevel",
+ zerologLevel: zerolog.NoLevel, // An unknown level
+ expected: log.SeverityUndefined,
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ actual := convertLevel(tt.zerologLevel)
+ assert.Equal(t, tt.expected, actual, "severity mismatch")
+ })
+ }
+}
+
+func BenchmarkHookRun(b *testing.B) {
+ rec := logtest.NewRecorder()
+ hook := NewHook(loggerName, WithLoggerProvider(rec))
+ logger := zerolog.New(nil).Hook(hook)
+ level := zerolog.InfoLevel
+ msg := "benchmark log message"
+ event := logger.Info()
+ b.ResetTimer()
+ b.ReportAllocs()
+ for i := 0; i < b.N; i++ {
+ hook.Run(event, level, msg)
+ }
+}

bridges/prometheus/go.mod

@@ -26,7 +26,7 @@ require (
  github.com/rogpeppe/go-internal v1.12.0 // indirect
  go.opentelemetry.io/otel/metric v1.28.0 // indirect
  go.opentelemetry.io/otel/trace v1.28.0 // indirect
- golang.org/x/sys v0.22.0 // indirect
+ golang.org/x/sys v0.23.0 // indirect
  google.golang.org/protobuf v1.34.2 // indirect
  gopkg.in/yaml.v3 v3.0.1 // indirect
 )

bridges/prometheus/go.sum

@@ -44,8 +44,8 @@ go.opentelemetry.io/otel/sdk/metric v1.28.0 h1:OkuaKgKrgAbYrrY0t92c+cC+2F6hsFNnC
 go.opentelemetry.io/otel/sdk/metric v1.28.0/go.mod h1:cWPjykihLAPvXKi4iZc1dpER3Jdq2Z0YLse3moQUCpg=
 go.opentelemetry.io/otel/trace v1.28.0 h1:GhQ9cUuQGmNDd5BTCP2dAvv75RdMxEfTmYejp+lkx9g=
 go.opentelemetry.io/otel/trace v1.28.0/go.mod h1:jPyXzNPg6da9+38HEwElrQiHlVMTnVfM3/yv2OlIHaI=
-golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI=
-golang.org/x/sys v0.22.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.23.0 h1:YfKFowiIMvtgl1UERQoTPPToxltDeZfbj4H7dVUCwmM=
+golang.org/x/sys v0.23.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 google.golang.org/protobuf v1.34.2 h1:6xV6lTsCfpGD21XK49h7MhtcApnLqkfYgPcdHftf6hg=
 google.golang.org/protobuf v1.34.2/go.mod h1:qYOHts0dSfpeUzUFpOMr/WGzszTmLH+DiWniOlNbLDw=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=