2023-05-09 17:19:48 +00:00
|
|
|
/*
|
|
|
|
*
|
|
|
|
* Copyright 2020 gRPC 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.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2024-09-16 09:06:00 +00:00
|
|
|
// Package grpclog provides logging functionality for internal gRPC packages,
|
|
|
|
// outside of the functionality provided by the external `grpclog` package.
|
2023-05-09 17:19:48 +00:00
|
|
|
package grpclog
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
2024-09-16 09:06:00 +00:00
|
|
|
|
|
|
|
"google.golang.org/grpc/grpclog"
|
2023-05-09 17:19:48 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
// PrefixLogger does logging with a prefix.
|
|
|
|
//
|
|
|
|
// Logging method on a nil logs without any prefix.
|
|
|
|
type PrefixLogger struct {
|
2024-09-16 09:06:00 +00:00
|
|
|
logger grpclog.DepthLoggerV2
|
2023-05-09 17:19:48 +00:00
|
|
|
prefix string
|
|
|
|
}
|
|
|
|
|
|
|
|
// Infof does info logging.
|
2023-09-18 12:47:28 +00:00
|
|
|
func (pl *PrefixLogger) Infof(format string, args ...any) {
|
2023-05-09 17:19:48 +00:00
|
|
|
if pl != nil {
|
|
|
|
// Handle nil, so the tests can pass in a nil logger.
|
|
|
|
format = pl.prefix + format
|
|
|
|
pl.logger.InfoDepth(1, fmt.Sprintf(format, args...))
|
|
|
|
return
|
|
|
|
}
|
2024-09-16 09:06:00 +00:00
|
|
|
grpclog.InfoDepth(1, fmt.Sprintf(format, args...))
|
2023-05-09 17:19:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Warningf does warning logging.
|
2023-09-18 12:47:28 +00:00
|
|
|
func (pl *PrefixLogger) Warningf(format string, args ...any) {
|
2023-05-09 17:19:48 +00:00
|
|
|
if pl != nil {
|
|
|
|
format = pl.prefix + format
|
|
|
|
pl.logger.WarningDepth(1, fmt.Sprintf(format, args...))
|
|
|
|
return
|
|
|
|
}
|
2024-09-16 09:06:00 +00:00
|
|
|
grpclog.WarningDepth(1, fmt.Sprintf(format, args...))
|
2023-05-09 17:19:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Errorf does error logging.
|
2023-09-18 12:47:28 +00:00
|
|
|
func (pl *PrefixLogger) Errorf(format string, args ...any) {
|
2023-05-09 17:19:48 +00:00
|
|
|
if pl != nil {
|
|
|
|
format = pl.prefix + format
|
|
|
|
pl.logger.ErrorDepth(1, fmt.Sprintf(format, args...))
|
|
|
|
return
|
|
|
|
}
|
2024-09-16 09:06:00 +00:00
|
|
|
grpclog.ErrorDepth(1, fmt.Sprintf(format, args...))
|
2023-05-12 12:33:40 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// V reports whether verbosity level l is at least the requested verbose level.
|
|
|
|
func (pl *PrefixLogger) V(l int) bool {
|
2024-09-16 09:06:00 +00:00
|
|
|
if pl != nil {
|
|
|
|
return pl.logger.V(l)
|
|
|
|
}
|
|
|
|
return true
|
2023-05-09 17:19:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// NewPrefixLogger creates a prefix logger with the given prefix.
|
2024-09-16 09:06:00 +00:00
|
|
|
func NewPrefixLogger(logger grpclog.DepthLoggerV2, prefix string) *PrefixLogger {
|
2023-05-09 17:19:48 +00:00
|
|
|
return &PrefixLogger{logger: logger, prefix: prefix}
|
|
|
|
}
|