logging

Documentation

Overview

Package logging //

Package logging //

Package logging //

Index

• func GetSdkKeyLogMapping(sdkKey string) string
• func SetLogLevel(logLevel LogLevel)
• func SetLogger(logger OptimizelyLogConsumer)
• func SetSdkKeyLogMapping(sdkKey, logMapping string)
• func UseSdkKeyForLogging(sdkKey string)
• type FilteredLevelLogConsumer
  • func NewFilteredLevelLogConsumer(level LogLevel, out io.Writer) *FilteredLevelLogConsumer
  • func (l *FilteredLevelLogConsumer) Log(level LogLevel, message string, fields map[string]interface{})
  • func (l *FilteredLevelLogConsumer) SetLogLevel(level LogLevel)
• type LogLevel
  • func (l LogLevel) String() string
• type NamedLogProducer
  • func (p NamedLogProducer) Debug(message string)
  • func (p NamedLogProducer) Error(message string, err interface{})
  • func (p NamedLogProducer) Info(message string)
  • func (p NamedLogProducer) Warning(message string)
• type OptimizelyLogConsumer
• type OptimizelyLogProducer
  • func GetLogger(sdkKey, name string) OptimizelyLogProducer

Functions

func GetSdkKeyLogMapping

func GetSdkKeyLogMapping(sdkKey string) string

GetSdkKeyLogMapping returns a string that maps to the sdk key that is used for logging (hiding the sdk key)

func SetLogLevel

func SetLogLevel(logLevel LogLevel)

SetLogLevel sets the log level to the given level

func SetLogger

func SetLogger(logger OptimizelyLogConsumer)

SetLogger replaces the default logger with the given logger

func SetSdkKeyLogMapping

func SetSdkKeyLogMapping(sdkKey, logMapping string)

SetSdkKeyLogMapping sets the logging key to use for the Optimizely sdk key. By default, the sdk key has masking. This can override the default of optimizely-1,2,3,4,etc.. This should be set before creating your Optimizely client factory.

func UseSdkKeyForLogging

func UseSdkKeyForLogging(sdkKey string)

UseSdkKeyForLogging by default the sdk key is masked for logging. This sets it to use the SDK Key and should be set before the creating your client factory.

Types

type FilteredLevelLogConsumer

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

FilteredLevelLogConsumer is an implementation of the OptimizelyLogConsumer that filters by log level

func NewFilteredLevelLogConsumer

func NewFilteredLevelLogConsumer(level LogLevel, out io.Writer) *FilteredLevelLogConsumer

NewFilteredLevelLogConsumer returns a new logger that logs to stdout

func (*FilteredLevelLogConsumer) Log

func (l *FilteredLevelLogConsumer) Log(level LogLevel, message string, fields map[string]interface{})

Log logs the message if it's log level is higher than or equal to the logger's set level

func (*FilteredLevelLogConsumer) SetLogLevel

func (l *FilteredLevelLogConsumer) SetLogLevel(level LogLevel)

SetLogLevel changes the log level to the given level

type LogLevel

type LogLevel int

LogLevel represents the level of the log (i.e. Debug, Info, Warning, Error)

const (
	// LogLevelDebug log level
	LogLevelDebug LogLevel = iota + 1

	// LogLevelInfo log level
	LogLevelInfo

	// LogLevelWarning log level
	LogLevelWarning

	// LogLevelError log level
	LogLevelError
)

func (LogLevel) String

func (l LogLevel) String() string

type NamedLogProducer

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

NamedLogProducer produces logs prefixed with its name

func (NamedLogProducer) Debug

func (p NamedLogProducer) Debug(message string)

Debug logs the given message with a DEBUG level

func (NamedLogProducer) Error

func (p NamedLogProducer) Error(message string, err interface{})

Error logs the given message with a ERROR level

func (NamedLogProducer) Info

func (p NamedLogProducer) Info(message string)

Info logs the given message with a INFO level

func (NamedLogProducer) Warning

func (p NamedLogProducer) Warning(message string)

Warning logs the given message with a WARNING level

type OptimizelyLogConsumer

type OptimizelyLogConsumer interface {
	Log(level LogLevel, message string, fields map[string]interface{})
	SetLogLevel(logLevel LogLevel)
}

OptimizelyLogConsumer consumes log messages produced by the log producers

type OptimizelyLogProducer

type OptimizelyLogProducer interface {
	Debug(message string)
	Info(message string)
	Warning(message string)
	Error(message string, err interface{})
}

OptimizelyLogProducer produces log messages to be consumed by the log consumer

func GetLogger

func GetLogger(sdkKey, name string) OptimizelyLogProducer

GetLogger returns a log producer with the given name