log

package
v5.0.0-...-0681bf2 Latest Latest
Warning

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

 Go to latest Published: Dec 30, 2024 License: AGPL-3.0 Imports: 20 Imported by: 0

README

Pydio LOG

Pydio relies on zap logging framework.

We mainly use 2 loggers that are defined in this package and used throughout the backend:

  • A syslog logger: it should be used to log technical information.
  • An audit logger: it only logs some very precise information at strategic places and is used to monitor the Application from a business point of view. Audit logs are among others used for GRDP compliance.

WARNING: you should not modify nor remove any of the audit log.

Guidelines

  • When enriching the log with zap fields, always use constants from common/zapfields.go as keys, otherwise the logs won't be usable for analysis
  • Pydio provides some shortcuts to easily generate zap fields for commons pydio objects. Typically when loging info about a tree.Node, one should write: ...Debug("A message", node.Zap())
  • Depending on the level of details required, one can either use Zap() that serializes all accessible information or ZapPath(), ZapUuid() or ZapId() (depending on the relevant info) that simply calls zap.String() with relevant pydio zap id (as seen in common/zapfields.go) and corresponding value.

Conventions

  • it is idiomatic in Go to write error message that start with a lower case letter and do not end with a punctuation mark.

Documentation

Overview

Package log define and configure the Pydio loggers based on zap.

We mainly use 2 loggers that are defined in this package and used throughout the backend: - A syslog logger: it should be used to log technical information. - An audit logger: it only logs some very precise information at strategic places and is used to monitor the Application from a business point of view. Audit logs are among others used for GRDP compliance.

WARNING: you should not modify nor remove any of the audit log.

Index

Constants

View Source 
const (
	ConsoleColorRest  = 32
	ConsoleColorGrpc  = 35
	ConsoleColorOther = 36
)

Variables

View Source 
var (
	JSONEncoder    zapcore.Encoder
	ConsoleEncoder zapcore.Encoder
)
View Source 
var (
	EncoderHttpMetaKeys []string

	ConsoleSkipKeys = []string{

		common.KeySpanOtel,
		common.KeySpanUuid,
		common.KeySpanRootUuid,
		common.KeySpanParentUuid,
		common.KeySchedulerJobId,
		common.KeySchedulerActionPath,
		common.KeySchedulerActionTags,
		common.KeySchedulerTaskId,

		common.KeyUsername,
		common.KeyUserUuid,
		common.KeyGroupPath,
		common.KeyProfile,
		common.KeyRoles,
	}
)
View Source 
var (
	ReadyLogSyncerContext context.Context

	StdOut *os.File
)
View Source 
var (
	EmptyServiceKey = "empty"
)

Functions

func DangerouslyZapSmallSlice 

func DangerouslyZapSmallSlice(key string, value interface{}) zapcore.Field

DangerouslyZapSmallSlice is a simple clone for zap.Any, allowing the linter to consider the slice zap as legitimate. It informs the developer to make sure that the slice passed must be small, otherwise it can hang the internal logger

func Debug 

func Debug(msg string, fields ...zapcore.Field)

func Error 

func Error(msg string, fields ...zapcore.Field)

func Fatal 

func Fatal(msg string, fields ...zapcore.Field)

func GetAuditId 

func GetAuditId(msgId string) zapcore.Field

GetAuditId simply returns a zap field that contains this message id to ease audit log analysis.

func Info 

func Info(msg string, fields ...zapcore.Field)

func Init 

func Init(svc otel.Service, conf []LoggerConfig, ww ...ContextWrapper)

Init for the log package - called by the main

func LoadCores 

func LoadCores(ctx context.Context, svc otel.Service, cfg []LoggerConfig) (cores []zapcore.Core, closers []io.Closer, hasDebug bool)

func RFC3369TimeEncoder 

func RFC3369TimeEncoder(t time.Time, enc zapcore.PrimitiveArrayEncoder)

RFC3369TimeEncoder serializes a time.Time to an RFC3339-formatted string

func RegisterConsoleNamedColor 

func RegisterConsoleNamedColor(serviceName string, color int)

RegisterConsoleNamedColor allows external registration of colors based on Logger Name.

func RegisterWriteSyncer 

func RegisterWriteSyncer(syncer LoggerConfig)

RegisterWriteSyncer optional writers for logs

func ReloadMainLogger 

func ReloadMainLogger(scv otel.Service, cfg []LoggerConfig)

ReloadMainLogger passes an updated config and force logger reset

func SetAuditerInit 

func SetAuditerInit(f LoggerInitializer, globalConnInit func(ctx context.Context))

SetAuditerInit defines what function to use to init the auditer

func SetDynamicDebugLevels 

func SetDynamicDebugLevels(reset, level bool, services ...string)

SetDynamicDebugLevels overrides Info level for a specific subset of services

func SetLoggerInit 

func SetLoggerInit(f LoggerInitializer, globalConnInit func(ctx context.Context))

SetLoggerInit defines what function to use to init the logger

func SetSkipServerSync 

func SetSkipServerSync()

SetSkipServerSync can disable the core syncing to cells service Must be called before initialization

func SetTasksLoggerInit 

func SetTasksLoggerInit(f LoggerInitializer, globalConnInit func(ctx context.Context))

SetTasksLoggerInit defines what function to use to init the tasks logger

func Warn 

func Warn(msg string, fields ...zapcore.Field)

