log

Documentation

Overview

Package log provides logging for rclone

Index

• Variables
• func InitLogging()
• func InstallJSONLogger(logLevel fs.LogLevel)
• func NewCallerHook(levels ...logrus.Level) logrus.Hook
• func Redirected() bool
• func Stack(o interface{}, info string)
• func Trace(o interface{}, format string, a ...interface{}) func(string, ...interface{})
• type CallerHook
  • func (h *CallerHook) Fire(entry *logrus.Entry) error
  • func (h *CallerHook) Levels() []logrus.Level
• type MultiWriter
  • func (mw *MultiWriter) Write(p []byte) (n int, err error)
• type Options

Variables

var OptionsInfo = fs.Options{{
	Name:    "log_file",
	Default: "",
	Help:    "Log everything to this file",
	Groups:  "Logging",
}, {
	Name:    "log_format",
	Default: "date,time",
	Help:    "Comma separated list of log format options",
	Groups:  "Logging",
}, {
	Name:    "syslog",
	Default: false,
	Help:    "Use Syslog for logging",
	Groups:  "Logging",
}, {
	Name:    "syslog_facility",
	Default: "DAEMON",
	Help:    "Facility for syslog, e.g. KERN,USER",
	Groups:  "Logging",
}, {
	Name:    "log_systemd",
	Default: false,
	Help:    "Activate systemd integration for the logger",
	Groups:  "Logging",
}}

OptionsInfo descripts the Options in use

Functions

func InitLogging

func InitLogging()

InitLogging start the logging as per the command line flags

func InstallJSONLogger

func InstallJSONLogger(logLevel fs.LogLevel)

InstallJSONLogger installs the JSON logger at the specified log level

func NewCallerHook

func NewCallerHook(levels ...logrus.Level) logrus.Hook

NewCallerHook use to make a hook

func Redirected

func Redirected() bool

Redirected returns true if the log has been redirected from stdout

func Stack

func Stack(o interface{}, info string)

Stack logs a stack trace of callers with the o and info passed in

func Trace

func Trace(o interface{}, format string, a ...interface{}) func(string, ...interface{})

Trace debugs the entry and exit of the calling function

It is designed to be used in a defer statement, so it returns a function that logs the exit parameters.

Any pointers in the exit function will be dereferenced

Types

type CallerHook

type CallerHook struct {
	Field string
	Skip  int
	// contains filtered or unexported fields
}

CallerHook for log the calling file and line of the fine

func (*CallerHook) Fire

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

Fire logs the information of context (filename and line)

func (*CallerHook) Levels

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

Levels implement applied hook to which levels

type MultiWriter

type MultiWriter struct {
	Writers []io.Writer
}

MultiWriter是一个自定义的Writer，它可以将输出同时写入多个Writer，例如文件和标准输出。

func (*MultiWriter) Write

func (mw *MultiWriter) Write(p []byte) (n int, err error)

Write将给定的字节切片写入所有的Writer。 如果写入时发生错误，它会返回第一个遇到的错误。

type Options

type Options struct {
	File              string `config:"log_file"`        // Log everything to this file
	Format            string `config:"log_format"`      // Comma separated list of log format options
	UseSyslog         bool   `config:"syslog"`          // Use Syslog for logging
	SyslogFacility    string `config:"syslog_facility"` // Facility for syslog, e.g. KERN,USER,...
	LogSystemdSupport bool   `config:"log_systemd"`     // set if using systemd logging
}

Options contains options for controlling the logging

var Opt Options

Opt is the options for the logger