From ff42f72b6c79154c49db5d273bd2c6b535f5abb1 Mon Sep 17 00:00:00 2001 From: thomasgouveia Date: Wed, 26 Jun 2024 10:59:11 +0200 Subject: [PATCH] docs(bridges/otelzap): add README (#5191) Signed-off-by: thomasgouveia --- bridges/otelzap/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 bridges/otelzap/README.md diff --git a/bridges/otelzap/README.md b/bridges/otelzap/README.md new file mode 100644 index 00000000000..c0f9c918c3e --- /dev/null +++ b/bridges/otelzap/README.md @@ -0,0 +1,11 @@ +# OpenTelemetry Zap Log Bridge + +[![Go Reference](https://pkg.go.dev/badge/go.opentelemetry.io/contrib/bridges/otelzap.svg)](https://pkg.go.dev/go.opentelemetry.io/contrib/bridges/otelzap) + +This package implements a [Log Bridge](https://opentelemetry.io/docs/specs/otel/logs/bridge-api/) for the [Zap](https://github.com/uber-go/zap) logger. This bridge can be used to send logs emitted by application using Zap to an OpenTelemetry compatible endpoint through the [OpenTelemetry Log API](https://pkg.go.dev/go.opentelemetry.io/otel/log). + +## Example + +Please refer to the [example_test.go](./example_test.go) file for a complete example of how to create a Zap logger using the bridge. + +