package capnslog

Import Path
	github.com/coreos/pkg/capnslog (on go.dev)

Dependency Relation
	imports 16 packages, and imported by one package

Involved Source Files

	    formatters.go
	    glog_formatter.go
	    init.go
	    journald_formatter.go
	    log_hijack.go
	    logmap.go
	    pkg_logger.go
	    syslog_formatter.go
Package-Level Type Names (total 9)

	/* sort by: alphabet | popularity */
	 type Formatter (interface)

		Methods (total 2)
			( Formatter) Flush()
			( Formatter) Format(pkg string, level LogLevel, depth int, entries ...interface{})
		Implemented By (at least 5)
			*GlogFormatter
			*LogFormatter
			*NilFormatter
			*PrettyFormatter
			*StringFormatter
		Implements (at least one exported)
			 Formatter : net/http.Flusher
		As Outputs Of (at least 8)
			func NewDefaultFormatter(out io.Writer) Formatter
			func NewDefaultSyslogFormatter(tag string) (Formatter, error)
			func NewJournaldFormatter() (Formatter, error)
			func NewLogFormatter(w io.Writer, prefix string, flag int) Formatter
			func NewNilFormatter() Formatter
			func NewPrettyFormatter(w io.Writer, debug bool) Formatter
			func NewStringFormatter(w io.Writer) Formatter
			func NewSyslogFormatter(w *syslog.Writer) Formatter
		As Inputs Of (at least one exported)
			func SetFormatter(f Formatter)

	 type GlogFormatter (struct)

		Fields (only one)
			StringFormatter StringFormatter
		Methods (total 2)
			(*GlogFormatter) Flush()
			( GlogFormatter) Format(pkg string, level LogLevel, depth int, entries ...interface{})
		Implements (at least 2)
			*GlogFormatter : Formatter
			*GlogFormatter : net/http.Flusher
		As Outputs Of (at least one exported)
			func NewGlogFormatter(w io.Writer) *GlogFormatter

	 type LogFormatter (struct)
		LogFormatter emulates the form of the traditional built-in logger.

		Methods (total 2)
			(*LogFormatter) Flush()
				Flush is included so that the interface is complete, but is a no-op.

			(*LogFormatter) Format(pkg string, _ LogLevel, _ int, entries ...interface{})
				Format builds a log message for the LogFormatter. The LogLevel is ignored.

		Implements (at least 2)
			*LogFormatter : Formatter
			*LogFormatter : net/http.Flusher

	 type LogLevel int8 (basic type)
		LogLevel is the set of all log levels.

		Methods (total 4)
			( LogLevel) Char() string
				Char returns a single-character representation of the log level.

			(*LogLevel) Set(s string) error
				Update using the given string value. Fulfills the flag.Value interface.

			( LogLevel) String() string
				String returns a multi-character representation of the log level.

			(*LogLevel) Type() string
				Returns an empty string, only here to fulfill the pflag.Value interface.

		Implements (at least 4)
			*LogLevel : github.com/spf13/pflag.Value
			 LogLevel : expvar.Var
			*LogLevel : flag.Value
			 LogLevel : fmt.Stringer
		As Outputs Of (at least 2)
			func ParseLevel(s string) (LogLevel, error)
			func RepoLogger.ParseLogLevelConfig(conf string) (map[string]LogLevel, error)
		As Inputs Of (at least 14)
			func GlogHeader(level LogLevel, depth int) []byte
			func SetGlobalLogLevel(l LogLevel)
			func Formatter.Format(pkg string, level LogLevel, depth int, entries ...interface{})
			func GlogFormatter.Format(pkg string, level LogLevel, depth int, entries ...interface{})
			func (*LogFormatter).Format(pkg string, _ LogLevel, _ int, entries ...interface{})
			func (*NilFormatter).Format(_ string, _ LogLevel, _ int, _ ...interface{})
			func (*PackageLogger).LevelAt(l LogLevel) bool
			func (*PackageLogger).Log(l LogLevel, args ...interface{})
			func (*PackageLogger).Logf(l LogLevel, format string, args ...interface{})
			func (*PackageLogger).SetLevel(l LogLevel)
			func (*PrettyFormatter).Format(pkg string, l LogLevel, depth int, entries ...interface{})
			func RepoLogger.SetLogLevel(m map[string]LogLevel)
			func RepoLogger.SetRepoLogLevel(l LogLevel)
			func (*StringFormatter).Format(pkg string, l LogLevel, i int, entries ...interface{})
		As Types Of (total 7)
			const CRITICAL
			const DEBUG
			const ERROR
			const INFO
			const NOTICE
			const TRACE
			const WARNING

	 type NilFormatter (struct)
		NilFormatter is a no-op log formatter that does nothing.

		Methods (total 2)
			(*NilFormatter) Flush()
				Flush is included so that the interface is complete, but is a no-op.

			(*NilFormatter) Format(_ string, _ LogLevel, _ int, _ ...interface{})
				Format does nothing.

		Implements (at least 2)
			*NilFormatter : Formatter
			*NilFormatter : net/http.Flusher

	 type PackageLogger (struct)

		Methods (total 26)
			(*PackageLogger) Debug(entries ...interface{})
			(*PackageLogger) Debugf(format string, args ...interface{})
			(*PackageLogger) Error(entries ...interface{})
			(*PackageLogger) Errorf(format string, args ...interface{})
			(*PackageLogger) Fatal(args ...interface{})
			(*PackageLogger) Fatalf(format string, args ...interface{})
			(*PackageLogger) Fatalln(args ...interface{})
			(*PackageLogger) Flush()
			(*PackageLogger) Info(entries ...interface{})
			(*PackageLogger) Infof(format string, args ...interface{})
			(*PackageLogger) LevelAt(l LogLevel) bool
				LevelAt checks if the given log level will be outputted under current setting.

			(*PackageLogger) Log(l LogLevel, args ...interface{})
				Log a message at any level between ERROR and TRACE

			(*PackageLogger) Logf(l LogLevel, format string, args ...interface{})
				Log a formatted string at any level between ERROR and TRACE

			(*PackageLogger) Notice(entries ...interface{})
			(*PackageLogger) Noticef(format string, args ...interface{})
			(*PackageLogger) Panic(args ...interface{})
			(*PackageLogger) Panicf(format string, args ...interface{})
			(*PackageLogger) Panicln(args ...interface{})
			(*PackageLogger) Print(args ...interface{})
			(*PackageLogger) Printf(format string, args ...interface{})
			(*PackageLogger) Println(args ...interface{})
			(*PackageLogger) SetLevel(l LogLevel)
				SetLevel allows users to change the current logging level.

			(*PackageLogger) Trace(entries ...interface{})
			(*PackageLogger) Tracef(format string, args ...interface{})
			(*PackageLogger) Warning(entries ...interface{})
			(*PackageLogger) Warningf(format string, args ...interface{})
		Implements (at least 7)
			*PackageLogger : github.com/go-sql-driver/mysql.Logger
			*PackageLogger : github.com/stretchr/testify/assert.TestingT
			*PackageLogger : go.uber.org/fx.Printer
			*PackageLogger : google.golang.org/grpc/grpclog.Logger
			*PackageLogger : google.golang.org/grpc/grpclog/internal.Logger
			*PackageLogger : gorm.io/gorm/logger.Writer
			*PackageLogger : net/http.Flusher
		As Outputs Of (at least one exported)
			func NewPackageLogger(repo string, pkg string) (p *PackageLogger)

	 type PrettyFormatter (struct)

		Methods (total 2)
			(*PrettyFormatter) Flush()
			(*PrettyFormatter) Format(pkg string, l LogLevel, depth int, entries ...interface{})
		Implements (at least 2)
			*PrettyFormatter : Formatter
			*PrettyFormatter : net/http.Flusher

	 type RepoLogger (map)

		Methods (total 3)
			( RepoLogger) ParseLogLevelConfig(conf string) (map[string]LogLevel, error)
				ParseLogLevelConfig parses a comma-separated string of "package=loglevel", in
				order, and returns a map of the results, for use in SetLogLevel.

			( RepoLogger) SetLogLevel(m map[string]LogLevel)
				SetLogLevel takes a map of package names within a repository to their desired
				loglevel, and sets the levels appropriately. Unknown packages are ignored.
				"*" is a special package name that corresponds to all packages, and will be
				processed first.

			( RepoLogger) SetRepoLogLevel(l LogLevel)
				SetRepoLogLevel sets the log level for all packages in the repository.

		As Outputs Of (at least 2)
			func GetRepoLogger(repo string) (RepoLogger, error)
			func MustRepoLogger(repo string) RepoLogger

	 type StringFormatter (struct)

		Methods (total 2)
			(*StringFormatter) Flush()
			(*StringFormatter) Format(pkg string, l LogLevel, i int, entries ...interface{})
		Implements (at least 2)
			*StringFormatter : Formatter
			*StringFormatter : net/http.Flusher


