prometheus/util/logging/dedupe_test.go
TJ Hoplock 6ebfbd2d54 chore!: adopt log/slog, remove go-kit/log
For: #14355

This commit updates Prometheus to adopt stdlib's log/slog package in
favor of go-kit/log. As part of converting to use slog, several other
related changes are required to get prometheus working, including:
- removed unused logging util func `RateLimit()`
- forward ported the util/logging/Deduper logging by implementing a small custom slog.Handler that does the deduping before chaining log calls to the underlying real slog.Logger
- move some of the json file logging functionality to use prom/common package functionality
- refactored some of the new json file logging for scraping
- changes to promql.QueryLogger interface to swap out logging methods for relevant slog sugar wrappers
- updated lots of tests that used/replicated custom logging functionality, attempting to keep the logical goal of the tests consistent after the transition
- added a healthy amount of `if logger == nil { $makeLogger }` type conditional checks amongst various functions where none were provided -- old code that used the go-kit/log.Logger interface had several places where there were nil references when trying to use functions like `With()` to add keyvals on the new *slog.Logger type

Signed-off-by: TJ Hoplock <t.hoplock@gmail.com>
2024-10-07 15:58:50 -04:00

59 lines
1.5 KiB
Go

// Copyright 2019 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package logging
import (
"bytes"
"log/slog"
"strings"
"testing"
"time"
"github.com/prometheus/common/promslog"
"github.com/stretchr/testify/require"
)
func TestDedupe(t *testing.T) {
var buf bytes.Buffer
d := Dedupe(promslog.New(&promslog.Config{Writer: &buf}), 100*time.Millisecond)
dlog := slog.New(d)
defer d.Stop()
// Log 10 times quickly, ensure they are deduped.
for i := 0; i < 10; i++ {
dlog.Info("test", "hello", "world")
}
// Trim empty lines
lines := []string{}
for _, line := range strings.Split(buf.String(), "\n") {
if line != "" {
lines = append(lines, line)
}
}
require.Len(t, lines, 1)
// Wait, then log again, make sure it is logged.
time.Sleep(200 * time.Millisecond)
dlog.Info("test", "hello", "world")
// Trim empty lines
lines = []string{}
for _, line := range strings.Split(buf.String(), "\n") {
if line != "" {
lines = append(lines, line)
}
}
require.Len(t, lines, 2)
}