jsonstream

README

gomol-jsonfile

A logger for Gomol to log to a file on the filesystem using JSON objects.

Documentation

Overview

Example

Code for the README example to make sure it still builds!

// Open a file to write JSON logs to
logFile, _ := os.Open("my/logs/run.log")
defer logFile.Close()

// Add an io.Writer logger
jsCfg := NewConfig(logFile)
jsLogger, _ := NewLogger(jsCfg)
gomol.AddLogger(jsLogger)

// Set some global attrs that will be added to all
// messages automatically
gomol.SetAttr("facility", "gomol.example")
gomol.SetAttr("another_attr", 1234)

// Initialize the loggers
gomol.InitLoggers()
defer gomol.ShutdownLoggers()

// Log some debug messages with message-level attrs
// that will be sent only with that message
for idx := 1; idx <= 10; idx++ {
	gomol.Dbgm(
		gomol.NewAttrs().
			SetAttr("msg_attr1", 4321),
		"Test message %v", idx)
}

Index

• Variables
• func WithHeaders(headers map[string]interface{}) loggerConfig
• type Config
  • func NewConfig(w io.Writer, configs ...loggerConfig) *Config
• type HeaderMsg
• type LogMsg
• type Logger
  • func NewLogger(cfg *Config) (*Logger, error)
  • func (l *Logger) Flush() error
  • func (l *Logger) InitLogger() error
  • func (l *Logger) IsInitialized() bool
  • func (l *Logger) Logm(timestamp time.Time, level gomol.LogLevel, attrs map[string]interface{}, ...) error
  • func (l *Logger) SetBase(base *gomol.Base)
  • func (l *Logger) ShutdownLogger() error
• type Message
• type Reader
  • func NewReader(r io.Reader) *Reader
  • func (r *Reader) Next() (Message, error)

Examples

• Package

Variables

var (
	ErrUnknownType = errors.New("unknown message type")
)

Functions

func WithHeaders

func WithHeaders(headers map[string]interface{}) loggerConfig

Types

type Config

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

func NewConfig

func NewConfig(w io.Writer, configs ...loggerConfig) *Config

type HeaderMsg

type HeaderMsg struct {
	Timestamp time.Time              `json:"time"`
	Headers   map[string]interface{} `json:"headers"`
}

type LogMsg

type LogMsg struct {
	Timestamp time.Time              `json:"time"`
	Msg       string                 `json:"msg"`
	Level     gomol.LogLevel         `json:"level"`
	Attrs     map[string]interface{} `json:"attrs"`
}

type Logger

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

func NewLogger

func NewLogger(cfg *Config) (*Logger, error)

func (*Logger) Flush

func (l *Logger) Flush() error

func (*Logger) InitLogger

func (l *Logger) InitLogger() error

func (*Logger) IsInitialized

func (l *Logger) IsInitialized() bool

func (*Logger) Logm

func (l *Logger) Logm(timestamp time.Time, level gomol.LogLevel, attrs map[string]interface{}, msg string) error

func (*Logger) SetBase

func (l *Logger) SetBase(base *gomol.Base)

func (*Logger) ShutdownLogger

func (l *Logger) ShutdownLogger() error

type Message

type Message interface{}

type Reader

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

func NewReader

func NewReader(r io.Reader) *Reader

func (*Reader) Next

func (r *Reader) Next() (Message, error)