Enable setting default chunk encoding by config file (#2077)

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## master / unreleased
 
 * [CHANGE] Querier / ruler: deprecated `-store.query-chunk-limit` CLI flag (and its respective YAML config option `max_chunks_per_query`) in favour of `-querier.max-fetched-chunks-per-query` (and its respective YAML config option `max_fetched_chunks_per_query`). The new limit specifies the maximum number of chunks that can be fetched in a single query from ingesters and long-term storage: the total number of actual fetched chunks could be 2x the limit, being independently applied when querying ingesters and long-term storage. #4125
+* [ENHANCEMENT] Ingester: enable setting default chunk encoding by config file. #4086
 
 ## 1.9.0 in progress
 

development/tsdb-blocks-storage-s3-gossip/config/cortex.yaml

@@ -116,6 +116,9 @@ alertmanager_storage:
 storage:
   engine: blocks
 
+encoding:
+  chunk_encoding: BigChunk
+
 compactor:
   compaction_interval: 30s
   data_dir:            /tmp/cortex-compactor

development/tsdb-blocks-storage-s3-single-binary/config/cortex.yaml

@@ -60,6 +60,9 @@ blocks_storage:
 storage:
   engine: blocks
 
+encoding:
+  chunk_encoding: BigChunk
+
 ruler:
   enable_api: true
   enable_sharding: true

development/tsdb-blocks-storage-s3/config/cortex.yaml

@@ -114,6 +114,9 @@ alertmanager_storage:
 storage:
   engine: blocks
 
+encoding:
+  chunk_encoding: BigChunk
+
 compactor:
   compaction_interval: 30s
   data_dir:            /tmp/cortex-compactor

development/tsdb-blocks-storage-swift-single-binary/config/cortex.yaml

@@ -61,6 +61,9 @@ blocks_storage:
 storage:
   engine: blocks
 
+encoding:
+  chunk_encoding: BigChunk
+
 ruler:
   enable_api: true
   enable_sharding: true

docs/configuration/config-file-reference.md

@@ -130,6 +130,11 @@ api:
 # The table_manager_config configures the Cortex table-manager.
 [table_manager: <table_manager_config>]
 
+encoding:
+  # Encoding version to use for chunks.
+  # CLI flag: -encoding.chunk-encoding
+  [chunk_encoding: <string> | default = "BigChunk"]
+
 # The blocks_storage_config configures the blocks storage.
 [blocks_storage: <blocks_storage_config>]
 

pkg/chunk/encoding/factory.go

@@ -11,7 +11,9 @@ import (
 type Encoding byte
 
 // Config configures the behaviour of chunk encoding
-type Config struct{}
+type Config struct {
+	EncodingName string `yaml:"chunk_encoding"`
+}
 
 var (
 	// DefaultEncoding exported for use in unit tests elsewhere
@@ -20,8 +22,8 @@ var (
 )
 
 // RegisterFlags registers configuration settings.
-func (Config) RegisterFlags(f *flag.FlagSet) {
-	f.Var(&DefaultEncoding, "ingester.chunk-encoding", "Encoding version to use for chunks.")
+func (cfg *Config) RegisterFlags(f *flag.FlagSet) {
+	f.StringVar(&cfg.EncodingName, "encoding.chunk-encoding", "BigChunk", "Encoding version to use for chunks.")
 	f.IntVar(&bigchunkSizeCapBytes, "store.bigchunk-size-cap-bytes", bigchunkSizeCapBytes, "When using bigchunk encoding, start a new bigchunk if over this size (0 = unlimited)")
 }
 
@@ -75,7 +77,7 @@ var encodings = map[Encoding]encoding{
 		},
 	},
 	Bigchunk: {
-		Name: "Bigchunk",
+		Name: "BigChunk",
 		New: func() Chunk {
 			return newBigchunk()
 		},
@@ -90,7 +92,12 @@ var encodings = map[Encoding]encoding{
 
 // Set implements flag.Value.
 func (e *Encoding) Set(s string) error {
-	// First see if the name was given
+	// If nothing is provided, keep the original value
+	if s == "" {
+		return nil
+	}
+
+	// Then see if the name was given
 	for k, v := range encodings {
 		if s == v.Name {
 			*e = k

pkg/cortex/cortex.go

@@ -108,7 +108,7 @@ type Config struct {
 	Frontend         frontend.CombinedFrontendConfig `yaml:"frontend"`
 	QueryRange       queryrange.Config               `yaml:"query_range"`
 	TableManager     chunk.TableManagerConfig        `yaml:"table_manager"`
-	Encoding         encoding.Config                 `yaml:"-"` // No yaml for this, it only works with flags.
+	Encoding         encoding.Config                 `yaml:"encoding"`
 	BlocksStorage    tsdb.BlocksStorageConfig        `yaml:"blocks_storage"`
 	Compactor        compactor.Config                `yaml:"compactor"`
 	StoreGateway     storegateway.Config             `yaml:"store_gateway"`
@@ -355,6 +355,11 @@ func New(cfg Config) (*Cortex, error) {
 		Cfg: cfg,
 	}
 
+	// Set default chunk encoding
+	if err := encoding.DefaultEncoding.Set(cfg.Encoding.EncodingName); err != nil {
+		return nil, err
+	}
+
 	cortex.setupThanosTracing()
 
 	if err := cortex.setupModuleManager(); err != nil {