feat(server): Initial Stackdriver-compatible log formatter
This formatter has basic support for the Stackdriver Error Reporting format, but several things are still lacking: * the service version (preferably git commit?) needs to be included in the server somehow * log streams should be split between stdout/stderr as that is how AppEngine (and several other GCP services?) seemingly differentiate between info/error logs
This commit is contained in:
parent
0642f7044d
commit
95abb1bcde
1 changed files with 68 additions and 0 deletions
68
tools/nixery/server/logs.go
Normal file
68
tools/nixery/server/logs.go
Normal file
|
@ -0,0 +1,68 @@
|
|||
package main
|
||||
|
||||
// This file configures different log formatters via logrus. The
|
||||
// standard formatter uses a structured JSON format that is compatible
|
||||
// with Stackdriver Error Reporting.
|
||||
//
|
||||
// https://cloud.google.com/error-reporting/docs/formatting-error-messages
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
log "github.com/sirupsen/logrus"
|
||||
)
|
||||
|
||||
type stackdriverFormatter struct{}
|
||||
|
||||
type serviceContext struct {
|
||||
Service string `json:"service"`
|
||||
Version string `json:"version"`
|
||||
}
|
||||
|
||||
type reportLocation struct {
|
||||
FilePath string `json:"filePath"`
|
||||
LineNumber int `json:"lineNumber"`
|
||||
FunctionName string `json:"functionName"`
|
||||
}
|
||||
|
||||
var nixeryContext = serviceContext{
|
||||
Service: "nixery",
|
||||
Version: "TODO(tazjin)", // angry?
|
||||
}
|
||||
|
||||
// isError determines whether an entry should be logged as an error
|
||||
// (i.e. with attached `context`).
|
||||
//
|
||||
// This requires the caller information to be present on the log
|
||||
// entry, as stacktraces are not available currently.
|
||||
func isError(e *log.Entry) bool {
|
||||
l := e.Level
|
||||
return (l == log.ErrorLevel || l == log.FatalLevel || l == log.PanicLevel) &&
|
||||
e.HasCaller()
|
||||
}
|
||||
|
||||
func (f stackdriverFormatter) Format(e *log.Entry) ([]byte, error) {
|
||||
msg := e.Data
|
||||
msg["serviceContext"] = &nixeryContext
|
||||
msg["message"] = &e.Message
|
||||
msg["eventTime"] = &e.Time
|
||||
|
||||
if isError(e) {
|
||||
loc := reportLocation{
|
||||
FilePath: e.Caller.File,
|
||||
LineNumber: e.Caller.Line,
|
||||
FunctionName: e.Caller.Function,
|
||||
}
|
||||
msg["context"] = &loc
|
||||
}
|
||||
|
||||
b := new(bytes.Buffer)
|
||||
err := json.NewEncoder(b).Encode(&msg)
|
||||
|
||||
return b.Bytes(), err
|
||||
}
|
||||
|
||||
func init() {
|
||||
log.SetReportCaller(true)
|
||||
log.SetFormatter(stackdriverFormatter{})
|
||||
}
|
Loading…
Reference in a new issue