mirror of
https://github.com/hanzoai/traces.git
synced 2026-10-30 18:20:41 +00:00
76c2c85b97
* [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]>
69 lines
2.3 KiB
Go
69 lines
2.3 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
|
|
|
|
// DeletionCause the cause why a cached entry was deleted.
|
|
type DeletionCause int
|
|
|
|
const (
|
|
// CauseInvalidation means that the entry was manually deleted by the user.
|
|
CauseInvalidation DeletionCause = iota + 1
|
|
// CauseReplacement means that the entry itself was not actually deleted, but its value was replaced by the user.
|
|
CauseReplacement
|
|
// CauseOverflow means that the entry was evicted due to size constraints.
|
|
CauseOverflow
|
|
// CauseExpiration means that the entry's expiration timestamp has passed.
|
|
CauseExpiration
|
|
)
|
|
|
|
const causeUnknown DeletionCause = 0
|
|
|
|
var deletionCauseStrings = []string{
|
|
"Invalidation",
|
|
"Replacement",
|
|
"Overflow",
|
|
"Expiration",
|
|
}
|
|
|
|
// String implements [fmt.Stringer] interface.
|
|
func (dc DeletionCause) String() string {
|
|
if dc >= 1 && int(dc) <= len(deletionCauseStrings) {
|
|
return deletionCauseStrings[dc-1]
|
|
}
|
|
return "<unknown otter.DeletionCause>"
|
|
}
|
|
|
|
// IsEviction returns true if there was an automatic deletion due to eviction
|
|
// (the cause is neither [CauseInvalidation] nor [CauseReplacement]).
|
|
func (dc DeletionCause) IsEviction() bool {
|
|
return !(dc == CauseInvalidation || dc == CauseReplacement)
|
|
}
|
|
|
|
// DeletionEvent is an event of the deletion of a single entry.
|
|
type DeletionEvent[K comparable, V any] struct {
|
|
// Key is the key corresponding to the deleted entry.
|
|
Key K
|
|
// Value is the value corresponding to the deleted entry.
|
|
Value V
|
|
// Cause is the cause for which entry was deleted.
|
|
Cause DeletionCause
|
|
}
|
|
|
|
// WasEvicted returns true if there was an automatic deletion due to eviction (the cause is neither
|
|
// [CauseInvalidation] nor [CauseReplacement]).
|
|
func (de DeletionEvent[K, V]) WasEvicted() bool {
|
|
return de.Cause.IsEviction()
|
|
}
|