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>
83 lines
2.7 KiB
Go
83 lines
2.7 KiB
Go
// Copyright 2020 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 (
|
|
"fmt"
|
|
"log/slog"
|
|
"os"
|
|
|
|
"github.com/prometheus/common/promslog"
|
|
)
|
|
|
|
// JSONFileLogger represents a logger that writes JSON to a file. It implements the promql.QueryLogger interface.
|
|
type JSONFileLogger struct {
|
|
logger *slog.Logger
|
|
file *os.File
|
|
}
|
|
|
|
// NewJSONFileLogger returns a new JSONFileLogger.
|
|
func NewJSONFileLogger(s string) (*JSONFileLogger, error) {
|
|
if s == "" {
|
|
return nil, nil
|
|
}
|
|
|
|
f, err := os.OpenFile(s, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0o666)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("can't create json log file: %w", err)
|
|
}
|
|
|
|
jsonFmt := &promslog.AllowedFormat{}
|
|
_ = jsonFmt.Set("json")
|
|
return &JSONFileLogger{
|
|
logger: promslog.New(&promslog.Config{Format: jsonFmt, Writer: f}),
|
|
file: f,
|
|
}, nil
|
|
}
|
|
|
|
// Close closes the underlying file. It implements the promql.QueryLogger interface.
|
|
func (l *JSONFileLogger) Close() error {
|
|
return l.file.Close()
|
|
}
|
|
|
|
// With calls the `With()` method on the underlying `log/slog.Logger` with the
|
|
// provided msg and args. It implements the promql.QueryLogger interface.
|
|
func (l *JSONFileLogger) With(args ...any) {
|
|
l.logger = l.logger.With(args...)
|
|
}
|
|
|
|
// Info calls the `Info()` method on the underlying `log/slog.Logger` with the
|
|
// provided msg and args. It implements the promql.QueryLogger interface.
|
|
func (l *JSONFileLogger) Info(msg string, args ...any) {
|
|
l.logger.Info(msg, args...)
|
|
}
|
|
|
|
// Error calls the `Error()` method on the underlying `log/slog.Logger` with the
|
|
// provided msg and args. It implements the promql.QueryLogger interface.
|
|
func (l *JSONFileLogger) Error(msg string, args ...any) {
|
|
l.logger.Error(msg, args...)
|
|
}
|
|
|
|
// Debug calls the `Debug()` method on the underlying `log/slog.Logger` with the
|
|
// provided msg and args. It implements the promql.QueryLogger interface.
|
|
func (l *JSONFileLogger) Debug(msg string, args ...any) {
|
|
l.logger.Debug(msg, args...)
|
|
}
|
|
|
|
// Warn calls the `Warn()` method on the underlying `log/slog.Logger` with the
|
|
// provided msg and args. It implements the promql.QueryLogger interface.
|
|
func (l *JSONFileLogger) Warn(msg string, args ...any) {
|
|
l.logger.Warn(msg, args...)
|
|
}
|