package internal

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

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	  d grpclog.go
		Package internal contains functionality internal to the grpclog package.

	    logger.go
	    loggerv2.go
Package-Level Type Names (total 6, in which 5 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 ...any)
				Error logs to ERROR log. Arguments are handled in the manner of fmt.Print.

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

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

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

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

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

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

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

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

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

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

			( DepthLoggerV2) Infoln(args ...any)
				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 ...any)
				Warning logs to WARNING log. Arguments are handled in the manner of fmt.Print.

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

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

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

		Implemented By (at least 2, in which 1 is exported)
			 google.golang.org/grpc/grpclog.DepthLoggerV2 (interface)
			/* at least one unexported ... *//* at least one unexported: */
			*google.golang.org/grpc/grpclog.componentData
		Implements (at least 5, all are exported)
			 DepthLoggerV2 : LoggerV2
			 DepthLoggerV2 : google.golang.org/grpc/grpclog.DepthLoggerV2
			 DepthLoggerV2 : google.golang.org/grpc/grpclog.LoggerV2
			 DepthLoggerV2 : go.uber.org/goleak.TestingT
			 DepthLoggerV2 : go.uber.org/mock/gomock.TestReporter
		As Types Of (only one, which is exported)
			  var DepthLoggerV2Impl

	 type Logger (interface)
		Logger mimics golang's standard Logger as an interface.
		
		Deprecated: use LoggerV2.

		Methods (total 6, all are exported)
			( Logger) Fatal(args ...any)
			( Logger) Fatalf(format string, args ...any)
			( Logger) Fatalln(args ...any)
			( Logger) Print(args ...any)
			( Logger) Printf(format string, args ...any)
			( Logger) Println(args ...any)
		Implemented By (at least 3, all are exported)
			 LoggerWrapper
			 google.golang.org/grpc/grpclog.Logger (interface)
			*log.Logger
		Implements (at least one exported)
			 Logger : google.golang.org/grpc/grpclog.Logger

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

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

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

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

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

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

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

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

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

			( LoggerV2) Infoln(args ...any)
				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 ...any)
				Warning logs to WARNING log. Arguments are handled in the manner of fmt.Print.

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

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

		Implemented By (at least 6, in which 4 are exported)
			 DepthLoggerV2 (interface)
			*LoggerWrapper
			 google.golang.org/grpc/grpclog.DepthLoggerV2 (interface)
			 google.golang.org/grpc/grpclog.LoggerV2 (interface)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*loggerT
			*google.golang.org/grpc/grpclog.componentData
		Implements (at least 3, all are exported)
			 LoggerV2 : google.golang.org/grpc/grpclog.LoggerV2
			 LoggerV2 : go.uber.org/goleak.TestingT
			 LoggerV2 : go.uber.org/mock/gomock.TestReporter
		As Outputs Of (at least one exported)
			func NewLoggerV2(infoW, warningW, errorW io.Writer, c LoggerV2Config) LoggerV2
		As Types Of (only one, which is exported)
			  var LoggerV2Impl

	 type LoggerV2Config (struct)
		LoggerV2Config configures the LoggerV2 implementation.

		Fields (total 2, both are exported)
			FormatJSON bool
				FormatJSON controls whether the logger should output logs in JSON format.

			Verbosity int
				Verbosity sets the verbosity level of the logger.

		As Inputs Of (at least one exported)
			func NewLoggerV2(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 ...any)
				Error logs to ERROR log. Arguments are handled in the manner of fmt.Print.

			(*LoggerWrapper) Errorf(format string, args ...any)
				Errorf logs to ERROR log. Arguments are handled in the manner of fmt.Printf.

			(*LoggerWrapper) Errorln(args ...any)
				Errorln logs to ERROR log. Arguments are handled in the manner of fmt.Println.

			( LoggerWrapper) Fatal(args ...any)
			( LoggerWrapper) Fatalf(format string, args ...any)
			( LoggerWrapper) Fatalln(args ...any)
			(*LoggerWrapper) Info(args ...any)
				Info logs to INFO log. Arguments are handled in the manner of fmt.Print.

			(*LoggerWrapper) Infof(format string, args ...any)
				Infof logs to INFO log. Arguments are handled in the manner of fmt.Printf.

			(*LoggerWrapper) Infoln(args ...any)
				Infoln logs to INFO log. Arguments are handled in the manner of fmt.Println.

			( LoggerWrapper) Print(args ...any)
			( LoggerWrapper) Printf(format string, args ...any)
			( LoggerWrapper) Println(args ...any)
			(*LoggerWrapper) V(int) bool
				V reports whether verbosity level l is at least the requested verbose level.

			(*LoggerWrapper) Warning(args ...any)
				Warning logs to WARNING log. Arguments are handled in the manner of fmt.Print.

			(*LoggerWrapper) Warningf(format string, args ...any)
				Warningf logs to WARNING log. Arguments are handled in the manner of fmt.Printf.

			(*LoggerWrapper) Warningln(args ...any)
				Warningln logs to WARNING log. Arguments are handled in the manner of fmt.Println.

		Implements (at least 6, all are exported)
			 LoggerWrapper : Logger
			*LoggerWrapper : LoggerV2
			 LoggerWrapper : google.golang.org/grpc/grpclog.Logger
			*LoggerWrapper : google.golang.org/grpc/grpclog.LoggerV2
			*LoggerWrapper : go.uber.org/goleak.TestingT
			*LoggerWrapper : go.uber.org/mock/gomock.TestReporter

	/* one unexported ... *//* one unexported: */
	 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 17, in which 13 are exported)
			(*loggerT) Error(args ...any)
			(*loggerT) Errorf(format string, args ...any)
			(*loggerT) Errorln(args ...any)
			(*loggerT) Fatal(args ...any)
			(*loggerT) Fatalf(format string, args ...any)
			(*loggerT) Fatalln(args ...any)
			(*loggerT) Info(args ...any)
			(*loggerT) Infof(format string, args ...any)
			(*loggerT) Infoln(args ...any)
			(*loggerT) V(l int) bool
			(*loggerT) Warning(args ...any)
			(*loggerT) Warningf(format string, args ...any)
			(*loggerT) Warningln(args ...any)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			(*loggerT) output(severity int, s string)
			(*loggerT) print(severity int, v ...any)
			(*loggerT) printf(severity int, format string, args ...any)
			(*loggerT) println(severity int, v ...any)
		Implements (at least 4, all are exported)
			*loggerT : LoggerV2
			*loggerT : google.golang.org/grpc/grpclog.LoggerV2
			*loggerT : go.uber.org/goleak.TestingT
			*loggerT : go.uber.org/mock/gomock.TestReporter


