logger

package module

v1.0.1 Latest Latest Go to latest Published: Nov 17, 2023 License: MIT Imports: 6 Imported by: 90

Details

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

Repository

github.com/threatwinds/logger

Links

Open Source Insights

Documentation ¶

Index ¶

func Is(e error, kargs ...string) bool
type Config
type Error
- func (e *Error) Is(kargs ...string) bool
type Log
- func (l Log) ToJSON() string
- func (l Log) ToString() string
type Logger
- func New(config *Config) *Logger
- func (l Logger) ErrorF(statusCode int, format string, args ...any) *Error
- func (l Logger) LogF(statusCode int, format string, args ...any) *Log

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 Config ¶

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

Config represents the configuration for the logger.

type Error ¶

type Error struct {
	UUID    string `json:"uuid"`
	Status  int    `json:"status"`
	Message string `json:"message"`
}

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 New ¶

func New(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) 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.

Source Files ¶

View all Source files

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