Skip to content

fix(metrics): fallback to mock writer on file open failure to prevent panic #596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abhaygoudannavar wants to merge 2 commits into
base: main
Choose a base branch
from
+15 −1
Open

fix(metrics): fallback to mock writer on file open failure to prevent panic #596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05344a3
fix(metrics): fallback to mock writer on file open failure
abhaygoudannavar May 1, 2026
f5df606
test(metrics): explicitly check for non-nil writer instead of crash t…
abhaygoudannavar May 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion internal/metrics/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import (
"os"

"github.com/rs/zerolog"
"github.com/sirupsen/logrus"
)

type Writer interface {
Expand Down Expand Up @@ -57,7 +58,8 @@ func NewZerologMetrics(enabled bool, target string, containerID string) Writer {
zerolog.TimeFieldFormat = zerolog.TimeFormatUnixNano
file, err := os.OpenFile(target, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
if err != nil {
return nil
logrus.Warnf("Failed to open metrics file %s: %v. Metrics will be disabled.", target, err)
return &mockWriter{}
}
logger := zerolog.New(file).Level(zerolog.InfoLevel).With().Timestamp().Logger()
return &zerologMetrics{
Expand Down
12 changes: 12 additions & 0 deletions internal/metrics/metrics_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,15 @@ func TestZerologMetricsMetadata(t *testing.T) {
t.Errorf("timestampOrder = %v, want 0", got)
}
}

func TestZerologMetricsInvalidFileDoesNotPanic(t *testing.T) {
// Provide a path to a directory that definitely does not exist
invalidPath := "/does/not/exist/timestamps.log"

// Create the metrics writer with timestamps enabled but an invalid path
writer := NewZerologMetrics(true, invalidPath, "container-test")

if writer == nil {
t.Fatal("expected non-nil writer (fallback to mockWriter), got nil")
}
}