mirror of
https://github.com/prometheus/prometheus.git
synced 2024-11-09 23:24:05 -08:00
817a2396cb
In the past, every sample value was a float, so it was fine to call a variable holding such a float "value" or "sample". With native histograms, a sample might have a histogram value. And a histogram value is still a value. Calling a float value just "value" or "sample" or "V" is therefore misleading. Over the last few commits, I already renamed many variables, but this cleans up a few more places where the changes are more invasive. Note that we do not to attempt naming in the JSON APIs or in the protobufs. That would be quite a disruption. However, internally, we can call variables as we want, and we should go with the option of avoiding misunderstandings. Signed-off-by: beorn7 <beorn@grafana.com>
138 lines
3.8 KiB
Go
138 lines
3.8 KiB
Go
// Copyright 2022 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 jsonutil
|
|
|
|
import (
|
|
"math"
|
|
"strconv"
|
|
|
|
jsoniter "github.com/json-iterator/go"
|
|
|
|
"github.com/prometheus/prometheus/model/histogram"
|
|
)
|
|
|
|
// MarshalTimestamp marshals a point timestamp using the passed jsoniter stream.
|
|
func MarshalTimestamp(t int64, stream *jsoniter.Stream) {
|
|
// Write out the timestamp as a float divided by 1000.
|
|
// This is ~3x faster than converting to a float.
|
|
if t < 0 {
|
|
stream.WriteRaw(`-`)
|
|
t = -t
|
|
}
|
|
stream.WriteInt64(t / 1000)
|
|
fraction := t % 1000
|
|
if fraction != 0 {
|
|
stream.WriteRaw(`.`)
|
|
if fraction < 100 {
|
|
stream.WriteRaw(`0`)
|
|
}
|
|
if fraction < 10 {
|
|
stream.WriteRaw(`0`)
|
|
}
|
|
stream.WriteInt64(fraction)
|
|
}
|
|
}
|
|
|
|
// MarshalFloat marshals a float value using the passed jsoniter stream.
|
|
func MarshalFloat(f float64, stream *jsoniter.Stream) {
|
|
stream.WriteRaw(`"`)
|
|
// Taken from https://github.com/json-iterator/go/blob/master/stream_float.go#L71 as a workaround
|
|
// to https://github.com/json-iterator/go/issues/365 (jsoniter, to follow json standard, doesn't allow inf/nan).
|
|
buf := stream.Buffer()
|
|
abs := math.Abs(f)
|
|
fmt := byte('f')
|
|
// Note: Must use float32 comparisons for underlying float32 value to get precise cutoffs right.
|
|
if abs != 0 {
|
|
if abs < 1e-6 || abs >= 1e21 {
|
|
fmt = 'e'
|
|
}
|
|
}
|
|
buf = strconv.AppendFloat(buf, f, fmt, -1, 64)
|
|
stream.SetBuffer(buf)
|
|
stream.WriteRaw(`"`)
|
|
}
|
|
|
|
// MarshalHistogram marshals a histogram value using the passed jsoniter stream.
|
|
// It writes something like:
|
|
//
|
|
// {
|
|
// "count": "42",
|
|
// "sum": "34593.34",
|
|
// "buckets": [
|
|
// [ 3, "-0.25", "0.25", "3"],
|
|
// [ 0, "0.25", "0.5", "12"],
|
|
// [ 0, "0.5", "1", "21"],
|
|
// [ 0, "2", "4", "6"]
|
|
// ]
|
|
// }
|
|
//
|
|
// The 1st element in each bucket array determines if the boundaries are
|
|
// inclusive (AKA closed) or exclusive (AKA open):
|
|
//
|
|
// 0: lower exclusive, upper inclusive
|
|
// 1: lower inclusive, upper exclusive
|
|
// 2: both exclusive
|
|
// 3: both inclusive
|
|
//
|
|
// The 2nd and 3rd elements are the lower and upper boundary. The 4th element is
|
|
// the bucket count.
|
|
func MarshalHistogram(h *histogram.FloatHistogram, stream *jsoniter.Stream) {
|
|
stream.WriteObjectStart()
|
|
stream.WriteObjectField(`count`)
|
|
MarshalFloat(h.Count, stream)
|
|
stream.WriteMore()
|
|
stream.WriteObjectField(`sum`)
|
|
MarshalFloat(h.Sum, stream)
|
|
|
|
bucketFound := false
|
|
it := h.AllBucketIterator()
|
|
for it.Next() {
|
|
bucket := it.At()
|
|
if bucket.Count == 0 {
|
|
continue // No need to expose empty buckets in JSON.
|
|
}
|
|
stream.WriteMore()
|
|
if !bucketFound {
|
|
stream.WriteObjectField(`buckets`)
|
|
stream.WriteArrayStart()
|
|
}
|
|
bucketFound = true
|
|
boundaries := 2 // Exclusive on both sides AKA open interval.
|
|
if bucket.LowerInclusive {
|
|
if bucket.UpperInclusive {
|
|
boundaries = 3 // Inclusive on both sides AKA closed interval.
|
|
} else {
|
|
boundaries = 1 // Inclusive only on lower end AKA right open.
|
|
}
|
|
} else {
|
|
if bucket.UpperInclusive {
|
|
boundaries = 0 // Inclusive only on upper end AKA left open.
|
|
}
|
|
}
|
|
stream.WriteArrayStart()
|
|
stream.WriteInt(boundaries)
|
|
stream.WriteMore()
|
|
MarshalFloat(bucket.Lower, stream)
|
|
stream.WriteMore()
|
|
MarshalFloat(bucket.Upper, stream)
|
|
stream.WriteMore()
|
|
MarshalFloat(bucket.Count, stream)
|
|
stream.WriteArrayEnd()
|
|
}
|
|
if bucketFound {
|
|
stream.WriteArrayEnd()
|
|
}
|
|
stream.WriteObjectEnd()
|
|
}
|