Files
76c2c85b97 [Generator] Add DRAIN span_name sanitizer (#6098)
* [Generator] Add DRAIN span_name sanitizer

* Fix linter

* Fix formatting

* Update default manifest

* Fix build error in update-fixtures

* Remove bad test

* Remove misleading comment

* Add per-tenant override for drain mode

* Do a machines job

* Address PR feedback

* Address PR review: rename drain_mode config and improve sanitizer

- Rename `drain_mode` to `span_name_sanitization` across all config,
  legacy config, interfaces, and overrides for better user-facing clarity
- Add explicit default value "disabled" in RegisterFlagsAndApplyDefaults
- Add ValidateSpanNameSanitization function in validation/fields.go
- Rename metrics to remove DRAIN reference:
  `drain_spans_compacted_total` -> `spans_sanitized_total`
  `post_drain_demand_estimate` -> `post_sanitization_demand_estimate`
- Pass configured staleDuration to NewDrainSanitizer instead of
  hardcoded 15min, consistent with other registry components
- Extract "span_name" magic string to labelSpanName constant
- Update all tests with new names and signatures

* Update manifest

* Use empty string as disabled

* Update CHANGELOG.md

Co-authored-by: Suraj Nath <[email protected]>

* Update manifest

---------

Co-authored-by: Suraj Nath <[email protected]>
2026-02-22 00:55:22 -08:00

53 lines
1.6 KiB
Go

// Copyright (c) 2024 Alexey Mayshev and contributors. All rights reserved.
//
// 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 otter
import (
"context"
"log/slog"
)
// Logger is the interface used to get log output from otter.
type Logger interface {
// Warn logs a message at the warn level with an error.
Warn(ctx context.Context, msg string, err error)
// Error logs a message at the error level with an error.
Error(ctx context.Context, msg string, err error)
}
type defaultLogger struct {
log *slog.Logger
}
func newDefaultLogger() *defaultLogger {
return &defaultLogger{
log: slog.Default(),
}
}
func (dl *defaultLogger) Warn(ctx context.Context, msg string, err error) {
dl.log.WarnContext(ctx, msg, slog.Any("err", err))
}
func (dl *defaultLogger) Error(ctx context.Context, msg string, err error) {
dl.log.ErrorContext(ctx, msg, slog.Any("err", err))
}
// NoopLogger is a stub implementation of [Logger] interface. It may be useful if error logging is not necessary.
type NoopLogger struct{}
func (nl *NoopLogger) Warn(ctx context.Context, msg string, err error) {}
func (nl *NoopLogger) Error(ctx context.Context, msg string, err error) {}