mirror of
https://github.com/fleetdm/fleet
synced 2026-04-21 13:37:30 +00:00
aaac4b1dfe
<!-- Add the related story/sub-task/bug number, like Resolves #123, or remove if NA --> **Related issue:** Resolves #38889 PLEASE READ BELOW before looking at file changes Before converting individual files/packages to slog, we generally need to make these 2 changes to make the conversion easier: - Replace uses of `kitlog.With` since they are not fully compatible with our kitlog adapter - Directly use the kitlog adapter logger type instead of the kitlog interface, which will let us have direct access to the underlying slog logger: `*logging.Logger` Note: that I did not replace absolutely all uses of `kitlog.Logger`, but I did remove all uses of `kitlog.With` except for these due to complexity: - server/logging/filesystem.go and the other log writers (webhook, firehose, kinesis, lambda, pubsub, nats) - server/datastore/mysql/nanomdm_storage.go (adapter pattern) - server/vulnerabilities/nvd/* (cascades to CLI tools) - server/service/osquery_utils/queries.go (callback type signatures cascade broadly) - cmd/maintained-apps/ (standalone, so can be transitioned later all at once) Most of the changes in this PR follow these patterns: - `kitlog.Logger` type → `*logging.Logger` - `kitlog.With(logger, ...)` → `logger.With(...)` - `kitlog.NewNopLogger() → logging.NewNopLogger()`, including similar variations such as `logging.NewLogfmtLogger(w)` and `logging.NewJSONLogger(w)` - removed many now-unused kitlog imports Unique changes that the PR review should focus on: - server/platform/logging/kitlog_adapter.go: Core adapter changes - server/platform/logging/logging.go: New convenience functions - server/service/integration_logger_test.go: Test changes for slog # Checklist for submitter If some of the following don't apply, delete the relevant line. - [x] Changes file added for user-visible changes in `changes/`, `orbit/changes/` or `ee/fleetd-chrome/changes`. - Was added in previous PR ## Testing - [x] Added/updated automated tests - [x] QA'd all new/changed functionality manually <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Refactor** * Migrated the codebase to a unified internal structured logging system for more consistent, reliable logs and observability. * No user-facing functionality changed; runtime behavior and APIs remain compatible. * **Tests** * Updated tests to use the new logging helpers to ensure consistent test logging and validation. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
107 lines
2.5 KiB
Go
107 lines
2.5 KiB
Go
package logging
|
|
|
|
import (
|
|
"log/slog"
|
|
"testing"
|
|
|
|
kitlog "github.com/go-kit/log"
|
|
"github.com/go-kit/log/level"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/fleetdm/fleet/v4/server/platform/logging/testutils"
|
|
)
|
|
|
|
// newTestAdapter creates a kitlog adapter with a TestHandler for capturing records.
|
|
func newTestAdapter(t *testing.T) (*testutils.TestHandler, kitlog.Logger) {
|
|
t.Helper()
|
|
handler := testutils.NewTestHandler()
|
|
slogLogger := slog.New(handler)
|
|
return handler, NewLogger(slogLogger)
|
|
}
|
|
|
|
func TestKitlogAdapter(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
t.Run("basic logging", func(t *testing.T) {
|
|
t.Parallel()
|
|
handler, adapter := newTestAdapter(t)
|
|
|
|
err := adapter.Log("msg", "hello world", "key", "value")
|
|
require.NoError(t, err)
|
|
|
|
record := handler.LastRecord()
|
|
require.NotNil(t, record)
|
|
assert.Equal(t, "hello world", record.Message)
|
|
|
|
attrs := testutils.RecordAttrs(record)
|
|
assert.Equal(t, "value", attrs["key"])
|
|
})
|
|
|
|
t.Run("with context via With", func(t *testing.T) {
|
|
t.Parallel()
|
|
handler, adapter := newTestAdapter(t)
|
|
|
|
kitlogAdapter, ok := adapter.(*Logger)
|
|
require.True(t, ok, "adapter should be *Logger")
|
|
|
|
contextLogger := kitlogAdapter.With("component", "test-component")
|
|
err := contextLogger.Log("msg", "message with context")
|
|
require.NoError(t, err)
|
|
|
|
record := handler.LastRecord()
|
|
require.NotNil(t, record)
|
|
assert.Equal(t, "message with context", record.Message)
|
|
|
|
attrs := testutils.RecordAttrs(record)
|
|
assert.Equal(t, "test-component", attrs["component"])
|
|
})
|
|
|
|
}
|
|
|
|
func TestKitlogAdapterLevels(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tests := []struct {
|
|
name string
|
|
levelFunc func(kitlog.Logger) kitlog.Logger
|
|
expectedLevel slog.Level
|
|
}{
|
|
{
|
|
name: "info",
|
|
levelFunc: level.Info,
|
|
expectedLevel: slog.LevelInfo,
|
|
},
|
|
{
|
|
name: "debug",
|
|
levelFunc: level.Debug,
|
|
expectedLevel: slog.LevelDebug,
|
|
},
|
|
{
|
|
name: "warn",
|
|
levelFunc: level.Warn,
|
|
expectedLevel: slog.LevelWarn,
|
|
},
|
|
{
|
|
name: "error",
|
|
levelFunc: level.Error,
|
|
expectedLevel: slog.LevelError,
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
handler, adapter := newTestAdapter(t)
|
|
|
|
leveledLogger := tc.levelFunc(adapter)
|
|
err := leveledLogger.Log("msg", tc.name+" message")
|
|
require.NoError(t, err)
|
|
|
|
record := handler.LastRecord()
|
|
require.NotNil(t, record)
|
|
assert.Equal(t, tc.name+" message", record.Message)
|
|
assert.Equal(t, tc.expectedLevel, record.Level)
|
|
})
|
|
}
|
|
}
|