2016-02-11 02:47:46 +00:00
|
|
|
package logcollector
|
2016-02-10 02:24:30 +00:00
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
2016-02-10 15:52:15 +00:00
|
|
|
"io"
|
2016-02-10 02:24:30 +00:00
|
|
|
"log"
|
2016-02-10 20:09:07 +00:00
|
|
|
s1 "log/syslog"
|
2016-02-10 02:24:30 +00:00
|
|
|
"net"
|
2016-02-10 15:52:15 +00:00
|
|
|
"path/filepath"
|
2016-02-10 02:24:30 +00:00
|
|
|
|
|
|
|
"github.com/hashicorp/nomad/client/allocdir"
|
2016-02-10 23:27:40 +00:00
|
|
|
"github.com/hashicorp/nomad/client/driver/executor"
|
2016-02-10 02:24:30 +00:00
|
|
|
"github.com/hashicorp/nomad/client/driver/logrotator"
|
|
|
|
"github.com/hashicorp/nomad/nomad/structs"
|
|
|
|
"github.com/mcuadros/go-syslog"
|
|
|
|
)
|
|
|
|
|
2016-02-10 16:13:08 +00:00
|
|
|
// LogCollectorContext holds context to configure the syslog server
|
2016-02-10 02:24:30 +00:00
|
|
|
type LogCollectorContext struct {
|
2016-02-10 16:13:08 +00:00
|
|
|
// TaskName is the name of the Task
|
|
|
|
TaskName string
|
|
|
|
|
|
|
|
// AllocDir is the handle to do operations on the alloc dir of
|
|
|
|
// the task
|
|
|
|
AllocDir *allocdir.AllocDir
|
|
|
|
|
|
|
|
// LogConfig provides configuration related to log rotation
|
|
|
|
LogConfig *structs.LogConfig
|
|
|
|
|
|
|
|
// PortUpperBound is the upper bound of the ports that we can use to start
|
|
|
|
// the syslog server
|
2016-02-10 15:52:15 +00:00
|
|
|
PortUpperBound uint
|
2016-02-10 16:13:08 +00:00
|
|
|
|
|
|
|
// PortLowerBound is the lower bound of the ports that we can use to start
|
|
|
|
// the syslog server
|
2016-02-10 15:52:15 +00:00
|
|
|
PortLowerBound uint
|
2016-02-10 02:24:30 +00:00
|
|
|
}
|
|
|
|
|
2016-02-10 16:13:08 +00:00
|
|
|
// SyslogCollectorState holds the address and islation information of a launched
|
|
|
|
// syslog server
|
2016-02-10 02:24:30 +00:00
|
|
|
type SyslogCollectorState struct {
|
2016-02-10 23:27:40 +00:00
|
|
|
IsolationConfig *executor.IsolationConfig
|
2016-02-10 15:52:15 +00:00
|
|
|
Addr string
|
2016-02-10 02:24:30 +00:00
|
|
|
}
|
|
|
|
|
2016-02-10 16:13:08 +00:00
|
|
|
// LogCollector is an interface which allows a driver to launch a log server
|
|
|
|
// and update log configuration
|
2016-02-10 02:24:30 +00:00
|
|
|
type LogCollector interface {
|
2016-02-10 15:52:15 +00:00
|
|
|
LaunchCollector(ctx *LogCollectorContext) (*SyslogCollectorState, error)
|
2016-02-10 02:24:30 +00:00
|
|
|
Exit() error
|
|
|
|
UpdateLogConfig(logConfig *structs.LogConfig) error
|
|
|
|
}
|
|
|
|
|
2016-02-10 16:13:08 +00:00
|
|
|
// SyslogCollector is a LogCollector which starts a syslog server and does
|
|
|
|
// rotation to incoming stream
|
2016-02-10 02:24:30 +00:00
|
|
|
type SyslogCollector struct {
|
|
|
|
addr net.Addr
|
|
|
|
logConfig *structs.LogConfig
|
|
|
|
ctx *LogCollectorContext
|
|
|
|
|
|
|
|
lro *logrotator.LogRotator
|
|
|
|
lre *logrotator.LogRotator
|
|
|
|
server *syslog.Server
|
|
|
|
taskDir string
|
|
|
|
|
|
|
|
logger *log.Logger
|
|
|
|
}
|
|
|
|
|
2016-02-10 16:13:08 +00:00
|
|
|
// NewSyslogCollector returns an implementation of the SyslogCollector
|
2016-02-10 02:24:30 +00:00
|
|
|
func NewSyslogCollector(logger *log.Logger) *SyslogCollector {
|
|
|
|
return &SyslogCollector{logger: logger}
|
|
|
|
}
|
|
|
|
|
2016-02-10 16:13:08 +00:00
|
|
|
// LaunchCollector launches a new syslog server and starts writing log lines to
|
|
|
|
// files and rotates them
|
2016-02-10 15:52:15 +00:00
|
|
|
func (s *SyslogCollector) LaunchCollector(ctx *LogCollectorContext) (*SyslogCollectorState, error) {
|
|
|
|
addr, err := s.getFreePort(ctx.PortLowerBound, ctx.PortUpperBound)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2016-02-11 00:40:36 +00:00
|
|
|
s.logger.Printf("[DEBUG] sylog-server: launching syslog server on addr: %v", addr)
|
2016-02-10 02:24:30 +00:00
|
|
|
s.ctx = ctx
|
|
|
|
// configuring the task dir
|
|
|
|
if err := s.configureTaskDir(); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
channel := make(syslog.LogPartsChannel)
|
|
|
|
handler := syslog.NewChannelHandler(channel)
|
|
|
|
|
|
|
|
s.server = syslog.NewServer()
|
2016-02-10 15:52:15 +00:00
|
|
|
s.server.SetFormat(&CustomParser{logger: s.logger})
|
2016-02-10 02:24:30 +00:00
|
|
|
s.server.SetHandler(handler)
|
|
|
|
s.server.ListenTCP(addr.String())
|
|
|
|
if err := s.server.Boot(); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2016-02-10 15:52:15 +00:00
|
|
|
logFileSize := int64(ctx.LogConfig.MaxFileSizeMB * 1024 * 1024)
|
2016-02-10 20:09:07 +00:00
|
|
|
|
|
|
|
ro, wo := io.Pipe()
|
2016-02-10 15:52:15 +00:00
|
|
|
lro, err := logrotator.NewLogRotator(filepath.Join(s.taskDir, allocdir.TaskLocal),
|
|
|
|
fmt.Sprintf("%v.stdout", ctx.TaskName), ctx.LogConfig.MaxFiles,
|
|
|
|
logFileSize, s.logger)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2016-02-10 20:09:07 +00:00
|
|
|
go lro.Start(ro)
|
|
|
|
|
|
|
|
re, we := io.Pipe()
|
|
|
|
lre, err := logrotator.NewLogRotator(filepath.Join(s.taskDir, allocdir.TaskLocal),
|
|
|
|
fmt.Sprintf("%v.stderr", ctx.TaskName), ctx.LogConfig.MaxFiles,
|
|
|
|
logFileSize, s.logger)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
go lre.Start(re)
|
2016-02-10 02:24:30 +00:00
|
|
|
|
|
|
|
go func(channel syslog.LogPartsChannel) {
|
|
|
|
for logParts := range channel {
|
2016-02-11 00:40:36 +00:00
|
|
|
// If the severity of the log line is err then we write to stderr
|
|
|
|
// otherwise all messages go to stdout
|
2016-02-11 02:47:46 +00:00
|
|
|
s := logParts["severity"].(Priority)
|
|
|
|
if s.Severity == s1.LOG_ERR {
|
2016-02-10 20:09:07 +00:00
|
|
|
we.Write(logParts["content"].([]byte))
|
|
|
|
} else {
|
|
|
|
wo.Write(logParts["content"].([]byte))
|
|
|
|
}
|
|
|
|
wo.Write([]byte("\n"))
|
2016-02-10 02:24:30 +00:00
|
|
|
}
|
|
|
|
}(channel)
|
|
|
|
go s.server.Wait()
|
2016-02-10 15:52:15 +00:00
|
|
|
return &SyslogCollectorState{Addr: addr.String()}, nil
|
2016-02-10 02:24:30 +00:00
|
|
|
}
|
|
|
|
|
2016-02-10 16:13:08 +00:00
|
|
|
// Exit kills the syslog server
|
2016-02-10 02:24:30 +00:00
|
|
|
func (s *SyslogCollector) Exit() error {
|
2016-02-10 16:13:08 +00:00
|
|
|
return s.server.Kill()
|
2016-02-10 02:24:30 +00:00
|
|
|
}
|
|
|
|
|
2016-02-10 16:13:08 +00:00
|
|
|
// UpdateLogConfig updates the log configuration
|
2016-02-10 02:24:30 +00:00
|
|
|
func (s *SyslogCollector) UpdateLogConfig(logConfig *structs.LogConfig) error {
|
2016-02-10 16:13:08 +00:00
|
|
|
s.ctx.LogConfig = logConfig
|
|
|
|
if s.lro == nil {
|
|
|
|
return fmt.Errorf("log rotator for stdout doesn't exist")
|
|
|
|
}
|
|
|
|
s.lro.MaxFiles = logConfig.MaxFiles
|
|
|
|
s.lro.FileSize = int64(logConfig.MaxFileSizeMB * 1024 * 1024)
|
|
|
|
|
|
|
|
if s.lre == nil {
|
|
|
|
return fmt.Errorf("log rotator for stderr doesn't exist")
|
|
|
|
}
|
|
|
|
s.lre.MaxFiles = logConfig.MaxFiles
|
|
|
|
s.lre.FileSize = int64(logConfig.MaxFileSizeMB * 1024 * 1024)
|
2016-02-10 02:24:30 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2016-02-11 00:13:13 +00:00
|
|
|
// configureTaskDir sets the task dir in the SyslogCollector
|
2016-02-10 02:24:30 +00:00
|
|
|
func (s *SyslogCollector) configureTaskDir() error {
|
|
|
|
taskDir, ok := s.ctx.AllocDir.TaskDirs[s.ctx.TaskName]
|
|
|
|
if !ok {
|
|
|
|
return fmt.Errorf("couldn't find task directory for task %v", s.ctx.TaskName)
|
|
|
|
}
|
|
|
|
s.taskDir = taskDir
|
|
|
|
return nil
|
|
|
|
}
|
2016-02-10 15:52:15 +00:00
|
|
|
|
|
|
|
// getFreePort returns a free port ready to be listened on between upper and
|
|
|
|
// lower bounds
|
|
|
|
func (s *SyslogCollector) getFreePort(lowerBound uint, upperBound uint) (net.Addr, error) {
|
|
|
|
for i := lowerBound; i <= upperBound; i++ {
|
|
|
|
addr, err := net.ResolveTCPAddr("tcp", fmt.Sprintf("localhost:%v", i))
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
l, err := net.ListenTCP("tcp", addr)
|
|
|
|
if err != nil {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
defer l.Close()
|
|
|
|
return l.Addr(), nil
|
|
|
|
}
|
|
|
|
return nil, fmt.Errorf("No free port found")
|
|
|
|
}
|