Change distributor.remote-write2-enabled naming

Signed-off-by: SungJin1212 <[email protected]>

Author: SungJin1212

docs/configuration/config-file-reference.md

@@ -3142,7 +3142,7 @@ ha_tracker:
 
 # EXPERIMENTAL: If true, accept prometheus remote write v2 protocol push
 # request.
-# CLI flag: -distributor.remote-write2-enabled
+# CLI flag: -distributor.remote-writev2-enabled
 [remote_write2_enabled: <boolean> | default = false]
 
 ring:

docs/configuration/v1-guarantees.md

@@ -59,7 +59,7 @@ Currently experimental features are:
 - Distributor:
   - Do not extend writes on unhealthy ingesters (`-distributor.extend-writes=false`)
   - Accept multiple HA pairs in the same request (enabled via `-experimental.distributor.ha-tracker.mixed-ha-samples=true`)
-  - Accept Prometheus remote write 2.0 request (`-distributor.remote-write2-enabled=true`)
+  - Accept Prometheus remote write 2.0 request (`-distributor.remote-writev2-enabled=true`)
 - Tenant Deletion in Purger, for blocks storage.
 - Query-frontend: query stats tracking (`-frontend.query-stats-enabled`)
 - Blocks storage bucket index

integration/remote_write_v2_test.go

@@ -25,7 +25,7 @@ import (
 )
 
 func TestIngesterRollingUpdate(t *testing.T) {
-	// Test ingester rolling update situation: when -distributor.remote-write2-enabled is true, and ingester uses the v1.19.0 image.
+	// Test ingester rolling update situation: when -distributor.remote-writev2-enabled is true, and ingester uses the v1.19.0 image.
 	// Expected: remote write 2.0 push success
 	const blockRangePeriod = 5 * time.Second
 	ingesterImage := "quay.io/cortexproject/cortex:v1.19.0"
@@ -65,7 +65,7 @@ func TestIngesterRollingUpdate(t *testing.T) {
 	)
 
 	distributorFlag := mergeFlags(flags, map[string]string{
-		"-distributor.remote-write2-enabled": "true",
+		"-distributor.remote-writev2-enabled": "true",
 	})
 
 	// make alert manager config dir
@@ -139,7 +139,7 @@ func TestIngesterRollingUpdate(t *testing.T) {
 }
 
 func TestIngest_SenderSendPRW2_DistributorNotAllowPRW2(t *testing.T) {
-	// Test `-distributor.remote-write2-enabled=false` but the Sender pushes PRW2
+	// Test `-distributor.remote-writev2-enabled=false` but the Sender pushes PRW2
 	// Expected: status code is 200, but samples are not written.
 	const blockRangePeriod = 5 * time.Second
 
@@ -169,8 +169,8 @@ func TestIngest_SenderSendPRW2_DistributorNotAllowPRW2(t *testing.T) {
 			"-ring.store":      "consul",
 			"-consul.hostname": consul.NetworkHTTPEndpoint(),
 			// Distributor.
-			"-distributor.replication-factor":    "1",
-			"-distributor.remote-write2-enabled": "false",
+			"-distributor.replication-factor":     "1",
+			"-distributor.remote-writev2-enabled": "false",
 			// Store-gateway.
 			"-store-gateway.sharding-enabled": "false",
 			// alert manager
@@ -237,8 +237,8 @@ func TestIngest(t *testing.T) {
 			"-ring.store":      "consul",
 			"-consul.hostname": consul.NetworkHTTPEndpoint(),
 			// Distributor.
-			"-distributor.replication-factor":    "1",
-			"-distributor.remote-write2-enabled": "true",
+			"-distributor.replication-factor":     "1",
+			"-distributor.remote-writev2-enabled": "true",
 			// Store-gateway.
 			"-store-gateway.sharding-enabled": "false",
 			// alert manager
@@ -336,8 +336,8 @@ func TestExemplar(t *testing.T) {
 			"-consul.hostname":        consul.NetworkHTTPEndpoint(),
 			"-ingester.max-exemplars": "100",
 			// Distributor.
-			"-distributor.replication-factor":    "1",
-			"-distributor.remote-write2-enabled": "true",
+			"-distributor.replication-factor":     "1",
+			"-distributor.remote-writev2-enabled": "true",
 			// Store-gateway.
 			"-store-gateway.sharding-enabled": "false",
 			// alert manager
@@ -420,8 +420,8 @@ func Test_WriteStatWithReplication(t *testing.T) {
 			"-consul.hostname":        consul.NetworkHTTPEndpoint(),
 			"-ingester.max-exemplars": "100",
 			// Distributor.
-			"-distributor.replication-factor":    "3",
-			"-distributor.remote-write2-enabled": "true",
+			"-distributor.replication-factor":     "3",
+			"-distributor.remote-writev2-enabled": "true",
 			// Store-gateway.
 			"-store-gateway.sharding-enabled": "false",
 			// alert manager

pkg/distributor/distributor.go

@@ -215,7 +215,7 @@ func (cfg *Config) RegisterFlags(f *flag.FlagSet) {
 	f.BoolVar(&cfg.ExtendWrites, "distributor.extend-writes", true, "Try writing to an additional ingester in the presence of an ingester not in the ACTIVE state. It is useful to disable this along with -ingester.unregister-on-shutdown=false in order to not spread samples to extra ingesters during rolling restarts with consistent naming.")
 	f.BoolVar(&cfg.ZoneResultsQuorumMetadata, "distributor.zone-results-quorum-metadata", false, "Experimental, this flag may change in the future. If zone awareness and this both enabled, when querying metadata APIs (labels names and values for now), only results from quorum number of zones will be included.")
 	f.IntVar(&cfg.NumPushWorkers, "distributor.num-push-workers", 0, "EXPERIMENTAL: Number of go routines to handle push calls from distributors to ingesters. When no workers are available, a new goroutine will be spawned automatically. If set to 0 (default), workers are disabled, and a new goroutine will be created for each push request.")
-	f.BoolVar(&cfg.RemoteWrite2Enabled, "distributor.remote-write2-enabled", false, "EXPERIMENTAL: If true, accept prometheus remote write v2 protocol push request.")
+	f.BoolVar(&cfg.RemoteWrite2Enabled, "distributor.remote-writev2-enabled", false, "EXPERIMENTAL: If true, accept prometheus remote write v2 protocol push request.")
 
 	f.Float64Var(&cfg.InstanceLimits.MaxIngestionRate, "distributor.instance-limits.max-ingestion-rate", 0, "Max ingestion rate (samples/sec) that this distributor will accept. This limit is per-distributor, not per-tenant. Additional push requests will be rejected. Current ingestion rate is computed as exponentially weighted moving average, updated every second. 0 = unlimited.")
 	f.IntVar(&cfg.InstanceLimits.MaxInflightPushRequests, "distributor.instance-limits.max-inflight-push-requests", 0, "Max inflight push requests that this distributor can handle. This limit is per-distributor, not per-tenant. Additional requests will be rejected. 0 = unlimited.")