zap

Documentation

Overview

Package zap provides a small adapter required to use zap in logging gRPC middlewares. Please see examples for examples of use.

Example (InitializationWithCustomLevels)

package main

import (
	grpczap "github.com/grpc-ecosystem/go-grpc-middleware/providers/zap/v2"
	"go.uber.org/zap"
	"google.golang.org/grpc"

	middleware "github.com/grpc-ecosystem/go-grpc-middleware/v2"
	"github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/logging"
)

var customFunc logging.CodeToLevel

func main() {
	// Logger is used, allowing pre-definition of certain fields by the user.
	logger := zap.NewNop()
	// Shared options for the logger, with a custom gRPC code to log level function.
	opts := []logging.Option{
		logging.WithLevels(customFunc),
	}
	// Create a server, make sure we put the tags context before everything else.
	_ = grpc.NewServer(
		middleware.WithUnaryServerChain(
			logging.UnaryServerInterceptor(grpczap.InterceptorLogger(logger), opts...),
		),
		middleware.WithStreamServerChain(
			logging.StreamServerInterceptor(grpczap.InterceptorLogger(logger), opts...),
		),
	)
}

Example (InitializationWithDurationFieldOverride)

package main

import (
	grpczap "github.com/grpc-ecosystem/go-grpc-middleware/providers/zap/v2"
	"go.uber.org/zap"
	"google.golang.org/grpc"

	middleware "github.com/grpc-ecosystem/go-grpc-middleware/v2"
	"github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/logging"
)

var customDurationToFields logging.DurationToFields

func main() {
	// Logger is used, allowing pre-definition of certain fields by the user.
	logger := zap.NewNop()
	// Shared options for the logger, with a custom duration to log field function.
	opts := []logging.Option{
		logging.WithDurationField(customDurationToFields),
	}
	// Create a server, make sure we put the tags context before everything else.
	_ = grpc.NewServer(
		middleware.WithUnaryServerChain(
			logging.UnaryServerInterceptor(grpczap.InterceptorLogger(logger), opts...),
		),
		middleware.WithStreamServerChain(
			logging.StreamServerInterceptor(grpczap.InterceptorLogger(logger), opts...),
		),
	)
}

Index

• type Logger
  • func InterceptorLogger(logger *zap.Logger) *Logger
  • func (l *Logger) Log(lvl logging.Level, msg string)
  • func (l *Logger) With(fields ...string) logging.Logger

Examples

• Package (InitializationWithCustomLevels)
• Package (InitializationWithDurationFieldOverride)

Types

type Logger

type Logger struct {
	*zap.Logger
}

Logger is a zap logging adapter compatible with logging middlewares.

func InterceptorLogger

func InterceptorLogger(logger *zap.Logger) *Logger

InterceptorLogger converts zap logger to Logger adapter.

func (*Logger) Log

func (l *Logger) Log(lvl logging.Level, msg string)

Log implements logging.Logger interface.

func (*Logger) With

func (l *Logger) With(fields ...string) logging.Logger

With implements logging.Logger interface.