Skip to content

Commit

Permalink
fixes #8 Want log API
Browse files Browse the repository at this point in the history
  • Loading branch information
gdamore committed Sep 1, 2015
1 parent 773699d commit edc26dc
Show file tree
Hide file tree
Showing 7 changed files with 178 additions and 35 deletions.
8 changes: 6 additions & 2 deletions govisor_test.go
Expand Up @@ -157,11 +157,15 @@ var testS2 = &testS{
depends: []string{"dep:S2"},
}

func SetTestLogger(t *testing.T, m *Manager) {
m.SetLogger(log.New(&testLog{t: t}, "", log.LstdFlags))
}

func WithManager(t *testing.T, name string, fn func(m *Manager)) func() {
return func() {
m := NewManager(name)
So(m, ShouldNotBeNil)
m.SetLogWriter(&testLog{t: t})
SetTestLogger(t, m)
Reset(func() {
m.Shutdown()
})
Expand Down Expand Up @@ -281,7 +285,7 @@ func TestGovisor(t *testing.T) {
Convey("Given a new govisor", t, func() {
m := NewManager("TestGoVisor")
So(m, ShouldNotBeNil)
m.SetLogWriter(&testLog{t: t})
SetTestLogger(t, m)
Convey("And new services S1 and S2", func() {
s1 := NewService(&t1)
So(s1, ShouldNotBeNil)
Expand Down
29 changes: 6 additions & 23 deletions manager.go
Expand Up @@ -123,52 +123,35 @@ func (m *Manager) setBaseDir() {
}
}

// SetLogger sets the logger to use. This allows a framework to use a single
// logger for everything. Note that this must be called before services are
// added in order to have any effect.
// SetLogger is used to establish a logger. It overrides the default, so it
// shouldn't be used unless you want to control all logging.
func (m *Manager) SetLogger(l *log.Logger) {
m.logger = l
}

// SetLogWriter works like SetLogger, except that it only sets an output
// writer. This is probably more convenient for most loggers.
func (m *Manager) SetLogWriter(w io.Writer) {
m.logger = log.New(w, "["+m.Name()+"] ", log.LstdFlags)
m.writer = w
}

func (m *Manager) getLogger(s *Service) *log.Logger {

flags := log.LstdFlags
if m.logger != nil {
flags = m.logger.Flags()
}
if m.writer != nil {
prefix := "[" + s.Name() + "] "
return log.New(m.writer, prefix, flags)
} else if m.logger != nil {
return m.logger
}

// Default logger
prefix := "[" + s.Name() + "] "
if len(m.baseDir) == 0 {
return log.New(os.Stderr, prefix, flags)
return log.New(os.Stderr, "", 0)
}

if runtime.GOOS == "windows" {
// XXX: this needs to generate a proper Windows service log
return log.New(os.Stderr, prefix, log.LstdFlags)
return log.New(os.Stderr, "", 0)
}

// XXX: service specific file names?
f := path.Join(m.baseDir, m.Name(), s.Name()+".log")

w, e := os.OpenFile(f, os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0600)
if e != nil {
return log.New(os.Stderr, prefix, log.LstdFlags)
return log.New(os.Stderr, "", log.LstdFlags)
}
return log.New(w, prefix, log.LstdFlags)
return log.New(w, "", log.LstdFlags)
}

func (m *Manager) monitor() {
Expand Down
104 changes: 104 additions & 0 deletions multilog.go
@@ -0,0 +1,104 @@
// Copyright 2015 The Govisor Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use file except in compliance with the License.
// You may obtain a copy of the license at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package govisor

import (
"log"
"strings"
"sync"
)

// MultiLogger implements a wrapper around log.Logger, that permits a single
// logger interface to be used to fan out multiple logs. The idea is that it
// implements an io.Writer, which breaks up the lines and delivers them
// each to the various contained loggers. The contained loggers may have
// their own Prefix and Flags, and those shall not interfere with the parent.
type MultiLogger struct {
log *log.Logger
loggers []*log.Logger
lock sync.Mutex
}

// Write implements the io.Writer, suitable for use with Logger. It is
// expected that the input is text, delimited by newlines, and delivered
// an entire line at a time. This isn't exactly io.Writer, but it is the
// semantic to which the log.Logger interface conforms.
func (l *MultiLogger) Write(b []byte) (int, error) {
lines := strings.Split(strings.Trim(string(b), "\n"), "\n")
l.lock.Lock()
for _, line := range lines {
for _, logger := range l.loggers {
logger.Println(line)
}
}
l.lock.Unlock()
return len(b), nil
}

// AddLogger adds a logger to the MultiLogger. Once called, all new log entries
// will be fanned out to this logger, as well as any others that may have been
// registered earlier. A logger can only be added once.
func (l *MultiLogger) AddLogger(logger *log.Logger) {
l.lock.Lock()
defer l.lock.Unlock()
for _, x := range l.loggers {
if x == logger {
return
}
}
l.loggers = append(l.loggers, logger)
}

// DeleteLogger is removes a logger from the list of destinations that logged
// events are fanned out to.
func (l *MultiLogger) DelLogger(logger *log.Logger) {
l.lock.Lock()
defer l.lock.Unlock()

for i, x := range l.loggers {
if x == logger {
l.loggers = append(l.loggers[:i], l.loggers[i+1:]...)
break
}
}
}

// SetPrefix applies the prefix to every registered logger.
func (l *MultiLogger) SetPrefix(prefix string) {
l.lock.Lock()
for _, x := range l.loggers {
x.SetPrefix(prefix)
}
l.lock.Unlock()
}

// SetFlags applies the flags to every registered logger.
func (l *MultiLogger) SetFlags(flags int) {
l.lock.Lock()
for _, x := range l.loggers {
x.SetFlags(flags)
}
l.lock.Unlock()
}

func (l *MultiLogger) Logger() *log.Logger {
return l.log
}

func NewMultiLogger() *MultiLogger {
m := &MultiLogger{}
m.log = log.New(m, "", 0)
return m
}
1 change: 1 addition & 0 deletions process.go
Expand Up @@ -162,6 +162,7 @@ func (p *Process) Start() error {
p.reason = e
return e
}
p.logger.Printf("Process id %d", cmd.Process.Pid)
p.process = cmd.Process
p.waiter.Add(1)

Expand Down
4 changes: 2 additions & 2 deletions process_test.go
Expand Up @@ -31,7 +31,7 @@ import (
func TestProcessStartStop(t *testing.T) {
Convey("Test start/stop of a new process", t, func() {
m := NewManager("TestProcessStartStop")
m.SetLogWriter(&testLog{t: t})
SetTestLogger(t, m)
s1 := NewProcess("ProcessStartStop:S1", &exec.Cmd{
Path: "process_test.sh",
Args: []string{"process_test.sh", "3600"},
Expand Down Expand Up @@ -62,7 +62,7 @@ func TestProcessStartStop(t *testing.T) {
func TestProcessFail(t *testing.T) {
Convey("Test a failing process", t, func() {
m := NewManager("TestProcessFail")
m.SetLogWriter(&testLog{t: t})
SetTestLogger(t, m)
s1 := NewProcess("ProcessFail:S1", &exec.Cmd{
Path: "process_test.sh",
Args: []string{"process_test.sh", "fail"},
Expand Down
9 changes: 8 additions & 1 deletion rpc/server.go
Expand Up @@ -164,7 +164,14 @@ func (h *Handler) clearService(w http.ResponseWriter, r *http.Request) {
}

func (h *Handler) getLog(w http.ResponseWriter, r *http.Request) {
http.Error(w, "Log TBD", http.StatusNotImplemented)
vars := mux.Vars(r)
name := vars["service"]
if svc, e := h.findService(name); e != nil {
e.write(w)
} else {
lines := svc.GetLog()
h.writeJson(w, lines)
}
}

func (h *Handler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
Expand Down
58 changes: 51 additions & 7 deletions service.go
Expand Up @@ -85,6 +85,27 @@ type Service struct {
ratePeriod time.Duration
startTimes []time.Time
notify func()
slog *ServiceLog
mlog *MultiLogger
}

const maxLogRecords = 1000

type ServiceLog struct {
Records []string
NumRecords int
}

func (s *ServiceLog) Write(b []byte) (int, error) {
if s.Records == nil {
s.Records = make([]string, maxLogRecords)
}
str := strings.Trim(string(b), "\n")
for _, line := range strings.Split(str, "\n") {
s.Records[s.NumRecords%len(s.Records)] = line
s.NumRecords++
}
return len(b), nil
}

// The service name. This takes either the form <base> or <base>:<variant>.
Expand Down Expand Up @@ -344,7 +365,11 @@ func (s *Service) setProp(n PropertyName, v interface{}) error {
// Cannot change logger while service enabled.
return ErrPropReadOnly
}
if s.logger != nil {
s.mlog.DelLogger(s.logger)
}
s.logger = v
s.mlog.AddLogger(s.logger)
} else {
return ErrBadPropType
}
Expand Down Expand Up @@ -453,6 +478,24 @@ func (s *Service) GetProperty(n PropertyName) (interface{}, error) {
return s.prov.Property(n)
}

func (s *Service) GetLog() []string {
if m := s.mgr; m != nil {
m.lock()
defer m.unlock()
}
recs := make([]string, 0, s.slog.NumRecords%len(s.slog.Records))
cur := s.slog.NumRecords
cnt := cur % len(s.slog.Records)
if cnt > cur {
cnt = cur
}
for i := cur - cnt; i < cnt; i++ {
recs = append(recs, s.slog.Records[i%len(s.slog.Records)])

}
return recs
}

// setManager is called by the framework when the service is added to
// the manager. This calculates the various dependency graphs, updating
// links to other services in the manager.
Expand All @@ -461,9 +504,7 @@ func (s *Service) setManager(mgr *Manager) {
// This is a serious programmer mistake
panic("Already added to a manager")
}

s.logger = mgr.getLogger(s)
s.prov.SetProperty(PropLogger, s.logger)
s.mlog.AddLogger(mgr.getLogger(s))
s.mgr = mgr

s.incompat = make(map[*Service]bool)
Expand Down Expand Up @@ -546,9 +587,7 @@ func (s *Service) delManager() {
}

func (s *Service) logf(fmt string, v ...interface{}) {
if s.logger != nil {
s.logger.Printf(fmt, v...)
}
s.mlog.Logger().Printf(fmt, v...)
}

func (s *Service) startRecurse() {
Expand Down Expand Up @@ -630,7 +669,7 @@ func (s *Service) checkService() error {
}
s.checking = true
if e := s.prov.Check(); e != nil {
s.logger.Printf("Service %s failed: %v", s.Name(), e)
s.logf("Service %s failed: %v", s.Name(), e)
s.failed = true
s.stopRecurse()
s.err = e
Expand Down Expand Up @@ -726,6 +765,11 @@ func NewService(p Provider) *Service {
s.conflicts = append([]string{}, p.Conflicts()...)
s.depends = append([]string{}, p.Depends()...)
s.provides = append([]string{}, p.Provides()...)
s.mlog = NewMultiLogger()
s.mlog.Logger().SetPrefix("[" + s.Name() + "] ")
s.prov.SetProperty(PropLogger, s.mlog.Logger())
s.slog = &ServiceLog{}
s.mlog.AddLogger(log.New(s.slog, "", log.LstdFlags))
p.SetProperty(PropNotify, s.doNotify)
return s
}

0 comments on commit edc26dc

Please sign in to comment.