Compare commits

...

9 Commits

Author SHA1 Message Date
4e491639e6 Merge remote-tracking branch 'getters/metrics'
Some checks failed
main / Build (push) Failing after 9s
2024-11-09 19:39:05 +03:00
cfcb00051e Merge remote-tracking branch 'prometheus/master' 2024-11-09 19:33:55 +03:00
6aa41f4081 change import path
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2024-11-09 19:32:47 +03:00
Anshal Shukla
a5eb7684ff add getters to histogram and summary metrics 2023-07-27 13:15:23 +05:30
greyireland
880d8e1cc6 backward compatibility 2023-02-20 12:54:52 +08:00
greyireland
4a30cca184 rename compatible 2023-02-07 15:38:08 +08:00
greyireland
8969e845c9 update nameMetric 2023-02-07 15:15:54 +08:00
greyireland
8466104303 add inf 2023-02-07 15:00:56 +08:00
greyireland
60fb01a811 feature:compatible 2023-02-07 14:27:40 +08:00
14 changed files with 121 additions and 11 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
.idea/

View File

@ -2,7 +2,7 @@ package metrics_test
import (
"fmt"
"github.com/VictoriaMetrics/metrics"
"go.unistack.org/metrics"
)
func ExampleCounter() {

View File

@ -2,7 +2,7 @@ package metrics_test
import (
"fmt"
"github.com/VictoriaMetrics/metrics"
"go.unistack.org/metrics"
)
func ExampleFloatCounter() {

View File

@ -4,7 +4,7 @@ import (
"fmt"
"runtime"
"github.com/VictoriaMetrics/metrics"
"go.unistack.org/metrics"
)
func ExampleGauge() {

2
go.mod
View File

@ -1,4 +1,4 @@
module github.com/VictoriaMetrics/metrics
module go.unistack.org/metrics
require (
github.com/valyala/histogram v1.2.0

View File

@ -36,7 +36,7 @@ func initSupportedRuntimeMetrics(rms [][2]string) [][2]string {
if _, ok := exposedMetrics[metricName]; ok {
supportedMetrics = append(supportedMetrics, rm)
} else {
log.Printf("github.com/VictoriaMetrics/metrics: do not expose %s metric, since the corresponding metric %s isn't supported in the current Go runtime", rm[1], metricName)
log.Printf("go.unistack.org/metrics: do not expose %s metric, since the corresponding metric %s isn't supported in the current Go runtime", rm[1], metricName)
}
}
return supportedMetrics

View File

@ -4,6 +4,7 @@ import (
"fmt"
"io"
"math"
"strings"
"sync"
"time"
)
@ -63,6 +64,8 @@ type Histogram struct {
// sum is the sum of all the values put into Histogram
sum float64
compatible bool
}
// Reset resets the given histogram.
@ -82,6 +85,14 @@ func (h *Histogram) Reset() {
h.mu.Unlock()
}
func (h *Histogram) GetSum() float64 {
return h.sum
}
func (h *Histogram) GetDecimalBuckets() [decimalBucketsCount]*[bucketsPerDecimal]uint64 {
return h.decimalBuckets
}
// Update updates h with v.
//
// Negative values and NaNs are ignored.
@ -187,6 +198,9 @@ func (h *Histogram) VisitNonZeroBuckets(f func(vmrange string, count uint64)) {
func NewHistogram(name string) *Histogram {
return defaultSet.NewHistogram(name)
}
func NewCompatibleHistogram(name string) *Histogram {
return defaultSet.NewCompatibleHistogram(name)
}
// GetOrCreateHistogram returns registered histogram with the given name
// or creates new histogram if the registry doesn't contain histogram with
@ -205,6 +219,9 @@ func NewHistogram(name string) *Histogram {
func GetOrCreateHistogram(name string) *Histogram {
return defaultSet.GetOrCreateHistogram(name)
}
func GetOrCreateCompatibleHistogram(name string) *Histogram {
return defaultSet.GetOrCreateCompatibleHistogram(name)
}
// UpdateDuration updates request duration based on the given startTime.
func (h *Histogram) UpdateDuration(startTime time.Time) {
@ -237,6 +254,10 @@ var (
)
func (h *Histogram) marshalTo(prefix string, w io.Writer) {
if h.compatible {
h.marshalToPrometheus(prefix, w)
return
}
countTotal := uint64(0)
h.VisitNonZeroBuckets(func(vmrange string, count uint64) {
tag := fmt.Sprintf("vmrange=%q", vmrange)
@ -257,6 +278,41 @@ func (h *Histogram) marshalTo(prefix string, w io.Writer) {
}
fmt.Fprintf(w, "%s_count%s %d\n", name, labels, countTotal)
}
func (h *Histogram) marshalToPrometheus(prefix string, w io.Writer) {
countTotal := uint64(0)
inf := false
h.VisitNonZeroBuckets(func(vmrange string, count uint64) {
v := strings.Split(vmrange, "...")
if len(v) != 2 {
return
}
if v[1] == "+Inf" {
inf = true
}
tag := fmt.Sprintf("le=%q", v[1])
metricName := addTag(prefix, tag)
name, labels := splitMetricName(metricName)
countTotal += count
fmt.Fprintf(w, "%s_bucket%s %d\n", name, labels, countTotal)
})
if countTotal == 0 {
return
}
if !inf {
tag := fmt.Sprintf("le=%q", "+Inf")
metricName := addTag(prefix, tag)
name, labels := splitMetricName(metricName)
fmt.Fprintf(w, "%s_bucket%s %d\n", name, labels, countTotal)
}
name, labels := splitMetricName(prefix)
sum := h.getSum()
if float64(int64(sum)) == sum {
fmt.Fprintf(w, "%s_sum%s %d\n", name, labels, int64(sum))
} else {
fmt.Fprintf(w, "%s_sum%s %g\n", name, labels, sum)
}
fmt.Fprintf(w, "%s_count%s %d\n", name, labels, countTotal)
}
func (h *Histogram) getSum() float64 {
h.mu.Lock()

View File

@ -4,7 +4,7 @@ import (
"fmt"
"time"
"github.com/VictoriaMetrics/metrics"
"go.unistack.org/metrics"
)
func ExampleHistogram() {

View File

@ -3,7 +3,7 @@ package metrics_test
import (
"net/http"
"github.com/VictoriaMetrics/metrics"
"go.unistack.org/metrics"
)
func ExampleWritePrometheus() {

View File

@ -99,10 +99,10 @@ func writeIOMetrics(w io.Writer) {
data, err := ioutil.ReadFile(ioFilepath)
if err != nil {
// Do not spam the logs with errors - this error cannot be fixed without process restart.
// See https://github.com/VictoriaMetrics/metrics/issues/42
// See https://go.unistack.org/metrics/issues/42
if atomic.CompareAndSwapUint32(&procSelfIOErrLogged, 0, 1) {
log.Printf("ERROR: metrics: cannot read process_io_* metrics from %q, so these metrics won't be updated until the error is fixed; "+
"see https://github.com/VictoriaMetrics/metrics/issues/42 ; The error: %s", ioFilepath, err)
"see https://go.unistack.org/metrics/issues/42 ; The error: %s", ioFilepath, err)
}
}

33
set.go
View File

@ -85,6 +85,11 @@ func (s *Set) NewHistogram(name string) *Histogram {
s.registerMetric(name, h)
return h
}
func (s *Set) NewCompatibleHistogram(name string) *Histogram {
h := &Histogram{compatible: true}
s.registerMetric(name, h)
return h
}
// GetOrCreateHistogram returns registered histogram in s with the given name
// or creates new histogram if s doesn't contain histogram with the given name.
@ -127,6 +132,34 @@ func (s *Set) GetOrCreateHistogram(name string) *Histogram {
}
return h
}
func (s *Set) GetOrCreateCompatibleHistogram(name string) *Histogram {
s.mu.Lock()
nm := s.m[name]
s.mu.Unlock()
if nm == nil {
// Slow path - create and register missing histogram.
if err := validateMetric(name); err != nil {
panic(fmt.Errorf("BUG: invalid metric name %q: %s", name, err))
}
nmNew := &namedMetric{
name: name,
metric: &Histogram{compatible: true},
}
s.mu.Lock()
nm = s.m[name]
if nm == nil {
nm = nmNew
s.m[name] = nm
s.a = append(s.a, nm)
}
s.mu.Unlock()
}
h, ok := nm.metric.(*Histogram)
if !ok {
panic(fmt.Errorf("BUG: metric %q isn't a Histogram. It is %T", name, nm.metric))
}
return h
}
// NewCounter registers and returns new counter with the given name in the s.
//

View File

@ -3,7 +3,7 @@ package metrics_test
import (
"bytes"
"fmt"
"github.com/VictoriaMetrics/metrics"
"go.unistack.org/metrics"
)
func ExampleSet() {

View File

@ -31,6 +31,26 @@ type Summary struct {
window time.Duration
}
func (s *Summary) GetSum() float64 {
return s.sum
}
func (s *Summary) GetCount() uint64 {
return s.count
}
func (s *Summary) GetTime() time.Duration {
return s.window
}
func (s *Summary) GetQuantiles() []float64 {
return s.quantiles
}
func (s *Summary) GetQuantileValues() []float64 {
return s.quantileValues
}
// NewSummary creates and returns new summary with the given name.
//
// name must be valid Prometheus-compatible metric with possible labels.

View File

@ -4,7 +4,7 @@ import (
"fmt"
"time"
"github.com/VictoriaMetrics/metrics"
"go.unistack.org/metrics"
)
func ExampleSummary() {