logger

Documentation

Index

• Constants
• Variables
• type Config
• type Logger
  • func NewLogger(options *OptionsLogger) *Logger
  • func (l *Logger) AsyncWrite()
  • func (l *Logger) Close()
  • func (l *Logger) LogRequest(req *http.Request, userdata types.UserData) error
  • func (l *Logger) LogResponse(resp *http.Response, userdata types.UserData) error
• type OptionsLogger
• type OutputFileWriter
  • func NewOutputFileWriter(format, filePath string) (OutputFileWriter, error)
• type Store

Constants

const (
	LoggerConfigFilename = "export-config.yaml"
)

Variables

var (
	ErrorInvalidFormat = errors.New("invalid format: expected jsonl or yaml")
)

Types

type Config

type Config struct {
	Kafka   kafka.Options   `yaml:"kafka"`
	Elastic elastic.Options `yaml:"elastic"`
}

Config is a configuration file for proxify logger module

type Logger

type Logger struct {
	Store []Store
	// contains filtered or unexported fields
}

func NewLogger

func NewLogger(options *OptionsLogger) *Logger

NewLogger instance

func (*Logger) AsyncWrite

func (l *Logger) AsyncWrite()

AsyncWrite data

func (*Logger) Close

func (l *Logger) Close()

Close logger instance

func (*Logger) LogRequest

func (l *Logger) LogRequest(req *http.Request, userdata types.UserData) error

LogRequest and user data

func (*Logger) LogResponse

func (l *Logger) LogResponse(resp *http.Response, userdata types.UserData) error

LogResponse and user data

type OptionsLogger

type OptionsLogger struct {
	Verbosity    types.Verbosity
	OutputFolder string // when output is written to multiple files
	OutputFile   string // when output is written to single file
	OutputFormat string // jsonl or yaml
	DumpRequest  bool   // dump request to file
	DumpResponse bool   // dump response to file
	MaxSize      int    // max size of the output
	Elastic      *elastic.Options
	Kafka        *kafka.Options
}

type OutputFileWriter

type OutputFileWriter interface {
	// Write writes a http transaction to the file.
	Write(data *types.HTTPRequestResponseLog) error
	// Close closes the file writer.
	Close() error
}

OutputFileWriter is an interface for writing structured data to a file.

func NewOutputFileWriter

func NewOutputFileWriter(format, filePath string) (OutputFileWriter, error)

NewOutputFileWriter creates a new output file writer

type Store

type Store interface {
	Save(data types.HTTPTransaction) error
}