Store: Document --chunk-pool-size better (#2057)

Signed-off-by: Xiang Dai <[email protected]>
thanos-io · Feb 6, 2020 · a79edc7 · a79edc7
1 parent 1b22a17
commit a79edc7
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/cmd/thanos/store.go b/cmd/thanos/store.go
@@ -50,7 +50,7 @@ func registerStore(m map[string]setupFunc, app *kingpin.Application) {
 		"YAML file that contains index cache configuration. See format details: https://thanos.io/components/store.md/#index-cache",
 		false)
 
-	chunkPoolSize := cmd.Flag("chunk-pool-size", "Maximum size of concurrently allocatable bytes for chunks.").
+	chunkPoolSize := cmd.Flag("chunk-pool-size", "Maximum size of concurrently allocatable bytes reserved strictly to reuse for chunks in memory.").
 		Default("2GB").Bytes()
 
 	maxSampleCount := cmd.Flag("store.grpc.series-sample-limit",

diff --git a/docs/components/store.md b/docs/components/store.md
@@ -83,7 +83,8 @@ Flags:
                                  details:
                                  https://thanos.io/components/store.md/#index-cache
       --chunk-pool-size=2GB      Maximum size of concurrently allocatable bytes
-                                 for chunks.
+                                 reserved strictly to reuse for chunks in
+                                 memory.
       --store.grpc.series-sample-limit=0
                                  Maximum amount of samples returned via a single
                                  Series call. 0 means no limit. NOTE: For