log

package

v1.1.0-alpha.1 Latest Latest Go to latest Published: Mar 14, 2025 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/opencloud-eu/opencloud

Links

Documentation ¶

Index ¶

Variables
func Deprecation(a ...any)
func LogrusWrap(zr zerolog.Logger) *logrus.Logger
type LineInfoHook
- func (h LineInfoHook) Run(e *zerolog.Event, _ zerolog.Level, _ string)
type Logger
- func NewLogger(opts ...Option) Logger
- func NopLogger() Logger
- func (l Logger) SubloggerWithRequestID(c context.Context) Logger
type LogrusWrapper
- func (h *LogrusWrapper) Fire(entry *logrus.Entry) error
- func (h *LogrusWrapper) Levels() []logrus.Level
type Option
type Options

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	RequestIDString = "request-id"
)

Functions ¶

func Deprecation ¶

func Deprecation(a ...any)

Deprecation logs a deprecation message, it is used to inform the user that a certain feature is deprecated and will be removed in the future. Do not use a logger here because the message MUST be visible independent of the log level.

func LogrusWrap ¶

func LogrusWrap(zr zerolog.Logger) *logrus.Logger

LogrusWrap returns a logrus logger which internally logs to /dev/null. Messages are passed to the underlying zerolog via hooks.

Types ¶

type LineInfoHook ¶

type LineInfoHook struct{}

func (LineInfoHook) Run ¶

func (h LineInfoHook) Run(e *zerolog.Event, _ zerolog.Level, _ string)

Run is a hook to add line info to log messages. I found the zerolog example for this here: https://github.com/rs/zerolog/issues/22#issuecomment-1127295489

type Logger ¶

type Logger struct {
	zerolog.Logger
}

Logger simply wraps the zerolog logger.

func NewLogger ¶

func NewLogger(opts ...Option) Logger

NewLogger initializes a new logger instance.

func NopLogger ¶

func NopLogger() Logger

NopLogger initializes a no-operation logger.

func (Logger) SubloggerWithRequestID ¶

func (l Logger) SubloggerWithRequestID(c context.Context) Logger

SubloggerWithRequestID returns a sub-logger with the x-request-id added to all events

type LogrusWrapper ¶

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

LogrusWrapper around zerolog. Required because idp uses logrus internally.

func (*LogrusWrapper) Fire ¶

func (h *LogrusWrapper) Fire(entry *logrus.Entry) error

Fire called by logrus on new message

func (*LogrusWrapper) Levels ¶

func (h *LogrusWrapper) Levels() []logrus.Level

Levels on which logrus hooks should be triggered

type Option ¶

type Option func(o *Options)

Option defines a single option function.

func Color ¶

func Color(val bool) Option

Color provides a function to set the color option.

func File ¶

func File(val string) Option

File provides a function to set the file option.

func Level ¶

func Level(val string) Option

Level provides a function to set the level option.

func Name ¶

func Name(val string) Option

Name provides a function to set the name option.

func Pretty ¶

func Pretty(val bool) Option

Pretty provides a function to set the pretty option.

type Options ¶

type Options struct {
	Name   string
	Level  string
	Pretty bool
	Color  bool
	File   string
}

Options defines the available options for this package.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL