log

Documentation

Index

• func From(ctx context.Context) log.Logger
• func Init(logLevel int, options ...InitOption) (log.LoggerCloser, error)
• func NopLogger() log.Logger
• func WithLoggerContext(ctx context.Context, logger log.Logger) context.Context
• func Wrap(z *zap.SugaredLogger) log.LoggerCloser
• type EventStreamer
• type InitOption
• type ListenCancelFunc
• type Message
  • func ConvertBytesToMessage(b []byte, options ...Option) (Message, error)
• type MessageIDGenerator
• type MessageListenerFactory
• type OctantSink
  • func NewOctantSink(options ...OctantSinkOption) *OctantSink
  • func (o *OctantSink) Close() error
  • func (o *OctantSink) Listen() (<-chan Message, ListenCancelFunc)
  • func (o *OctantSink) Sync() error
  • func (o *OctantSink) Write(p []byte) (n int, err error)
• type OctantSinkOption
• type Option
  • func WithIDGenerator(g MessageIDGenerator) Option
• type Streamer
  • func NewStreamer(messageListenerFactory MessageListenerFactory) *Streamer
  • func (lm *Streamer) Close()
  • func (lm *Streamer) Stream(readyCh <-chan struct{}) (<-chan event.Event, func())
• type UUIDMessageIDGenerator
  • func (d UUIDMessageIDGenerator) Generate() string

Functions

func From

func From(ctx context.Context) log.Logger

From extracts a logger from the supplied context, or returns a NopLogger if none is found.

func Init

func Init(logLevel int, options ...InitOption) (log.LoggerCloser, error)

Init initializes a logger with options.

func NopLogger

func NopLogger() log.Logger

NopLogger constructs a nop logger

func WithLoggerContext

func WithLoggerContext(ctx context.Context, logger log.Logger) context.Context

WithLoggerContext returns a new context with a set logger

func Wrap

func Wrap(z *zap.SugaredLogger) log.LoggerCloser

Wrap zap.SugaredLogger as Logger interface

Types

type EventStreamer

type EventStreamer interface {
	// Stream streams events.
	Stream(ready <-chan struct{}) (<-chan event.Event, func())
	// Close closes the streamer. No more events will be generated
	// one the streamer is closed.
	Close()
}

EventStreamer is an interface for streaming.

type InitOption

type InitOption func(config zap.Config) zap.Config

InitOption is a functional option for configuring a logger.

type ListenCancelFunc

type ListenCancelFunc func()

ListenCancelFunc is a function for canceling a sink listener.

type Message

type Message struct {
	// ID is the identifier for this log message.
	ID string
	// Date is the seconds since epoch.
	Date int64 `json:"date"`
	// LogLevel is the log level.
	LogLevel string `json:"logLevel"`
	// Location is the source location.
	Location string `json:"location"`
	// Text is the actual message.
	Text string `json:"text"`
	// JSON is the JSON payload.
	JSON string `json:"json"`
	// StackTrace is an optional stack trace.
	StackTrace string `json:"stackTrace"`
}

Message is an Octant log message.

func ConvertBytesToMessage

func ConvertBytesToMessage(b []byte, options ...Option) (Message, error)

ConvertBytesToMessage converts a zap message string to a Message instance.

type MessageIDGenerator

type MessageIDGenerator interface {
	Generate() string
}

MessageIDGenerator is an interface for generating message IDs.

type MessageListenerFactory

type MessageListenerFactory interface {
	// Listen creates a listener.
	Listen() (<-chan Message, ListenCancelFunc)
}

MessageListenerFactory is a factory which generates message listeners.

type OctantSink

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

OctantSink is an Octant log sink for zap. It creates a method that allows multiple loggers to listen to message.

func NewOctantSink

func NewOctantSink(options ...OctantSinkOption) *OctantSink

NewOctantSink creates an instance of OctantSink.

func (*OctantSink) Close

func (o *OctantSink) Close() error

Close closes the sink and its listeners.

func (*OctantSink) Listen

func (o *OctantSink) Listen() (<-chan Message, ListenCancelFunc)

Listen creates a channel for listening for messages and cancel func.

func (*OctantSink) Sync

func (o *OctantSink) Sync() error

Sync is a no-op as.

func (*OctantSink) Write

func (o *OctantSink) Write(p []byte) (n int, err error)

Write converts the message to a Message and sends it to all listeners. The message format is IS8061 date[\t]level[\t]location[\t]text[\t]optional payload[\n]

type OctantSinkOption

type OctantSinkOption func(o *OctantSink)

OctantSinkOption is an option for configuring OctantSink.

type Option

type Option func(o *options)

Option is a log option.

func WithIDGenerator

func WithIDGenerator(g MessageIDGenerator) Option

WithIDGenerator sets the message id generator option.

type Streamer

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

Streamer streams events using a ring buffer.

func NewStreamer

func NewStreamer(messageListenerFactory MessageListenerFactory) *Streamer

NewStreamer creates an instance of Streamer.

func (*Streamer) Close

func (lm *Streamer) Close()

Close closes the streamer.

func (*Streamer) Stream

func (lm *Streamer) Stream(readyCh <-chan struct{}) (<-chan event.Event, func())

Stream creates a channel which streams messages and a cancel function.

type UUIDMessageIDGenerator

type UUIDMessageIDGenerator struct{}

UUIDMessageIDGenerator generates messages IDs as UUIDs.

func (UUIDMessageIDGenerator) Generate

func (d UUIDMessageIDGenerator) Generate() string

Generate generates a UUID as a string.