aboutsummaryrefslogtreecommitdiffstats
path: root/log/logger.go
blob: 47c33da9a62ea8ad9be2f20a361f96dec1709834 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
package log

import (
	"io"
	"log"
	"net"
	"sync"
	"time"

	"github.com/mpolden/zdns/sql"
)

// Logger wraps a standard log.Logger and an optional log database.
type Logger struct {
	*log.Logger
	Now        func() time.Time
	queue      chan Entry
	db         *sql.Client
	maintainer *maintainer
	wg         sync.WaitGroup
}

// RecordOptions configures recording of DNS requests.
type RecordOptions struct {
	Database       string
	ExpiryInterval time.Duration
	TTL            time.Duration
}

// Entry represents a DNS request log entry.
type Entry struct {
	Time       time.Time
	RemoteAddr net.IP
	Qtype      uint16
	Question   string
	Answers    []string
}

type maintainer struct {
	interval time.Duration
	ttl      time.Duration
	done     chan bool
}

// New creates a new logger wrapping a standard log.Logger.
func New(w io.Writer, prefix string, options RecordOptions) (*Logger, error) {
	logger := &Logger{
		Logger: log.New(w, prefix, 0),
		queue:  make(chan Entry, 100),
		Now:    time.Now,
	}
	var err error
	if options.Database != "" {
		logger.db, err = sql.New(options.Database)
		if err != nil {
			return nil, err
		}
	}
	logger.wg.Add(1)
	go logger.readQueue()
	if options.TTL > 0 {
		if options.ExpiryInterval <= 0 {
			options.ExpiryInterval = time.Minute
		}
		maintain(logger, options.ExpiryInterval, options.TTL)
	}
	return logger, nil
}

func maintain(logger *Logger, interval, ttl time.Duration) {
	m := &maintainer{
		interval: interval,
		ttl:      ttl,
		done:     make(chan bool),
	}
	logger.maintainer = m
	logger.wg.Add(1)
	go m.run(logger)
}

func (m *maintainer) run(logger *Logger) {
	ticker := time.NewTicker(m.interval)
	defer logger.wg.Done()
	for {
		select {
		case <-ticker.C:
			t := logger.Now().Add(-m.ttl)
			if err := logger.db.DeleteLogBefore(t); err != nil {
				logger.Printf("error deleting log entries before %v: %s", t, err)
			}
		case <-m.done:
			ticker.Stop()
			return
		}
	}
}

// Close consumes any outstanding log requests and closes the logger.
func (l *Logger) Close() error {
	close(l.queue)
	if l.maintainer != nil {
		l.maintainer.done <- true
	}
	l.wg.Wait()
	return nil
}

// Record records the given DNS request to the log database.
func (l *Logger) Record(remoteAddr net.IP, qtype uint16, question string, answers ...string) {
	if l.db == nil {
		return
	}
	l.queue <- Entry{
		Time:       l.Now(),
		RemoteAddr: remoteAddr,
		Qtype:      qtype,
		Question:   question,
		Answers:    answers,
	}
}

// Get returns the n most recent persisted log entries.
func (l *Logger) Get(n int) ([]Entry, error) {
	logEntries, err := l.db.ReadLog(n)
	if err != nil {
		return nil, err
	}
	ids := make(map[int64]*Entry)
	entries := make([]Entry, 0, len(logEntries))
	for _, le := range logEntries {
		entry, ok := ids[le.ID]
		if !ok {
			newEntry := Entry{
				Time:       time.Unix(le.Time, 0).UTC(),
				RemoteAddr: le.RemoteAddr,
				Qtype:      le.Qtype,
				Question:   le.Question,
			}
			entries = append(entries, newEntry)
			entry = &entries[len(entries)-1]
			ids[le.ID] = entry
		}
		entry.Answers = append(entry.Answers, le.Answer)
	}
	return entries, nil
}

func (l *Logger) readQueue() {
	defer l.wg.Done()
	for entry := range l.queue {
		if err := l.db.WriteLog(entry.Time, entry.RemoteAddr, entry.Qtype, entry.Question, entry.Answers...); err != nil {
			l.Printf("write failed: %+v: %s", entry, err)
		}
	}
}