grpclog

Documentation

Overview

Package grpclog defines logging for grpc.

All logs in transport and grpclb packages only go to verbose level 2. All logs in other packages in grpc are logged in spite of the verbosity level.

In the default logger, severity level can be set by environment variable GRPC_GO_LOG_SEVERITY_LEVEL, verbosity level can be set by GRPC_GO_LOG_VERBOSITY_LEVEL.

Index

• func Error(args ...any)
• func Errorf(format string, args ...any)
• func Errorln(args ...any)
• func Fatal(args ...any)
• func Fatalf(format string, args ...any)
• func Fatalln(args ...any)
• func Info(args ...any)
• func Infof(format string, args ...any)
• func Infoln(args ...any)
• func Print(args ...any)
• func Printf(format string, args ...any)
• func Println(args ...any)
• func SetLogger(l Logger)
• func SetLoggerV2(l LoggerV2)
• func V(l int) bool
• func Warning(args ...any)
• func Warningf(format string, args ...any)
• func Warningln(args ...any)
• type DepthLoggerV2
  • func Component(componentName string) DepthLoggerV2
• type Logger
• type LoggerV2
  • func NewLoggerV2(infoW, warningW, errorW io.Writer) LoggerV2
  • func NewLoggerV2WithVerbosity(infoW, warningW, errorW io.Writer, v int) LoggerV2

Functions

func Error

func Error(args ...any)

Error logs to the ERROR log.

func Errorf

func Errorf(format string, args ...any)

Errorf logs to the ERROR log. Arguments are handled in the manner of fmt.Printf.

func Errorln

func Errorln(args ...any)

Errorln logs to the ERROR log. Arguments are handled in the manner of fmt.Println.

func Fatal

func Fatal(args ...any)

Fatal logs to the FATAL log. Arguments are handled in the manner of fmt.Print. It calls os.Exit() with exit code 1.

func Fatalf

func Fatalf(format string, args ...any)

Fatalf logs to the FATAL log. Arguments are handled in the manner of fmt.Printf. It calls os.Exit() with exit code 1.

func Fatalln

func Fatalln(args ...any)

Fatalln logs to the FATAL log. Arguments are handled in the manner of fmt.Println. It calle os.Exit()) with exit code 1.

func Info

func Info(args ...any)

Info logs to the INFO log.

func Infof

func Infof(format string, args ...any)

Infof logs to the INFO log. Arguments are handled in the manner of fmt.Printf.

func Infoln

func Infoln(args ...any)

Infoln logs to the INFO log. Arguments are handled in the manner of fmt.Println.

func Print

func Print(args ...any)

Print prints to the logger. Arguments are handled in the manner of fmt.Print.

Deprecated: use Info.

func Printf

func Printf(format string, args ...any)

Printf prints to the logger. Arguments are handled in the manner of fmt.Printf.

Deprecated: use Infof.

func Println

func Println(args ...any)

Println prints to the logger. Arguments are handled in the manner of fmt.Println.

Deprecated: use Infoln.

func SetLogger

func SetLogger(l Logger)

SetLogger sets the logger that is used in grpc. Call only from init() functions.

Deprecated: use SetLoggerV2.

func SetLoggerV2

func SetLoggerV2(l LoggerV2)

SetLoggerV2 sets logger that is used in grpc to a V2 logger. Not mutex-protected, should be called before any gRPC functions.

func V

func V(l int) bool

V reports whether verbosity level l is at least the requested verbose level.

func Warning

func Warning(args ...any)

Warning logs to the WARNING log.

func Warningf

func Warningf(format string, args ...any)

Warningf logs to the WARNING log. Arguments are handled in the manner of fmt.Printf.

func Warningln

func Warningln(args ...any)

Warningln logs to the WARNING log. Arguments are handled in the manner of fmt.Println.

Types

type DepthLoggerV2

