logsreader

Documentation

Index

• Variables
• func SaveState(conn ConnectionInfo, stats State) error
• type ConnectionInfo
  • func (conn ConnectionInfo) ServerName() string
  • func (conn ConnectionInfo) String() string
• type FileInfo
• type LogRecord
• type State
  • func GetState(conn ConnectionInfo) (State, error)
  • func ReadLogs(conn ConnectionInfo, readerState State, recordProcessor func(*LogRecord)) (*State, error)

Variables

var ErrNoStateFile = errors.New("state file doesn't exist")

ErrNoStateFile indicates that state file doesn't exist. Most likely this happens because server is being processed first time

Functions

func SaveState

func SaveState(conn ConnectionInfo, stats State) error

SaveState saves State for given server

Types

type ConnectionInfo

type ConnectionInfo struct {
	Address  string
	Port     int
	UserName string
	Password string
}

ConnectionInfo represents information about connection to server with nginx logs

func (ConnectionInfo) ServerName

func (conn ConnectionInfo) ServerName() string

ServerName returns server name as Address:Port

func (ConnectionInfo) String

func (conn ConnectionInfo) String() string

type FileInfo

type FileInfo struct {
	Name         string
	ModifiedDate int64
}

FileInfo provides information about file

type LogRecord

type LogRecord struct {
	IPAddress      string
	Time           time.Time
	Duration       float64
	Verb           string
	Path           string
	HTTPStatusCode int
	Size           int
	Domain         string
	Referrer       string
	UserAgent      string
}

LogRecord represents a line of nginx log file

type State

type State struct {
	// NotZippedLogFile stores the name of only log file that was not zipped yet except access.log.
	// If this name changes it means that nginx has started new log file and archived access.log that we were reading last time
	RotatedLog FileInfo

	// BytesRead stores Number of bytes that were already read from access.log
	BytesRead int
}

State store information about state from previous connection

func GetState

func GetState(conn ConnectionInfo) (State, error)

GetState returns State object for given server

func ReadLogs

func ReadLogs(conn ConnectionInfo, readerState State, recordProcessor func(*LogRecord)) (*State, error)

ReadLogs read logs from server