logger

package module
v1.0.4 Latest Latest
Warning

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

Go to latest
Published: Dec 5, 2023 License: MIT Imports: 11 Imported by: 90

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Is

func Is(e error, kargs ...string) bool

Is checks if the given error contains any of the specified substrings. It returns true if any of the substrings are found, otherwise false.

Types

type CSVConfig added in v1.0.3

type CSVConfig struct {
	Output     string   // <filepath>
	CsvHeaders []string // csv fields
	// contains filtered or unexported fields
}

type CSVLogger added in v1.0.3

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

func NewCSVLogger added in v1.0.3

func NewCSVLogger(config *CSVConfig) (*CSVLogger, error)

WriteCsv writes a CSV record to the CSV file.

func (CSVLogger) Close added in v1.0.3

func (l CSVLogger) Close() error

Close closes the CSV file.

func (CSVLogger) WriteCsvLog added in v1.0.3

func (l CSVLogger) WriteCsvLog(values map[string]string) error

WriteCsvLog writes a log entry to a CSV file.

type Config

type Config struct {
	Format string // json, text
	Level  int    // 100: DEBUG, 200: INFO, 300: NOTICE, 400: WARNING, 500: ERROR, 502: CRITICAL, 509: ALERT
	Output string // stdout, <filepath>, none
}

Config represents the configuration for the logger.

type Error

type Error struct {
	UUID    string `json:"uuid"`
	Status  int    `json:"-"`
	Message string `json:"error"`
}

Error represents an error with a UUID, status, and message.

func (*Error) Is

func (e *Error) Is(kargs ...string) bool

Is checks if the error's message contains any of the specified substrings. It returns true if any of the substrings are found, otherwise false.

type Log

type Log struct {
	Timestamp string `json:"timestamp"`
	Severity  string `json:"severity"`
	Path      string `json:"path"`
	Line      int    `json:"line"`
	Error
}

Log represents a log entry.

func (Log) ToJSON

func (l Log) ToJSON() string

ToJSON converts the log entry to JSON formated string.

func (Log) ToString

func (l Log) ToString() string

ToString converts the log entry to a string format.

type Logger

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

Logger represents a logger instance.

func NewLogger added in v1.0.3

func NewLogger(config *Config) *Logger

New creates a new logger instance with the given configuration.

func (Logger) ErrorF

func (l Logger) ErrorF(statusCode int, format string, args ...any) *Error

ErrorF logs an error message with the given status code and arguments. It returns an error object.

func (Logger) ErrorFatal added in v1.0.4

func (l Logger) ErrorFatal(format string, args ...any)

ErrorFatal logs an error message and exits the program

func (Logger) Info added in v1.0.4

func (l Logger) Info(format string, args ...any) *Log

Info logs an info message with the given arguments.

func (Logger) LogF

func (l Logger) LogF(statusCode int, format string, args ...any) *Log

LogF logs a formatted message with the given status code and arguments. It returns the log entry.

Jump to

Keyboard shortcuts

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