Package-Level Functions (total 2, in which 1 is exported)

	 func NewLoggerV2(infoW, warningW, errorW io.Writer, c LoggerV2Config) LoggerV2
		NewLoggerV2 creates a new LoggerV2 instance with the provided configuration.
		The infoW, warningW, and errorW writers are used to write log messages of
		different severity levels.

	/* one unexported ... *//* one unexported: */
	 func combineLoggers(lower, higher io.Writer) io.Writer
		combineLoggers returns a combined logger for both higher & lower severity logs,
		or only one if the other is io.Discard.
		
		This uses io.Discard instead of io.MultiWriter when all loggers
		are set to io.Discard. Both this package and the standard log package have
		significant optimizations for io.Discard, which io.MultiWriter lacks (as of
		this writing).


Package-Level Variables (total 7, in which 2 are exported)

	  var DepthLoggerV2Impl DepthLoggerV2
		DepthLoggerV2Impl is the logger used for the depth log functions.

	  var LoggerV2Impl LoggerV2
		LoggerV2Impl is the logger used for the non-depth log functions.

	/* 5 unexporteds ... *//* 5 unexporteds: */
	  var exit func(code int)
		exit is os.Exit.
		This var exists to make it possible to test functions calling os.Exit.

	  var severityName []string
		severityName contains the string representation of each severity.

	  var sprint func(a ...interface{}) string
		sprint is fmt.Sprint.
		These vars exist to make it possible to test that expensive format calls aren't made unnecessarily.

	  var sprintf func(format string, a ...interface{}) string
		sprintf is fmt.Sprintf.
		These vars exist to make it possible to test that expensive format calls aren't made unnecessarily.

	  var sprintln func(a ...interface{}) string
		sprintln is fmt.Sprintln.
		These vars exist to make it possible to test that expensive format calls aren't made unnecessarily.


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.7.6. (GOOS=linux GOARCH=amd64)