update docs

Signed-off-by: Ben Ye <[email protected]>
thanos-io · Jan 6, 2025 · 27c675e · 27c675e
1 parent 4cf5544
commit 27c675e
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,7 +21,7 @@ We use *breaking :warning:* to mark changes that are not backward compatible (re
 - [#7961](https://github.com/thanos-io/thanos/pull/7961) Store Gateway: Add `--store.posting-group-max-keys` flag to mark posting group as lazy if it exceeds number of keys limit. Added `thanos_bucket_store_lazy_expanded_posting_groups_total` for total number of lazy posting groups and corresponding reasons.
 - [#8000](https://github.com/thanos-io/thanos/pull/8000) Query: Bump promql-engine, pass partial response through options
 - [#7353](https://github.com/thanos-io/thanos/pull/7353) Receiver: introduce optional cache for matchers in series calls.
-- [#7957](https://github.com/thanos-io/thanos/pull/7957) Compact, Store Gateway: Compactor will set series p90, p99, p999 and p9999 size in `meta.json` file. Lazy expanded postings will choose estimated series size based on `estimated-series-size-stat` flag.
+- [#7957](https://github.com/thanos-io/thanos/pull/7957) Compact, Store Gateway: Compactor will set series p90, p99, p999, p9999, average size and standard deviation in `meta.json` file. Lazy expanded postings can choose estimated series size based on `estimated-series-size-stat` flag, available options are p90, p99, p999, p9999, max and zscore. If zscore option is picked, `estimated-series-size-stat-zscore` can be used to set the zscore value.
 
 ### Changed
 

diff --git a/docs/components/store.md b/docs/components/store.md
@@ -95,11 +95,22 @@ Flags:
       --enable-auto-gomemlimit   Enable go runtime to automatically limit memory
                                  consumption.
       --estimated-series-size-stat=max
-                                 Statistic to use to estimate block series size.
-                                 This is currently used for lazy expanded
-                                 posting series size estimation. Available
-                                 options are max, p90, p99, p999 and p9999.
-                                 Default value is max
+                                 Statistic to use to estimate block series
+                                 size. This is currently used for lazy
+                                 expanded posting series size estimation.
+                                 Available options are max, p90, p99, p99,
+                                 p9999 and zscore. If zscore is picked,
+                                 the actual zscore value is set via
+                                 estimated-series-size-stat-zscore. Default
+                                 value is max
+      --estimated-series-size-stat-zscore=2
+                                 Zscore is a statistical measurement that
+                                 describes a value's relationship to the mean
+                                 series size. Zscore 2 is calculated as average
+                                 size + 2 * standard deviation. Use a larger
+                                 zscore if you want a larger estimated series
+                                 size. Default value is 2. Cannot be lower than
+                                 0.
       --grpc-address="0.0.0.0:10901"
                                  Listen ip:port address for gRPC endpoints
                                  (StoreAPI). Make sure this address is routable

diff --git a/go.mod b/go.mod
@@ -5,6 +5,7 @@ go 1.23.0
 require (
 	capnproto.org/go/capnp/v3 v3.0.0-alpha.30
 	cloud.google.com/go/trace v1.10.12
+	github.com/DataDog/sketches-go v1.4.6
 	github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/trace v1.8.3
 	github.com/KimMachineGun/automemlimit v0.6.1
 	github.com/alecthomas/units v0.0.0-20240626203959-61d1e3462e30
@@ -18,7 +19,6 @@ require (
 	github.com/cortexproject/promqlsmith v0.0.0-20240506042652-6cfdd9739a5e
 	github.com/cristalhq/hedgedhttp v0.9.1
 	github.com/dustin/go-humanize v1.0.1
-	github.com/DataDog/sketches-go v1.4.6
 	github.com/efficientgo/core v1.0.0-rc.3
 	github.com/efficientgo/e2e v0.14.1-0.20230710114240-c316eb95ae5b
 	github.com/efficientgo/tools/extkingpin v0.0.0-20220817170617-6c25e3b627dd