logrus: add deployment channel as field to the logs

This commit is contained in:
Florian Schüller 2024-08-01 18:04:06 +02:00 committed by Florian Schüller
parent 2da3a73308
commit 9006836afc
5 changed files with 80 additions and 11 deletions

View file

@ -0,0 +1,26 @@
package common
import (
"github.com/sirupsen/logrus"
)
type EnvironmentHook struct {
Channel string
}
func (h *EnvironmentHook) Levels() []logrus.Level {
return []logrus.Level{
logrus.DebugLevel,
logrus.InfoLevel,
logrus.WarnLevel,
logrus.ErrorLevel,
logrus.FatalLevel,
logrus.PanicLevel,
}
}
func (h *EnvironmentHook) Fire(e *logrus.Entry) error {
e.Data["channel"] = h.Channel
return nil
}

View file

@ -0,0 +1,30 @@
package common
import (
"bytes"
"testing"
"github.com/sirupsen/logrus"
"github.com/stretchr/testify/require"
)
func makeLogrus(buf *bytes.Buffer) *logrus.Logger {
return &logrus.Logger{
Out: buf,
Formatter: &logrus.TextFormatter{
DisableTimestamp: true,
DisableColors: true,
},
Hooks: make(logrus.LevelHooks),
Level: logrus.DebugLevel,
}
}
func TestInfoWithEnvironment(t *testing.T) {
buf := &bytes.Buffer{}
l := makeLogrus(buf)
l.AddHook(&EnvironmentHook{Channel: "test_framework"})
l.Info("test message")
require.Equal(t, "level=info msg=\"test message\" channel=test_framework\n", buf.String())
}