grpclog

Documentation

Overview

Package grpclog (internal) defines depth logging for grpc.

Index

• Variables
• func ErrorDepth(depth int, args ...interface{})
• func FatalDepth(depth int, args ...interface{})
• func InfoDepth(depth int, args ...interface{})
• func WarningDepth(depth int, args ...interface{})
• type DepthLoggerV2
• type LoggerV2
• type PrefixLogger
  • func NewPrefixLogger(logger DepthLoggerV2, prefix string) *PrefixLogger
  • func (pl *PrefixLogger) Errorf(format string, args ...interface{})
  • func (pl *PrefixLogger) Infof(format string, args ...interface{})
  • func (pl *PrefixLogger) Warnf(format string, args ...interface{})

Variables

var Logger = func() logger.Logger {
	logger.InitLogger(&logger.Config{
		CallerSkip: 2,
	})
	return logger.GetLogger()
}()

Logger is the logger used for the non-depth log functions.

Functions

func ErrorDepth

func ErrorDepth(depth int, args ...interface{})

ErrorDepth logs to the ERROR log at the specified depth.

func FatalDepth

func FatalDepth(depth int, args ...interface{})

FatalDepth logs to the FATAL log at the specified depth.

func InfoDepth

func InfoDepth(depth int, args ...interface{})

InfoDepth logs to the INFO log at the specified depth.

func WarningDepth

func WarningDepth(depth int, args ...interface{})

WarningDepth logs to the WARNING log at the specified depth.

Types

type DepthLoggerV2

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

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. This is a copy of the DepthLoggerV2 defined in the external grpclog package. It is defined here to avoid a circular dependency.

Experimental

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

var DepthLogger DepthLoggerV2

DepthLogger is the logger used for the depth log functions.

type LoggerV2

type LoggerV2 interface {
	// Info logs to INFO log. Arguments are handled in the manner of fmt.Print.
	Info(args ...interface{})
	// Infoln logs to INFO log. Arguments are handled in the manner of fmt.Println.
	Infoln(args ...interface{})
	// Infof logs to INFO log. Arguments are handled in the manner of fmt.Printf.
	Infof(format string, args ...interface{})
	// Warning logs to WARNING log. Arguments are handled in the manner of fmt.Print.
	Warning(args ...interface{})
	// Warningln logs to WARNING log. Arguments are handled in the manner of fmt.Println.
	Warningln(args ...interface{})
	// Warnf logs to WARNING log. Arguments are handled in the manner of fmt.Printf.
	Warnf(format string, args ...interface{})
	// Error logs to ERROR log. Arguments are handled in the manner of fmt.Print.
	Error(args ...interface{})
	// Errorln logs to ERROR log. Arguments are handled in the manner of fmt.Println.
	Errorln(args ...interface{})
	// Errorf logs to ERROR log. Arguments are handled in the manner of fmt.Printf.
	Errorf(format string, args ...interface{})
	// 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 ...interface{})
	// 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 ...interface{})
	// 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 ...interface{})
	// V reports whether verbosity level l is at least the requested verbose level.
	V(l int) bool
}

LoggerV2 does underlying logging work for grpclog. This is a copy of the LoggerV2 defined in the external grpclog package. It is defined here to avoid a circular dependency.

type PrefixLogger

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

PrefixLogger does logging with a prefix.

Logging method on a nil logs without any prefix.

func NewPrefixLogger

func NewPrefixLogger(logger DepthLoggerV2, prefix string) *PrefixLogger

NewPrefixLogger creates a prefix logger with the given prefix.

func (*PrefixLogger) Errorf

func (pl *PrefixLogger) Errorf(format string, args ...interface{})

Errorf does error logging.

func (*PrefixLogger) Infof

func (pl *PrefixLogger) Infof(format string, args ...interface{})

Infof does info logging.

func (*PrefixLogger) Warnf

func (pl *PrefixLogger) Warnf(format string, args ...interface{})

Warnf does warning logging.