2021-06-29 01:37:41 -07:00
// Copyright 2021 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 chunkenc
import (
"testing"
"github.com/stretchr/testify/require"
2021-11-17 10:57:31 -08:00
"github.com/prometheus/prometheus/model/histogram"
2023-11-29 02:39:12 -08:00
"github.com/prometheus/prometheus/tsdb/tsdbutil"
2021-06-29 01:37:41 -07:00
)
2022-12-11 14:39:53 -08:00
type result struct {
t int64
h * histogram . Histogram
fh * histogram . FloatHistogram
}
2023-09-01 14:39:15 -07:00
func TestFirstHistogramExplicitCounterReset ( t * testing . T ) {
tests := map [ string ] struct {
hint histogram . CounterResetHint
expHeader CounterResetHeader
} {
"CounterReset" : {
hint : histogram . CounterReset ,
expHeader : CounterReset ,
} ,
"NotCounterReset" : {
hint : histogram . NotCounterReset ,
expHeader : UnknownCounterReset ,
} ,
"UnknownCounterReset" : {
hint : histogram . UnknownCounterReset ,
expHeader : UnknownCounterReset ,
} ,
"Gauge" : {
hint : histogram . GaugeType ,
expHeader : GaugeType ,
} ,
}
for name , test := range tests {
t . Run ( name , func ( t * testing . T ) {
h := & histogram . Histogram {
CounterResetHint : test . hint ,
}
chk := NewHistogramChunk ( )
app , err := chk . Appender ( )
require . NoError ( t , err )
newChk , recoded , newApp , err := app . AppendHistogram ( nil , 0 , h , false )
require . NoError ( t , err )
require . Nil ( t , newChk )
require . False ( t , recoded )
require . Equal ( t , app , newApp )
require . Equal ( t , test . expHeader , chk . GetCounterResetHeader ( ) )
} )
}
}
Style cleanup of all the changes in sparsehistogram so far
A lot of this code was hacked together, literally during a
hackathon. This commit intends not to change the code substantially,
but just make the code obey the usual style practices.
A (possibly incomplete) list of areas:
* Generally address linter warnings.
* The `pgk` directory is deprecated as per dev-summit. No new packages should
be added to it. I moved the new `pkg/histogram` package to `model`
anticipating what's proposed in #9478.
* Make the naming of the Sparse Histogram more consistent. Including
abbreviations, there were just too many names for it: SparseHistogram,
Histogram, Histo, hist, his, shs, h. The idea is to call it "Histogram" in
general. Only add "Sparse" if it is needed to avoid confusion with
conventional Histograms (which is rare because the TSDB really has no notion
of conventional Histograms). Use abbreviations only in local scope, and then
really abbreviate (not just removing three out of seven letters like in
"Histo"). This is in the spirit of
https://github.com/golang/go/wiki/CodeReviewComments#variable-names
* Several other minor name changes.
* A lot of formatting of doc comments. For one, following
https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences
, but also layout question, anticipating how things will look like
when rendered by `godoc` (even where `godoc` doesn't render them
right now because they are for unexported types or not a doc comment
at all but just a normal code comment - consistency is queen!).
* Re-enabled `TestQueryLog` and `TestEndopints` (they pass now,
leaving them disabled was presumably an oversight).
* Bucket iterator for histogram.Histogram is now created with a
method.
* HistogramChunk.iterator now allows iterator recycling. (I think
@dieterbe only commented it out because he was confused by the
question in the comment.)
* HistogramAppender.Append panics now because we decided to treat
staleness marker differently.
Signed-off-by: beorn7 <beorn@grafana.com>
2021-10-09 06:57:07 -07:00
func TestHistogramChunkSameBuckets ( t * testing . T ) {
c := NewHistogramChunk ( )
2022-12-11 14:39:53 -08:00
var exp [ ] result
2021-06-29 01:37:41 -07:00
Style cleanup of all the changes in sparsehistogram so far
A lot of this code was hacked together, literally during a
hackathon. This commit intends not to change the code substantially,
but just make the code obey the usual style practices.
A (possibly incomplete) list of areas:
* Generally address linter warnings.
* The `pgk` directory is deprecated as per dev-summit. No new packages should
be added to it. I moved the new `pkg/histogram` package to `model`
anticipating what's proposed in #9478.
* Make the naming of the Sparse Histogram more consistent. Including
abbreviations, there were just too many names for it: SparseHistogram,
Histogram, Histo, hist, his, shs, h. The idea is to call it "Histogram" in
general. Only add "Sparse" if it is needed to avoid confusion with
conventional Histograms (which is rare because the TSDB really has no notion
of conventional Histograms). Use abbreviations only in local scope, and then
really abbreviate (not just removing three out of seven letters like in
"Histo"). This is in the spirit of
https://github.com/golang/go/wiki/CodeReviewComments#variable-names
* Several other minor name changes.
* A lot of formatting of doc comments. For one, following
https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences
, but also layout question, anticipating how things will look like
when rendered by `godoc` (even where `godoc` doesn't render them
right now because they are for unexported types or not a doc comment
at all but just a normal code comment - consistency is queen!).
* Re-enabled `TestQueryLog` and `TestEndopints` (they pass now,
leaving them disabled was presumably an oversight).
* Bucket iterator for histogram.Histogram is now created with a
method.
* HistogramChunk.iterator now allows iterator recycling. (I think
@dieterbe only commented it out because he was confused by the
question in the comment.)
* HistogramAppender.Append panics now because we decided to treat
staleness marker differently.
Signed-off-by: beorn7 <beorn@grafana.com>
2021-10-09 06:57:07 -07:00
// Create fresh appender and add the first histogram.
2021-06-29 01:37:41 -07:00
app , err := c . Appender ( )
require . NoError ( t , err )
2021-07-01 23:20:30 -07:00
require . Equal ( t , 0 , c . NumSamples ( ) )
2021-06-29 01:37:41 -07:00
2021-06-29 06:57:59 -07:00
ts := int64 ( 1234567890 )
2021-11-12 10:07:41 -08:00
h := & histogram . Histogram {
2022-12-11 14:39:53 -08:00
Count : 15 ,
2021-08-06 05:38:41 -07:00
ZeroCount : 2 ,
Sum : 18.4 ,
ZeroThreshold : 1e-100 ,
Schema : 1 ,
2021-06-29 01:37:41 -07:00
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 2 } ,
{ Offset : 1 , Length : 2 } ,
} ,
2021-06-30 03:45:43 -07:00
PositiveBuckets : [ ] int64 { 1 , 1 , - 1 , 0 } , // counts: 1, 2, 1, 1 (total 5)
2022-12-11 14:39:53 -08:00
NegativeSpans : [ ] histogram . Span {
{ Offset : 1 , Length : 1 } ,
{ Offset : 2 , Length : 3 } ,
} ,
NegativeBuckets : [ ] int64 { 2 , 1 , - 1 , - 1 } , // counts: 2, 3, 2, 1 (total 8)
2021-06-29 01:37:41 -07:00
}
2023-07-26 06:08:16 -07:00
chk , _ , app , err := app . AppendHistogram ( nil , ts , h , false )
require . NoError ( t , err )
require . Nil ( t , chk )
2023-11-29 06:15:57 -08:00
exp = append ( exp , result { t : ts , h : h , fh : h . ToFloat ( nil ) } )
2021-07-01 23:20:30 -07:00
require . Equal ( t , 1 , c . NumSamples ( ) )
2021-06-29 01:37:41 -07:00
2021-08-06 01:56:56 -07:00
// Add an updated histogram.
2021-06-30 03:45:43 -07:00
ts += 16
2021-11-12 10:07:41 -08:00
h = h . Copy ( )
2022-12-11 14:39:53 -08:00
h . Count = 32
2021-06-30 03:45:43 -07:00
h . ZeroCount ++
h . Sum = 24.4
h . PositiveBuckets = [ ] int64 { 5 , - 2 , 1 , - 2 } // counts: 5, 3, 4, 2 (total 14)
2022-12-11 14:39:53 -08:00
h . NegativeBuckets = [ ] int64 { 4 , - 1 , 1 , - 1 } // counts: 4, 3, 4, 4 (total 15)
2023-07-26 06:08:16 -07:00
chk , _ , _ , err = app . AppendHistogram ( nil , ts , h , false )
require . NoError ( t , err )
require . Nil ( t , chk )
2023-01-18 08:59:29 -08:00
hExp := h . Copy ( )
hExp . CounterResetHint = histogram . NotCounterReset
2023-11-29 06:15:57 -08:00
exp = append ( exp , result { t : ts , h : hExp , fh : hExp . ToFloat ( nil ) } )
2021-07-01 23:20:30 -07:00
require . Equal ( t , 2 , c . NumSamples ( ) )
2021-06-30 03:45:43 -07:00
Style cleanup of all the changes in sparsehistogram so far
A lot of this code was hacked together, literally during a
hackathon. This commit intends not to change the code substantially,
but just make the code obey the usual style practices.
A (possibly incomplete) list of areas:
* Generally address linter warnings.
* The `pgk` directory is deprecated as per dev-summit. No new packages should
be added to it. I moved the new `pkg/histogram` package to `model`
anticipating what's proposed in #9478.
* Make the naming of the Sparse Histogram more consistent. Including
abbreviations, there were just too many names for it: SparseHistogram,
Histogram, Histo, hist, his, shs, h. The idea is to call it "Histogram" in
general. Only add "Sparse" if it is needed to avoid confusion with
conventional Histograms (which is rare because the TSDB really has no notion
of conventional Histograms). Use abbreviations only in local scope, and then
really abbreviate (not just removing three out of seven letters like in
"Histo"). This is in the spirit of
https://github.com/golang/go/wiki/CodeReviewComments#variable-names
* Several other minor name changes.
* A lot of formatting of doc comments. For one, following
https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences
, but also layout question, anticipating how things will look like
when rendered by `godoc` (even where `godoc` doesn't render them
right now because they are for unexported types or not a doc comment
at all but just a normal code comment - consistency is queen!).
* Re-enabled `TestQueryLog` and `TestEndopints` (they pass now,
leaving them disabled was presumably an oversight).
* Bucket iterator for histogram.Histogram is now created with a
method.
* HistogramChunk.iterator now allows iterator recycling. (I think
@dieterbe only commented it out because he was confused by the
question in the comment.)
* HistogramAppender.Append panics now because we decided to treat
staleness marker differently.
Signed-off-by: beorn7 <beorn@grafana.com>
2021-10-09 06:57:07 -07:00
// Add update with new appender.
2021-06-30 03:45:43 -07:00
app , err = c . Appender ( )
require . NoError ( t , err )
ts += 14
2021-11-12 10:07:41 -08:00
h = h . Copy ( )
2022-12-11 14:39:53 -08:00
h . Count = 54
2021-06-30 03:45:43 -07:00
h . ZeroCount += 2
h . Sum = 24.4
h . PositiveBuckets = [ ] int64 { 6 , 1 , - 3 , 6 } // counts: 6, 7, 4, 10 (total 27)
2022-12-11 14:39:53 -08:00
h . NegativeBuckets = [ ] int64 { 5 , 1 , - 2 , 3 } // counts: 5, 6, 4, 7 (total 22)
2023-07-26 06:08:16 -07:00
chk , _ , _ , err = app . AppendHistogram ( nil , ts , h , false )
require . NoError ( t , err )
require . Nil ( t , chk )
2023-01-18 08:59:29 -08:00
hExp = h . Copy ( )
hExp . CounterResetHint = histogram . NotCounterReset
2023-11-29 06:15:57 -08:00
exp = append ( exp , result { t : ts , h : hExp , fh : hExp . ToFloat ( nil ) } )
2021-07-01 23:20:30 -07:00
require . Equal ( t , 3 , c . NumSamples ( ) )
2021-06-29 01:37:41 -07:00
// 1. Expand iterator in simple case.
2022-12-11 14:39:53 -08:00
it := c . Iterator ( nil )
2021-08-06 01:56:56 -07:00
require . NoError ( t , it . Err ( ) )
2022-12-11 14:39:53 -08:00
var act [ ] result
2021-11-28 23:54:23 -08:00
for it . Next ( ) == ValHistogram {
2024-01-23 08:02:14 -08:00
ts , h := it . AtHistogram ( nil )
fts , fh := it . AtFloatHistogram ( nil )
2022-12-11 14:39:53 -08:00
require . Equal ( t , ts , fts )
act = append ( act , result { t : ts , h : h , fh : fh } )
2021-06-29 01:37:41 -07:00
}
2021-08-06 01:56:56 -07:00
require . NoError ( t , it . Err ( ) )
require . Equal ( t , exp , act )
2021-06-29 01:37:41 -07:00
// 2. Expand second iterator while reusing first one.
2022-11-30 04:19:33 -08:00
it2 := c . Iterator ( it )
2022-12-11 14:39:53 -08:00
var act2 [ ] result
2022-11-30 04:19:33 -08:00
for it2 . Next ( ) == ValHistogram {
2024-01-23 08:02:14 -08:00
ts , h := it2 . AtHistogram ( nil )
fts , fh := it2 . AtFloatHistogram ( nil )
2022-12-11 14:39:53 -08:00
require . Equal ( t , ts , fts )
act2 = append ( act2 , result { t : ts , h : h , fh : fh } )
2022-11-30 04:19:33 -08:00
}
require . NoError ( t , it2 . Err ( ) )
2022-12-11 14:39:53 -08:00
require . Equal ( t , exp , act2 )
2021-06-29 01:37:41 -07:00
2022-12-11 14:39:53 -08:00
// 3. Now recycle an iterator that was never used to access anything.
itX := c . Iterator ( nil )
2023-10-31 04:35:13 -07:00
for itX . Next ( ) == ValHistogram {
2022-12-11 14:39:53 -08:00
// Just iterate through without accessing anything.
}
it3 := c . iterator ( itX )
var act3 [ ] result
for it3 . Next ( ) == ValHistogram {
2024-01-23 08:02:14 -08:00
ts , h := it3 . AtHistogram ( nil )
fts , fh := it3 . AtFloatHistogram ( nil )
2022-12-11 14:39:53 -08:00
require . Equal ( t , ts , fts )
act3 = append ( act3 , result { t : ts , h : h , fh : fh } )
}
require . NoError ( t , it3 . Err ( ) )
require . Equal ( t , exp , act3 )
2021-06-29 01:37:41 -07:00
2022-12-11 14:39:53 -08:00
// 4. Test iterator Seek.
mid := len ( exp ) / 2
it4 := c . Iterator ( nil )
var act4 [ ] result
require . Equal ( t , ValHistogram , it4 . Seek ( exp [ mid ] . t ) )
2021-06-29 01:37:41 -07:00
// Below ones should not matter.
2022-12-11 14:39:53 -08:00
require . Equal ( t , ValHistogram , it4 . Seek ( exp [ mid ] . t ) )
require . Equal ( t , ValHistogram , it4 . Seek ( exp [ mid ] . t ) )
2024-01-23 08:02:14 -08:00
ts , h = it4 . AtHistogram ( nil )
fts , fh := it4 . AtFloatHistogram ( nil )
2022-12-11 14:39:53 -08:00
require . Equal ( t , ts , fts )
act4 = append ( act4 , result { t : ts , h : h , fh : fh } )
for it4 . Next ( ) == ValHistogram {
2024-01-23 08:02:14 -08:00
ts , h := it4 . AtHistogram ( nil )
fts , fh := it4 . AtFloatHistogram ( nil )
2022-12-11 14:39:53 -08:00
require . Equal ( t , ts , fts )
act4 = append ( act4 , result { t : ts , h : h , fh : fh } )
}
require . NoError ( t , it4 . Err ( ) )
require . Equal ( t , exp [ mid : ] , act4 )
require . Equal ( t , ValNone , it4 . Seek ( exp [ len ( exp ) - 1 ] . t + 1 ) )
2021-07-15 02:05:35 -07:00
}
2023-01-18 04:47:22 -08:00
// Mimics the scenario described for expandSpansForward.
Style cleanup of all the changes in sparsehistogram so far
A lot of this code was hacked together, literally during a
hackathon. This commit intends not to change the code substantially,
but just make the code obey the usual style practices.
A (possibly incomplete) list of areas:
* Generally address linter warnings.
* The `pgk` directory is deprecated as per dev-summit. No new packages should
be added to it. I moved the new `pkg/histogram` package to `model`
anticipating what's proposed in #9478.
* Make the naming of the Sparse Histogram more consistent. Including
abbreviations, there were just too many names for it: SparseHistogram,
Histogram, Histo, hist, his, shs, h. The idea is to call it "Histogram" in
general. Only add "Sparse" if it is needed to avoid confusion with
conventional Histograms (which is rare because the TSDB really has no notion
of conventional Histograms). Use abbreviations only in local scope, and then
really abbreviate (not just removing three out of seven letters like in
"Histo"). This is in the spirit of
https://github.com/golang/go/wiki/CodeReviewComments#variable-names
* Several other minor name changes.
* A lot of formatting of doc comments. For one, following
https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences
, but also layout question, anticipating how things will look like
when rendered by `godoc` (even where `godoc` doesn't render them
right now because they are for unexported types or not a doc comment
at all but just a normal code comment - consistency is queen!).
* Re-enabled `TestQueryLog` and `TestEndopints` (they pass now,
leaving them disabled was presumably an oversight).
* Bucket iterator for histogram.Histogram is now created with a
method.
* HistogramChunk.iterator now allows iterator recycling. (I think
@dieterbe only commented it out because he was confused by the
question in the comment.)
* HistogramAppender.Append panics now because we decided to treat
staleness marker differently.
Signed-off-by: beorn7 <beorn@grafana.com>
2021-10-09 06:57:07 -07:00
func TestHistogramChunkBucketChanges ( t * testing . T ) {
c := Chunk ( NewHistogramChunk ( ) )
2021-07-01 23:20:30 -07:00
2021-08-06 01:56:56 -07:00
// Create fresh appender and add the first histogram.
2021-07-01 23:20:30 -07:00
app , err := c . Appender ( )
require . NoError ( t , err )
require . Equal ( t , 0 , c . NumSamples ( ) )
ts1 := int64 ( 1234567890 )
2021-11-12 10:07:41 -08:00
h1 := & histogram . Histogram {
2022-12-11 14:39:53 -08:00
Count : 27 ,
2021-08-06 05:38:41 -07:00
ZeroCount : 2 ,
Sum : 18.4 ,
ZeroThreshold : 1e-125 ,
Schema : 1 ,
2021-07-01 23:20:30 -07:00
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 2 } ,
{ Offset : 2 , Length : 1 } ,
{ Offset : 3 , Length : 2 } ,
{ Offset : 3 , Length : 1 } ,
{ Offset : 1 , Length : 1 } ,
} ,
PositiveBuckets : [ ] int64 { 6 , - 3 , 0 , - 1 , 2 , 1 , - 4 } , // counts: 6, 3, 3, 2, 4, 5, 1 (total 24)
2022-12-11 14:39:53 -08:00
NegativeSpans : [ ] histogram . Span { { Offset : 1 , Length : 1 } } ,
NegativeBuckets : [ ] int64 { 1 } ,
2021-07-01 23:20:30 -07:00
}
2023-07-26 06:08:16 -07:00
chk , _ , app , err := app . AppendHistogram ( nil , ts1 , h1 , false )
require . NoError ( t , err )
require . Nil ( t , chk )
2021-07-01 23:20:30 -07:00
require . Equal ( t , 1 , c . NumSamples ( ) )
2021-08-06 01:56:56 -07:00
// Add a new histogram that has expanded buckets.
2021-07-01 23:20:30 -07:00
ts2 := ts1 + 16
2021-11-12 10:07:41 -08:00
h2 := h1 . Copy ( )
2021-07-01 23:20:30 -07:00
h2 . PositiveSpans = [ ] histogram . Span {
{ Offset : 0 , Length : 3 } ,
{ Offset : 1 , Length : 1 } ,
{ Offset : 1 , Length : 4 } ,
{ Offset : 3 , Length : 3 } ,
}
2022-12-11 14:39:53 -08:00
h2 . NegativeSpans = [ ] histogram . Span { { Offset : 0 , Length : 2 } }
h2 . Count = 35
2021-07-01 23:20:30 -07:00
h2 . ZeroCount ++
h2 . Sum = 30
Style cleanup of all the changes in sparsehistogram so far
A lot of this code was hacked together, literally during a
hackathon. This commit intends not to change the code substantially,
but just make the code obey the usual style practices.
A (possibly incomplete) list of areas:
* Generally address linter warnings.
* The `pgk` directory is deprecated as per dev-summit. No new packages should
be added to it. I moved the new `pkg/histogram` package to `model`
anticipating what's proposed in #9478.
* Make the naming of the Sparse Histogram more consistent. Including
abbreviations, there were just too many names for it: SparseHistogram,
Histogram, Histo, hist, his, shs, h. The idea is to call it "Histogram" in
general. Only add "Sparse" if it is needed to avoid confusion with
conventional Histograms (which is rare because the TSDB really has no notion
of conventional Histograms). Use abbreviations only in local scope, and then
really abbreviate (not just removing three out of seven letters like in
"Histo"). This is in the spirit of
https://github.com/golang/go/wiki/CodeReviewComments#variable-names
* Several other minor name changes.
* A lot of formatting of doc comments. For one, following
https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences
, but also layout question, anticipating how things will look like
when rendered by `godoc` (even where `godoc` doesn't render them
right now because they are for unexported types or not a doc comment
at all but just a normal code comment - consistency is queen!).
* Re-enabled `TestQueryLog` and `TestEndopints` (they pass now,
leaving them disabled was presumably an oversight).
* Bucket iterator for histogram.Histogram is now created with a
method.
* HistogramChunk.iterator now allows iterator recycling. (I think
@dieterbe only commented it out because he was confused by the
question in the comment.)
* HistogramAppender.Append panics now because we decided to treat
staleness marker differently.
Signed-off-by: beorn7 <beorn@grafana.com>
2021-10-09 06:57:07 -07:00
// Existing histogram should get values converted from the above to:
// 6 3 0 3 0 0 2 4 5 0 1 (previous values with some new empty buckets in between)
2021-07-01 23:20:30 -07:00
// so the new histogram should have new counts >= these per-bucket counts, e.g.:
h2 . PositiveBuckets = [ ] int64 { 7 , - 2 , - 4 , 2 , - 2 , - 1 , 2 , 3 , 0 , - 5 , 1 } // 7 5 1 3 1 0 2 5 5 0 1 (total 30)
2022-12-11 14:39:53 -08:00
// Existing histogram should get values converted from the above to:
// 0 1 (previous values with some new empty buckets in between)
// so the new histogram should have new counts >= these per-bucket counts, e.g.:
h2 . NegativeBuckets = [ ] int64 { 2 , - 1 } // 2 1 (total 3)
2021-08-06 01:56:56 -07:00
// This is how span changes will be handled.
Style cleanup of all the changes in sparsehistogram so far
A lot of this code was hacked together, literally during a
hackathon. This commit intends not to change the code substantially,
but just make the code obey the usual style practices.
A (possibly incomplete) list of areas:
* Generally address linter warnings.
* The `pgk` directory is deprecated as per dev-summit. No new packages should
be added to it. I moved the new `pkg/histogram` package to `model`
anticipating what's proposed in #9478.
* Make the naming of the Sparse Histogram more consistent. Including
abbreviations, there were just too many names for it: SparseHistogram,
Histogram, Histo, hist, his, shs, h. The idea is to call it "Histogram" in
general. Only add "Sparse" if it is needed to avoid confusion with
conventional Histograms (which is rare because the TSDB really has no notion
of conventional Histograms). Use abbreviations only in local scope, and then
really abbreviate (not just removing three out of seven letters like in
"Histo"). This is in the spirit of
https://github.com/golang/go/wiki/CodeReviewComments#variable-names
* Several other minor name changes.
* A lot of formatting of doc comments. For one, following
https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences
, but also layout question, anticipating how things will look like
when rendered by `godoc` (even where `godoc` doesn't render them
right now because they are for unexported types or not a doc comment
at all but just a normal code comment - consistency is queen!).
* Re-enabled `TestQueryLog` and `TestEndopints` (they pass now,
leaving them disabled was presumably an oversight).
* Bucket iterator for histogram.Histogram is now created with a
method.
* HistogramChunk.iterator now allows iterator recycling. (I think
@dieterbe only commented it out because he was confused by the
question in the comment.)
* HistogramAppender.Append panics now because we decided to treat
staleness marker differently.
Signed-off-by: beorn7 <beorn@grafana.com>
2021-10-09 06:57:07 -07:00
hApp , _ := app . ( * HistogramAppender )
2023-07-26 06:08:16 -07:00
posInterjections , negInterjections , ok , cr := hApp . appendable ( h2 )
2023-12-07 03:35:01 -08:00
require . NotEmpty ( t , posInterjections )
require . NotEmpty ( t , negInterjections )
2021-08-06 01:56:56 -07:00
require . True ( t , ok ) // Only new buckets came in.
2021-10-04 06:14:12 -07:00
require . False ( t , cr )
2023-07-26 06:08:16 -07:00
c , app = hApp . recode ( posInterjections , negInterjections , h2 . PositiveSpans , h2 . NegativeSpans )
chk , _ , _ , err = app . AppendHistogram ( nil , ts2 , h2 , false )
require . NoError ( t , err )
require . Nil ( t , chk )
2021-07-01 23:20:30 -07:00
require . Equal ( t , 2 , c . NumSamples ( ) )
Style cleanup of all the changes in sparsehistogram so far
A lot of this code was hacked together, literally during a
hackathon. This commit intends not to change the code substantially,
but just make the code obey the usual style practices.
A (possibly incomplete) list of areas:
* Generally address linter warnings.
* The `pgk` directory is deprecated as per dev-summit. No new packages should
be added to it. I moved the new `pkg/histogram` package to `model`
anticipating what's proposed in #9478.
* Make the naming of the Sparse Histogram more consistent. Including
abbreviations, there were just too many names for it: SparseHistogram,
Histogram, Histo, hist, his, shs, h. The idea is to call it "Histogram" in
general. Only add "Sparse" if it is needed to avoid confusion with
conventional Histograms (which is rare because the TSDB really has no notion
of conventional Histograms). Use abbreviations only in local scope, and then
really abbreviate (not just removing three out of seven letters like in
"Histo"). This is in the spirit of
https://github.com/golang/go/wiki/CodeReviewComments#variable-names
* Several other minor name changes.
* A lot of formatting of doc comments. For one, following
https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences
, but also layout question, anticipating how things will look like
when rendered by `godoc` (even where `godoc` doesn't render them
right now because they are for unexported types or not a doc comment
at all but just a normal code comment - consistency is queen!).
* Re-enabled `TestQueryLog` and `TestEndopints` (they pass now,
leaving them disabled was presumably an oversight).
* Bucket iterator for histogram.Histogram is now created with a
method.
* HistogramChunk.iterator now allows iterator recycling. (I think
@dieterbe only commented it out because he was confused by the
question in the comment.)
* HistogramAppender.Append panics now because we decided to treat
staleness marker differently.
Signed-off-by: beorn7 <beorn@grafana.com>
2021-10-09 06:57:07 -07:00
// Because the 2nd histogram has expanded buckets, we should expect all
// histograms (in particular the first) to come back using the new spans
// metadata as well as the expanded buckets.
2021-07-01 23:20:30 -07:00
h1 . PositiveSpans = h2 . PositiveSpans
h1 . PositiveBuckets = [ ] int64 { 6 , - 3 , - 3 , 3 , - 3 , 0 , 2 , 2 , 1 , - 5 , 1 }
2022-12-11 14:39:53 -08:00
h1 . NegativeSpans = h2 . NegativeSpans
h1 . NegativeBuckets = [ ] int64 { 0 , 1 }
2023-01-18 08:59:29 -08:00
hExp := h2 . Copy ( )
hExp . CounterResetHint = histogram . NotCounterReset
2022-12-11 14:39:53 -08:00
exp := [ ] result {
2023-11-29 06:15:57 -08:00
{ t : ts1 , h : h1 , fh : h1 . ToFloat ( nil ) } ,
{ t : ts2 , h : hExp , fh : hExp . ToFloat ( nil ) } ,
2021-07-01 23:20:30 -07:00
}
2021-08-06 01:56:56 -07:00
it := c . Iterator ( nil )
2022-12-11 14:39:53 -08:00
var act [ ] result
2021-11-28 23:54:23 -08:00
for it . Next ( ) == ValHistogram {
2024-01-23 08:02:14 -08:00
ts , h := it . AtHistogram ( nil )
fts , fh := it . AtFloatHistogram ( nil )
2022-12-11 14:39:53 -08:00
require . Equal ( t , ts , fts )
act = append ( act , result { t : ts , h : h , fh : fh } )
2021-07-01 23:20:30 -07:00
}
2021-08-06 01:56:56 -07:00
require . NoError ( t , it . Err ( ) )
require . Equal ( t , exp , act )
2021-07-01 23:20:30 -07:00
}
2021-08-17 09:34:45 -07:00
2022-12-11 14:39:53 -08:00
func TestHistogramChunkAppendable ( t * testing . T ) {
2024-03-22 06:36:39 -07:00
eh := & histogram . Histogram {
Count : 5 ,
ZeroCount : 2 ,
Sum : 18.4 ,
ZeroThreshold : 1e-125 ,
Schema : 1 ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 2 } ,
{ Offset : 2 , Length : 1 } ,
{ Offset : 3 , Length : 2 } ,
{ Offset : 3 , Length : 1 } ,
{ Offset : 1 , Length : 1 } ,
} ,
PositiveBuckets : [ ] int64 { 6 , - 3 , 0 , - 1 , 2 , 1 , - 4 } , // counts: 6, 3, 3, 2, 4, 5, 1 (total 24)
}
cbh := & histogram . Histogram {
Count : 24 ,
Sum : 18.4 ,
Schema : histogram . CustomBucketsSchema ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 2 } ,
{ Offset : 2 , Length : 1 } ,
{ Offset : 3 , Length : 2 } ,
{ Offset : 3 , Length : 1 } ,
{ Offset : 1 , Length : 1 } ,
} ,
PositiveBuckets : [ ] int64 { 6 , - 3 , 0 , - 1 , 2 , 1 , - 4 } , // counts: 6, 3, 3, 2, 4, 5, 1 (total 24)
CustomValues : [ ] float64 { 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 , 13 , 14 , 15 , 16 , 17 , 18 , 19 , 20 } ,
}
setup := func ( h * histogram . Histogram ) ( Chunk , * HistogramAppender , int64 , * histogram . Histogram ) {
2023-07-26 06:08:16 -07:00
c := Chunk ( NewHistogramChunk ( ) )
// Create fresh appender and add the first histogram.
app , err := c . Appender ( )
require . NoError ( t , err )
require . Equal ( t , 0 , c . NumSamples ( ) )
ts := int64 ( 1234567890 )
2021-08-17 09:34:45 -07:00
2024-03-22 06:36:39 -07:00
chk , _ , app , err := app . AppendHistogram ( nil , ts , h . Copy ( ) , false )
2023-07-26 06:08:16 -07:00
require . NoError ( t , err )
require . Nil ( t , chk )
require . Equal ( t , 1 , c . NumSamples ( ) )
require . Equal ( t , UnknownCounterReset , c . ( * HistogramChunk ) . GetCounterResetHeader ( ) )
2024-03-22 06:36:39 -07:00
return c , app . ( * HistogramAppender ) , ts , h
2021-08-17 09:34:45 -07:00
}
2023-01-05 01:14:24 -08:00
{ // Schema change.
2024-03-22 06:36:39 -07:00
c , hApp , ts , h1 := setup ( eh )
2023-01-05 01:14:24 -08:00
h2 := h1 . Copy ( )
h2 . Schema ++
2023-07-26 06:08:16 -07:00
_ , _ , ok , _ := hApp . appendable ( h2 )
2023-01-05 01:14:24 -08:00
require . False ( t , ok )
2023-07-26 06:08:16 -07:00
assertNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , UnknownCounterReset )
2023-01-05 01:14:24 -08:00
}
{ // Zero threshold change.
2024-03-22 06:36:39 -07:00
c , hApp , ts , h1 := setup ( eh )
2023-01-05 01:14:24 -08:00
h2 := h1 . Copy ( )
h2 . ZeroThreshold += 0.1
2023-07-26 06:08:16 -07:00
_ , _ , ok , _ := hApp . appendable ( h2 )
2023-01-05 01:14:24 -08:00
require . False ( t , ok )
2023-07-26 06:08:16 -07:00
assertNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , UnknownCounterReset )
2023-01-05 01:14:24 -08:00
}
2021-08-17 09:34:45 -07:00
{ // New histogram that has more buckets.
2024-03-22 06:36:39 -07:00
c , hApp , ts , h1 := setup ( eh )
2023-01-05 01:14:24 -08:00
h2 := h1 . Copy ( )
2021-08-17 09:34:45 -07:00
h2 . PositiveSpans = [ ] histogram . Span {
{ Offset : 0 , Length : 3 } ,
{ Offset : 1 , Length : 1 } ,
{ Offset : 1 , Length : 4 } ,
{ Offset : 3 , Length : 3 } ,
}
h2 . Count += 9
h2 . ZeroCount ++
h2 . Sum = 30
Style cleanup of all the changes in sparsehistogram so far
A lot of this code was hacked together, literally during a
hackathon. This commit intends not to change the code substantially,
but just make the code obey the usual style practices.
A (possibly incomplete) list of areas:
* Generally address linter warnings.
* The `pgk` directory is deprecated as per dev-summit. No new packages should
be added to it. I moved the new `pkg/histogram` package to `model`
anticipating what's proposed in #9478.
* Make the naming of the Sparse Histogram more consistent. Including
abbreviations, there were just too many names for it: SparseHistogram,
Histogram, Histo, hist, his, shs, h. The idea is to call it "Histogram" in
general. Only add "Sparse" if it is needed to avoid confusion with
conventional Histograms (which is rare because the TSDB really has no notion
of conventional Histograms). Use abbreviations only in local scope, and then
really abbreviate (not just removing three out of seven letters like in
"Histo"). This is in the spirit of
https://github.com/golang/go/wiki/CodeReviewComments#variable-names
* Several other minor name changes.
* A lot of formatting of doc comments. For one, following
https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences
, but also layout question, anticipating how things will look like
when rendered by `godoc` (even where `godoc` doesn't render them
right now because they are for unexported types or not a doc comment
at all but just a normal code comment - consistency is queen!).
* Re-enabled `TestQueryLog` and `TestEndopints` (they pass now,
leaving them disabled was presumably an oversight).
* Bucket iterator for histogram.Histogram is now created with a
method.
* HistogramChunk.iterator now allows iterator recycling. (I think
@dieterbe only commented it out because he was confused by the
question in the comment.)
* HistogramAppender.Append panics now because we decided to treat
staleness marker differently.
Signed-off-by: beorn7 <beorn@grafana.com>
2021-10-09 06:57:07 -07:00
// Existing histogram should get values converted from the above to:
// 6 3 0 3 0 0 2 4 5 0 1 (previous values with some new empty buckets in between)
2021-08-17 09:34:45 -07:00
// so the new histogram should have new counts >= these per-bucket counts, e.g.:
h2 . PositiveBuckets = [ ] int64 { 7 , - 2 , - 4 , 2 , - 2 , - 1 , 2 , 3 , 0 , - 5 , 1 } // 7 5 1 3 1 0 2 5 5 0 1 (total 30)
2023-07-26 06:08:16 -07:00
posInterjections , negInterjections , ok , cr := hApp . appendable ( h2 )
2023-12-07 03:35:01 -08:00
require . NotEmpty ( t , posInterjections )
require . Empty ( t , negInterjections )
2021-08-17 09:34:45 -07:00
require . True ( t , ok ) // Only new buckets came in.
2021-10-04 06:14:12 -07:00
require . False ( t , cr )
2023-07-26 06:08:16 -07:00
assertRecodedHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , UnknownCounterReset )
2021-08-17 09:34:45 -07:00
}
{ // New histogram that has a bucket missing.
2024-03-22 06:36:39 -07:00
c , hApp , ts , h1 := setup ( eh )
2023-01-05 01:14:24 -08:00
h2 := h1 . Copy ( )
2021-08-17 09:34:45 -07:00
h2 . PositiveSpans = [ ] histogram . Span {
{ Offset : 0 , Length : 2 } ,
{ Offset : 5 , Length : 2 } ,
{ Offset : 3 , Length : 1 } ,
{ Offset : 1 , Length : 1 } ,
}
h2 . Sum = 21
h2 . PositiveBuckets = [ ] int64 { 6 , - 3 , - 1 , 2 , 1 , - 4 } // counts: 6, 3, 2, 4, 5, 1 (total 21)
2023-07-26 06:08:16 -07:00
posInterjections , negInterjections , ok , cr := hApp . appendable ( h2 )
2023-12-07 03:35:01 -08:00
require . Empty ( t , posInterjections )
require . Empty ( t , negInterjections )
2021-08-17 09:34:45 -07:00
require . False ( t , ok ) // Need to cut a new chunk.
2021-10-06 02:58:10 -07:00
require . True ( t , cr )
2023-07-26 06:08:16 -07:00
assertNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , CounterReset )
2021-08-17 09:34:45 -07:00
}
{ // New histogram that has a counter reset while buckets are same.
2024-03-22 06:36:39 -07:00
c , hApp , ts , h1 := setup ( eh )
2023-01-05 01:14:24 -08:00
h2 := h1 . Copy ( )
2021-08-17 09:34:45 -07:00
h2 . Sum = 23
h2 . PositiveBuckets = [ ] int64 { 6 , - 4 , 1 , - 1 , 2 , 1 , - 4 } // counts: 6, 2, 3, 2, 4, 5, 1 (total 23)
2023-07-26 06:08:16 -07:00
posInterjections , negInterjections , ok , cr := hApp . appendable ( h2 )
2023-12-07 03:35:01 -08:00
require . Empty ( t , posInterjections )
require . Empty ( t , negInterjections )
2021-08-17 09:34:45 -07:00
require . False ( t , ok ) // Need to cut a new chunk.
2021-10-04 06:14:12 -07:00
require . True ( t , cr )
2023-07-26 06:08:16 -07:00
assertNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , CounterReset )
2021-08-17 09:34:45 -07:00
}
{ // New histogram that has a counter reset while new buckets were added.
2024-03-22 06:36:39 -07:00
c , hApp , ts , h1 := setup ( eh )
2023-01-05 01:14:24 -08:00
h2 := h1 . Copy ( )
2021-08-17 09:34:45 -07:00
h2 . PositiveSpans = [ ] histogram . Span {
{ Offset : 0 , Length : 3 } ,
{ Offset : 1 , Length : 1 } ,
{ Offset : 1 , Length : 4 } ,
{ Offset : 3 , Length : 3 } ,
}
h2 . Sum = 29
Style cleanup of all the changes in sparsehistogram so far
A lot of this code was hacked together, literally during a
hackathon. This commit intends not to change the code substantially,
but just make the code obey the usual style practices.
A (possibly incomplete) list of areas:
* Generally address linter warnings.
* The `pgk` directory is deprecated as per dev-summit. No new packages should
be added to it. I moved the new `pkg/histogram` package to `model`
anticipating what's proposed in #9478.
* Make the naming of the Sparse Histogram more consistent. Including
abbreviations, there were just too many names for it: SparseHistogram,
Histogram, Histo, hist, his, shs, h. The idea is to call it "Histogram" in
general. Only add "Sparse" if it is needed to avoid confusion with
conventional Histograms (which is rare because the TSDB really has no notion
of conventional Histograms). Use abbreviations only in local scope, and then
really abbreviate (not just removing three out of seven letters like in
"Histo"). This is in the spirit of
https://github.com/golang/go/wiki/CodeReviewComments#variable-names
* Several other minor name changes.
* A lot of formatting of doc comments. For one, following
https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences
, but also layout question, anticipating how things will look like
when rendered by `godoc` (even where `godoc` doesn't render them
right now because they are for unexported types or not a doc comment
at all but just a normal code comment - consistency is queen!).
* Re-enabled `TestQueryLog` and `TestEndopints` (they pass now,
leaving them disabled was presumably an oversight).
* Bucket iterator for histogram.Histogram is now created with a
method.
* HistogramChunk.iterator now allows iterator recycling. (I think
@dieterbe only commented it out because he was confused by the
question in the comment.)
* HistogramAppender.Append panics now because we decided to treat
staleness marker differently.
Signed-off-by: beorn7 <beorn@grafana.com>
2021-10-09 06:57:07 -07:00
// Existing histogram should get values converted from the above to:
// 6 3 0 3 0 0 2 4 5 0 1 (previous values with some new empty buckets in between)
2021-08-17 09:34:45 -07:00
// so the new histogram should have new counts >= these per-bucket counts, e.g.:
h2 . PositiveBuckets = [ ] int64 { 7 , - 2 , - 4 , 2 , - 2 , - 1 , 2 , 3 , 0 , - 5 , 0 } // 7 5 1 3 1 0 2 5 5 0 0 (total 29)
2023-07-26 06:08:16 -07:00
posInterjections , negInterjections , ok , cr := hApp . appendable ( h2 )
2023-12-07 03:35:01 -08:00
require . Empty ( t , posInterjections )
require . Empty ( t , negInterjections )
2021-08-17 09:34:45 -07:00
require . False ( t , ok ) // Need to cut a new chunk.
2021-10-04 06:14:12 -07:00
require . True ( t , cr )
2023-07-26 06:08:16 -07:00
assertNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , CounterReset )
2021-08-17 09:34:45 -07:00
}
Style cleanup of all the changes in sparsehistogram so far
A lot of this code was hacked together, literally during a
hackathon. This commit intends not to change the code substantially,
but just make the code obey the usual style practices.
A (possibly incomplete) list of areas:
* Generally address linter warnings.
* The `pgk` directory is deprecated as per dev-summit. No new packages should
be added to it. I moved the new `pkg/histogram` package to `model`
anticipating what's proposed in #9478.
* Make the naming of the Sparse Histogram more consistent. Including
abbreviations, there were just too many names for it: SparseHistogram,
Histogram, Histo, hist, his, shs, h. The idea is to call it "Histogram" in
general. Only add "Sparse" if it is needed to avoid confusion with
conventional Histograms (which is rare because the TSDB really has no notion
of conventional Histograms). Use abbreviations only in local scope, and then
really abbreviate (not just removing three out of seven letters like in
"Histo"). This is in the spirit of
https://github.com/golang/go/wiki/CodeReviewComments#variable-names
* Several other minor name changes.
* A lot of formatting of doc comments. For one, following
https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences
, but also layout question, anticipating how things will look like
when rendered by `godoc` (even where `godoc` doesn't render them
right now because they are for unexported types or not a doc comment
at all but just a normal code comment - consistency is queen!).
* Re-enabled `TestQueryLog` and `TestEndopints` (they pass now,
leaving them disabled was presumably an oversight).
* Bucket iterator for histogram.Histogram is now created with a
method.
* HistogramChunk.iterator now allows iterator recycling. (I think
@dieterbe only commented it out because he was confused by the
question in the comment.)
* HistogramAppender.Append panics now because we decided to treat
staleness marker differently.
Signed-off-by: beorn7 <beorn@grafana.com>
2021-10-09 06:57:07 -07:00
{
// New histogram that has a counter reset while new buckets were
// added before the first bucket and reset on first bucket. (to
// catch the edge case where the new bucket should be forwarded
// ahead until first old bucket at start)
2024-03-22 06:36:39 -07:00
c , hApp , ts , h1 := setup ( eh )
2023-01-05 01:14:24 -08:00
h2 := h1 . Copy ( )
2021-08-17 09:34:45 -07:00
h2 . PositiveSpans = [ ] histogram . Span {
{ Offset : - 3 , Length : 2 } ,
{ Offset : 1 , Length : 2 } ,
{ Offset : 2 , Length : 1 } ,
{ Offset : 3 , Length : 2 } ,
{ Offset : 3 , Length : 1 } ,
{ Offset : 1 , Length : 1 } ,
}
h2 . Sum = 26
Style cleanup of all the changes in sparsehistogram so far
A lot of this code was hacked together, literally during a
hackathon. This commit intends not to change the code substantially,
but just make the code obey the usual style practices.
A (possibly incomplete) list of areas:
* Generally address linter warnings.
* The `pgk` directory is deprecated as per dev-summit. No new packages should
be added to it. I moved the new `pkg/histogram` package to `model`
anticipating what's proposed in #9478.
* Make the naming of the Sparse Histogram more consistent. Including
abbreviations, there were just too many names for it: SparseHistogram,
Histogram, Histo, hist, his, shs, h. The idea is to call it "Histogram" in
general. Only add "Sparse" if it is needed to avoid confusion with
conventional Histograms (which is rare because the TSDB really has no notion
of conventional Histograms). Use abbreviations only in local scope, and then
really abbreviate (not just removing three out of seven letters like in
"Histo"). This is in the spirit of
https://github.com/golang/go/wiki/CodeReviewComments#variable-names
* Several other minor name changes.
* A lot of formatting of doc comments. For one, following
https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences
, but also layout question, anticipating how things will look like
when rendered by `godoc` (even where `godoc` doesn't render them
right now because they are for unexported types or not a doc comment
at all but just a normal code comment - consistency is queen!).
* Re-enabled `TestQueryLog` and `TestEndopints` (they pass now,
leaving them disabled was presumably an oversight).
* Bucket iterator for histogram.Histogram is now created with a
method.
* HistogramChunk.iterator now allows iterator recycling. (I think
@dieterbe only commented it out because he was confused by the
question in the comment.)
* HistogramAppender.Append panics now because we decided to treat
staleness marker differently.
Signed-off-by: beorn7 <beorn@grafana.com>
2021-10-09 06:57:07 -07:00
// Existing histogram should get values converted from the above to:
// 0, 0, 6, 3, 3, 2, 4, 5, 1
2021-08-17 09:34:45 -07:00
// so the new histogram should have new counts >= these per-bucket counts, e.g.:
h2 . PositiveBuckets = [ ] int64 { 1 , 1 , 3 , - 2 , 0 , - 1 , 2 , 1 , - 4 } // counts: 1, 2, 5, 3, 3, 2, 4, 5, 1 (total 26)
2023-07-26 06:08:16 -07:00
posInterjections , negInterjections , ok , cr := hApp . appendable ( h2 )
2023-12-07 03:35:01 -08:00
require . Empty ( t , posInterjections )
require . Empty ( t , negInterjections )
2021-08-17 09:34:45 -07:00
require . False ( t , ok ) // Need to cut a new chunk.
2021-10-04 06:14:12 -07:00
require . True ( t , cr )
2023-07-26 06:08:16 -07:00
assertNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , CounterReset )
2021-08-17 09:34:45 -07:00
}
2023-09-01 14:39:15 -07:00
{ // New histogram that has an explicit counter reset.
2024-03-22 06:36:39 -07:00
c , hApp , ts , h1 := setup ( eh )
2023-09-01 14:39:15 -07:00
h2 := h1 . Copy ( )
h2 . CounterResetHint = histogram . CounterReset
assertNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , CounterReset )
}
{ // Start new chunk explicitly, and append a new histogram that is considered appendable to the previous chunk.
2024-03-22 06:36:39 -07:00
_ , hApp , ts , h1 := setup ( eh )
2023-09-01 14:39:15 -07:00
h2 := h1 . Copy ( ) // Identity is appendable.
nextChunk := NewHistogramChunk ( )
app , err := nextChunk . Appender ( )
require . NoError ( t , err )
newChunk , recoded , newApp , err := app . AppendHistogram ( hApp , ts + 1 , h2 , false )
require . NoError ( t , err )
require . Nil ( t , newChunk )
require . False ( t , recoded )
require . Equal ( t , app , newApp )
assertSampleCount ( t , nextChunk , 1 , ValHistogram )
require . Equal ( t , NotCounterReset , nextChunk . GetCounterResetHeader ( ) )
}
{ // Start new chunk explicitly, and append a new histogram that is not considered appendable to the previous chunk.
2024-03-22 06:36:39 -07:00
_ , hApp , ts , h1 := setup ( eh )
2023-09-01 14:39:15 -07:00
h2 := h1 . Copy ( )
h2 . Count -- // Make this not appendable due to counter reset.
nextChunk := NewHistogramChunk ( )
app , err := nextChunk . Appender ( )
require . NoError ( t , err )
newChunk , recoded , newApp , err := app . AppendHistogram ( hApp , ts + 1 , h2 , false )
require . NoError ( t , err )
require . Nil ( t , newChunk )
require . False ( t , recoded )
require . Equal ( t , app , newApp )
assertSampleCount ( t , nextChunk , 1 , ValHistogram )
require . Equal ( t , CounterReset , nextChunk . GetCounterResetHeader ( ) )
}
{ // Start new chunk explicitly, and append a new histogram that would need recoding if we added it to the chunk.
2024-03-22 06:36:39 -07:00
_ , hApp , ts , h1 := setup ( eh )
2023-09-01 14:39:15 -07:00
h2 := h1 . Copy ( )
h2 . PositiveSpans = [ ] histogram . Span {
{ Offset : 0 , Length : 3 } ,
{ Offset : 1 , Length : 1 } ,
{ Offset : 1 , Length : 4 } ,
{ Offset : 3 , Length : 3 } ,
}
h2 . Count += 9
h2 . ZeroCount ++
h2 . Sum = 30
// Existing histogram should get values converted from the above to:
// 6 3 0 3 0 0 2 4 5 0 1 (previous values with some new empty buckets in between)
// so the new histogram should have new counts >= these per-bucket counts, e.g.:
h2 . PositiveBuckets = [ ] int64 { 7 , - 2 , - 4 , 2 , - 2 , - 1 , 2 , 3 , 0 , - 5 , 1 } // 7 5 1 3 1 0 2 5 5 0 1 (total 30)
nextChunk := NewHistogramChunk ( )
app , err := nextChunk . Appender ( )
require . NoError ( t , err )
newChunk , recoded , newApp , err := app . AppendHistogram ( hApp , ts + 1 , h2 , false )
require . NoError ( t , err )
require . Nil ( t , newChunk )
require . False ( t , recoded )
require . Equal ( t , app , newApp )
assertSampleCount ( t , nextChunk , 1 , ValHistogram )
require . Equal ( t , NotCounterReset , nextChunk . GetCounterResetHeader ( ) )
}
2024-03-22 06:36:39 -07:00
{ // Custom buckets, no change.
c , hApp , ts , h1 := setup ( cbh )
h2 := h1 . Copy ( )
_ , _ , ok , _ := hApp . appendable ( h2 )
require . True ( t , ok )
assertNoNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , UnknownCounterReset )
}
{ // Custom buckets, increase in bucket counts but no change in layout.
c , hApp , ts , h1 := setup ( cbh )
h2 := h1 . Copy ( )
h2 . Count ++
h2 . PositiveBuckets = [ ] int64 { 6 , - 3 , 0 , - 1 , 2 , 1 , - 3 }
_ , _ , ok , _ := hApp . appendable ( h2 )
require . True ( t , ok )
assertNoNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , UnknownCounterReset )
}
{ // Custom buckets, decrease in bucket counts but no change in layout.
c , hApp , ts , h1 := setup ( cbh )
h2 := h1 . Copy ( )
h2 . Count --
h2 . PositiveBuckets = [ ] int64 { 6 , - 3 , 0 , - 1 , 2 , 1 , - 5 }
_ , _ , ok , _ := hApp . appendable ( h2 )
require . False ( t , ok )
assertNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , CounterReset )
}
{ // Custom buckets, change only in custom bounds.
c , hApp , ts , h1 := setup ( cbh )
h2 := h1 . Copy ( )
h2 . CustomValues = [ ] float64 { 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 , 13 , 14 , 15 , 16 , 17 , 18 , 19 , 20 , 21 }
_ , _ , ok , _ := hApp . appendable ( h2 )
require . False ( t , ok )
assertNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , CounterReset )
}
{ // Custom buckets, with more buckets.
c , hApp , ts , h1 := setup ( cbh )
h2 := h1 . Copy ( )
h2 . PositiveSpans = [ ] histogram . Span {
{ Offset : 0 , Length : 3 } ,
{ Offset : 1 , Length : 1 } ,
{ Offset : 1 , Length : 4 } ,
{ Offset : 3 , Length : 3 } ,
}
h2 . Count += 6
h2 . Sum = 30
// Existing histogram should get values converted from the above to:
// 6 3 0 3 0 0 2 4 5 0 1 (previous values with some new empty buckets in between)
// so the new histogram should have new counts >= these per-bucket counts, e.g.:
h2 . PositiveBuckets = [ ] int64 { 7 , - 2 , - 4 , 2 , - 2 , - 1 , 2 , 3 , 0 , - 5 , 1 } // 7 5 1 3 1 0 2 5 5 0 1 (total 30)
posInterjections , negInterjections , ok , cr := hApp . appendable ( h2 )
require . NotEmpty ( t , posInterjections )
require . Empty ( t , negInterjections )
require . True ( t , ok ) // Only new buckets came in.
require . False ( t , cr )
assertRecodedHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , UnknownCounterReset )
}
2021-08-17 09:34:45 -07:00
}
2022-10-11 10:23:51 -07:00
2023-07-26 06:08:16 -07:00
func assertNewHistogramChunkOnAppend ( t * testing . T , oldChunk Chunk , hApp * HistogramAppender , ts int64 , h * histogram . Histogram , expectHeader CounterResetHeader ) {
oldChunkBytes := oldChunk . Bytes ( )
newChunk , recoded , newAppender , err := hApp . AppendHistogram ( nil , ts , h , false )
require . Equal ( t , oldChunkBytes , oldChunk . Bytes ( ) ) // Sanity check that previous chunk is untouched.
require . NoError ( t , err )
require . NotNil ( t , newChunk )
require . False ( t , recoded )
require . NotEqual ( t , oldChunk , newChunk )
require . Equal ( t , expectHeader , newChunk . ( * HistogramChunk ) . GetCounterResetHeader ( ) )
require . NotNil ( t , newAppender )
require . NotEqual ( t , hApp , newAppender )
assertSampleCount ( t , newChunk , 1 , ValHistogram )
}
2024-03-22 06:36:39 -07:00
func assertNoNewHistogramChunkOnAppend ( t * testing . T , currChunk Chunk , hApp * HistogramAppender , ts int64 , h * histogram . Histogram , expectHeader CounterResetHeader ) {
prevChunkBytes := currChunk . Bytes ( )
newChunk , recoded , newAppender , err := hApp . AppendHistogram ( nil , ts , h , false )
require . Greater ( t , len ( currChunk . Bytes ( ) ) , len ( prevChunkBytes ) ) // Check that current chunk is bigger than previously.
require . NoError ( t , err )
require . Nil ( t , newChunk )
require . False ( t , recoded )
require . Equal ( t , expectHeader , currChunk . ( * HistogramChunk ) . GetCounterResetHeader ( ) )
require . NotNil ( t , newAppender )
require . Equal ( t , hApp , newAppender )
assertSampleCount ( t , currChunk , 2 , ValHistogram )
}
2023-07-26 06:08:16 -07:00
func assertRecodedHistogramChunkOnAppend ( t * testing . T , prevChunk Chunk , hApp * HistogramAppender , ts int64 , h * histogram . Histogram , expectHeader CounterResetHeader ) {
prevChunkBytes := prevChunk . Bytes ( )
newChunk , recoded , newAppender , err := hApp . AppendHistogram ( nil , ts , h , false )
require . Equal ( t , prevChunkBytes , prevChunk . Bytes ( ) ) // Sanity check that previous chunk is untouched. This may change in the future if we implement in-place recoding.
require . NoError ( t , err )
require . NotNil ( t , newChunk )
require . True ( t , recoded )
require . NotEqual ( t , prevChunk , newChunk )
require . Equal ( t , expectHeader , newChunk . ( * HistogramChunk ) . GetCounterResetHeader ( ) )
require . NotNil ( t , newAppender )
require . NotEqual ( t , hApp , newAppender )
assertSampleCount ( t , newChunk , 2 , ValHistogram )
}
func assertSampleCount ( t * testing . T , c Chunk , exp int64 , vtype ValueType ) {
count := int64 ( 0 )
it := c . Iterator ( nil )
require . NoError ( t , it . Err ( ) )
for it . Next ( ) == vtype {
count ++
}
require . NoError ( t , it . Err ( ) )
require . Equal ( t , exp , count )
}
2023-05-11 12:02:02 -07:00
func TestHistogramChunkAppendableWithEmptySpan ( t * testing . T ) {
2023-09-13 03:59:42 -07:00
tests := map [ string ] struct {
h1 * histogram . Histogram
h2 * histogram . Histogram
} {
"empty span in old and new histogram" : {
h1 : & histogram . Histogram {
Schema : 0 ,
Count : 21 ,
Sum : 1234.5 ,
ZeroThreshold : 0.001 ,
ZeroCount : 4 ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 4 } ,
{ Offset : 0 , Length : 0 } ,
{ Offset : 0 , Length : 3 } ,
} ,
PositiveBuckets : [ ] int64 { 1 , 1 , - 1 , 0 , 0 , 0 , 0 } ,
NegativeSpans : [ ] histogram . Span {
{ Offset : 1 , Length : 4 } ,
{ Offset : 2 , Length : 0 } ,
{ Offset : 2 , Length : 3 } ,
} ,
NegativeBuckets : [ ] int64 { 1 , 1 , - 1 , 1 , 0 , 0 , 0 } ,
} ,
h2 : & histogram . Histogram {
Schema : 0 ,
Count : 37 ,
Sum : 2345.6 ,
ZeroThreshold : 0.001 ,
ZeroCount : 5 ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 4 } ,
{ Offset : 0 , Length : 0 } ,
{ Offset : 0 , Length : 3 } ,
} ,
PositiveBuckets : [ ] int64 { 1 , 2 , - 2 , 1 , - 1 , 0 , 0 } ,
NegativeSpans : [ ] histogram . Span {
{ Offset : 1 , Length : 4 } ,
{ Offset : 2 , Length : 0 } ,
{ Offset : 2 , Length : 3 } ,
} ,
NegativeBuckets : [ ] int64 { 1 , 3 , - 2 , 5 , - 2 , 0 , - 3 } ,
} ,
2023-05-11 12:02:02 -07:00
} ,
2023-09-13 03:59:42 -07:00
"empty span in old histogram" : {
h1 : & histogram . Histogram {
Schema : 0 ,
Count : 21 ,
Sum : 1234.5 ,
ZeroThreshold : 0.001 ,
ZeroCount : 4 ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 1 , Length : 0 } , // This span will disappear.
{ Offset : 2 , Length : 4 } ,
{ Offset : 0 , Length : 3 } ,
} ,
PositiveBuckets : [ ] int64 { 1 , 1 , - 1 , 0 , 0 , 0 , 0 } ,
NegativeSpans : [ ] histogram . Span {
{ Offset : 1 , Length : 4 } ,
{ Offset : 2 , Length : 0 } ,
{ Offset : 2 , Length : 3 } ,
} ,
NegativeBuckets : [ ] int64 { 1 , 1 , - 1 , 1 , 0 , 0 , 0 } ,
} ,
h2 : & histogram . Histogram {
Schema : 0 ,
Count : 37 ,
Sum : 2345.6 ,
ZeroThreshold : 0.001 ,
ZeroCount : 5 ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 3 , Length : 4 } ,
{ Offset : 0 , Length : 3 } ,
} ,
PositiveBuckets : [ ] int64 { 1 , 2 , - 2 , 1 , - 1 , 0 , 0 } ,
NegativeSpans : [ ] histogram . Span {
{ Offset : 1 , Length : 4 } ,
{ Offset : 2 , Length : 0 } ,
{ Offset : 2 , Length : 3 } ,
} ,
NegativeBuckets : [ ] int64 { 1 , 3 , - 2 , 5 , - 2 , 0 , - 3 } ,
} ,
2023-05-11 12:02:02 -07:00
} ,
2023-09-13 03:59:42 -07:00
"empty span in new histogram" : {
h1 : & histogram . Histogram {
Schema : 0 ,
Count : 21 ,
Sum : 1234.5 ,
ZeroThreshold : 0.001 ,
ZeroCount : 4 ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 4 } ,
{ Offset : 3 , Length : 3 } ,
} ,
PositiveBuckets : [ ] int64 { 1 , 1 , - 1 , 0 , 0 , 0 , 0 } ,
NegativeSpans : [ ] histogram . Span {
{ Offset : 1 , Length : 4 } ,
{ Offset : 2 , Length : 0 } ,
{ Offset : 2 , Length : 3 } ,
} ,
NegativeBuckets : [ ] int64 { 1 , 1 , - 1 , 1 , 0 , 0 , 0 } ,
} ,
h2 : & histogram . Histogram {
Schema : 0 ,
Count : 37 ,
Sum : 2345.6 ,
ZeroThreshold : 0.001 ,
ZeroCount : 5 ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 4 } ,
{ Offset : 1 , Length : 0 } , // This span is new.
{ Offset : 2 , Length : 3 } ,
} ,
PositiveBuckets : [ ] int64 { 1 , 2 , - 2 , 1 , - 1 , 0 , 0 } ,
NegativeSpans : [ ] histogram . Span {
{ Offset : 1 , Length : 4 } ,
{ Offset : 2 , Length : 0 } ,
{ Offset : 2 , Length : 3 } ,
} ,
NegativeBuckets : [ ] int64 { 1 , 3 , - 2 , 5 , - 2 , 0 , - 3 } ,
} ,
2023-05-11 12:02:02 -07:00
} ,
2023-09-13 03:59:42 -07:00
"two empty spans mixing offsets" : {
h1 : & histogram . Histogram {
Schema : 0 ,
Count : 21 ,
Sum : 1234.5 ,
ZeroThreshold : 0.001 ,
ZeroCount : 4 ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 4 } ,
{ Offset : 1 , Length : 0 } ,
{ Offset : 3 , Length : 0 } ,
{ Offset : 4 , Length : 3 } ,
} ,
PositiveBuckets : [ ] int64 { 1 , 1 , - 1 , 0 , 0 , 0 , 0 } ,
NegativeSpans : [ ] histogram . Span {
{ Offset : 1 , Length : 4 } ,
{ Offset : 2 , Length : 0 } ,
{ Offset : 2 , Length : 3 } ,
} ,
NegativeBuckets : [ ] int64 { 1 , 1 , - 1 , 1 , 0 , 0 , 0 } ,
} ,
h2 : & histogram . Histogram {
Schema : 0 ,
Count : 37 ,
Sum : 2345.6 ,
ZeroThreshold : 0.001 ,
ZeroCount : 5 ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 4 } ,
{ Offset : 3 , Length : 0 } ,
{ Offset : 1 , Length : 0 } ,
{ Offset : 4 , Length : 3 } ,
} ,
PositiveBuckets : [ ] int64 { 1 , 2 , - 2 , 1 , - 1 , 0 , 0 } ,
NegativeSpans : [ ] histogram . Span {
{ Offset : 1 , Length : 4 } ,
{ Offset : 2 , Length : 0 } ,
{ Offset : 2 , Length : 3 } ,
} ,
NegativeBuckets : [ ] int64 { 1 , 3 , - 2 , 5 , - 2 , 0 , - 3 } ,
} ,
2023-05-11 12:02:02 -07:00
} ,
2024-03-22 06:36:39 -07:00
"empty span in old and new custom buckets histogram" : {
h1 : & histogram . Histogram {
Schema : histogram . CustomBucketsSchema ,
Count : 7 ,
Sum : 1234.5 ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 4 } ,
{ Offset : 0 , Length : 0 } ,
{ Offset : 0 , Length : 3 } ,
} ,
PositiveBuckets : [ ] int64 { 1 , 1 , - 1 , 0 , 0 , 0 , 0 } ,
CustomValues : [ ] float64 { 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 } ,
} ,
h2 : & histogram . Histogram {
Schema : histogram . CustomBucketsSchema ,
Count : 10 ,
Sum : 2345.6 ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 4 } ,
{ Offset : 0 , Length : 0 } ,
{ Offset : 0 , Length : 3 } ,
} ,
PositiveBuckets : [ ] int64 { 1 , 2 , - 2 , 1 , - 1 , 0 , 0 } ,
CustomValues : [ ] float64 { 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 } ,
} ,
} ,
2023-05-11 12:02:02 -07:00
}
2023-09-13 03:59:42 -07:00
for name , tc := range tests {
t . Run ( name , func ( t * testing . T ) {
c := Chunk ( NewHistogramChunk ( ) )
2023-05-11 12:02:02 -07:00
2023-09-13 03:59:42 -07:00
// Create fresh appender and add the first histogram.
app , err := c . Appender ( )
require . NoError ( t , err )
require . Equal ( t , 0 , c . NumSamples ( ) )
2023-05-11 12:02:02 -07:00
2023-09-13 03:59:42 -07:00
_ , _ , _ , err = app . AppendHistogram ( nil , 1 , tc . h1 , true )
require . NoError ( t , err )
require . Equal ( t , 1 , c . NumSamples ( ) )
hApp , _ := app . ( * HistogramAppender )
pI , nI , okToAppend , counterReset := hApp . appendable ( tc . h2 )
require . Empty ( t , pI )
require . Empty ( t , nI )
require . True ( t , okToAppend )
require . False ( t , counterReset )
} )
}
2023-05-11 12:02:02 -07:00
}
2022-10-11 10:23:51 -07:00
func TestAtFloatHistogram ( t * testing . T ) {
input := [ ] histogram . Histogram {
{
Schema : 0 ,
Count : 21 ,
Sum : 1234.5 ,
ZeroThreshold : 0.001 ,
ZeroCount : 4 ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 4 } ,
{ Offset : 0 , Length : 0 } ,
{ Offset : 0 , Length : 3 } ,
} ,
PositiveBuckets : [ ] int64 { 1 , 1 , - 1 , 0 , 0 , 0 , 0 } ,
NegativeSpans : [ ] histogram . Span {
{ Offset : 1 , Length : 4 } ,
{ Offset : 2 , Length : 0 } ,
{ Offset : 2 , Length : 3 } ,
} ,
NegativeBuckets : [ ] int64 { 1 , 1 , - 1 , 1 , 0 , 0 , 0 } ,
} ,
{
Schema : 0 ,
Count : 36 ,
Sum : 2345.6 ,
ZeroThreshold : 0.001 ,
ZeroCount : 5 ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 4 } ,
{ Offset : 0 , Length : 0 } ,
{ Offset : 0 , Length : 3 } ,
} ,
PositiveBuckets : [ ] int64 { 1 , 2 , - 2 , 1 , - 1 , 0 , 0 } ,
NegativeSpans : [ ] histogram . Span {
{ Offset : 1 , Length : 4 } ,
{ Offset : 2 , Length : 0 } ,
{ Offset : 2 , Length : 3 } ,
} ,
NegativeBuckets : [ ] int64 { 1 , 3 , - 2 , 5 , - 2 , 0 , - 3 } ,
} ,
{
Schema : 0 ,
Count : 36 ,
Sum : 1111.1 ,
ZeroThreshold : 0.001 ,
ZeroCount : 5 ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 4 } ,
{ Offset : 0 , Length : 0 } ,
{ Offset : 0 , Length : 3 } ,
} ,
PositiveBuckets : [ ] int64 { 1 , 2 , - 2 , 2 , - 1 , 0 , 0 } ,
NegativeSpans : [ ] histogram . Span {
{ Offset : 1 , Length : 4 } ,
{ Offset : 2 , Length : 0 } ,
{ Offset : 2 , Length : 3 } ,
} ,
NegativeBuckets : [ ] int64 { 1 , 3 , - 2 , 5 , - 1 , 0 , - 3 } ,
} ,
}
expOutput := [ ] * histogram . FloatHistogram {
{
Schema : 0 ,
Count : 21 ,
Sum : 1234.5 ,
ZeroThreshold : 0.001 ,
ZeroCount : 4 ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 4 } ,
{ Offset : 0 , Length : 0 } ,
{ Offset : 0 , Length : 3 } ,
} ,
PositiveBuckets : [ ] float64 { 1 , 2 , 1 , 1 , 1 , 1 , 1 } ,
NegativeSpans : [ ] histogram . Span {
{ Offset : 1 , Length : 4 } ,
{ Offset : 2 , Length : 0 } ,
{ Offset : 2 , Length : 3 } ,
} ,
NegativeBuckets : [ ] float64 { 1 , 2 , 1 , 2 , 2 , 2 , 2 } ,
} ,
{
2023-01-18 08:59:29 -08:00
CounterResetHint : histogram . NotCounterReset ,
Schema : 0 ,
Count : 36 ,
Sum : 2345.6 ,
ZeroThreshold : 0.001 ,
ZeroCount : 5 ,
2022-10-11 10:23:51 -07:00
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 4 } ,
{ Offset : 0 , Length : 0 } ,
{ Offset : 0 , Length : 3 } ,
} ,
PositiveBuckets : [ ] float64 { 1 , 3 , 1 , 2 , 1 , 1 , 1 } ,
NegativeSpans : [ ] histogram . Span {
{ Offset : 1 , Length : 4 } ,
{ Offset : 2 , Length : 0 } ,
{ Offset : 2 , Length : 3 } ,
} ,
NegativeBuckets : [ ] float64 { 1 , 4 , 2 , 7 , 5 , 5 , 2 } ,
} ,
{
2023-01-18 08:59:29 -08:00
CounterResetHint : histogram . NotCounterReset ,
Schema : 0 ,
Count : 36 ,
Sum : 1111.1 ,
ZeroThreshold : 0.001 ,
ZeroCount : 5 ,
2022-10-11 10:23:51 -07:00
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 4 } ,
{ Offset : 0 , Length : 0 } ,
{ Offset : 0 , Length : 3 } ,
} ,
PositiveBuckets : [ ] float64 { 1 , 3 , 1 , 3 , 2 , 2 , 2 } ,
NegativeSpans : [ ] histogram . Span {
{ Offset : 1 , Length : 4 } ,
{ Offset : 2 , Length : 0 } ,
{ Offset : 2 , Length : 3 } ,
} ,
NegativeBuckets : [ ] float64 { 1 , 4 , 2 , 7 , 6 , 6 , 3 } ,
} ,
}
chk := NewHistogramChunk ( )
app , err := chk . Appender ( )
require . NoError ( t , err )
for i := range input {
2023-07-26 06:08:16 -07:00
newc , _ , _ , err := app . AppendHistogram ( nil , int64 ( i ) , & input [ i ] , false )
require . NoError ( t , err )
require . Nil ( t , newc )
2022-10-11 10:23:51 -07:00
}
it := chk . Iterator ( nil )
i := int64 ( 0 )
for it . Next ( ) != ValNone {
2024-01-23 08:02:14 -08:00
ts , h := it . AtFloatHistogram ( nil )
2022-10-11 10:23:51 -07:00
require . Equal ( t , i , ts )
require . Equal ( t , expOutput [ i ] , h , "histogram %d unequal" , i )
i ++
}
}
2023-01-10 15:49:13 -08:00
func TestHistogramChunkAppendableGauge ( t * testing . T ) {
2024-03-22 06:36:39 -07:00
eh := & histogram . Histogram {
CounterResetHint : histogram . GaugeType ,
Count : 5 ,
ZeroCount : 2 ,
Sum : 18.4 ,
ZeroThreshold : 1e-125 ,
Schema : 1 ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 2 } ,
{ Offset : 2 , Length : 1 } ,
{ Offset : 3 , Length : 2 } ,
{ Offset : 3 , Length : 1 } ,
{ Offset : 1 , Length : 1 } ,
} ,
PositiveBuckets : [ ] int64 { 6 , - 3 , 0 , - 1 , 2 , 1 , - 4 } , // {6, 3, 3, 2, 4, 5, 1}
}
cbh := & histogram . Histogram {
CounterResetHint : histogram . GaugeType ,
Count : 24 ,
Sum : 18.4 ,
Schema : histogram . CustomBucketsSchema ,
PositiveSpans : [ ] histogram . Span {
{ Offset : 0 , Length : 2 } ,
{ Offset : 2 , Length : 1 } ,
{ Offset : 3 , Length : 2 } ,
{ Offset : 3 , Length : 1 } ,
{ Offset : 1 , Length : 1 } ,
} ,
PositiveBuckets : [ ] int64 { 6 , - 3 , 0 , - 1 , 2 , 1 , - 4 } , // {6, 3, 3, 2, 4, 5, 1}
CustomValues : [ ] float64 { 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 , 13 , 14 , 15 , 16 , 17 , 18 , 19 , 20 } ,
}
setup := func ( h * histogram . Histogram ) ( Chunk , * HistogramAppender , int64 , * histogram . Histogram ) {
2023-07-26 06:08:16 -07:00
c := Chunk ( NewHistogramChunk ( ) )
// Create fresh appender and add the first histogram.
app , err := c . Appender ( )
require . NoError ( t , err )
require . Equal ( t , 0 , c . NumSamples ( ) )
ts := int64 ( 1234567890 )
2023-01-10 15:49:13 -08:00
2024-03-22 06:36:39 -07:00
chk , _ , app , err := app . AppendHistogram ( nil , ts , h . Copy ( ) , false )
2023-07-26 06:08:16 -07:00
require . NoError ( t , err )
require . Nil ( t , chk )
require . Equal ( t , 1 , c . NumSamples ( ) )
require . Equal ( t , GaugeType , c . ( * HistogramChunk ) . GetCounterResetHeader ( ) )
2023-01-10 15:49:13 -08:00
2024-03-22 06:36:39 -07:00
return c , app . ( * HistogramAppender ) , ts , h
2023-01-10 15:49:13 -08:00
}
{ // Schema change.
2024-03-22 06:36:39 -07:00
c , hApp , ts , h1 := setup ( eh )
2023-01-10 15:49:13 -08:00
h2 := h1 . Copy ( )
h2 . Schema ++
2023-07-26 06:08:16 -07:00
_ , _ , _ , _ , _ , _ , ok := hApp . appendableGauge ( h2 )
2023-01-10 15:49:13 -08:00
require . False ( t , ok )
2023-07-26 06:08:16 -07:00
2024-03-22 06:36:39 -07:00
assertNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , GaugeType )
2023-01-10 15:49:13 -08:00
}
{ // Zero threshold change.
2024-03-22 06:36:39 -07:00
c , hApp , ts , h1 := setup ( eh )
2023-01-10 15:49:13 -08:00
h2 := h1 . Copy ( )
h2 . ZeroThreshold += 0.1
2023-07-26 06:08:16 -07:00
_ , _ , _ , _ , _ , _ , ok := hApp . appendableGauge ( h2 )
2023-01-10 15:49:13 -08:00
require . False ( t , ok )
2023-07-26 06:08:16 -07:00
2024-03-22 06:36:39 -07:00
assertNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , GaugeType )
2023-01-10 15:49:13 -08:00
}
{ // New histogram that has more buckets.
2024-03-22 06:36:39 -07:00
c , hApp , ts , h1 := setup ( eh )
2023-01-10 15:49:13 -08:00
h2 := h1 . Copy ( )
h2 . PositiveSpans = [ ] histogram . Span {
{ Offset : 0 , Length : 3 } ,
{ Offset : 1 , Length : 1 } ,
{ Offset : 1 , Length : 4 } ,
{ Offset : 3 , Length : 3 } ,
}
h2 . Count += 9
h2 . ZeroCount ++
h2 . Sum = 30
h2 . PositiveBuckets = [ ] int64 { 7 , - 2 , - 4 , 2 , - 2 , - 1 , 2 , 3 , 0 , - 5 , 1 } // {7, 5, 1, 3, 1, 0, 2, 5, 5, 0, 1}
2023-07-26 06:08:16 -07:00
pI , nI , pBackwardI , nBackwardI , _ , _ , ok := hApp . appendableGauge ( h2 )
2023-12-07 03:35:01 -08:00
require . NotEmpty ( t , pI )
require . Empty ( t , nI )
require . Empty ( t , pBackwardI )
require . Empty ( t , nBackwardI )
2023-01-10 15:49:13 -08:00
require . True ( t , ok )
2023-07-26 06:08:16 -07:00
2024-03-22 06:36:39 -07:00
assertRecodedHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , GaugeType )
2023-01-10 15:49:13 -08:00
}
{ // New histogram that has buckets missing.
2024-03-22 06:36:39 -07:00
c , hApp , ts , h1 := setup ( eh )
2023-01-10 15:49:13 -08:00
h2 := h1 . Copy ( )
h2 . PositiveSpans = [ ] histogram . Span {
{ Offset : 0 , Length : 2 } ,
{ Offset : 2 , Length : 1 } ,
{ Offset : 3 , Length : 1 } ,
{ Offset : 4 , Length : 1 } ,
{ Offset : 1 , Length : 1 } ,
}
h2 . Count -= 4
h2 . Sum --
h2 . PositiveBuckets = [ ] int64 { 6 , - 3 , 0 , - 1 , 3 , - 4 } // {6, 3, 3, 2, 5, 1}
2023-07-26 06:08:16 -07:00
pI , nI , pBackwardI , nBackwardI , _ , _ , ok := hApp . appendableGauge ( h2 )
2023-12-07 03:35:01 -08:00
require . Empty ( t , pI )
require . Empty ( t , nI )
require . NotEmpty ( t , pBackwardI )
require . Empty ( t , nBackwardI )
2023-01-10 15:49:13 -08:00
require . True ( t , ok )
2023-07-26 06:08:16 -07:00
2024-03-22 06:36:39 -07:00
assertNoNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , GaugeType )
2023-01-10 15:49:13 -08:00
}
{ // New histogram that has a bucket missing and new buckets.
2024-03-22 06:36:39 -07:00
c , hApp , ts , h1 := setup ( eh )
2023-01-10 15:49:13 -08:00
h2 := h1 . Copy ( )
h2 . PositiveSpans = [ ] histogram . Span {
{ Offset : 0 , Length : 2 } ,
{ Offset : 5 , Length : 2 } ,
{ Offset : 3 , Length : 1 } ,
{ Offset : 1 , Length : 1 } ,
}
h2 . Sum = 21
h2 . PositiveBuckets = [ ] int64 { 6 , - 3 , - 1 , 2 , 1 , - 4 } // {6, 3, 2, 4, 5, 1}
2023-07-26 06:08:16 -07:00
pI , nI , pBackwardI , nBackwardI , _ , _ , ok := hApp . appendableGauge ( h2 )
2023-12-07 03:35:01 -08:00
require . NotEmpty ( t , pI )
require . NotEmpty ( t , pBackwardI )
require . Empty ( t , nI )
require . Empty ( t , nBackwardI )
2023-01-10 15:49:13 -08:00
require . True ( t , ok )
2023-07-26 06:08:16 -07:00
2024-03-22 06:36:39 -07:00
assertRecodedHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , GaugeType )
2023-01-10 15:49:13 -08:00
}
{ // New histogram that has a counter reset while buckets are same.
2024-03-22 06:36:39 -07:00
c , hApp , ts , h1 := setup ( eh )
2023-01-10 15:49:13 -08:00
h2 := h1 . Copy ( )
h2 . Sum = 23
h2 . PositiveBuckets = [ ] int64 { 6 , - 4 , 1 , - 1 , 2 , 1 , - 4 } // {6, 2, 3, 2, 4, 5, 1}
2023-07-26 06:08:16 -07:00
pI , nI , pBackwardI , nBackwardI , _ , _ , ok := hApp . appendableGauge ( h2 )
2023-12-07 03:35:01 -08:00
require . Empty ( t , pI )
require . Empty ( t , nI )
require . Empty ( t , pBackwardI )
require . Empty ( t , nBackwardI )
2023-01-10 15:49:13 -08:00
require . True ( t , ok )
2023-07-26 06:08:16 -07:00
2024-03-22 06:36:39 -07:00
assertNoNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , GaugeType )
2023-01-10 15:49:13 -08:00
}
{ // New histogram that has a counter reset while new buckets were added.
2024-03-22 06:36:39 -07:00
c , hApp , ts , h1 := setup ( eh )
2023-01-10 15:49:13 -08:00
h2 := h1 . Copy ( )
h2 . PositiveSpans = [ ] histogram . Span {
{ Offset : 0 , Length : 3 } ,
{ Offset : 1 , Length : 1 } ,
{ Offset : 1 , Length : 4 } ,
{ Offset : 3 , Length : 3 } ,
}
h2 . Sum = 29
h2 . PositiveBuckets = [ ] int64 { 7 , - 2 , - 4 , 2 , - 2 , - 1 , 2 , 3 , 0 , - 5 , 0 } // {7, 5, 1, 3, 1, 0, 2, 5, 5, 0, 0}
2023-07-26 06:08:16 -07:00
pI , nI , pBackwardI , nBackwardI , _ , _ , ok := hApp . appendableGauge ( h2 )
2023-12-07 03:35:01 -08:00
require . NotEmpty ( t , pI )
require . Empty ( t , nI )
require . Empty ( t , pBackwardI )
require . Empty ( t , nBackwardI )
2023-01-10 15:49:13 -08:00
require . True ( t , ok )
2023-07-26 06:08:16 -07:00
2024-03-22 06:36:39 -07:00
assertRecodedHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , GaugeType )
2023-01-10 15:49:13 -08:00
}
{
// New histogram that has a counter reset while new buckets were
// added before the first bucket and reset on first bucket.
2024-03-22 06:36:39 -07:00
c , hApp , ts , h1 := setup ( eh )
2023-01-10 15:49:13 -08:00
h2 := h1 . Copy ( )
h2 . PositiveSpans = [ ] histogram . Span {
{ Offset : - 3 , Length : 2 } ,
{ Offset : 1 , Length : 2 } ,
{ Offset : 2 , Length : 1 } ,
{ Offset : 3 , Length : 2 } ,
{ Offset : 3 , Length : 1 } ,
{ Offset : 1 , Length : 1 } ,
}
h2 . Sum = 26
h2 . PositiveBuckets = [ ] int64 { 1 , 1 , 3 , - 2 , 0 , - 1 , 2 , 1 , - 4 } // {1, 2, 5, 3, 3, 2, 4, 5, 1}
2023-07-26 06:08:16 -07:00
pI , nI , pBackwardI , nBackwardI , _ , _ , ok := hApp . appendableGauge ( h2 )
2023-12-07 03:35:01 -08:00
require . NotEmpty ( t , pI )
require . Empty ( t , nI )
require . Empty ( t , pBackwardI )
require . Empty ( t , nBackwardI )
2023-01-10 15:49:13 -08:00
require . True ( t , ok )
2023-07-26 06:08:16 -07:00
2024-03-22 06:36:39 -07:00
assertRecodedHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , GaugeType )
}
{ // Custom buckets, no change.
c , hApp , ts , h1 := setup ( cbh )
h2 := h1 . Copy ( )
_ , _ , _ , _ , _ , _ , ok := hApp . appendableGauge ( h2 )
require . True ( t , ok )
assertNoNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , GaugeType )
}
{ // Custom buckets, increase in bucket counts but no change in layout.
c , hApp , ts , h1 := setup ( cbh )
h2 := h1 . Copy ( )
h2 . Count ++
h2 . PositiveBuckets = [ ] int64 { 6 , - 3 , 0 , - 1 , 2 , 1 , - 3 }
_ , _ , _ , _ , _ , _ , ok := hApp . appendableGauge ( h2 )
require . True ( t , ok )
assertNoNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , GaugeType )
}
{ // Custom buckets, decrease in bucket counts but no change in layout.
c , hApp , ts , h1 := setup ( cbh )
h2 := h1 . Copy ( )
h2 . Count --
h2 . PositiveBuckets = [ ] int64 { 6 , - 3 , 0 , - 1 , 2 , 1 , - 5 }
_ , _ , _ , _ , _ , _ , ok := hApp . appendableGauge ( h2 )
require . True ( t , ok )
assertNoNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , GaugeType )
}
{ // Custom buckets, change only in custom bounds.
c , hApp , ts , h1 := setup ( cbh )
h2 := h1 . Copy ( )
h2 . CustomValues = [ ] float64 { 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 , 13 , 14 , 15 , 16 , 17 , 18 , 19 , 20 , 21 }
_ , _ , _ , _ , _ , _ , ok := hApp . appendableGauge ( h2 )
require . False ( t , ok )
assertNewHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , GaugeType )
}
{ // Custom buckets, with more buckets.
c , hApp , ts , h1 := setup ( cbh )
h2 := h1 . Copy ( )
h2 . PositiveSpans = [ ] histogram . Span {
{ Offset : 0 , Length : 3 } ,
{ Offset : 1 , Length : 1 } ,
{ Offset : 1 , Length : 4 } ,
{ Offset : 3 , Length : 3 } ,
}
h2 . Count += 6
h2 . Sum = 30
// Existing histogram should get values converted from the above to:
// 6 3 0 3 0 0 2 4 5 0 1 (previous values with some new empty buckets in between)
// so the new histogram should have new counts >= these per-bucket counts, e.g.:
h2 . PositiveBuckets = [ ] int64 { 7 , - 2 , - 4 , 2 , - 2 , - 1 , 2 , 3 , 0 , - 5 , 1 } // 7 5 1 3 1 0 2 5 5 0 1 (total 30)
posInterjections , negInterjections , pBackwardI , nBackwardI , _ , _ , ok := hApp . appendableGauge ( h2 )
require . NotEmpty ( t , posInterjections )
require . Empty ( t , negInterjections )
require . Empty ( t , pBackwardI )
require . Empty ( t , nBackwardI )
require . True ( t , ok ) // Only new buckets came in.
assertRecodedHistogramChunkOnAppend ( t , c , hApp , ts + 1 , h2 , GaugeType )
2023-01-10 15:49:13 -08:00
}
}
2023-11-29 02:39:12 -08:00
func TestHistogramAppendOnlyErrors ( t * testing . T ) {
t . Run ( "schema change error" , func ( t * testing . T ) {
c := Chunk ( NewHistogramChunk ( ) )
// Create fresh appender and add the first histogram.
app , err := c . Appender ( )
require . NoError ( t , err )
h := tsdbutil . GenerateTestHistogram ( 0 )
var isRecoded bool
c , isRecoded , app , err = app . AppendHistogram ( nil , 1 , h , true )
require . Nil ( t , c )
require . False ( t , isRecoded )
require . NoError ( t , err )
// Add erroring histogram.
h2 := h . Copy ( )
h2 . Schema ++
c , isRecoded , _ , err = app . AppendHistogram ( nil , 2 , h2 , true )
require . Nil ( t , c )
require . False ( t , isRecoded )
require . EqualError ( t , err , "histogram schema change" )
} )
t . Run ( "counter reset error" , func ( t * testing . T ) {
c := Chunk ( NewHistogramChunk ( ) )
// Create fresh appender and add the first histogram.
app , err := c . Appender ( )
require . NoError ( t , err )
h := tsdbutil . GenerateTestHistogram ( 0 )
var isRecoded bool
c , isRecoded , app , err = app . AppendHistogram ( nil , 1 , h , true )
require . Nil ( t , c )
require . False ( t , isRecoded )
require . NoError ( t , err )
// Add erroring histogram.
h2 := h . Copy ( )
h2 . CounterResetHint = histogram . CounterReset
c , isRecoded , _ , err = app . AppendHistogram ( nil , 2 , h2 , true )
require . Nil ( t , c )
require . False ( t , isRecoded )
require . EqualError ( t , err , "histogram counter reset" )
} )
2024-03-22 06:36:39 -07:00
t . Run ( "counter reset error with custom buckets" , func ( t * testing . T ) {
c := Chunk ( NewHistogramChunk ( ) )
// Create fresh appender and add the first histogram.
app , err := c . Appender ( )
require . NoError ( t , err )
h := tsdbutil . GenerateTestCustomBucketsHistogram ( 0 )
var isRecoded bool
c , isRecoded , app , err = app . AppendHistogram ( nil , 1 , h , true )
require . Nil ( t , c )
require . False ( t , isRecoded )
require . NoError ( t , err )
// Add erroring histogram.
h2 := h . Copy ( )
h2 . CustomValues = [ ] float64 { 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 }
c , isRecoded , _ , err = app . AppendHistogram ( nil , 2 , h2 , true )
require . Nil ( t , c )
require . False ( t , isRecoded )
require . EqualError ( t , err , "histogram counter reset" )
} )
2023-11-29 02:39:12 -08:00
}