mtail

Documentation

Index

• func BindAddress(address, port string) func(*Server) error
• func BuildInfo(info string) func(*Server) error
• func CompileOnly(m *Server) error
• func DumpAst(m *Server) error
• func DumpAstTypes(m *Server) error
• func DumpBytecode(m *Server) error
• func ExpiredMetricGcTickInterval(interval time.Duration) func(*Server) error
• func FaviconHandler(w http.ResponseWriter, r *http.Request)
• func LogPathPatterns(patterns ...string) func(*Server) error
• func OmitMetricSource(m *Server) error
• func OmitProgLabel(m *Server) error
• func OneShot(m *Server) error
• func OverrideLocation(loc *time.Location) func(*Server) error
• func ProgramPath(path string) func(*Server) error
• func StaleLogGcTickInterval(interval time.Duration) func(*Server) error
• func SyslogUseCurrentYear(m *Server) error
• type Server
  • func New(store *metrics.Store, w watcher.Watcher, options ...func(*Server) error) (*Server, error)
  • func (m *Server) Addr() string
  • func (m *Server) Close() error
  • func (m *Server) Run() error
  • func (m *Server) Serve() error
  • func (m *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (m *Server) SetOption(options ...func(*Server) error) error
  • func (m *Server) StartTailing() error
  • func (m *Server) WaitForShutdown()
  • func (m *Server) WriteMetrics(w io.Writer) error

Functions

func BindAddress

func BindAddress(address, port string) func(*Server) error

BindAddress sets the HTTP server address in MtailServer.

func BuildInfo

func BuildInfo(info string) func(*Server) error

BuildInfo sets the mtail program build information in the MtailServer.

func CompileOnly

func CompileOnly(m *Server) error

CompileOnly sets compile-only mode in the MtailServer.

func DumpAst

func DumpAst(m *Server) error

DumpAst instructs the MtailServer's compiler to print the AST after parsing.

func DumpAstTypes

func DumpAstTypes(m *Server) error

DumpAstTypes instructs the MtailServer's copmiler to print the AST after type checking.

func DumpBytecode

func DumpBytecode(m *Server) error

DumpBytecode instructs the MtailServer's compiuler to print the program bytecode after code generation.

func ExpiredMetricGcTickInterval

func ExpiredMetricGcTickInterval(interval time.Duration) func(*Server) error

ExpiredMetricGcTickInterval sets the interval to run ticker to delete expired metrics from store.

func FaviconHandler

func FaviconHandler(w http.ResponseWriter, r *http.Request)

func LogPathPatterns

func LogPathPatterns(patterns ...string) func(*Server) error

LogPathPatterns sets the patterns to find log paths in the MtailServer.

func OmitMetricSource

func OmitMetricSource(m *Server) error

OmitMetricSource sets the MtailServer to not link created metrics to their source program.

func OmitProgLabel

func OmitProgLabel(m *Server) error

OmitProgLabel sets the MtailServer to not put the program name as a label in exported metrics.

func OneShot

func OneShot(m *Server) error

OneShot sets one-shot mode in the MtailServer.

func OverrideLocation

func OverrideLocation(loc *time.Location) func(*Server) error

OverrideLocation sets the timezone location for log timestamps without any such information.

func ProgramPath

func ProgramPath(path string) func(*Server) error

ProgramPath sets the path to find mtail programs in the MtailServer.

func StaleLogGcTickInterval

func StaleLogGcTickInterval(interval time.Duration) func(*Server) error

StaleLogGcTickInterval sets the interval to run ticker to remove stale log handles.

func SyslogUseCurrentYear

func SyslogUseCurrentYear(m *Server) error

SyslogUseCurrentYear instructs the MtailServer to use the current year for year-less log timestamp during parsing.

Types

type Server

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

Server contains the state of the main mtail program.

func New

func New(store *metrics.Store, w watcher.Watcher, options ...func(*Server) error) (*Server, error)

New creates a MtailServer from the supplied Options.

func (*Server) Addr

func (m *Server) Addr() string

func (*Server) Close

func (m *Server) Close() error

Close handles the graceful shutdown of this mtail instance, ensuring that it only occurs once.

func (*Server) Run

func (m *Server) Run() error

Run starts MtailServer's primary function, in which it watches the log files for changes and sends any new lines found into the lines channel for pick up by the virtual machines. If OneShot mode is enabled, it will exit.

func (*Server) Serve

func (m *Server) Serve() error

Serve begins the webserver and awaits a shutdown instruction.

func (*Server) ServeHTTP

func (m *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Server) SetOption

func (m *Server) SetOption(options ...func(*Server) error) error

SetOption takes one or more option functions and applies them in order to MtailServer.

func (*Server) StartTailing

func (m *Server) StartTailing() error

StartTailing adds each log path pattern to the tailer.

func (*Server) WaitForShutdown

func (m *Server) WaitForShutdown()

WaitForShutdown handles shutdown requests from the system or the UI.

func (*Server) WriteMetrics

func (m *Server) WriteMetrics(w io.Writer) error

WriteMetrics dumps the current state of the metrics store in JSON format to the io.Writer.