package grpclog

Import Path
	google.golang.org/grpc/grpclog (on go.dev)

Dependency Relation
	imports 8 packages, and imported by 11 packages

Involved Source Files

	      component.go
	   #d grpclog.go
		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.

	      logger.go
	      loggerv2.go
Package-Level Type Names (total 7, in which 3 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type DepthLoggerV2 (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.

		# Experimental

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

		Methods (total 17, all are exported)
			( DepthLoggerV2) Error(args ...interface{})
				Error logs to ERROR log. Arguments are handled in the manner of fmt.Print.

			( DepthLoggerV2) ErrorDepth(depth int, args ...interface{})
				ErrorDepth logs to ERROR log at the specified depth. Arguments are handled in the manner of fmt.Println.

			( DepthLoggerV2) Errorf(format string, args ...interface{})
				Errorf logs to ERROR log. Arguments are handled in the manner of fmt.Printf.

			( DepthLoggerV2) Errorln(args ...interface{})
				Errorln logs to ERROR log. Arguments are handled in the manner of fmt.Println.

			( DepthLoggerV2) Fatal(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.

			( DepthLoggerV2) FatalDepth(depth int, args ...interface{})
				FatalDepth logs to FATAL log at the specified depth. Arguments are handled in the manner of fmt.Println.

			( DepthLoggerV2) Fatalf(format string, 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.

			( DepthLoggerV2) Fatalln(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.

			( DepthLoggerV2) Info(args ...interface{})
				Info logs to INFO log. Arguments are handled in the manner of fmt.Print.

			( DepthLoggerV2) InfoDepth(depth int, args ...interface{})
				InfoDepth logs to INFO log at the specified depth. Arguments are handled in the manner of fmt.Println.

			( DepthLoggerV2) Infof(format string, args ...interface{})
				Infof logs to INFO log. Arguments are handled in the manner of fmt.Printf.

			( DepthLoggerV2) Infoln(args ...interface{})
				Infoln logs to INFO log. Arguments are handled in the manner of fmt.Println.

			( DepthLoggerV2) V(l int) bool
				V reports whether verbosity level l is at least the requested verbose level.

			( DepthLoggerV2) Warning(args ...interface{})
				Warning logs to WARNING log. Arguments are handled in the manner of fmt.Print.

			( DepthLoggerV2) WarningDepth(depth int, args ...interface{})
				WarningDepth logs to WARNING log at the specified depth. Arguments are handled in the manner of fmt.Println.

			( DepthLoggerV2) Warningf(format string, args ...interface{})
				Warningf logs to WARNING log. Arguments are handled in the manner of fmt.Printf.

			( DepthLoggerV2) Warningln(args ...interface{})
				Warningln logs to WARNING log. Arguments are handled in the manner of fmt.Println.

		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*componentData
		Implements (at least 5, all are exported)
			 DepthLoggerV2 : LoggerV2
			 DepthLoggerV2 : google.golang.org/grpc/internal/grpclog.DepthLoggerV2
			 DepthLoggerV2 : google.golang.org/grpc/internal/grpclog.LoggerV2
			 DepthLoggerV2 : github.com/golang/mock/gomock.TestReporter
			 DepthLoggerV2 : go.uber.org/goleak.TestingT
		As Outputs Of (at least one exported)
			func Component(componentName string) DepthLoggerV2
		As Inputs Of (at least 7, all are exported)
			func google.golang.org/grpc/internal/channelz.AddTraceEvent(l DepthLoggerV2, id *channelz.Identifier, depth int, desc *channelz.TraceEventDesc)
			func google.golang.org/grpc/internal/channelz.Error(l DepthLoggerV2, id *channelz.Identifier, args ...interface{})
			func google.golang.org/grpc/internal/channelz.Errorf(l DepthLoggerV2, id *channelz.Identifier, format string, args ...interface{})
			func google.golang.org/grpc/internal/channelz.Info(l DepthLoggerV2, id *channelz.Identifier, args ...interface{})
			func google.golang.org/grpc/internal/channelz.Infof(l DepthLoggerV2, id *channelz.Identifier, format string, args ...interface{})
			func google.golang.org/grpc/internal/channelz.Warning(l DepthLoggerV2, id *channelz.Identifier, args ...interface{})
			func google.golang.org/grpc/internal/channelz.Warningf(l DepthLoggerV2, id *channelz.Identifier, format string, args ...interface{})
		As Types Of (total 11, none are exported)
			/* 11 unexporteds ... *//* 11 unexporteds: */
			  var google.golang.org/grpc.logger
			  var google.golang.org/grpc/balancer/base.logger
			  var google.golang.org/grpc/balancer/roundrobin.logger
			  var google.golang.org/grpc/connectivity.logger
			  var google.golang.org/grpc/internal/binarylog.grpclogLogger
			  var google.golang.org/grpc/internal/channelz.logger
			  var google.golang.org/grpc/internal/credentials.logger
			  var google.golang.org/grpc/internal/resolver/dns.logger
			  var google.golang.org/grpc/internal/serviceconfig.logger
			  var google.golang.org/grpc/internal/syscall.logger
			  var google.golang.org/grpc/internal/transport.logger

	 type Logger (interface)
		Logger mimics golang's standard Logger as an interface.

		Deprecated: use LoggerV2.

		Methods (total 6, all are exported)
			( Logger) Fatal(args ...interface{})
			( Logger) Fatalf(format string, args ...interface{})
			( Logger) Fatalln(args ...interface{})
			( Logger) Print(args ...interface{})
			( Logger) Printf(format string, args ...interface{})
			( Logger) Println(args ...interface{})
		Implemented By (at least 2, in which 1 are exported)
			*log.Logger
			/* at least one unexported ... *//* at least one unexported: */
			 loggerWrapper
		As Inputs Of (at least one exported)
			func SetLogger(l Logger)

	 type LoggerV2 (interface)
		LoggerV2 does underlying logging work for grpclog.

		Methods (total 13, all are exported)
			( LoggerV2) Error(args ...interface{})
				Error logs to ERROR log. Arguments are handled in the manner of fmt.Print.

			( LoggerV2) Errorf(format string, args ...interface{})
				Errorf logs to ERROR log. Arguments are handled in the manner of fmt.Printf.

			( LoggerV2) Errorln(args ...interface{})
				Errorln logs to ERROR log. Arguments are handled in the manner of fmt.Println.

			( LoggerV2) Fatal(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.

			( LoggerV2) Fatalf(format string, 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.

			( LoggerV2) Fatalln(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.

			( LoggerV2) Info(args ...interface{})
				Info logs to INFO log. Arguments are handled in the manner of fmt.Print.

			( LoggerV2) Infof(format string, args ...interface{})
				Infof logs to INFO log. Arguments are handled in the manner of fmt.Printf.

			( LoggerV2) Infoln(args ...interface{})
				Infoln logs to INFO log. Arguments are handled in the manner of fmt.Println.

			( LoggerV2) V(l int) bool
				V reports whether verbosity level l is at least the requested verbose level.

			( LoggerV2) Warning(args ...interface{})
				Warning logs to WARNING log. Arguments are handled in the manner of fmt.Print.

			( LoggerV2) Warningf(format string, args ...interface{})
				Warningf logs to WARNING log. Arguments are handled in the manner of fmt.Printf.

			( LoggerV2) Warningln(args ...interface{})
				Warningln logs to WARNING log. Arguments are handled in the manner of fmt.Println.

		Implemented By (at least 5, in which 2 are exported)
			 DepthLoggerV2 (interface)
			 google.golang.org/grpc/internal/grpclog.LoggerV2 (interface)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*componentData
			*loggerT
			*loggerWrapper
		Implements (at least 3, all are exported)
			 LoggerV2 : google.golang.org/grpc/internal/grpclog.LoggerV2
			 LoggerV2 : github.com/golang/mock/gomock.TestReporter
			 LoggerV2 : go.uber.org/goleak.TestingT
		As Outputs Of (at least 4, in which 2 are exported)
			func NewLoggerV2(infoW, warningW, errorW io.Writer) LoggerV2
			func NewLoggerV2WithVerbosity(infoW, warningW, errorW io.Writer, v int) LoggerV2
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func newLoggerV2() LoggerV2
			func newLoggerV2WithConfig(infoW, warningW, errorW io.Writer, c loggerV2Config) LoggerV2
		As Inputs Of (at least one exported)
			func SetLoggerV2(l LoggerV2)

	/* 4 unexporteds ... *//* 4 unexporteds: */
	 type componentData (struct)
		componentData records the settings for a component.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			name string
		Methods (total 17, all are exported)
			(*componentData) Error(args ...interface{})
			(*componentData) ErrorDepth(depth int, args ...interface{})
			(*componentData) Errorf(format string, args ...interface{})
			(*componentData) Errorln(args ...interface{})
			(*componentData) Fatal(args ...interface{})
			(*componentData) FatalDepth(depth int, args ...interface{})
			(*componentData) Fatalf(format string, args ...interface{})
			(*componentData) Fatalln(args ...interface{})
			(*componentData) Info(args ...interface{})
			(*componentData) InfoDepth(depth int, args ...interface{})
			(*componentData) Infof(format string, args ...interface{})
			(*componentData) Infoln(args ...interface{})
			(*componentData) V(l int) bool
			(*componentData) Warning(args ...interface{})
			(*componentData) WarningDepth(depth int, args ...interface{})
			(*componentData) Warningf(format string, args ...interface{})
			(*componentData) Warningln(args ...interface{})
		Implements (at least 6, all are exported)
			*componentData : DepthLoggerV2
			*componentData : LoggerV2
			*componentData : google.golang.org/grpc/internal/grpclog.DepthLoggerV2
			*componentData : google.golang.org/grpc/internal/grpclog.LoggerV2
			*componentData : github.com/golang/mock/gomock.TestReporter
			*componentData : go.uber.org/goleak.TestingT

	 type loggerT (struct)
		loggerT is the default logger used by grpclog.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			jsonFormat bool
			m []*log.Logger
			v int
		Methods (total 14, in which 13 are exported)
			(*loggerT) Error(args ...interface{})
			(*loggerT) Errorf(format string, args ...interface{})
			(*loggerT) Errorln(args ...interface{})
			(*loggerT) Fatal(args ...interface{})
			(*loggerT) Fatalf(format string, args ...interface{})
			(*loggerT) Fatalln(args ...interface{})
			(*loggerT) Info(args ...interface{})
			(*loggerT) Infof(format string, args ...interface{})
			(*loggerT) Infoln(args ...interface{})
			(*loggerT) V(l int) bool
			(*loggerT) Warning(args ...interface{})
			(*loggerT) Warningf(format string, args ...interface{})
			(*loggerT) Warningln(args ...interface{})
			/* one unexported ... *//* one unexported: */
			(*loggerT) output(severity int, s string)
		Implements (at least 4, all are exported)
			*loggerT : LoggerV2
			*loggerT : google.golang.org/grpc/internal/grpclog.LoggerV2
			*loggerT : github.com/golang/mock/gomock.TestReporter
			*loggerT : go.uber.org/goleak.TestingT

	 type loggerV2Config (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			jsonFormat bool
			verbose int
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newLoggerV2WithConfig(infoW, warningW, errorW io.Writer, c loggerV2Config) LoggerV2

	 type loggerWrapper (struct)
		loggerWrapper wraps Logger into a LoggerV2.

		Fields (only one, which is exported)
			Logger Logger
		Methods (total 16, all are exported)
			(*loggerWrapper) Error(args ...interface{})
			(*loggerWrapper) Errorf(format string, args ...interface{})
			(*loggerWrapper) Errorln(args ...interface{})
			( loggerWrapper) Fatal(args ...interface{})
			( loggerWrapper) Fatalf(format string, args ...interface{})
			( loggerWrapper) Fatalln(args ...interface{})
			(*loggerWrapper) Info(args ...interface{})
			(*loggerWrapper) Infof(format string, args ...interface{})
			(*loggerWrapper) Infoln(args ...interface{})
			( loggerWrapper) Print(args ...interface{})
			( loggerWrapper) Printf(format string, args ...interface{})
			( loggerWrapper) Println(args ...interface{})
			(*loggerWrapper) V(l int) bool
			(*loggerWrapper) Warning(args ...interface{})
			(*loggerWrapper) Warningf(format string, args ...interface{})
			(*loggerWrapper) Warningln(args ...interface{})
		Implements (at least 5, all are exported)
			 loggerWrapper : Logger
			*loggerWrapper : LoggerV2
			*loggerWrapper : google.golang.org/grpc/internal/grpclog.LoggerV2
			*loggerWrapper : github.com/golang/mock/gomock.TestReporter
			*loggerWrapper : go.uber.org/goleak.TestingT


Package-Level Functions (total 24, in which 21 are exported)

	 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.

	 func Error(args ...interface{})
		Error logs to the ERROR log.

	 func Errorf(format string, args ...interface{})
		Errorf logs to the ERROR log. Arguments are handled in the manner of fmt.Printf.

	 func Errorln(args ...interface{})
		Errorln logs to the ERROR log. Arguments are handled in the manner of fmt.Println.

	 func Fatal(args ...interface{})
		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(format string, args ...interface{})
		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(args ...interface{})
		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(args ...interface{})
		Info logs to the INFO log.

	 func Infof(format string, args ...interface{})
		Infof logs to the INFO log. Arguments are handled in the manner of fmt.Printf.

	 func Infoln(args ...interface{})
		Infoln logs to the INFO log. Arguments are handled in the manner of fmt.Println.

	 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(infoW, warningW, errorW io.Writer, v int) LoggerV2
		NewLoggerV2WithVerbosity creates a loggerV2 with the provided writers and
		verbosity level.

	 func Print(args ...interface{})
		Print prints to the logger. Arguments are handled in the manner of fmt.Print.

		Deprecated: use Info.

	 func Printf(format string, args ...interface{})
		Printf prints to the logger. Arguments are handled in the manner of fmt.Printf.

		Deprecated: use Infof.

	 func Println(args ...interface{})
		Println prints to the logger. Arguments are handled in the manner of fmt.Println.

		Deprecated: use Infoln.

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

		Deprecated: use 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(l int) bool
		V reports whether verbosity level l is at least the requested verbose level.

	 func Warning(args ...interface{})
		Warning logs to the WARNING log.

	 func Warningf(format string, args ...interface{})
		Warningf logs to the WARNING log. Arguments are handled in the manner of fmt.Printf.

	 func Warningln(args ...interface{})
		Warningln logs to the WARNING log. Arguments are handled in the manner of fmt.Println.

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func init()
	 func newLoggerV2() LoggerV2
		newLoggerV2 creates a loggerV2 to be used as default logger.
		All logs are written to stderr.

	 func newLoggerV2WithConfig(infoW, warningW, errorW io.Writer, c loggerV2Config) LoggerV2
Package-Level Variables (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var cache map[string]*componentData
	  var severityName []string
		severityName contains the string representation of each severity.


Package-Level Constants (total 4, none are exported)

	/* 4 unexporteds ... *//* 4 unexporteds: */
	const errorLog int = 2
		errorLog indicates Error severity.

	const fatalLog int = 3
		fatalLog indicates Fatal severity.

	const infoLog int = 0
		infoLog indicates Info severity.

	const warningLog int = 1
		warningLog indicates Warning severity.

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)