mirror of
https://github.com/hanzoai/telemetry.git
synced 2026-10-30 20:01:49 +00:00
kruthiwusirika5andGitHub
48f5acba1c
Fixes #5169 ## Problem When a gRPC client disconnects normally (e.g., a .NET app shutting down its `TracerProvider`), the collector logs spurious WARN messages from the gRPC transport layer: These are expected during graceful client shutdown but appear alarming to operators and pollute production logs. ## Root cause grpc-go is doing the right thing: messages like this are gated behind `LoggerV2.V(2)` in `internal/transport/http2_server.go`, i.e. they are explicitly classified as supplemental verbosity, not severity-level warnings. They should never reach a WARN sink. The bug is in zapgrpc. `zapgrpc.Logger.V` is implemented as `levelEnabler.Enabled(zapcore.Level(level - 1))`, which conflates grpclog's *verbosity* with zap's *severity*. With WARN enabled, `V(2)` returns true, so grpc-go thinks verbosity level 2 is permitted and emits the message — which then gets formatted by zapgrpc as a WARN entry. See [uber-go/zap#1544](https://github.com/uber-go/zap/issues/1544). ## Solution Wrap the installed `grpclog.LoggerV2` with a `fixedVerbosityLogger` whose `V()` compares the requested level against a fixed threshold (default 0) instead of the underlying zap severity enabler. This restores grpclog's intended verbosity gating, so verbose messages stop at grpc-go before formatting rather than being filtered out of the log stream after the fact. The default threshold of `0` matches grpclog when `GRPC_GO_LOG_VERBOSITY_LEVEL` is unset. This approach: - Addresses the root cause (broken `V()` mapping) rather than string-matching specific message contents. - Stops chatty messages at the source, before grpc-go formats them. - Is generic — kills *all* `V(2)+` noise, including future grpc-go additions, not just two cherry-picked patterns. - Leaves severity-level emission (`Info` / `Warning` / `Error`) completely unchanged. - Tiny: ~10 lines of wrapper plus comment. ## Testing - `TestFixedVerbosity` — asserts `V(0)` is enabled and `V(1)`/`V(2)` are not at the default threshold. - `TestSeverityLevelsUnaffected` — direct `Warning("…")` still fires at WARN, confirming the wrapper does not gate severity. - Existing `TestGRPCLogger` cases continue to pass unchanged. --------- Signed-off-by: Sai Kruthi Wusirika <[email protected]>
56 lines
2.1 KiB
Go
56 lines
2.1 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package grpclog // import "go.opentelemetry.io/collector/otelcol/internal/grpclog"
|
|
|
|
import (
|
|
"go.uber.org/zap"
|
|
"go.uber.org/zap/zapcore"
|
|
"go.uber.org/zap/zapgrpc"
|
|
"google.golang.org/grpc/grpclog"
|
|
)
|
|
|
|
// fixedVerbosityLogger wraps a grpclog.LoggerV2 and reports verbosity against a
|
|
// fixed threshold instead of zap's severity enabler.
|
|
//
|
|
// zapgrpc.Logger.V(level) is implemented as levelEnabler.Enabled(zapcore.Level(level-1)),
|
|
// which conflates grpclog's supplemental verbosity with zap's severity. With WARN
|
|
// enabled, V(2) returns true, so grpc-go emits chatty per-RPC messages — including
|
|
// transport-layer notices logged on normal client disconnect — at WARN. See
|
|
// uber-go/zap#1544.
|
|
//
|
|
// Comparing against a fixed threshold restores grpclog's intended semantics.
|
|
// The default of 0 matches grpclog when GRPC_GO_LOG_VERBOSITY_LEVEL is unset.
|
|
type fixedVerbosityLogger struct {
|
|
grpclog.LoggerV2
|
|
verbosity int
|
|
}
|
|
|
|
func (l *fixedVerbosityLogger) V(level int) bool {
|
|
return level <= l.verbosity
|
|
}
|
|
|
|
// SetLogger constructs a zapgrpc.Logger instance, and installs it as grpc logger, cloned from baseLogger with
|
|
// exact configuration. The minimum level of gRPC logs is set to WARN should the loglevel of the collector is set to
|
|
// INFO to avoid copious logging from grpc framework.
|
|
func SetLogger(baseLogger *zap.Logger) *zapgrpc.Logger {
|
|
logger := zapgrpc.NewLogger(baseLogger.WithOptions(zap.WrapCore(func(core zapcore.Core) zapcore.Core {
|
|
var c zapcore.Core
|
|
var err error
|
|
loglevel := baseLogger.Level()
|
|
if loglevel == zapcore.InfoLevel {
|
|
loglevel = zapcore.WarnLevel
|
|
}
|
|
// NewIncreaseLevelCore errors only if the new log level is less than the initial core level.
|
|
c, err = zapcore.NewIncreaseLevelCore(core, loglevel)
|
|
// In case of an error changing the level, move on, this happens when using the NopCore
|
|
if err != nil {
|
|
c = core
|
|
}
|
|
return c.With([]zapcore.Field{zap.Bool("grpc_log", true)})
|
|
}), zap.AddCallerSkip(5)))
|
|
|
|
grpclog.SetLoggerV2(&fixedVerbosityLogger{LoggerV2: logger})
|
|
return logger
|
|
}
|