mirror of
https://github.com/prometheus/prometheus.git
synced 2024-11-09 23:24:05 -08:00
6ebfbd2d54
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>
91 lines
2.6 KiB
Go
91 lines
2.6 KiB
Go
// Copyright 2021 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 tsdbutil
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"testing"
|
|
|
|
prom_testutil "github.com/prometheus/client_golang/prometheus/testutil"
|
|
"github.com/prometheus/common/promslog"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/prometheus/prometheus/util/testutil"
|
|
)
|
|
|
|
// TestDirLockerUsage performs a set of tests which guarantee correct usage of
|
|
// DirLocker. open should use data as the storage directory, and createLock
|
|
// to determine if a lock file should be used.
|
|
func TestDirLockerUsage(t *testing.T, open func(t *testing.T, data string, createLock bool) (*DirLocker, testutil.Closer)) {
|
|
t.Helper()
|
|
|
|
cases := []struct {
|
|
fileAlreadyExists bool
|
|
lockFileDisabled bool
|
|
expectedValue int
|
|
}{
|
|
{
|
|
fileAlreadyExists: false,
|
|
lockFileDisabled: false,
|
|
expectedValue: lockfileCreatedCleanly,
|
|
},
|
|
{
|
|
fileAlreadyExists: true,
|
|
lockFileDisabled: false,
|
|
expectedValue: lockfileReplaced,
|
|
},
|
|
{
|
|
fileAlreadyExists: true,
|
|
lockFileDisabled: true,
|
|
expectedValue: lockfileDisabled,
|
|
},
|
|
{
|
|
fileAlreadyExists: false,
|
|
lockFileDisabled: true,
|
|
expectedValue: lockfileDisabled,
|
|
},
|
|
}
|
|
|
|
for _, c := range cases {
|
|
t.Run(fmt.Sprintf("%+v", c), func(t *testing.T) {
|
|
tmpdir, err := os.MkdirTemp("", "test")
|
|
require.NoError(t, err)
|
|
t.Cleanup(func() {
|
|
require.NoError(t, os.RemoveAll(tmpdir))
|
|
})
|
|
|
|
// Test preconditions (file already exists + lockfile option)
|
|
if c.fileAlreadyExists {
|
|
tmpLocker, err := NewDirLocker(tmpdir, "tsdb", promslog.NewNopLogger(), nil)
|
|
require.NoError(t, err)
|
|
err = os.WriteFile(tmpLocker.path, []byte{}, 0o644)
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
locker, closer := open(t, tmpdir, !c.lockFileDisabled)
|
|
require.Equal(t, float64(c.expectedValue), prom_testutil.ToFloat64(locker.createdCleanly))
|
|
|
|
// Close the client. This should delete the lockfile.
|
|
closer.Close()
|
|
|
|
// Check that the lockfile is always deleted
|
|
if !c.lockFileDisabled {
|
|
_, err = os.Stat(locker.path)
|
|
require.True(t, os.IsNotExist(err), "lockfile was not deleted")
|
|
}
|
|
})
|
|
}
|
|
}
|