hide flag from docs

Signed-off-by: Jesus Vazquez <[email protected]>
grafana · Jan 2, 2025 · 2f556e2 · 2f556e2
1 parent 2036175
commit 2f556e2
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 21 deletions.
diff --git a/cmd/mimir/config-descriptor.json b/cmd/mimir/config-descriptor.json
@@ -1690,17 +1690,6 @@
           "fieldFlag": "distributor.reusable-ingester-push-workers",
           "fieldType": "int",
           "fieldCategory": "advanced"
-        },
-        {
-          "kind": "field",
-          "name": "start_time_quiet_zero",
-          "required": false,
-          "desc": "Change the implementation of Otel startTime from a real zero to a special NaN value.",
-          "fieldValue": null,
-          "fieldDefaultValue": false,
-          "fieldFlag": "distributor.otel-start-time-quiet-zero",
-          "fieldType": "boolean",
-          "fieldCategory": "advanced"
         }
       ],
       "fieldValue": null,

diff --git a/cmd/mimir/help-all.txt.tmpl b/cmd/mimir/help-all.txt.tmpl
@@ -1393,8 +1393,6 @@ Usage of ./cmd/mimir/mimir:
     	Whether to enable automatic suffixes to names of metrics ingested through OTLP.
   -distributor.otel-promote-resource-attributes comma-separated-list-of-strings
     	[experimental] Optionally specify OTel resource attributes to promote to labels.
-  -distributor.otel-start-time-quiet-zero
-    	Change the implementation of Otel startTime from a real zero to a special NaN value.
   -distributor.remote-timeout duration
     	Timeout for downstream ingesters. (default 2s)
   -distributor.request-burst-size int

diff --git a/docs/sources/mimir/configure/configuration-parameters/index.md b/docs/sources/mimir/configure/configuration-parameters/index.md
@@ -956,11 +956,6 @@ instance_limits:
 # limiting feature.)
 # CLI flag: -distributor.reusable-ingester-push-workers
 [reusable_ingester_push_workers: <int> | default = 2000]
-
-# (advanced) Change the implementation of Otel startTime from a real zero to a
-# special NaN value.
-# CLI flag: -distributor.otel-start-time-quiet-zero
-[start_time_quiet_zero: <boolean> | default = false]
 ```
 
 ### ingester

diff --git a/pkg/distributor/distributor.go b/pkg/distributor/distributor.go
@@ -250,8 +250,8 @@ type Config struct {
 	// OTelResourceAttributePromotionConfig allows for specializing OTel resource attribute promotion.
 	OTelResourceAttributePromotionConfig OTelResourceAttributePromotionConfig `yaml:"-"`
 
-	// Change the implementation of Otel startTime from a real zero to a special NaN value.
-	EnableStartTimeQuietZero bool `yaml:"start_time_quiet_zero" category:"advanced"`
+	// Change the implementation of OTel startTime from a real zero to a special NaN value.
+	EnableStartTimeQuietZero bool `yaml:"start_time_quiet_zero" category:"advanced" doc:"hidden"`
 }
 
 // PushWrapper wraps around a push. It is similar to middleware.Interface.
@@ -270,7 +270,7 @@ func (cfg *Config) RegisterFlags(f *flag.FlagSet, logger log.Logger) {
 	f.DurationVar(&cfg.RemoteTimeout, "distributor.remote-timeout", 2*time.Second, "Timeout for downstream ingesters.")
 	f.BoolVar(&cfg.WriteRequestsBufferPoolingEnabled, "distributor.write-requests-buffer-pooling-enabled", true, "Enable pooling of buffers used for marshaling write requests.")
 	f.IntVar(&cfg.ReusableIngesterPushWorkers, "distributor.reusable-ingester-push-workers", 2000, "Number of pre-allocated workers used to forward push requests to the ingesters. If 0, no workers will be used and a new goroutine will be spawned for each ingester push request. If not enough workers available, new goroutine will be spawned. (Note: this is a performance optimization, not a limiting feature.)")
-	f.BoolVar(&cfg.EnableStartTimeQuietZero, "distributor.otel-start-time-quiet-zero", false, "Change the implementation of Otel startTime from a real zero to a special NaN value.")
+	f.BoolVar(&cfg.EnableStartTimeQuietZero, "distributor.otel-start-time-quiet-zero", false, "Change the implementation of OTel startTime from a real zero to a special NaN value.")
 
 	cfg.DefaultLimits.RegisterFlags(f)
 }