jot

Documentation

Overview

Package jot provides simple asynchronous logging.

Index

• func Debug(v ...any)
• func Debugf(format string, v ...any)
• func Error(v ...any)
• func Errorf(format string, v ...any)
• func Fatal(status int, v ...any)
• func FatalIfErr(err error)
• func Fatalf(status int, format string, v ...any)
• func Flush()
• func Info(v ...any)
• func Infof(format string, v ...any)
• func SetMinimumLevel(level Level)
• func SetWriter(w io.Writer)
• func Time(v ...any) logadapter.Timing
• func Timef(format string, v ...any) logadapter.Timing
• func Warn(v ...any)
• func Warnf(format string, v ...any)
• type Level
• type Logger
  • func (lgr *Logger) Debug(v ...any)
  • func (lgr *Logger) Debugf(format string, v ...any)
  • func (lgr *Logger) Error(v ...any)
  • func (lgr *Logger) Errorf(format string, v ...any)
  • func (lgr *Logger) Fatal(status int, v ...any)
  • func (lgr *Logger) Fatalf(status int, format string, v ...any)
  • func (lgr *Logger) Flush()
  • func (lgr *Logger) Info(v ...any)
  • func (lgr *Logger) Infof(format string, v ...any)
  • func (lgr *Logger) SetMinimumLevel(level Level)
  • func (lgr *Logger) SetWriter(w io.Writer)
  • func (lgr *Logger) Time(v ...any) logadapter.Timing
  • func (lgr *Logger) Timef(format string, v ...any) logadapter.Timing
  • func (lgr *Logger) Warn(v ...any)
  • func (lgr *Logger) Warnf(format string, v ...any)
  • func (lgr *Logger) Write(data []byte) (int, error)
• type LoggerWriter
  • func (w *LoggerWriter) Write(p []byte) (n int, err error)

Functions

func Debug

func Debug(v ...any)

Debug logs a debugging message. Arguments are handled in the manner of fmt.Print.

Deprecated: Use slog instead. August 28, 2023

func Debugf

func Debugf(format string, v ...any)

Debugf logs a debugging message. Arguments are handled in the manner of fmt.Printf.

Deprecated: Use slog instead. August 28, 2023

func Error

func Error(v ...any)

Error logs an error message. Arguments are handled in the manner of fmt.Print.

Deprecated: Use slog instead. August 28, 2023

func Errorf

func Errorf(format string, v ...any)

Errorf logs an error message. Arguments are handled in the manner of fmt.Printf.

Deprecated: Use slog instead. August 28, 2023

func Fatal

func Fatal(status int, v ...any)

Fatal logs a fatal error message. Arguments other than the status are handled in the manner of fmt.Print.

Deprecated: Use slog instead. August 28, 2023

func FatalIfErr

func FatalIfErr(err error)

FatalIfErr calls 'Fatal(1, err)' if 'err' is not nil.

Deprecated: Use slog instead. August 28, 2023

func Fatalf

func Fatalf(status int, format string, v ...any)

Fatalf logs a fatal error message. Arguments other than the status are handled in the manner of fmt.Printf.

Deprecated: Use slog instead. August 28, 2023

func Flush

func Flush()

Flush waits for all current log entries to be written before returning.

Deprecated: Use slog instead. August 28, 2023

func Info

func Info(v ...any)

Info logs an informational message. Arguments are handled in the manner of fmt.Print.

Deprecated: Use slog instead. August 28, 2023

func Infof

func Infof(format string, v ...any)

Infof logs an informational message. Arguments are handled in the manner of fmt.Printf.

Deprecated: Use slog instead. August 28, 2023

func SetMinimumLevel

func SetMinimumLevel(level Level)

SetMinimumLevel sets the minimum log level that will be output. Default is DEBUG.

Deprecated: Use slog instead. August 28, 2023

func SetWriter

func SetWriter(w io.Writer)

SetWriter sets the io.Writer to use when writing log messages. Default is os.Stderr.

Deprecated: Use slog instead. August 28, 2023

func Time

func Time(v ...any) logadapter.Timing

Time starts timing an event and logs an informational message. Arguments are handled in the manner of fmt.Print.

Deprecated: Use slog instead. August 28, 2023

func Timef

func Timef(format string, v ...any) logadapter.Timing

Timef starts timing an event and logs an informational message. Arguments are handled in the manner of fmt.Printf.

Deprecated: Use slog instead. August 28, 2023

func Warn

func Warn(v ...any)

Warn logs a warning message. Arguments are handled in the manner of fmt.Print.

Deprecated: Use slog instead. August 28, 2023

func Warnf

func Warnf(format string, v ...any)

Warnf logs a warning message. Arguments are handled in the manner of fmt.Printf.