type DepthLoggerV2 interface {
	LoggerV2
	// InfoDepth logs to INFO log at the specified depth. Arguments are handled in the manner of fmt.Println.
	InfoDepth(depth int, args ...any)
	// WarningDepth logs to WARNING log at the specified depth. Arguments are handled in the manner of fmt.Println.
	WarningDepth(depth int, args ...any)
	// ErrorDepth logs to ERROR log at the specified depth. Arguments are handled in the manner of fmt.Println.
	ErrorDepth(depth int, args ...any)
	// FatalDepth logs to FATAL log at the specified depth. Arguments are handled in the manner of fmt.Println.
	FatalDepth(depth int, args ...any)
}

DepthLoggerV2 logs at a specified call frame. If a LoggerV2 also implements DepthLoggerV2, the below functions will be called with the appropriate stack depth set for trivial functions the logger may ignore.

Experimental

Notice: This type is EXPERIMENTAL and may be changed or removed in a later release.

func Component

func Component(componentName string) DepthLoggerV2

Component creates a new component and returns it for logging. If a component with the name already exists, nothing will be created and it will be returned. SetLoggerV2 will panic if it is called with a logger created by Component.

type Logger

type Logger interface {
	Fatal(args ...any)
	Fatalf(format string, args ...any)
	Fatalln(args ...any)
	Print(args ...any)
	Printf(format string, args ...any)
	Println(args ...any)
}

Logger mimics golang's standard Logger as an interface.

Deprecated: use LoggerV2.

type LoggerV2

type LoggerV2 interface {
	// Info logs to INFO log. Arguments are handled in the manner of fmt.Print.
	Info(args ...any)
	// Infoln logs to INFO log. Arguments are handled in the manner of fmt.Println.
	Infoln(args ...any)
	// Infof logs to INFO log. Arguments are handled in the manner of fmt.Printf.
	Infof(format string, args ...any)
	// Warning logs to WARNING log. Arguments are handled in the manner of fmt.Print.
	Warning(args ...any)
	// Warningln logs to WARNING log. Arguments are handled in the manner of fmt.Println.
	Warningln(args ...any)
	// Warningf logs to WARNING log. Arguments are handled in the manner of fmt.Printf.
	Warningf(format string, args ...any)
	// Error logs to ERROR log. Arguments are handled in the manner of fmt.Print.
	Error(args ...any)
	// Errorln logs to ERROR log. Arguments are handled in the manner of fmt.Println.
	Errorln(args ...any)
	// Errorf logs to ERROR log. Arguments are handled in the manner of fmt.Printf.
	Errorf(format string, args ...any)
	// Fatal logs to ERROR log. Arguments are handled in the manner of fmt.Print.
	// gRPC ensures that all Fatal logs will exit with os.Exit(1).
	// Implementations may also call os.Exit() with a non-zero exit code.
	Fatal(args ...any)
	// Fatalln logs to ERROR log. Arguments are handled in the manner of fmt.Println.
	// gRPC ensures that all Fatal logs will exit with os.Exit(1).
	// Implementations may also call os.Exit() with a non-zero exit code.
	Fatalln(args ...any)
	// Fatalf logs to ERROR log. Arguments are handled in the manner of fmt.Printf.
	// gRPC ensures that all Fatal logs will exit with os.Exit(1).
	// Implementations may also call os.Exit() with a non-zero exit code.
	Fatalf(format string, args ...any)
	// V reports whether verbosity level l is at least the requested verbose level.
	V(l int) bool
}

LoggerV2 does underlying logging work for grpclog.

func NewLoggerV2

func NewLoggerV2(infoW, warningW, errorW io.Writer) LoggerV2

NewLoggerV2 creates a loggerV2 with the provided writers. Fatal logs will be written to errorW, warningW, infoW, followed by exit(1). Error logs will be written to errorW, warningW and infoW. Warning logs will be written to warningW and infoW. Info logs will be written to infoW.

func NewLoggerV2WithVerbosity

func NewLoggerV2WithVerbosity(infoW, warningW, errorW io.Writer, v int) LoggerV2

NewLoggerV2WithVerbosity creates a loggerV2 with the provided writers and verbosity level.