logging

package
v0.7.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 25, 2024 License: MIT Imports: 24 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	FieldLevel   = "level"
	FieldMessage = "msg"
	FieldTime    = "time"
)
View Source 
const (
	JobField    string = "job"
	SubsysField string = "subsystem"
	SpanField   string = "span"
)
View Source 
const HumanFormatterDateFormat = time.RFC3339

Variables

View Source 
var AllSubsystems = []Subsystem{
	SubsysCron,
	SubsysMeta,
	SubsysJob,
	SubsysReplication,
	SubsysEndpoint,
	SubsysPruning,
	SubsysSnapshot,
	SubsysHooks,
	SubsysTransport,
	SubsysTransportMux,
	SubsysRPC,
	SubsysRPCControl,
	SubsysRPCData,
	SubsysZFSCmd,
	SubsysTraceData,
	SubsysPlatformtest,
}

Functions

func GetLogger added in v0.7.4 

func GetLogger(ctx context.Context, subsys Subsystem) logger.Logger

func OutletsFromConfig 

func OutletsFromConfig(in config.LoggingOutletEnumList) (*logger.Outlets, error)

func ParseOutlet added in v0.7.4 

func ParseOutlet(in config.LoggingOutletEnum) (o logger.Outlet, level logger.Level, err error)

func WithInherit added in v0.7.4 

func WithInherit(ctx, inheritFrom context.Context) context.Context

func WithInjectedField added in v0.7.4 

func WithInjectedField(ctx context.Context, field string, value interface{}) context.Context

func WithLoggers added in v0.7.4 

func WithLoggers(ctx context.Context, loggers SubsystemLoggers) context.Context

Types

type EntryFormatter 

type EntryFormatter interface {
	SetMetadataFlags(flags MetadataFlags)
	Format(e *logger.Entry) ([]byte, error)
	Write(w io.Writer, e *logger.Entry) error
}

type FileOutlet added in v0.7.4 

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

func (*FileOutlet) WithFormatter added in v0.7.4 

func (self *FileOutlet) WithFormatter(f EntryFormatter) *FileOutlet

func (*FileOutlet) WithWriter added in v0.7.4 

func (self *FileOutlet) WithWriter(w io.Writer) *FileOutlet

func (*FileOutlet) WriteEntry added in v0.7.4 

func (self *FileOutlet) WriteEntry(e logger.Entry) error

type HumanFormatter 

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

func (*HumanFormatter) Format 

func (f *HumanFormatter) Format(e *logger.Entry) (out []byte, err error)

func (*HumanFormatter) SetIgnoreFields 

func (f *HumanFormatter) SetIgnoreFields(ignore []string)

func (*HumanFormatter) SetMetadataFlags 

func (f *HumanFormatter) SetMetadataFlags(flags MetadataFlags)

func (*HumanFormatter) Write added in v0.7.4 

func (f *HumanFormatter) Write(w io.Writer, e *logger.Entry) error

type LogfmtFormatter 

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

func (*LogfmtFormatter) Format 

func (f *LogfmtFormatter) Format(e *logger.Entry) ([]byte, error)

func (*LogfmtFormatter) SetMetadataFlags 

func (f *LogfmtFormatter) SetMetadataFlags(flags MetadataFlags)

func (*LogfmtFormatter) Write added in v0.7.4 

func (f *LogfmtFormatter) Write(w io.Writer, e *logger.Entry) error

type MetadataFlags 

type MetadataFlags int64
const (
	MetadataTime MetadataFlags = 1 << iota
	MetadataLevel
	MetadataColor

	MetadataNone MetadataFlags = 0
	MetadataAll  MetadataFlags = ^0
)

type NoFormatter 

type NoFormatter struct{}

func (NoFormatter) Format 

func (f NoFormatter) Format(e *logger.Entry) ([]byte, error)

func (NoFormatter) SetMetadataFlags 

func (f NoFormatter) SetMetadataFlags(flags MetadataFlags)

