mirror of
https://github.com/prometheus/prometheus.git
synced 2024-09-20 07:47:31 -07:00
c05ebef306
Rather than removing the previous implementation of SanitizeLabelName, offer another version named SanitizeFullLabelName that achieved the desired requirements, without breaking existing Prometheus code. Update testing to validate correctness of new variant. Signed-off-by: Nick Moore <nicholas.moore@grafana.com>
65 lines
2.2 KiB
Go
65 lines
2.2 KiB
Go
// Copyright 2013 The Prometheus 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.
|
|
|
|
package strutil
|
|
|
|
import (
|
|
"fmt"
|
|
"net/url"
|
|
"strings"
|
|
|
|
"github.com/grafana/regexp"
|
|
)
|
|
|
|
var invalidLabelCharRE = regexp.MustCompile(`[^a-zA-Z0-9_]`)
|
|
|
|
// TableLinkForExpression creates an escaped relative link to the table view of
|
|
// the provided expression.
|
|
func TableLinkForExpression(expr string) string {
|
|
escapedExpression := url.QueryEscape(expr)
|
|
return fmt.Sprintf("/graph?g0.expr=%s&g0.tab=1", escapedExpression)
|
|
}
|
|
|
|
// GraphLinkForExpression creates an escaped relative link to the graph view of
|
|
// the provided expression.
|
|
func GraphLinkForExpression(expr string) string {
|
|
escapedExpression := url.QueryEscape(expr)
|
|
return fmt.Sprintf("/graph?g0.expr=%s&g0.tab=0", escapedExpression)
|
|
}
|
|
|
|
// SanitizeLabelName replaces anything that doesn't match
|
|
// client_label.LabelNameRE with an underscore.
|
|
// Note: this does not handle all Prometheus label name restrictions (such as
|
|
// not starting with a digit 0-9), and hence should only be used if the label
|
|
// name is prefixed with a known valid string.
|
|
func SanitizeLabelName(name string) string {
|
|
return invalidLabelCharRE.ReplaceAllString(name, "_")
|
|
}
|
|
|
|
// SanitizeFullLabelName replaces any invalid character with an underscore, and
|
|
// if given an empty string, returns a string containing a single underscore.
|
|
func SanitizeFullLabelName(name string) string {
|
|
if len(name) == 0 {
|
|
return "_"
|
|
}
|
|
var validSb strings.Builder
|
|
for i, b := range name {
|
|
if !((b >= 'a' && b <= 'z') || (b >= 'A' && b <= 'Z') || b == '_' || (b >= '0' && b <= '9' && i > 0)) {
|
|
validSb.WriteRune('_')
|
|
} else {
|
|
validSb.WriteRune(b)
|
|
}
|
|
}
|
|
return validSb.String()
|
|
}
|