Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-23 08:58:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 111

Fix logging of errors in kitlog (#2427)

Browse source 
* Fix logging of errors in kitlog

* Update error messages
This commit is contained in:
Tomas Touceda 2021-10-07 18:15:40 -03:00 committed by GitHub
parent 834289c0c8
commit e08fcb949b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 62 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changes/fix-logging-of-errors Normal file
View file

@ -0,0 +1 @@
* Fix logging of errors in fleet serve.

19
server/contexts/logging/logging.go
View file

@ -110,13 +110,24 @@ func (l *LoggingContext) Log(ctx context.Context, logger kitlog.Logger) {
}
if len(l.Errs) > 0 {
var errs []string
var internalErrs []string
// Going for string concatenation here instead of json.Marshal mostly to not have to deal with error handling
// within this method. kitlog doesn't support slices of strings
var errs string
var internalErrs string
separator := " || "
for _, err := range l.Errs {
if e, ok := err.(fleet.ErrWithInternal); ok {
internalErrs = append(internalErrs, e.Internal())
if internalErrs == "" {
internalErrs = e.Internal()
} else {
internalErrs += separator + e.Internal()
}
} else {
errs = append(errs, err.Error())
if errs == "" {
errs = err.Error()
} else {
errs += separator + err.Error()
}
}
}
if len(errs) > 0 {

43
server/contexts/logging/logging_test.go Normal file
View file

@ -0,0 +1,43 @@
package logging
import (
"bytes"
"context"
"strings"
"testing"
kitlog "github.com/go-kit/kit/log"
"github.com/pkg/errors"
"github.com/stretchr/testify/assert"
)
func TestLoggingErrs(t *testing.T) {
setupTest := func() (*bytes.Buffer, kitlog.Logger, *LoggingContext, context.Context) {
buf := new(bytes.Buffer)
logger := kitlog.NewLogfmtLogger(buf)
lc := &LoggingContext{}
ctx := NewContext(context.Background(), lc)
return buf, logger, lc, ctx
}
checkLogEnds := func(t *testing.T, logLine string, expected string) bool {
return assert.True(t, strings.HasSuffix(strings.TrimSpace(logLine), expected), logLine)
}
t.Run("one error", func(t *testing.T) {
buf, logger, lc, ctx := setupTest()
WithErr(ctx, errors.Wrap(errors.New("AAAA"), "BLAH"))
lc.Log(ctx, logger)
logLine := buf.String()
checkLogEnds(t, logLine, `err="BLAH: AAAA"`)
})
t.Run("two errors", func(t *testing.T) {
buf, logger, lc, ctx := setupTest()
WithErr(ctx, errors.Wrap(errors.New("AAAA"), "BLAH"))
WithErr(ctx, errors.Wrap(errors.New("BBBB"), "FOO"))
lc.Log(ctx, logger)
logLine := buf.String()
checkLogEnds(t, logLine, `err="BLAH: AAAA || FOO: BBBB"`)
})
}

2
server/service/integration_logger_test.go
View file

@ -182,5 +182,5 @@ func (s *integrationLoggerTestSuite) TestEnrollAgentLogsErrors() {
require.Len(t, parts, 1)
logData := make(map[string]json.RawMessage)
require.NoError(t, json.Unmarshal([]byte(parts[0]), &logData))
assert.Equal(t, json.RawMessage(`["enroll failed: no matching secret found"]`), logData["err"])
assert.Equal(t, json.RawMessage(`"enroll failed: no matching secret found"`), logData["err"])
}

4
server/service/service_osquery_test.go
View file

@ -1664,8 +1664,8 @@ func TestDistributedQueriesLogsManyErrors(t *testing.T) {
require.Len(t, parts, 1)
logData := make(map[string]json.RawMessage)
require.NoError(t, json.Unmarshal([]byte(parts[0]), &logData))
assert.Equal(t, json.RawMessage(`["something went wrong"]`), logData["err"])
assert.Equal(t, json.RawMessage(`["Missing authorization check"]`), logData["internal"])
assert.Equal(t, json.RawMessage(`"something went wrong"`), logData["err"])
assert.Equal(t, json.RawMessage(`"Missing authorization check"`), logData["internal"])
}
func TestDistributedQueriesReloadsHostIfDetailsAreIn(t *testing.T) {