forked from mozilla/mig
/
logging_windows.go
377 lines (341 loc) · 7.81 KB
/
logging_windows.go
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
// +build windows
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
//
// Contributor: Julien Vehent jvehent@mozilla.com [:ulfr]
package mig /* import "mig.ninja/mig" */
import (
"fmt"
"log"
"os"
"sync"
"golang.org/x/sys/windows/svc/eventlog"
)
const (
MODE_STDOUT = 1 << iota
MODE_FILE
MODE_EVENTLOG
)
// Logging stores the attributes needed to perform the logging
type Logging struct {
// configuration
Mode, Level, File, Host, Protocol, Facility string
Port int
MaxFileSize int64
// internal
logmode int
maxlvl int
fd *eventlog.Log
rotateWriter rotateLogWriter
}
// Log defines a log entry
type Log struct {
OpID, ActionID, CommandID float64
Sev, Desc string
Priority int
}
func (l Log) Emerg() (mlog Log) {
mlog = l
mlog.Priority = eventlog.Error
mlog.Sev = "emergency"
return
}
func (l Log) Alert() (mlog Log) {
mlog = l
mlog.Priority = eventlog.Error
mlog.Sev = "alert"
return
}
func (l Log) Crit() (mlog Log) {
mlog = l
mlog.Priority = eventlog.Error
mlog.Sev = "critical"
return
}
func (l Log) Err() (mlog Log) {
mlog = l
mlog.Priority = eventlog.Error
mlog.Sev = "error"
return
}
func (l Log) Warning() (mlog Log) {
mlog = l
mlog.Priority = eventlog.Warning
mlog.Sev = "warning"
return
}
func (l Log) Notice() (mlog Log) {
mlog = l
mlog.Priority = eventlog.Warning
mlog.Sev = "notice"
return
}
func (l Log) Info() (mlog Log) {
mlog = l
mlog.Priority = eventlog.Info
mlog.Sev = "info"
return
}
// don't log debug messages on windows
func (l Log) Debug() (mlog Log) {
mlog = l
mlog.Priority = 999
mlog.Sev = "debug"
return
}
// Custom type to satisfy io.Writer to use as file logging output, handles
// log file rotation
type rotateLogWriter struct {
sync.Mutex
filename string
fd *os.File
maxBytes int64 // Maximum size for log file, 0 means no rotation
}
func (r *rotateLogWriter) new(filename string, maxbytes int64) error {
r.filename = filename
r.maxBytes = maxbytes
return r.initAndCheck()
}
func (r *rotateLogWriter) Write(output []byte) (int, error) {
var err error
err = r.initAndCheck()
if err != nil {
return 0, err
}
return r.fd.Write(output)
}
func (r *rotateLogWriter) initAndCheck() (err error) {
defer func() {
r.Unlock()
if e := recover(); e != nil {
err = fmt.Errorf("initAndCheck() -> %v", e)
}
}()
r.Lock()
// If we haven't initialized yet, open the log file
if r.fd == nil {
r.fd, err = os.OpenFile(r.filename, os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0640)
if err != nil {
panic(err)
}
}
// If the maximum file size is set to 0 we will never rotate
if r.maxBytes == 0 {
return nil
}
// Check the size of the existing log file, and rotate it if required.
// We only keep the current log file and one older one.
var fi os.FileInfo
fi, err = r.fd.Stat()
if err != nil {
panic(err)
}
if fi.Size() < r.maxBytes {
return
}
// Rotate the log and reinitialize it
// If the old file already exists remove it
rotatefile := r.filename + ".1"
_, err = os.Stat(rotatefile)
if err == nil || !os.IsNotExist(err) {
err = os.Remove(rotatefile)
if err != nil {
panic(err)
}
}
// Rename existing log file
err = os.Rename(r.filename, rotatefile)
if err != nil {
panic(err)
}
// Close existing descriptor and reinitialize
r.fd.Close()
r.fd, err = os.OpenFile(r.filename, os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0640)
if err != nil {
panic(err)
}
return
}
// InitLogger prepares the context for logging based on the configuration
// in Logging
func InitLogger(orig_logctx Logging, progname string) (logctx Logging, err error) {
defer func() {
if e := recover(); e != nil {
err = fmt.Errorf("mig.InitLogger() -> %v", e)
}
}()
logctx = orig_logctx
switch logctx.Mode {
case "stdout":
logctx.logmode = MODE_STDOUT
logctx, err = initLogStdOut(logctx)
if err != nil {
panic(err)
}
case "file":
logctx.logmode = MODE_FILE
logctx, err = initLogFile(logctx)
if err != nil {
panic(err)
}
case "syslog":
logctx.logmode = MODE_EVENTLOG
logctx, err = initEventlog(logctx, progname)
if err != nil {
panic(err)
}
default:
log.Println("Logging mode is missing. Assuming stdout.")
logctx.Mode = "stdout"
logctx.logmode = MODE_STDOUT
logctx, err = initLogStdOut(logctx)
if err != nil {
panic(err)
}
}
// set the minimal log level
switch logctx.Level {
case "emerg":
logctx.maxlvl = eventlog.Error
case "alert":
logctx.maxlvl = eventlog.Error
case "crit":
logctx.maxlvl = eventlog.Error
case "err":
logctx.maxlvl = eventlog.Error
case "warning":
logctx.maxlvl = eventlog.Warning
case "notice":
logctx.maxlvl = eventlog.Warning
case "info":
logctx.maxlvl = eventlog.Info
case "debug":
// discard
logctx.maxlvl = 999
}
return
}
// initEventlog creates a connection to event logs and stores the handler in ctx
func initEventlog(orig_logctx Logging, progname string) (logctx Logging, err error) {
logctx = orig_logctx
defer func() {
if e := recover(); e != nil {
err = fmt.Errorf("mig.initEventlog() -> %v", e)
}
}()
const name = "mylog"
const supports = eventlog.Error | eventlog.Warning | eventlog.Info
err = eventlog.InstallAsEventCreate(name, supports)
if err != nil {
panic(err)
}
logctx.fd, err = eventlog.Open(progname)
if err != nil {
panic(err)
}
return
}
// initLogFile creates a logfile and stores the descriptor in ctx
func initLogFile(orig_logctx Logging) (logctx Logging, err error) {
defer func() {
if e := recover(); e != nil {
err = fmt.Errorf("mig.InitLogFile() -> %v", e)
}
}()
logctx = orig_logctx
err = logctx.rotateWriter.new(logctx.File, logctx.MaxFileSize)
if err != nil {
panic(err)
}
log.SetOutput(&logctx.rotateWriter)
return
}
// initLogStdOut does nothing except storing in ctx that logs should be
// sent to stdout directly
func initLogStdOut(orig_logctx Logging) (logctx Logging, err error) {
logctx = orig_logctx
return
}
// processLog receives events and perform logging and evaluationg of the log
// if the log is too critical, Analyze will trigger a scheduler shutdown
func ProcessLog(logctx Logging, l Log) (stop bool, err error) {
stop = false
defer func() {
if e := recover(); e != nil {
err = fmt.Errorf("mig.ProcessLog() -> %v", e)
}
}()
var logline string
// if priority isn't set, use the default "info"
if l.Priority < 1 {
l.Priority = eventlog.Info
}
// discard logs that have a priority that's higher than the
// minimal log level we are configured to log
if l.Priority > logctx.maxlvl {
return
}
if l.OpID > 0 {
logline += fmt.Sprintf("%.0f ", l.OpID)
} else {
logline += "- "
}
if l.ActionID > 0 {
logline += fmt.Sprintf("%.0f ", l.ActionID)
} else {
logline += "- "
}
if l.CommandID > 0 {
logline += fmt.Sprintf("%.0f ", l.CommandID)
} else {
logline += "- "
}
if l.Sev != "" {
logline += "[" + l.Sev + "] "
} else {
logline += "[info] "
}
if l.Desc != "" {
logline += l.Desc
} else {
err = fmt.Errorf("Missing mandatory description in logent")
return
}
switch logctx.logmode {
case MODE_EVENTLOG:
switch l.Priority {
case eventlog.Error:
err = logctx.fd.Error(1, logline)
return
case eventlog.Warning:
err = logctx.fd.Warning(2, logline)
return
case eventlog.Info:
err = logctx.fd.Info(3, logline)
return
case 999:
// debug logs go to stdout
log.Println(logline)
return
default:
err = logctx.fd.Info(3, logline)
return
}
case MODE_STDOUT:
log.Println(logline)
return
case MODE_FILE:
log.Println(logline)
return
default:
log.Println(logline)
return
}
return
}
func (logctx Logging) Destroy() {
if logctx.Mode == "syslog" {
_ = logctx.fd.Close()
}
}