Package-Level Functions (total 16)

	 func GetRepoLogger(repo string) (RepoLogger, error)
		GetRepoLogger may return the handle to the repository's set of packages' loggers.

	 func GlogHeader(level LogLevel, depth int) []byte
	 func MustRepoLogger(repo string) RepoLogger
		MustRepoLogger returns the handle to the repository's packages' loggers.

	 func NewDefaultFormatter(out io.Writer) Formatter
	 func NewDefaultSyslogFormatter(tag string) (Formatter, error)
	 func NewGlogFormatter(w io.Writer) *GlogFormatter
	 func NewJournaldFormatter() (Formatter, error)
	 func NewLogFormatter(w io.Writer, prefix string, flag int) Formatter
		NewLogFormatter is a helper to produce a new LogFormatter struct. It uses the
		golang log package to actually do the logging work so that logs look similar.

	 func NewNilFormatter() Formatter
		NewNilFormatter is a helper to produce a new LogFormatter struct. It logs no
		messages so that you can cause part of your logging to be silent.

	 func NewPackageLogger(repo string, pkg string) (p *PackageLogger)
		NewPackageLogger creates a package logger object.
		This should be defined as a global var in your package, referencing your repo.

	 func NewPrettyFormatter(w io.Writer, debug bool) Formatter
	 func NewStringFormatter(w io.Writer) Formatter
	 func NewSyslogFormatter(w *syslog.Writer) Formatter
	 func ParseLevel(s string) (LogLevel, error)
		ParseLevel translates some potential loglevel strings into their corresponding levels.

	 func SetFormatter(f Formatter)
		SetFormatter sets the formatting function for all logs.

	 func SetGlobalLogLevel(l LogLevel)
		SetGlobalLogLevel sets the log level for all packages in all repositories
		registered with capnslog.


Package-Level Constants (total 7)

	const CRITICAL LogLevel = -1
		CRITICAL is the lowest log level; only errors which will end the program will be propagated.

	const DEBUG LogLevel = 4
		DEBUG is the default hidden level for more verbose updates about internal processes.

	const ERROR LogLevel = 0
		ERROR is for errors that are not fatal but lead to troubling behavior.

	const INFO LogLevel = 3
		INFO is a log level for common, everyday log updates.

	const NOTICE LogLevel = 2
		NOTICE is for normal but significant conditions.

	const TRACE LogLevel = 5
		TRACE is for (potentially) call by call tracing of programs.

	const WARNING LogLevel = 1
		WARNING is for errors which are not fatal and not errors, but are unusual. Often sourced from misconfigurations.

The pages are generated with Golds v0.8.2. (GOOS=linux 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 @zigo_101 (reachable from the left QR code) to get the latest news of Golds.