Deprecated: Use slog instead. August 28, 2023

Types

type Level

type Level int

Level holds a log level.

Deprecated: Use slog instead. August 28, 2023

const (
	DEBUG Level = iota
	INFO
	WARN
	ERROR
	FATAL
)

Log levels

type Logger

type Logger struct{}

Logger wraps the various jot function calls into a struct that can be passed around, typically for the sake of satisfying one or more logging interfaces.

Deprecated: Use slog instead. August 28, 2023

func (*Logger) Debug

func (lgr *Logger) Debug(v ...any)

Debug logs a debug message. Arguments are handled in the manner of fmt.Print.

Deprecated: Use slog instead. August 28, 2023

func (*Logger) Debugf

func (lgr *Logger) Debugf(format string, v ...any)

Debugf logs a debug message. Arguments are handled in the manner of fmt.Printf.

Deprecated: Use slog instead. August 28, 2023

func (*Logger) Error

func (lgr *Logger) Error(v ...any)

Error logs an error message. Arguments are handled in the manner of fmt.Print.

Deprecated: Use slog instead. August 28, 2023

func (*Logger) Errorf

func (lgr *Logger) Errorf(format string, v ...any)

Errorf logs an error message. Arguments are handled in the manner of fmt.Printf.

Deprecated: Use slog instead. August 28, 2023

func (*Logger) Fatal

func (lgr *Logger) Fatal(status int, v ...any)

Fatal logs a fatal error message. Arguments other than the status are handled in the manner of fmt.Print.

Deprecated: Use slog instead. August 28, 2023

func (*Logger) Fatalf

func (lgr *Logger) Fatalf(status int, format string, v ...any)

Fatalf logs a fatal error message. Arguments other than the status are handled in the manner of fmt.Printf.

Deprecated: Use slog instead. August 28, 2023

func (*Logger) Flush

func (lgr *Logger) Flush()

Flush waits for all current log entries to be written before returning.

Deprecated: Use slog instead. August 28, 2023

func (*Logger) Info

func (lgr *Logger) Info(v ...any)

Info logs an informational message. Arguments are handled in the manner of fmt.Print.

Deprecated: Use slog instead. August 28, 2023

func (*Logger) Infof

func (lgr *Logger) Infof(format string, v ...any)

Infof logs an informational message. Arguments are handled in the manner of fmt.Printf.

Deprecated: Use slog instead. August 28, 2023

func (*Logger) SetMinimumLevel

func (lgr *Logger) SetMinimumLevel(level Level)

SetMinimumLevel sets the minimum log level that will be output. Default is DEBUG.

Deprecated: Use slog instead. August 28, 2023

func (*Logger) SetWriter

func (lgr *Logger) SetWriter(w io.Writer)

SetWriter sets the io.Writer to use when writing log messages. Default is os.Stderr.

Deprecated: Use slog instead. August 28, 2023

func (*Logger) Time

func (lgr *Logger) Time(v ...any) logadapter.Timing

Time starts timing an event and logs an informational message. Arguments are handled in the manner of fmt.Print.

Deprecated: Use slog instead. August 28, 2023

func (*Logger) Timef

func (lgr *Logger) Timef(format string, v ...any) logadapter.Timing

Timef starts timing an event and logs an informational message. Arguments are handled in the manner of fmt.Printf.

Deprecated: Use slog instead. August 28, 2023

func (*Logger) Warn

func (lgr *Logger) Warn(v ...any)

Warn logs a warning message. Arguments are handled in the manner of fmt.Print.

Deprecated: Use slog instead. August 28, 2023

func (*Logger) Warnf

func (lgr *Logger) Warnf(format string, v ...any)

Warnf logs a warning message. Arguments are handled in the manner of fmt.Printf.

Deprecated: Use slog instead. August 28, 2023

func (*Logger) Write

func (lgr *Logger) Write(data []byte) (int, error)

Writer logs the data as an error after casting it to a string.

Deprecated: Use slog instead. August 28, 2023

type LoggerWriter

type LoggerWriter struct {
	Filter func(v ...any)
}

LoggerWriter provides a bridge between the standard log.Logger and the jot package. You can use it like this:

log.New(&jot.LoggerWriter{}, "", 0)

This will send all output for this logger to the jot.Error() call.

You can also set the Filter function to direct the output to a particular jot logging method:

log.New(&jot.LoggerWriter{Filter: jot.Info}), "", 0)

Deprecated: Use slog instead. August 28, 2023

func (*LoggerWriter) Write

func (w *LoggerWriter) Write(p []byte) (n int, err error)

Write implements the io.Writer interface required by log.Logger.

Deprecated: Use slog instead. August 28, 2023