Types

type ContextWrapper 

type ContextWrapper func(ctx context.Context, logger ZapLogger, fields ...zapcore.Field) ZapLogger

type CoreCloser 

type CoreCloser interface {
	zapcore.Core
	io.Closer
}

type CoreURLOpener 

type CoreURLOpener interface {
	OpenCore(ctx context.Context, u *url.URL, level zapcore.LevelEnabler, svc otel.Service) (CoreCloser, error)
}

CoreURLOpener represents types than can open Registries based on a URL.

type LoggerConfig 

type LoggerConfig struct {
	Level    string            `json:"level" yaml:"level"`
	Encoding string            `json:"encoding" yaml:"encoding"`
	Outputs  []string          `json:"outputs" yaml:"outputs"`
	Filters  map[string]string `json:"filters,omitempty" yaml:"filters,omitempty"`
}

func DefaultLegacyConfig 

func DefaultLegacyConfig(level, encoding, logToDir string) []LoggerConfig

func (LoggerConfig) Enabler 

func (c LoggerConfig) Enabler() zapcore.LevelEnabler

Enabler creates a dynamic enabler based on Level text value. Level may contain ">=debug" or "<debug" or "=debug" No comparator defaults to ">=", i.e "info" means Info and higher

func (LoggerConfig) Encoder 

func (c LoggerConfig) Encoder() zapcore.Encoder

Encoder computes encoder based on textual Encoder key Currently supported are "json" and "console"

func (LoggerConfig) Wrap 

func (c LoggerConfig) Wrap(core zapcore.Core) zapcore.Core

Wrap precomputes a list of matchers if there are k:v filters set and wrap the passed core with a filteringCore.

type LoggerInitializer 

type LoggerInitializer func(ctx context.Context) (*zap.Logger, []io.Closer)

type LoggerPool 

type LoggerPool *openurl.Pool[*logger]

type SyncURLOpener 

type SyncURLOpener interface {
	OpenSync(ctx context.Context, u *url.URL) (WriteSyncerCloser, error)
}

SyncURLOpener implements WriteSyncerCloser opener

type URLMux 

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

URLMux is a URL opener multiplexer. It matches the scheme of the URLs against a set of registered schemes and calls the opener that matches the URL's scheme. See https://gocloud.dev/concepts/urls/ for more information.

The zero value is a multiplexer with no registered schemes.

func DefaultURLMux 

func DefaultURLMux() *URLMux

DefaultURLMux returns the URLMux used by OpenTopic and OpenSubscription.

Driver packages can use this to register their TopicURLOpener and/or SubscriptionURLOpener on the mux.

func (*URLMux) OpenCore 

func (mux *URLMux) OpenCore(ctx context.Context, rawURL string, level zapcore.LevelEnabler, svc otel.Service) (CoreCloser, error)

OpenCore calls OpenURL with the URL parsed from urlstr. OpenStore is safe to call from multiple goroutines.

func (*URLMux) OpenSync 

func (mux *URLMux) OpenSync(ctx context.Context, rawURL string) (WriteSyncerCloser, error)

OpenSync calls OpenURL with the URL parsed from urlstr. OpenStore is safe to call from multiple goroutines.

func (*URLMux) RegisterCore 

func (mux *URLMux) RegisterCore(scheme string, opener CoreURLOpener)

RegisterCore registers the opener with the given scheme. If an opener already exists for the scheme, Register panics.

func (*URLMux) RegisterSync 

func (mux *URLMux) RegisterSync(scheme string, opener SyncURLOpener)

RegisterSync register an opener for a WriteSyncer

type WriteSyncer 

type WriteSyncer interface {
	io.Writer
	Sync() error
}

WriteSyncer implements zapcore.WriteSyncer

type WriteSyncerCloser 

type WriteSyncerCloser interface {
	zapcore.WriteSyncer
	io.Closer
}

type ZapLogger 

type ZapLogger interface {
	Named(s string) ZapLogger
	WithOptions(opts ...zap.Option) ZapLogger
	With(fields ...zap.Field) ZapLogger

	Debug(msg string, fields ...zap.Field)
	Info(msg string, fields ...zap.Field)
	Warn(msg string, fields ...zap.Field)
	Error(msg string, fields ...zap.Field)
	DPanic(msg string, fields ...zap.Field)
	Panic(msg string, fields ...zap.Field)
	Fatal(msg string, fields ...zap.Field)

	Debugf(format string, args ...interface{})
	Infof(format string, args ...interface{})
	Warnf(format string, args ...interface{})
	Errorf(format string, args ...interface{})

	Sugar() *zap.SugaredLogger
	Check(lvl zapcore.Level, msg string) *zapcore.CheckedEntry
	Sync() error
	Core() zapcore.Core
}

func Auditer 

func Auditer(ctx context.Context) ZapLogger

Auditer returns a zap logger with as much context as possible

func BasicContextWrapper 

func BasicContextWrapper(ctx context.Context, logger ZapLogger, fields ...zapcore.Field) ZapLogger

BasicContextWrapper creates a Named logger from serviceName found in context

func Logger 

func Logger(ctx context.Context) ZapLogger

Logger returns a zap logger with as much context as possible.

func TasksLogger 

func TasksLogger(ctx context.Context) ZapLogger

TasksLogger returns a zap logger with as much context as possible.

Source Files

View all Source files

Directories

Path Synopsis

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.