zapotel

README

zapotel

Zap helpers for writing opentelemetry formatted logs.

Installation

go get github.com/bakins/zapotel

Usage

package main

import (
	"github.com/bakins/zapotel"
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
    "go.opentelemetry.io/otel/sdk/resource"
)

func main() {
    // Will write json to stdout
    logger := zapotel.NewLogger(zapcore.InfoLevel).Named("testing")

    // add opentelemetry resource metadata
    logger = logger.With(zapotel.Resource(resource.Environment()))

    logger.Info("this is a message", zap.String("field", "value"))
}

Will print all on one line (formatted for easier viewing):

{
  "severity_text": "INFO",
  "timestamp": 1655157075426794000,
  "scope_name": "testing",
  "body": "this is a message",
  "severity": 9,
  "resource": {
    "hostname": "localhost"
  },
  "attributes": {
    "field": "value"
  }
}

See also

• https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/f531a708efce0e43cc4e999fd66f5ee7411e9c0e/pkg/stanza/entry/entry.go#L25

LICENSE

See LICENSE

Documentation

Index

• func EncoderConfig() zapcore.EncoderConfig
• func NewEncoder() zapcore.Encoder
• func NewLogger(enab zapcore.LevelEnabler) *zap.Logger
• func Resource(resource *resource.Resource) zap.Field
• func SpanID(spanID trace.SpanID) zap.Field
• func TraceID(traceID trace.TraceID) zap.Field
• func WrapCore(base zapcore.Core) zapcore.Core
• type Core
  • func NewCore(ws zapcore.WriteSyncer, enab zapcore.LevelEnabler) *Core
  • func (c *Core) Check(e zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry
  • func (c *Core) Enabled(l zapcore.Level) bool
  • func (c *Core) Sync() error
  • func (c *Core) With(fields []zap.Field) zapcore.Core
  • func (c *Core) Write(e zapcore.Entry, in []zapcore.Field) error

Functions

func EncoderConfig

func EncoderConfig() zapcore.EncoderConfig

func NewEncoder

func NewEncoder() zapcore.Encoder

func NewLogger

func NewLogger(enab zapcore.LevelEnabler) *zap.Logger

func Resource

func Resource(resource *resource.Resource) zap.Field

func SpanID

func SpanID(spanID trace.SpanID) zap.Field

func TraceID

func TraceID(traceID trace.TraceID) zap.Field

func WrapCore

func WrapCore(base zapcore.Core) zapcore.Core

Types

type Core

type Core struct {
	// contains filtered or unexported fields
}

func NewCore

func NewCore(ws zapcore.WriteSyncer, enab zapcore.LevelEnabler) *Core

func (*Core) Check

func (c *Core) Check(e zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry

func (*Core) Enabled

func (c *Core) Enabled(l zapcore.Level) bool

func (*Core) Sync

func (c *Core) Sync() error

func (*Core) With

func (c *Core) With(fields []zap.Field) zapcore.Core

func (*Core) Write

func (c *Core) Write(e zapcore.Entry, in []zapcore.Field) error