func (NoFormatter) Write added in v0.7.4 

func (f NoFormatter) Write(w io.Writer, e *logger.Entry) error

type SlogFormatter added in v0.7.4 

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

func NewSlogFormatter added in v0.7.4 

func NewSlogFormatter() *SlogFormatter

func (*SlogFormatter) Format added in v0.7.4 

func (self *SlogFormatter) Format(e *logger.Entry) ([]byte, error)

func (*SlogFormatter) SetMetadataFlags added in v0.7.4 

func (self *SlogFormatter) SetMetadataFlags(f MetadataFlags)

func (*SlogFormatter) WithHideFields added in v0.7.4 

func (self *SlogFormatter) WithHideFields(fields []string) *SlogFormatter

func (*SlogFormatter) WithJsonHandler added in v0.7.4 

func (self *SlogFormatter) WithJsonHandler() *SlogFormatter

func (*SlogFormatter) WithLevel added in v0.7.4 

func (self *SlogFormatter) WithLevel(l logger.Level) *SlogFormatter

func (*SlogFormatter) WithLogTime added in v0.7.4 

func (self *SlogFormatter) WithLogTime(enable bool) *SlogFormatter

func (*SlogFormatter) WithTextHandler added in v0.7.4 

func (self *SlogFormatter) WithTextHandler() *SlogFormatter

func (*SlogFormatter) Write added in v0.7.4 

func (self *SlogFormatter) Write(w io.Writer, e *logger.Entry) error

type Subsystem 

type Subsystem string
const (
	SubsysCron         Subsystem = "cron"
	SubsysMeta         Subsystem = "meta"
	SubsysJob          Subsystem = "job"
	SubsysReplication  Subsystem = "repl"
	SubsysEndpoint     Subsystem = "endpoint"
	SubsysPruning      Subsystem = "pruning"
	SubsysSnapshot     Subsystem = "snapshot"
	SubsysHooks        Subsystem = "hook"
	SubsysTransport    Subsystem = "transport"
	SubsysTransportMux Subsystem = "transportmux"
	SubsysRPC          Subsystem = "rpc"
	SubsysRPCControl   Subsystem = "rpc.ctrl"
	SubsysRPCData      Subsystem = "rpc.data"
	SubsysZFSCmd       Subsystem = "zfs.cmd"
	SubsysTraceData    Subsystem = "trace.data"
	SubsysPlatformtest Subsystem = "platformtest"
)

type SubsystemLoggers added in v0.7.4 

type SubsystemLoggers map[Subsystem]logger.Logger

func GetLoggers added in v0.7.4 

func GetLoggers(ctx context.Context) SubsystemLoggers

func SubsystemLoggersWithUniversalLogger added in v0.7.4 

func SubsystemLoggersWithUniversalLogger(l logger.Logger) SubsystemLoggers

type SyslogOutlet 

type SyslogOutlet struct {
	Formatter     EntryFormatter
	RetryInterval time.Duration
	Facility      syslog.Priority
	// contains filtered or unexported fields
}

func (*SyslogOutlet) WriteEntry 

func (o *SyslogOutlet) WriteEntry(entry logger.Entry) error

type TCPOutlet 

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

func NewTCPOutlet 

func NewTCPOutlet(formatter EntryFormatter, network, address string, tlsConfig *tls.Config, retryInterval time.Duration) *TCPOutlet

func (*TCPOutlet) Close 

func (h *TCPOutlet) Close()

FIXME: use this method

func (*TCPOutlet) WriteEntry 

func (h *TCPOutlet) WriteEntry(e logger.Entry) error

type WriterOutlet 

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

func (WriterOutlet) WriteEntry 

func (h WriterOutlet) WriteEntry(entry logger.Entry) error

Source Files

View all Source files

Directories

Path Synopsis
package trace provides activity tracing via ctx through Tasks and Spans
 package trace provides activity tracing via ctx through Tasks and Spans

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.