Skip to content

[ISSUE] Fix: Wildcard Stats Key Behavior Changes #1017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
collin-lee merged 7 commits into from
Dec 5, 2025
Merged

[ISSUE] Fix: Wildcard Stats Key Behavior Changes #1017

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5a4a039
Fix: Preserve metrics for wild card
xuannam230201 Dec 5, 2025
5b51726
Fix: Unify matchedWildCardKey for if-else statement
xuannam230201 Dec 5, 2025
a016fba
Fix: Remove hasShareThreshold conditional check in non-wild-card block
xuannam230201 Dec 5, 2025
26eaac9
Fix: Prevent log debug to creating stats from executing twice per req…
xuannam230201 Dec 5, 2025
f93cebe
Fix: Remove redundant assignment
xuannam230201 Dec 5, 2025
8b3be79
Fix: Remove dead code
xuannam230201 Dec 5, 2025
e06479e
Refactor: unify logic to include value to stats
xuannam230201 Dec 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 30 additions & 53 deletions src/config/config_impl.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,13 +368,13 @@ func (this *rateLimitConfigImpl) GetLimit(

logger.Debugf("looking up key: %s", finalKey)
nextDescriptor := descriptorsMap[finalKey]
matchedViaWildcard := false
var matchedWildcardKey string

if nextDescriptor == nil && len(prevDescriptor.wildcardKeys) > 0 {
for _, wildcardKey := range prevDescriptor.wildcardKeys {
if strings.HasPrefix(finalKey, strings.TrimSuffix(wildcardKey, "*")) {
nextDescriptor = descriptorsMap[wildcardKey]
matchedViaWildcard = true
matchedWildcardKey = wildcardKey
break
}
}
Expand All @@ -389,7 +389,7 @@ func (this *rateLimitConfigImpl) GetLimit(
}

// Track share_threshold pattern when matching via wildcard, even if no rate_limit at this level
if matchedViaWildcard && nextDescriptor != nil && nextDescriptor.shareThreshold && nextDescriptor.wildcardPattern != "" {
if matchedWildcardKey != "" && nextDescriptor != nil && nextDescriptor.shareThreshold && nextDescriptor.wildcardPattern != "" {
// Extract the value part from the wildcard pattern (e.g., "key_files*" -> "files*")
if shareThresholdPatterns == nil {
shareThresholdPatterns = make(map[int]string)
Expand All @@ -403,57 +403,38 @@ func (this *rateLimitConfigImpl) GetLimit(
// Build value_to_metric metrics path for this level
valueToMetricFullKey.WriteString(".")
if nextDescriptor != nil {
// Check if share_threshold is enabled for this entry
Copy link
Copy Markdown
Contributor Author

@xuannam230201 xuannam230201 Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Refactor the logic to include value in stats. It's not necessary to repeat:

valueToMetricFullKey.WriteString(entry.Key)
valueToMetricFullKey.WriteString("_")
valueToMetricFullKey.WriteString(...)

several times in this logic

// Determine the value to use for this entry
var valueToUse string
hasShareThreshold := shareThresholdPatterns[i] != ""
if matchedViaWildcard {
// When share_threshold is enabled AND value_to_metric is enabled, use the prefix of the wildcard pattern
if hasShareThreshold && nextDescriptor.valueToMetric {
wildcardPrefix := strings.TrimSuffix(shareThresholdPatterns[i], "*")
valueToMetricFullKey.WriteString(entry.Key)
valueToMetricFullKey.WriteString("_")
valueToMetricFullKey.WriteString(wildcardPrefix)

if matchedWildcardKey != "" {
// Matched via wildcard
if hasShareThreshold {
// share_threshold: always use wildcard pattern with *
valueToUse = shareThresholdPatterns[i]
} else if nextDescriptor.valueToMetric {
valueToMetricFullKey.WriteString(entry.Key)
if entry.Value != "" {
valueToMetricFullKey.WriteString("_")
valueToMetricFullKey.WriteString(entry.Value)
}
// value_to_metric: use actual runtime value
valueToUse = entry.Value
} else {
valueToMetricFullKey.WriteString(entry.Key)
// No flags: preserve wildcard pattern
valueToUse = strings.TrimPrefix(matchedWildcardKey, entry.Key+"_")
}
} else if matchedUsingValue {
// Matched explicit key+value in config
// When share_threshold is enabled AND value_to_metric is enabled, use the prefix of the wildcard pattern
if hasShareThreshold && nextDescriptor.valueToMetric {
wildcardPrefix := strings.TrimSuffix(shareThresholdPatterns[i], "*")
valueToMetricFullKey.WriteString(entry.Key)
valueToMetricFullKey.WriteString("_")
valueToMetricFullKey.WriteString(wildcardPrefix)
} else {
valueToMetricFullKey.WriteString(entry.Key)
if entry.Value != "" {
valueToMetricFullKey.WriteString("_")
valueToMetricFullKey.WriteString(entry.Value)
}
}
// Matched explicit key+value in config (share_threshold can't apply here)
valueToUse = entry.Value
} else {
// Matched default key (no value) in config
// When share_threshold is enabled AND value_to_metric is enabled, use the prefix of the wildcard pattern
if hasShareThreshold && nextDescriptor.valueToMetric {
wildcardPrefix := strings.TrimSuffix(shareThresholdPatterns[i], "*")
valueToMetricFullKey.WriteString(entry.Key)
valueToMetricFullKey.WriteString("_")
valueToMetricFullKey.WriteString(wildcardPrefix)
} else if nextDescriptor.valueToMetric {
valueToMetricFullKey.WriteString(entry.Key)
if entry.Value != "" {
valueToMetricFullKey.WriteString("_")
valueToMetricFullKey.WriteString(entry.Value)
}
} else {
valueToMetricFullKey.WriteString(entry.Key)
if nextDescriptor.valueToMetric {
valueToUse = entry.Value
}
}

// Write key and value (if any)
valueToMetricFullKey.WriteString(entry.Key)
if valueToUse != "" {
valueToMetricFullKey.WriteString("_")
valueToMetricFullKey.WriteString(valueToUse)
}
} else {
// No next descriptor found; still append something deterministic
valueToMetricFullKey.WriteString(entry.Key)
Expand Down Expand Up @@ -510,22 +491,20 @@ func (this *rateLimitConfigImpl) GetLimit(
}

// Replace metric with detailed metric, if leaf descriptor is detailed.
// When share_threshold is enabled, expose the prefix (before *) of the wildcard pattern
// If share_threshold is enabled, always use wildcard pattern with *
if rateLimit != nil && rateLimit.DetailedMetric {
// Check if any entry has share_threshold enabled
hasShareThreshold := rateLimit.ShareThresholdKeyPattern != nil && len(rateLimit.ShareThresholdKeyPattern) > 0
if hasShareThreshold {
// Build metric key with wildcard prefix for entries with share_threshold
// Build metric key with wildcard pattern (including *) for entries with share_threshold
var shareThresholdMetricKey strings.Builder
shareThresholdMetricKey.WriteString(domain)
for i, entry := range descriptor.Entries {
shareThresholdMetricKey.WriteString(".")
if i < len(rateLimit.ShareThresholdKeyPattern) && rateLimit.ShareThresholdKeyPattern[i] != "" {
// Use the prefix of the wildcard pattern (before *)
wildcardPrefix := strings.TrimSuffix(rateLimit.ShareThresholdKeyPattern[i], "*")
shareThresholdMetricKey.WriteString(entry.Key)
shareThresholdMetricKey.WriteString("_")
shareThresholdMetricKey.WriteString(wildcardPrefix)
shareThresholdMetricKey.WriteString(rateLimit.ShareThresholdKeyPattern[i])
} else {
// Include full key_value for entries without share_threshold
shareThresholdMetricKey.WriteString(entry.Key)
Expand All @@ -552,10 +531,8 @@ func (this *rateLimitConfigImpl) GetLimit(
if enhancedKey != rateLimit.FullKey {
// Recreate to ensure a clean stats struct, then set to enhanced stats
originalShareThresholdKeyPattern := rateLimit.ShareThresholdKeyPattern
rateLimit = NewRateLimit(rateLimit.Limit.RequestsPerUnit, rateLimit.Limit.Unit, this.statsManager.NewStats(rateLimit.FullKey), rateLimit.Unlimited, rateLimit.ShadowMode, rateLimit.Name, rateLimit.Replaces, rateLimit.DetailedMetric)
rateLimit = NewRateLimit(rateLimit.Limit.RequestsPerUnit, rateLimit.Limit.Unit, this.statsManager.NewStats(enhancedKey), rateLimit.Unlimited, rateLimit.ShadowMode, rateLimit.Name, rateLimit.Replaces, rateLimit.DetailedMetric)
rateLimit.ShareThresholdKeyPattern = originalShareThresholdKeyPattern
rateLimit.Stats = this.statsManager.NewStats(enhancedKey)
Copy link
Copy Markdown
Contributor Author

@xuannam230201 xuannam230201 Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove these codes because each time this.statsManager.NewStats is called, logger prints debug log "Creating stats..." once. As a result, with current code, each request makes logger log that twice.

FullKey is automatically assigned to stat.string when rateLimit is initialized; as a result, remove the assignment (redundant).

rateLimit.FullKey = enhancedKey
}
}

Expand Down
Loading
Loading