mirror of
https://github.com/prometheus/prometheus.git
synced 2025-07-03 19:13:23 +00:00
[PERF] textparse: further optimzations for OM CreatedTimestamps (#15097)
* feat: Added more tests; some changes/optimizations when pair-programming with Bartek. Signed-off-by: Manik Rana <manikrana54@gmail.com> * chore: imports Signed-off-by: Manik Rana <manikrana54@gmail.com> * chore: gofumpt Signed-off-by: Manik Rana <manikrana54@gmail.com> * feat: use an efficient replacement to p.Metric Signed-off-by: Manik Rana <manikrana54@gmail.com> * feat: reduce mem allocs + comments Signed-off-by: Manik Rana <manikrana54@gmail.com> * chore: gofumpt Signed-off-by: Manik Rana <manikrana54@gmail.com> * chore: use single quotes Co-authored-by: Bartlomiej Plotka <bwplotka@gmail.com> Signed-off-by: Manik Rana <Manikrana54@gmail.com> * refac: rename Co-authored-by: Bartlomiej Plotka <bwplotka@gmail.com> Signed-off-by: Manik Rana <Manikrana54@gmail.com> * refac: rename to seriesHash Signed-off-by: Manik Rana <manikrana54@gmail.com> * refac: switch condition order Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com> Signed-off-by: Manik Rana <Manikrana54@gmail.com> * refac: switch condition order Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com> Signed-off-by: Manik Rana <Manikrana54@gmail.com> * feat: stronger checking Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com> Signed-off-by: Manik Rana <Manikrana54@gmail.com> * chore: fmt Signed-off-by: Manik Rana <manikrana54@gmail.com> * refac: pass pointer of buf into seriesHash() Signed-off-by: Manik Rana <manikrana54@gmail.com> --------- Signed-off-by: Manik Rana <manikrana54@gmail.com> Signed-off-by: Manik Rana <Manikrana54@gmail.com> Co-authored-by: Bartlomiej Plotka <bwplotka@gmail.com> Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com>
This commit is contained in:
Manik Rana
GitHub
parent
8b545bab2f
commit
032ca9ef96
2 changed files with 165 additions and 82 deletions
|
|
@ -17,6 +17,7 @@
|
|||
package textparse
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
|
|
@ -24,6 +25,7 @@ import (
|
|||
"strings"
|
||||
"unicode/utf8"
|
||||
|
||||
"github.com/cespare/xxhash/v2"
|
||||
"github.com/prometheus/common/model"
|
||||
|
||||
"github.com/prometheus/prometheus/model/exemplar"
|
||||
|
|
@ -72,15 +74,16 @@ func (l *openMetricsLexer) Error(es string) {
|
|||
// OpenMetrics text exposition format.
|
||||
// This is based on the working draft https://docs.google.com/document/u/1/d/1KwV0mAXwwbvvifBvDKH_LU1YjyXE_wxCkHNoCGq1GX0/edit
|
||||
type OpenMetricsParser struct {
|
||||
l *openMetricsLexer
|
||||
builder labels.ScratchBuilder
|
||||
series []byte
|
||||
text []byte
|
||||
mtype model.MetricType
|
||||
val float64
|
||||
ts int64
|
||||
hasTS bool
|
||||
start int
|
||||
l *openMetricsLexer
|
||||
builder labels.ScratchBuilder
|
||||
series []byte
|
||||
mfNameLen int // length of metric family name to get from series.
|
||||
text []byte
|
||||
mtype model.MetricType
|
||||
val float64
|
||||
ts int64
|
||||
hasTS bool
|
||||
start int
|
||||
// offsets is a list of offsets into series that describe the positions
|
||||
// of the metric name and label names and values for this series.
|
||||
// p.offsets[0] is the start character of the metric name.
|
||||
|
|
@ -98,10 +101,10 @@ type OpenMetricsParser struct {
|
|||
// Created timestamp parsing state.
|
||||
ct int64
|
||||
ctHashSet uint64
|
||||
// visitedName is the metric name of the last visited metric when peeking ahead
|
||||
// visitedMFName is the metric family name of the last visited metric when peeking ahead
|
||||
// for _created series during the execution of the CreatedTimestamp method.
|
||||
visitedName string
|
||||
skipCTSeries bool
|
||||
visitedMFName []byte
|
||||
skipCTSeries bool
|
||||
}
|
||||
|
||||
type openMetricsParserOptions struct {
|
||||
|
|
@ -260,25 +263,24 @@ func (p *OpenMetricsParser) Exemplar(e *exemplar.Exemplar) bool {
|
|||
func (p *OpenMetricsParser) CreatedTimestamp() *int64 {
|
||||
if !typeRequiresCT(p.mtype) {
|
||||
// Not a CT supported metric type, fast path.
|
||||
p.ct = 0
|
||||
p.visitedName = ""
|
||||
p.ctHashSet = 0
|
||||
p.ctHashSet = 0 // Use ctHashSet as a single way of telling "empty cache"
|
||||
return nil
|
||||
}
|
||||
|
||||
var (
|
||||
currLset labels.Labels
|
||||
buf []byte
|
||||
peekWithoutNameLsetHash uint64
|
||||
buf []byte
|
||||
currName []byte
|
||||
)
|
||||
p.Metric(&currLset)
|
||||
currFamilyLsetHash, buf := currLset.HashWithoutLabels(buf, labels.MetricName, "le", "quantile")
|
||||
currName := currLset.Get(model.MetricNameLabel)
|
||||
currName = findBaseMetricName(currName)
|
||||
if len(p.series) > 1 && p.series[0] == '{' && p.series[1] == '"' {
|
||||
// special case for UTF-8 encoded metric family names.
|
||||
currName = p.series[p.offsets[0]-p.start : p.mfNameLen+2]
|
||||
} else {
|
||||
currName = p.series[p.offsets[0]-p.start : p.mfNameLen]
|
||||
}
|
||||
|
||||
// make sure we're on a new metric before returning
|
||||
if currName == p.visitedName && currFamilyLsetHash == p.ctHashSet && p.visitedName != "" && p.ctHashSet > 0 && p.ct > 0 {
|
||||
// CT is already known, fast path.
|
||||
currHash := p.seriesHash(&buf, currName)
|
||||
// Check cache, perhaps we fetched something already.
|
||||
if currHash == p.ctHashSet && p.ct > 0 {
|
||||
return &p.ct
|
||||
}
|
||||
|
||||
|
|
@ -309,17 +311,15 @@ func (p *OpenMetricsParser) CreatedTimestamp() *int64 {
|
|||
return nil
|
||||
}
|
||||
|
||||
var peekedLset labels.Labels
|
||||
p.Metric(&peekedLset)
|
||||
peekedName := peekedLset.Get(model.MetricNameLabel)
|
||||
if !strings.HasSuffix(peekedName, "_created") {
|
||||
peekedName := p.series[p.offsets[0]-p.start : p.offsets[1]-p.start]
|
||||
if len(peekedName) < 8 || string(peekedName[len(peekedName)-8:]) != "_created" {
|
||||
// Not a CT line, search more.
|
||||
continue
|
||||
}
|
||||
|
||||
// We got a CT line here, but let's search if CT line is actually for our series, edge case.
|
||||
peekWithoutNameLsetHash, _ = peekedLset.HashWithoutLabels(buf, labels.MetricName, "le", "quantile")
|
||||
if peekWithoutNameLsetHash != currFamilyLsetHash {
|
||||
// Remove _created suffix.
|
||||
peekedHash := p.seriesHash(&buf, peekedName[:len(peekedName)-8])
|
||||
if peekedHash != currHash {
|
||||
// Found CT line for a different series, for our series no CT.
|
||||
p.resetCTParseValues(resetLexer)
|
||||
return nil
|
||||
|
|
@ -328,44 +328,63 @@ func (p *OpenMetricsParser) CreatedTimestamp() *int64 {
|
|||
// All timestamps in OpenMetrics are Unix Epoch in seconds. Convert to milliseconds.
|
||||
// https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#timestamps
|
||||
ct := int64(p.val * 1000.0)
|
||||
p.setCTParseValues(ct, currFamilyLsetHash, currName, true, resetLexer)
|
||||
p.setCTParseValues(ct, currHash, currName, true, resetLexer)
|
||||
return &ct
|
||||
}
|
||||
}
|
||||
|
||||
var (
|
||||
leBytes = []byte{108, 101}
|
||||
quantileBytes = []byte{113, 117, 97, 110, 116, 105, 108, 101}
|
||||
)
|
||||
|
||||
// seriesHash generates a hash based on the metric family name and the offsets
|
||||
// of label names and values from the parsed OpenMetrics data. It skips quantile
|
||||
// and le labels for summaries and histograms respectively.
|
||||
func (p *OpenMetricsParser) seriesHash(offsetsArr *[]byte, metricFamilyName []byte) uint64 {
|
||||
// Iterate through p.offsets to find the label names and values.
|
||||
for i := 2; i < len(p.offsets); i += 4 {
|
||||
lStart := p.offsets[i] - p.start
|
||||
lEnd := p.offsets[i+1] - p.start
|
||||
label := p.series[lStart:lEnd]
|
||||
// Skip quantile and le labels for summaries and histograms.
|
||||
if p.mtype == model.MetricTypeSummary && bytes.Equal(label, quantileBytes) {
|
||||
continue
|
||||
}
|
||||
if p.mtype == model.MetricTypeHistogram && bytes.Equal(label, leBytes) {
|
||||
continue
|
||||
}
|
||||
*offsetsArr = append(*offsetsArr, p.series[lStart:lEnd]...)
|
||||
vStart := p.offsets[i+2] - p.start
|
||||
vEnd := p.offsets[i+3] - p.start
|
||||
*offsetsArr = append(*offsetsArr, p.series[vStart:vEnd]...)
|
||||
}
|
||||
|
||||
*offsetsArr = append(*offsetsArr, metricFamilyName...)
|
||||
hashedOffsets := xxhash.Sum64(*offsetsArr)
|
||||
|
||||
// Reset the offsets array for later reuse.
|
||||
*offsetsArr = (*offsetsArr)[:0]
|
||||
return hashedOffsets
|
||||
}
|
||||
|
||||
// setCTParseValues sets the parser to the state after CreatedTimestamp method was called and CT was found.
|
||||
// This is useful to prevent re-parsing the same series again and early return the CT value.
|
||||
func (p *OpenMetricsParser) setCTParseValues(ct int64, ctHashSet uint64, visitedName string, skipCTSeries bool, resetLexer *openMetricsLexer) {
|
||||
func (p *OpenMetricsParser) setCTParseValues(ct int64, ctHashSet uint64, mfName []byte, skipCTSeries bool, resetLexer *openMetricsLexer) {
|
||||
p.ct = ct
|
||||
p.l = resetLexer
|
||||
p.ctHashSet = ctHashSet
|
||||
p.visitedName = visitedName
|
||||
p.skipCTSeries = skipCTSeries
|
||||
p.visitedMFName = mfName
|
||||
p.skipCTSeries = skipCTSeries // Do we need to set it?
|
||||
}
|
||||
|
||||
// resetCtParseValues resets the parser to the state before CreatedTimestamp method was called.
|
||||
func (p *OpenMetricsParser) resetCTParseValues(resetLexer *openMetricsLexer) {
|
||||
p.l = resetLexer
|
||||
p.ct = 0
|
||||
p.ctHashSet = 0
|
||||
p.visitedName = ""
|
||||
p.skipCTSeries = true
|
||||
}
|
||||
|
||||
// findBaseMetricName returns the metric name without reserved suffixes such as "_created",
|
||||
// "_sum", etc. based on the OpenMetrics specification found at
|
||||
// https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md.
|
||||
// If no suffix is found, the original name is returned.
|
||||
func findBaseMetricName(name string) string {
|
||||
suffixes := []string{"_created", "_count", "_sum", "_bucket", "_total", "_gcount", "_gsum", "_info"}
|
||||
for _, suffix := range suffixes {
|
||||
if strings.HasSuffix(name, suffix) {
|
||||
return strings.TrimSuffix(name, suffix)
|
||||
}
|
||||
}
|
||||
return name
|
||||
}
|
||||
|
||||
// typeRequiresCT returns true if the metric type requires a _created timestamp.
|
||||
func typeRequiresCT(t model.MetricType) bool {
|
||||
switch t {
|
||||
|
|
@ -419,6 +438,7 @@ func (p *OpenMetricsParser) Next() (Entry, error) {
|
|||
mStart++
|
||||
mEnd--
|
||||
}
|
||||
p.mfNameLen = mEnd - mStart
|
||||
p.offsets = append(p.offsets, mStart, mEnd)
|
||||
default:
|
||||
return EntryInvalid, p.parseError("expected metric name after "+t.String(), t2)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue