mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
feat(logging): add streams (#11435)
# Which Problems Are Solved Streams allow differentiating logs produced by different components of Zitadel. # How the Problems Are Solved The `backend/v3/instrumentation/logging` package now exposes convenience function for setting and getting a logger from the context. As well as high-level functions to emit log records at various levels. When constructing a new logger a "stream" needs to be specified: - **runtime**: General runtime logs, such as startup and shutdown messages. Default for logs that do not belong to the other categories. - **request**: Logs for incoming API and HTTP requests. - **event_handler**: Logs for event handling in projections. - **queue**: Logs for the job queue processing. - **event_pusher**: Logs for event pushing to the database. Disabled by default, contains sensitive information. Each line from the returned logger contains a `stream` field as well as a `version` field with the current Zitadel version. ## Runtime config Streams can be enabled by passing an array of stream names in the runtime config. Because some log streams may contain sensitive data (especially events), it is now also possible to mask values by their key. # Additional Changes - Wrap `slogctx` in the `logging` package. (Except API error converter packages, because of import cycle) - Add some docs to `logging` package so other devs understand how to add logging to Zitadel - Add `logging.OnError` and `logging.WithError` helper functions with `Panic()` and `Fatal()` methods, to preserve current calls in the `cmd` packages. - Add instance context extractor. - Only output request details in the request info log. Request ID remains propagated through context. - Moved middleware functionality into protocol specific packages. - Removed setting of URI to context in metric middleware. There were ony setters and no getters. (Unused value) - Reuse a single statusWriter in the middleware package for middlewares that need to know the response status. # Additional Context - Closes #11333 - Closes #11331 - Partly #11330 --------- Co-authored-by: Silvan <[email protected]>
This commit is contained in:
Tim Möhlmann
Silvan
@@ -0,0 +1,583 @@
|
||||
package logging
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"log/slog"
|
||||
"os"
|
||||
"sync"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/zitadel/zitadel/backend/v3/instrumentation"
|
||||
"github.com/zitadel/zitadel/internal/zerrors"
|
||||
)
|
||||
|
||||
var globalLock sync.Mutex
|
||||
|
||||
type testLogEntry struct {
|
||||
Level string
|
||||
Msg string
|
||||
Err *testLogError `json:",omitempty"`
|
||||
Foo string
|
||||
Group struct {
|
||||
V int
|
||||
}
|
||||
}
|
||||
|
||||
type testLogError struct {
|
||||
Kind string
|
||||
Parent string
|
||||
Message string
|
||||
ID string
|
||||
}
|
||||
|
||||
func init() {
|
||||
// Only enable StreamRuntime for tests
|
||||
instrumentation.EnableStreams(StreamRuntime)
|
||||
}
|
||||
|
||||
// prepareDefaultLogger sets the global default logger to a JSON logger writing to a buffer.
|
||||
// It returns a function that MUST be called to retrieve exactly one logged entry and release the global lock.
|
||||
func prepareDefaultLogger() (done func() (*testLogEntry, error)) {
|
||||
globalLock.Lock()
|
||||
var buf bytes.Buffer
|
||||
logger := slog.New(slog.NewJSONHandler(&buf, &slog.HandlerOptions{
|
||||
Level: slog.LevelDebug,
|
||||
AddSource: false,
|
||||
}))
|
||||
slog.SetDefault(logger)
|
||||
|
||||
return func() (*testLogEntry, error) {
|
||||
defer globalLock.Unlock()
|
||||
if buf.Len() == 0 {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
entry := new(testLogEntry)
|
||||
decoder := json.NewDecoder(&buf)
|
||||
if err := decoder.Decode(entry); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return entry, nil
|
||||
}
|
||||
}
|
||||
|
||||
func TestNew(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
stream Stream
|
||||
want *testLogEntry
|
||||
}{
|
||||
{
|
||||
name: "enabled stream",
|
||||
stream: StreamRuntime,
|
||||
want: &testLogEntry{
|
||||
Level: "INFO",
|
||||
Msg: "test message",
|
||||
Foo: "bar",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "disabled stream",
|
||||
stream: StreamEventPusher,
|
||||
want: nil,
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
logger := New(tt.stream, slog.String("foo", "bar"))
|
||||
logger.Info("test message")
|
||||
got, err := done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, tt.want, got)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestFromCtx(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
ctx := NewCtx(
|
||||
t.Context(),
|
||||
StreamRuntime,
|
||||
slog.String("foo", "bar"),
|
||||
)
|
||||
FromCtx(ctx).Info("test message")
|
||||
want := &testLogEntry{
|
||||
Level: "INFO",
|
||||
Msg: "test message",
|
||||
Foo: "bar",
|
||||
}
|
||||
got, err := done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, want, got)
|
||||
}
|
||||
|
||||
func TestWith(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
ctx := NewCtx(
|
||||
t.Context(),
|
||||
StreamRuntime,
|
||||
)
|
||||
ctx = With(ctx, slog.String("foo", "bar"))
|
||||
FromCtx(ctx).Info("test message")
|
||||
want := &testLogEntry{
|
||||
Level: "INFO",
|
||||
Msg: "test message",
|
||||
Foo: "bar",
|
||||
}
|
||||
got, err := done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, want, got)
|
||||
}
|
||||
|
||||
func TestWithGroup(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
ctx := NewCtx(
|
||||
t.Context(),
|
||||
StreamRuntime,
|
||||
)
|
||||
ctx = WithGroup(ctx, "group")
|
||||
ctx = With(ctx, slog.Int("v", 42))
|
||||
FromCtx(ctx).Info("test message")
|
||||
want := &testLogEntry{
|
||||
Level: "INFO",
|
||||
Msg: "test message",
|
||||
Group: struct{ V int }{V: 42},
|
||||
}
|
||||
got, err := done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, want, got)
|
||||
}
|
||||
|
||||
func TestLog(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
ctx := NewCtx(
|
||||
t.Context(),
|
||||
StreamRuntime,
|
||||
)
|
||||
Log(ctx, slog.LevelInfo, "test message", slog.String("foo", "bar"))
|
||||
want := &testLogEntry{
|
||||
Level: "INFO",
|
||||
Msg: "test message",
|
||||
Foo: "bar",
|
||||
}
|
||||
got, err := done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, want, got)
|
||||
}
|
||||
|
||||
func TestDebug(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
ctx := NewCtx(
|
||||
t.Context(),
|
||||
StreamRuntime,
|
||||
)
|
||||
Debug(ctx, "test message", slog.String("foo", "bar"))
|
||||
want := &testLogEntry{
|
||||
Level: "DEBUG",
|
||||
Msg: "test message",
|
||||
Foo: "bar",
|
||||
}
|
||||
got, err := done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, want, got)
|
||||
}
|
||||
|
||||
func TestInfo(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
ctx := NewCtx(
|
||||
t.Context(),
|
||||
StreamRuntime,
|
||||
)
|
||||
Info(ctx, "test message", slog.String("foo", "bar"))
|
||||
want := &testLogEntry{
|
||||
Level: "INFO",
|
||||
Msg: "test message",
|
||||
Foo: "bar",
|
||||
}
|
||||
got, err := done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, want, got)
|
||||
}
|
||||
|
||||
func TestWarn(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
ctx := NewCtx(
|
||||
t.Context(),
|
||||
StreamRuntime,
|
||||
)
|
||||
Warn(ctx, "test message", slog.String("foo", "bar"))
|
||||
want := &testLogEntry{
|
||||
Level: "WARN",
|
||||
Msg: "test message",
|
||||
Foo: "bar",
|
||||
}
|
||||
got, err := done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, want, got)
|
||||
}
|
||||
|
||||
func TestError(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
ctx := NewCtx(
|
||||
t.Context(),
|
||||
StreamRuntime,
|
||||
)
|
||||
Error(ctx, "test message", slog.String("foo", "bar"))
|
||||
want := &testLogEntry{
|
||||
Level: "ERROR",
|
||||
Msg: "test message",
|
||||
Foo: "bar",
|
||||
}
|
||||
got, err := done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, want, got)
|
||||
}
|
||||
|
||||
func TestWithError(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
ctx := NewCtx(
|
||||
t.Context(),
|
||||
StreamRuntime,
|
||||
)
|
||||
err := errors.New("some error")
|
||||
logger := WithError(ctx, err)
|
||||
logger.Info("test message", slog.String("foo", "bar"))
|
||||
want := &testLogEntry{
|
||||
Level: "INFO",
|
||||
Msg: "test message",
|
||||
Err: &testLogError{
|
||||
Kind: "Unknown",
|
||||
Parent: "some error",
|
||||
Message: "an unknown error occurred",
|
||||
ID: "LOG-Ao5ch",
|
||||
},
|
||||
Foo: "bar",
|
||||
}
|
||||
got, err := done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, want, got)
|
||||
}
|
||||
|
||||
func TestOnError(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
err error
|
||||
want *testLogEntry
|
||||
}{
|
||||
{
|
||||
name: "nil error",
|
||||
err: nil,
|
||||
},
|
||||
{
|
||||
name: "non-zitadel error",
|
||||
err: errors.New("some error"),
|
||||
want: &testLogEntry{
|
||||
Level: "INFO",
|
||||
Msg: "test message",
|
||||
Err: &testLogError{
|
||||
Kind: "Unknown",
|
||||
Parent: "some error",
|
||||
Message: "an unknown error occurred",
|
||||
ID: "LOG-ii6Pi",
|
||||
},
|
||||
Foo: "bar",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "zitadel error",
|
||||
err: zerrors.CreateZitadelError(
|
||||
zerrors.KindNotFound,
|
||||
errors.New("parent error"),
|
||||
"ZIT-404",
|
||||
"resource not found",
|
||||
0,
|
||||
),
|
||||
want: &testLogEntry{
|
||||
Level: "INFO",
|
||||
Msg: "test message",
|
||||
Err: &testLogError{
|
||||
Kind: "NotFound",
|
||||
Parent: "parent error",
|
||||
Message: "resource not found",
|
||||
ID: "ZIT-404",
|
||||
},
|
||||
Foo: "bar",
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
ctx := NewCtx(
|
||||
t.Context(),
|
||||
StreamRuntime,
|
||||
)
|
||||
logger := OnError(ctx, tt.err)
|
||||
logger.Info("test message", slog.String("foo", "bar"))
|
||||
got, err := done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, tt.want, got)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestErrorContextLogger_Debug(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
ctx := NewCtx(
|
||||
t.Context(),
|
||||
StreamRuntime,
|
||||
)
|
||||
WithError(ctx, nil).Debug("test message", slog.String("foo", "bar"))
|
||||
want := &testLogEntry{
|
||||
Level: "DEBUG",
|
||||
Msg: "test message",
|
||||
Err: &testLogError{
|
||||
Kind: "Unknown",
|
||||
Parent: "",
|
||||
Message: "an unknown error occurred",
|
||||
ID: "LOG-Ao5ch",
|
||||
},
|
||||
Foo: "bar",
|
||||
}
|
||||
got, err := done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, want, got)
|
||||
}
|
||||
|
||||
func TestErrorContextLogger_Info(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
ctx := NewCtx(
|
||||
t.Context(),
|
||||
StreamRuntime,
|
||||
)
|
||||
WithError(ctx, nil).Info("test message", slog.String("foo", "bar"))
|
||||
want := &testLogEntry{
|
||||
Level: "INFO",
|
||||
Msg: "test message",
|
||||
Err: &testLogError{
|
||||
Kind: "Unknown",
|
||||
Parent: "",
|
||||
Message: "an unknown error occurred",
|
||||
ID: "LOG-Ao5ch",
|
||||
},
|
||||
Foo: "bar",
|
||||
}
|
||||
got, err := done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, want, got)
|
||||
}
|
||||
|
||||
func TestErrorContextLogger_Warn(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
ctx := NewCtx(
|
||||
t.Context(),
|
||||
StreamRuntime,
|
||||
)
|
||||
WithError(ctx, nil).Warn("test message", slog.String("foo", "bar"))
|
||||
want := &testLogEntry{
|
||||
Level: "WARN",
|
||||
Msg: "test message",
|
||||
Err: &testLogError{
|
||||
Kind: "Unknown",
|
||||
Parent: "",
|
||||
Message: "an unknown error occurred",
|
||||
ID: "LOG-Ao5ch",
|
||||
},
|
||||
Foo: "bar",
|
||||
}
|
||||
got, err := done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, want, got)
|
||||
}
|
||||
|
||||
func TestErrorContextLogger_Error(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
ctx := NewCtx(
|
||||
t.Context(),
|
||||
StreamRuntime,
|
||||
)
|
||||
WithError(ctx, nil).Error("test message", slog.String("foo", "bar"))
|
||||
want := &testLogEntry{
|
||||
Level: "ERROR",
|
||||
Msg: "test message",
|
||||
Err: &testLogError{
|
||||
Kind: "Unknown",
|
||||
Parent: "",
|
||||
Message: "an unknown error occurred",
|
||||
ID: "LOG-Ao5ch",
|
||||
},
|
||||
Foo: "bar",
|
||||
}
|
||||
got, err := done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, want, got)
|
||||
}
|
||||
|
||||
func TestErrorContextLogger_Panic(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
construct func(context.Context, error) *ErrorContextLogger
|
||||
err error
|
||||
want *testLogEntry
|
||||
wantPanic any
|
||||
}{
|
||||
{
|
||||
name: "with zitadel error",
|
||||
construct: WithError,
|
||||
err: zerrors.CreateZitadelError(
|
||||
zerrors.KindNotFound,
|
||||
errors.New("parent error"),
|
||||
"ZIT-404",
|
||||
"resource not found",
|
||||
0,
|
||||
),
|
||||
want: &testLogEntry{
|
||||
Level: "ERROR+4",
|
||||
Msg: "test message",
|
||||
Err: &testLogError{
|
||||
Kind: "NotFound",
|
||||
Parent: "parent error",
|
||||
Message: "resource not found",
|
||||
ID: "ZIT-404",
|
||||
},
|
||||
Foo: "bar",
|
||||
},
|
||||
wantPanic: "test message",
|
||||
},
|
||||
{
|
||||
name: "on nil error",
|
||||
construct: OnError,
|
||||
err: nil,
|
||||
want: nil,
|
||||
wantPanic: nil,
|
||||
},
|
||||
{
|
||||
name: "on non-zitadel error",
|
||||
construct: OnError,
|
||||
err: errors.New("some error"),
|
||||
want: &testLogEntry{
|
||||
Level: "ERROR+4",
|
||||
Msg: "test message",
|
||||
Err: &testLogError{
|
||||
Kind: "Unknown",
|
||||
Parent: "some error",
|
||||
Message: "an unknown error occurred",
|
||||
ID: "LOG-ii6Pi",
|
||||
},
|
||||
Foo: "bar",
|
||||
},
|
||||
wantPanic: "test message",
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
ctx := NewCtx(
|
||||
t.Context(),
|
||||
StreamRuntime,
|
||||
)
|
||||
var (
|
||||
gotPanic any
|
||||
gotEntry *testLogEntry
|
||||
err error
|
||||
)
|
||||
|
||||
// need to check in defer because of panic
|
||||
defer func() {
|
||||
gotPanic = recover()
|
||||
gotEntry, err = done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, tt.want, gotEntry)
|
||||
assert.Equal(t, tt.wantPanic, gotPanic)
|
||||
}()
|
||||
tt.construct(ctx, tt.err).Panic("test message", slog.String("foo", "bar"))
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestErrorContextLogger_Fatal(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
construct func(context.Context, error) *ErrorContextLogger
|
||||
err error
|
||||
want *testLogEntry
|
||||
wantExit int
|
||||
}{
|
||||
{
|
||||
name: "with zitadel error",
|
||||
construct: WithError,
|
||||
err: zerrors.CreateZitadelError(
|
||||
zerrors.KindNotFound,
|
||||
errors.New("parent error"),
|
||||
"ZIT-404",
|
||||
"resource not found",
|
||||
0,
|
||||
),
|
||||
want: &testLogEntry{
|
||||
Level: "ERROR+6",
|
||||
Msg: "test message",
|
||||
Err: &testLogError{
|
||||
Kind: "NotFound",
|
||||
Parent: "parent error",
|
||||
Message: "resource not found",
|
||||
ID: "ZIT-404",
|
||||
},
|
||||
Foo: "bar",
|
||||
},
|
||||
wantExit: 1,
|
||||
},
|
||||
{
|
||||
name: "on nil error",
|
||||
construct: OnError,
|
||||
err: nil,
|
||||
want: nil,
|
||||
wantExit: 0,
|
||||
},
|
||||
{
|
||||
name: "on non-zitadel error",
|
||||
construct: OnError,
|
||||
err: errors.New("some error"),
|
||||
want: &testLogEntry{
|
||||
Level: "ERROR+6",
|
||||
Msg: "test message",
|
||||
Err: &testLogError{
|
||||
Kind: "Unknown",
|
||||
Parent: "some error",
|
||||
Message: "an unknown error occurred",
|
||||
ID: "LOG-ii6Pi",
|
||||
},
|
||||
Foo: "bar",
|
||||
},
|
||||
wantExit: 1,
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
done := prepareDefaultLogger()
|
||||
ctx := NewCtx(
|
||||
t.Context(),
|
||||
StreamRuntime,
|
||||
)
|
||||
var gotExit int
|
||||
exit = func(code int) {
|
||||
gotExit = code
|
||||
}
|
||||
defer func() {
|
||||
exit = os.Exit
|
||||
}()
|
||||
|
||||
tt.construct(ctx, tt.err).Fatal("test message", slog.String("foo", "bar"))
|
||||
gotEntry, err := done()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, tt.want, gotEntry)
|
||||
assert.Equal(t, tt.wantExit, gotExit)
|
||||
})
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user