Add query format to native histograms flag description

Followup to #4513

Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>

cmd/mimir/config-descriptor.json

@@ -3056,7 +3056,7 @@
           "kind": "field",
           "name": "native_histograms_ingestion_enabled",
           "required": false,
-          "desc": "Enable ingestion of native histogram samples. If false, native histogram samples are ignored without an error.",
+          "desc": "Enable ingestion of native histogram samples. If true, -query-frontend.query-result-response-format must be set to 'protobuf' otherwise query sharding will fail. If false, native histogram samples are ignored without an error.",
           "fieldValue": null,
           "fieldDefaultValue": false,
           "fieldFlag": "ingester.native-histograms-ingestion-enabled",

cmd/mimir/help-all.txt.tmpl

@@ -1186,7 +1186,7 @@ Usage of ./cmd/mimir/mimir:
   -ingester.metadata-retain-period duration
     	Period at which metadata we have not seen will remain in memory before being deleted. (default 10m0s)
   -ingester.native-histograms-ingestion-enabled
-    	[experimental] Enable ingestion of native histogram samples. If false, native histogram samples are ignored without an error.
+    	[experimental] Enable ingestion of native histogram samples. If true, -query-frontend.query-result-response-format must be set to 'protobuf' otherwise query sharding will fail. If false, native histogram samples are ignored without an error.
   -ingester.out-of-order-blocks-external-label-enabled
     	[experimental] Whether the shipper should label out-of-order blocks with an external label before uploading them. Setting this label will compact out-of-order blocks separately from non-out-of-order blocks
   -ingester.out-of-order-time-window duration

docs/sources/mimir/references/configuration-parameters/index.md

@@ -2590,8 +2590,10 @@ The `limits` block configures default and per-tenant limits imposed by component
 # CLI flag: -ingester.max-global-exemplars-per-user
 [max_global_exemplars_per_user: <int> | default = 0]
 
-# (experimental) Enable ingestion of native histogram samples. If false, native
-# histogram samples are ignored without an error.
+# (experimental) Enable ingestion of native histogram samples. If true,
+# -query-frontend.query-result-response-format must be set to 'protobuf'
+# otherwise query sharding will fail. If false, native histogram samples are
+# ignored without an error.
 # CLI flag: -ingester.native-histograms-ingestion-enabled
 [native_histograms_ingestion_enabled: <boolean> | default = false]
 

pkg/util/validation/limits.go

@@ -209,7 +209,7 @@ func (l *Limits) RegisterFlags(f *flag.FlagSet) {
 	f.IntVar(&l.MaxGlobalExemplarsPerUser, "ingester.max-global-exemplars-per-user", 0, "The maximum number of exemplars in memory, across the cluster. 0 to disable exemplars ingestion.")
 	f.Var(&l.ActiveSeriesCustomTrackersConfig, "ingester.active-series-custom-trackers", "Additional active series metrics, matching the provided matchers. Matchers should be in form <name>:<matcher>, like 'foobar:{foo=\"bar\"}'. Multiple matchers can be provided either providing the flag multiple times or providing multiple semicolon-separated values to a single flag.")
 	f.Var(&l.OutOfOrderTimeWindow, "ingester.out-of-order-time-window", fmt.Sprintf("Non-zero value enables out-of-order support for most recent samples that are within the time window in relation to the TSDB's maximum time, i.e., within [db.maxTime-timeWindow, db.maxTime]). The ingester will need more memory as a factor of rate of out-of-order samples being ingested and the number of series that are getting out-of-order samples. If query falls into this window, cached results will use value from -%s option to specify TTL for resulting cache entry.", resultsCacheTTLForOutOfOrderWindowFlag))
-	f.BoolVar(&l.NativeHistogramsIngestionEnabled, "ingester.native-histograms-ingestion-enabled", false, "Enable ingestion of native histogram samples. If false, native histogram samples are ignored without an error.")
+	f.BoolVar(&l.NativeHistogramsIngestionEnabled, "ingester.native-histograms-ingestion-enabled", false, "Enable ingestion of native histogram samples. If true, -query-frontend.query-result-response-format must be set to 'protobuf' otherwise query sharding will fail. If false, native histogram samples are ignored without an error.")
 	f.BoolVar(&l.OutOfOrderBlocksExternalLabelEnabled, "ingester.out-of-order-blocks-external-label-enabled", false, "Whether the shipper should label out-of-order blocks with an external label before uploading them. Setting this label will compact out-of-order blocks separately from non-out-of-order blocks")
 
 	f.StringVar(&l.SeparateMetricsGroupLabel, "validation.separate-metrics-group-label", "", "Label used to define the group label for metrics separation. For each write request, the group is obtained from the first non-empty group label from the first timeseries in the incoming list of timeseries. Specific distributor and ingester metrics will be further separated adding a 'group' label with group label's value. Currently applies to the following metrics: cortex_discarded_samples_total")