package log

Import Path
	golang.org/x/pkgsite/internal/log (on go.dev)

Dependency Relation
	imports 11 packages, and imported by 17 packages

Involved Source Files

	   d➜ log.go
		Package log supports structured and unstructured logging with levels.
Package-Level Type Names (total 4, none are exported)

	/* sort exporteds by: alphabet | popularity */
	/* 4 unexporteds ... *//* 4 unexporteds: */
	 type labelsKey (struct)
		labelsKey is the type of the context key for labels.


	 type stackdriverLogger (struct)
		stackdriverLogger logs to GCP Stackdriver.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			sdlogger *logging.Logger
		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			(*T) log(ctx context.Context, s logging.Severity, payload interface{})

	 type stdlibLogger (struct)
		stdlibLogger uses the Go standard library logger.

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			( T) log(ctx context.Context, s logging.Severity, payload interface{})

	 type traceIDKey (struct)
		traceIDKey is the type of the context key for trace IDs.



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

	 func Debug(ctx context.Context, arg interface{})
		Debug logs arg, which can be a string or a struct, at the Debug level.

	 func Debugf(ctx context.Context, format string, args ...interface{})
		Debugf logs a formatted string at the Debug level.

	 func Error(ctx context.Context, arg interface{})
		Error logs arg, which can be a string or a struct, at the Error level.

	 func Errorf(ctx context.Context, format string, args ...interface{})
		Errorf logs a formatted string at the Error level.

	 func Fatal(ctx context.Context, arg interface{})
		Fatal logs arg, which can be a string or a struct, at the Critical level followed by exiting the program.

	 func Fatalf(ctx context.Context, format string, args ...interface{})
		Fatalf logs formatted string at the Critical level followed by exiting the program.

	 func Info(ctx context.Context, arg interface{})
		Info logs arg, which can be a string or a struct, at the Info level.

	 func Infof(ctx context.Context, format string, args ...interface{})
		Infof logs a formatted string at the Info level.

	 func NewContextWithLabel(ctx context.Context, key, value string) context.Context
		NewContextWithLabel creates anew context from ctx that adds a label that will
		appear in the log entry.

	 func NewContextWithTraceID(ctx context.Context, traceID string) context.Context
		NewContextWithTraceID creates a new context from ctx that adds the trace ID.

	 func SetLevel(v string)
		Set the log level

	 func UseStackdriver(ctx context.Context, cfg *config.Config, logName string) (_ *logging.Logger, err error)
		UseStackdriver switches from the default stdlib logger to a Stackdriver
		logger. It assumes config.Init has been called. UseStackdriver returns a
		"parent" *logging.Logger that should be used to log the start and end of a
		request. It also creates and remembers internally a "child" logger that will
		be used to log within a request. The two loggers are necessary to get request-scoped
		logs in Stackdriver.
		See https://cloud.google.com/appengine/docs/standard/go/writing-application-logs.

		UseStackdriver can only be called once. If it is called a second time, it returns an error.

	 func Warning(ctx context.Context, arg interface{})
		Warning logs arg, which can be a string or a struct, at the Warning level.

	 func Warningf(ctx context.Context, format string, args ...interface{})
		Warningf logs a formatted string at the Warning level.

	/* 7 unexporteds ... *//* 7 unexporteds: */
	 func die()
	 func doLog(ctx context.Context, s logging.Severity, payload interface{})
	 func experimentString(ctx context.Context) string
	 func getLevel() logging.Severity
	 func init()
	 func logf(ctx context.Context, s logging.Severity, format string, args []interface{})
	 func toLevel(v string) logging.Severity
		toLevel returns the logging.Severity for a given string.
		Possible input values are "", "debug", "info", "warning", "error", "fatal".
		In case of invalid string input, it maps to DefaultLevel.


Package-Level Variables (total 3, none are exported)

	/* 3 unexporteds ... *//* 3 unexporteds: */
	  var currentLevel logging.Severity
		currentLevel holds current log level.
		No logs will be printed below currentLevel.

	  var logger interface{log(context.Context, logging.Severity, interface{})}
	  var mu sync.Mutex

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.