Skip to content

Commit

Permalink
Fix otelzap docs (#5933)
Browse files Browse the repository at this point in the history
Currently the docs are not rendered because the doc comments are not
properly formatted.
  • Loading branch information
pellared authored Jul 22, 2024
1 parent 03da805 commit 5d2c609
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions bridges/otelzap/core.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

// Package otelzap provides a bridge between the [go.uber.org/zap] and
// [OpenTelemetry].

//
// # Record Conversion
//
// The [zapcore.Entry] and [zapcore.Field] are converted to OpenTelemetry [log.Record] in the following
Expand All @@ -14,9 +14,8 @@
// - 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.
// - 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.
//
Expand All @@ -31,7 +30,6 @@
// 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 (
Expand Down

0 comments on commit 5d2c609

Please sign in to comment.