feat: Querier: Split gRPC client into two.

docs/sources/shared/configuration.md

@@ -789,92 +789,92 @@ The `azure_storage_config` block configures the connection to Azure object stora
 ```yaml
 # Azure Cloud environment. Supported values are: AzureGlobal, AzureChinaCloud,
 # AzureGermanCloud, AzureUSGovernment.
-# CLI flag: -<prefix>.azure.environment
+# CLI flag: -azure.environment
 [environment: <string> | default = "AzureGlobal"]
 
 # Azure storage account name.
-# CLI flag: -<prefix>.azure.account-name
+# CLI flag: -azure.account-name
 [account_name: <string> | default = ""]
 
 # Azure storage account key.
-# CLI flag: -<prefix>.azure.account-key
+# CLI flag: -azure.account-key
 [account_key: <string> | default = ""]
 
 # If `connection-string` is set, the values of `account-name` and
 # `endpoint-suffix` values will not be used. Use this method over `account-key`
 # if you need to authenticate via a SAS token. Or if you use the Azurite
 # emulator.
-# CLI flag: -<prefix>.azure.connection-string
+# CLI flag: -azure.connection-string
 [connection_string: <string> | default = ""]
 
 # Name of the storage account blob container used to store chunks. This
 # container must be created before running cortex.
-# CLI flag: -<prefix>.azure.container-name
+# CLI flag: -azure.container-name
 [container_name: <string> | default = "loki"]
 
 # Azure storage endpoint suffix without schema. The storage account name will be
 # prefixed to this value to create the FQDN.
-# CLI flag: -<prefix>.azure.endpoint-suffix
+# CLI flag: -azure.endpoint-suffix
 [endpoint_suffix: <string> | default = ""]
 
 # Use Managed Identity to authenticate to the Azure storage account.
-# CLI flag: -<prefix>.azure.use-managed-identity
+# CLI flag: -azure.use-managed-identity
 [use_managed_identity: <boolean> | default = false]
 
 # Use Federated Token to authenticate to the Azure storage account.
-# CLI flag: -<prefix>.azure.use-federated-token
+# CLI flag: -azure.use-federated-token
 [use_federated_token: <boolean> | default = false]
 
 # User assigned identity ID to authenticate to the Azure storage account.
-# CLI flag: -<prefix>.azure.user-assigned-id
+# CLI flag: -azure.user-assigned-id
 [user_assigned_id: <string> | default = ""]
 
 # Use Service Principal to authenticate through Azure OAuth.
-# CLI flag: -<prefix>.azure.use-service-principal
+# CLI flag: -azure.use-service-principal
 [use_service_principal: <boolean> | default = false]
 
 # Azure Service Principal ID(GUID).
-# CLI flag: -<prefix>.azure.client-id
+# CLI flag: -azure.client-id
 [client_id: <string> | default = ""]
 
 # Azure Service Principal secret key.
-# CLI flag: -<prefix>.azure.client-secret
+# CLI flag: -azure.client-secret
 [client_secret: <string> | default = ""]
 
 # Azure Tenant ID is used to authenticate through Azure OAuth.
-# CLI flag: -<prefix>.azure.tenant-id
+# CLI flag: -azure.tenant-id
 [tenant_id: <string> | default = ""]
 
 # Chunk delimiter for blob ID to be used
-# CLI flag: -<prefix>.azure.chunk-delimiter
+# CLI flag: -azure.chunk-delimiter
 [chunk_delimiter: <string> | default = "-"]
 
 # Preallocated buffer size for downloads.
-# CLI flag: -<prefix>.azure.download-buffer-size
+# CLI flag: -azure.download-buffer-size
 [download_buffer_size: <int> | default = 512000]
 
 # Preallocated buffer size for uploads.
-# CLI flag: -<prefix>.azure.upload-buffer-size
+# CLI flag: -azure.upload-buffer-size
 [upload_buffer_size: <int> | default = 256000]
 
 # Number of buffers used to used to upload a chunk.
-# CLI flag: -<prefix>.azure.download-buffer-count
+# CLI flag: -azure.download-buffer-count
 [upload_buffer_count: <int> | default = 1]
 
 # Timeout for requests made against azure blob storage.
-# CLI flag: -<prefix>.azure.request-timeout
+# CLI flag: -azure.request-timeout
 [request_timeout: <duration> | default = 30s]
 
 # Number of retries for a request which times out.
-# CLI flag: -<prefix>.azure.max-retries
+# CLI flag: -azure.max-retries
 [max_retries: <int> | default = 5]
 
 # Minimum time to wait before retrying a request.
-# CLI flag: -<prefix>.azure.min-retry-delay
+# CLI flag: -azure.min-retry-delay
 [min_retry_delay: <duration> | default = 10ms]
 
 # Maximum time to wait before retrying a request.
-# CLI flag: -<prefix>.azure.max-retry-delay
+# CLI flag: -azure.max-retry-delay
 [max_retry_delay: <duration> | default = 500ms]
 ```
 
@@ -2236,25 +2236,23 @@ The `frontend_worker` configures the worker - running within the Loki querier -
 # CLI flag: -querier.id
 [id: <string> | default = ""]
 
-# Configures the gRPC client used to communicate between the querier and the
-# query-frontend, and the querier and the query-scheduler. If
-# 'use_separated_clients' is true, this config is only used for communicating
-# with frontend and 'query_scheduler_grpc_client_config' should be used to
-# configuring querier <-> scheduler communication.
+# Configures the querier gRPC client used to communicate with the
+# query-frontend. Shouldn't be used in conjunction with 'grpc_client_config'.
+# The CLI flags prefix for this block configuration is:
+# querier.frontend-grpc-client
+[query_frontend_grpc_client: <grpc_client>]
+
+# Configures the querier gRPC client used to communicate with the query-frontend
+# and with the query-scheduler if 'query_scheduler_grpc_client' isn't defined.
+# This shouldn't be used if 'query_frontend_grpc_client' is defined.
 # The CLI flags prefix for this block configuration is: querier.frontend-client
 [grpc_client_config: <grpc_client>]
 
-# Configures the gRPC client used to communicate between the querier and the
-# query-scheduler. If 'use_separated_clients' is false, this config is ignored.
-# The CLI flags prefix for this block configuration is: querier.scheduler-client
-[query_scheduler_grpc_client_config: <grpc_client>]
-
-# If set to true, querier will use 'query_scheduler_grpc_client_config' to
-# communicate with the scheduler. Otherwise,
-# 'query_scheduler_grpc_client_config' is ignored and 'grpc_client_config' is
-# used instead.
-# CLI flag: -querier.use-separated-grpc-clients
-[uses_separated_clients: <boolean> | default = false]
+# Configures the querier gRPC client used to communicate with the
+# query-scheduler. If not defined, 'grpc_client_config' is used instead.
+# The CLI flags prefix for this block configuration is:
+# querier.scheduler-grpc-client
+[query_scheduler_grpc_client: <grpc_client>]
 ```
 
 ### gcs_storage_config
@@ -2312,7 +2310,8 @@ The `grpc_client` block configures the gRPC client used to communicate between a
 - `ingester.client`
 - `pattern-ingester.client`
 - `querier.frontend-client`
-- `querier.scheduler-client`
+- `querier.frontend-grpc-client`
+- `querier.scheduler-grpc-client`
 - `query-scheduler.grpc-client-config`
 - `ruler.client`
 - `tsdb.shipper.index-gateway-client.grpc`
@@ -2374,7 +2373,7 @@ backoff_config:
 # TLS flag is set. If set to false, insecure connection to gRPC server will be
 # used.
 # CLI flag: -<prefix>.tls-enabled
-[tls_enabled: <boolean> | default = false]
+[tls_enabled: <boolean> | default = true]
 
 # Path to the client certificate, which will be used for authenticating with the
 # server. Also requires the key path to be configured.
@@ -5329,83 +5328,83 @@ The `swift_storage_config` block configures the connection to OpenStack Object S
 
 ```yaml
 # OpenStack Swift authentication API version. 0 to autodetect.
-# CLI flag: -<prefix>.swift.auth-version
+# CLI flag: -swift.auth-version
 [auth_version: <int> | default = 0]
 
 # OpenStack Swift authentication URL
-# CLI flag: -<prefix>.swift.auth-url
+# CLI flag: -swift.auth-url
 [auth_url: <string> | default = ""]
 
 # Set this to true to use the internal OpenStack Swift endpoint URL
-# CLI flag: -<prefix>.swift.internal
+# CLI flag: -swift.internal
 [internal: <boolean> | default = false]
 
 # OpenStack Swift username.
-# CLI flag: -<prefix>.swift.username
+# CLI flag: -swift.username
 [username: <string> | default = ""]
 
 # OpenStack Swift user's domain name.
-# CLI flag: -<prefix>.swift.user-domain-name
+# CLI flag: -swift.user-domain-name
 [user_domain_name: <string> | default = ""]
 
 # OpenStack Swift user's domain ID.
-# CLI flag: -<prefix>.swift.user-domain-id
+# CLI flag: -swift.user-domain-id
 [user_domain_id: <string> | default = ""]
 
 # OpenStack Swift user ID.
-# CLI flag: -<prefix>.swift.user-id
+# CLI flag: -swift.user-id
 [user_id: <string> | default = ""]
 
 # OpenStack Swift API key.
-# CLI flag: -<prefix>.swift.password
+# CLI flag: -swift.password
 [password: <string> | default = ""]
 
 # OpenStack Swift user's domain ID.
-# CLI flag: -<prefix>.swift.domain-id
+# CLI flag: -swift.domain-id
 [domain_id: <string> | default = ""]
 
 # OpenStack Swift user's domain name.
-# CLI flag: -<prefix>.swift.domain-name
+# CLI flag: -swift.domain-name
 [domain_name: <string> | default = ""]
 
 # OpenStack Swift project ID (v2,v3 auth only).
-# CLI flag: -<prefix>.swift.project-id
+# CLI flag: -swift.project-id
 [project_id: <string> | default = ""]
 
 # OpenStack Swift project name (v2,v3 auth only).
-# CLI flag: -<prefix>.swift.project-name
+# CLI flag: -swift.project-name
 [project_name: <string> | default = ""]
 
 # ID of the OpenStack Swift project's domain (v3 auth only), only needed if it
 # differs the from user domain.
-# CLI flag: -<prefix>.swift.project-domain-id
+# CLI flag: -swift.project-domain-id
 [project_domain_id: <string> | default = ""]
 
 # Name of the OpenStack Swift project's domain (v3 auth only), only needed if it
 # differs from the user domain.
-# CLI flag: -<prefix>.swift.project-domain-name
+# CLI flag: -swift.project-domain-name
 [project_domain_name: <string> | default = ""]
 
 # OpenStack Swift Region to use (v2,v3 auth only).
-# CLI flag: -<prefix>.swift.region-name
+# CLI flag: -swift.region-name
 [region_name: <string> | default = ""]
 
 # Name of the OpenStack Swift container to put chunks in.
-# CLI flag: -<prefix>.swift.container-name
+# CLI flag: -swift.container-name
 [container_name: <string> | default = ""]
 
 # Max retries on requests error.
-# CLI flag: -<prefix>.swift.max-retries
+# CLI flag: -swift.max-retries
 [max_retries: <int> | default = 3]
 
 # Time after which a connection attempt is aborted.
-# CLI flag: -<prefix>.swift.connect-timeout
+# CLI flag: -swift.connect-timeout
 [connect_timeout: <duration> | default = 10s]
 
 # Time after which an idle request is aborted. The timeout watchdog is reset
 # each time some data is received, so the timeout triggers after X time no data
 # is received on a request.
-# CLI flag: -<prefix>.swift.request-timeout
+# CLI flag: -swift.request-timeout
 [request_timeout: <duration> | default = 5s]
 ```
 

pkg/loki/config_wrapper.go

@@ -125,6 +125,9 @@ func (c *ConfigWrapper) ApplyDynamicConfig() cfg.Source {
 		applyIngesterFinalSleep(r)
 		applyIngesterReplicationFactor(r)
 		applyChunkRetain(r, &defaults)
+		if err := applyCommonQuerierWorkerGRPCConfig(r, &defaults); err != nil {
+			return err
+		}
 
 		return nil
 	}
@@ -684,3 +687,23 @@ func applyChunkRetain(cfg, defaults *ConfigWrapper) {
 		}
 	}
 }
+
+func applyCommonQuerierWorkerGRPCConfig(cfg, defaults *ConfigWrapper) error {
+	if !reflect.DeepEqual(cfg.Worker.OldQueryFrontendGRPCClientConfig, defaults.Worker.OldQueryFrontendGRPCClientConfig) {
+		// User is using the old grpc configuration.
+
+		if reflect.DeepEqual(cfg.Worker.NewQueryFrontendGRPCClientConfig, defaults.Worker.NewQueryFrontendGRPCClientConfig) {
+			// User is using the old grpc configuration only, we can just copy it to the new grpc client struct.
+			cfg.Worker.NewQueryFrontendGRPCClientConfig = cfg.Worker.OldQueryFrontendGRPCClientConfig
+		} else {
+			// User is using both, old and new way of configuring the grpc client, so we throw an error.
+			return fmt.Errorf("both `grpc_client_config` and `query_frontend_grpc_client` are set at the same time. Please use only one of them")
+		}
+
+		if reflect.DeepEqual(cfg.Worker.QuerySchedulerGRPCClientConfig, defaults.Worker.QuerySchedulerGRPCClientConfig) {
+			// Since the scheduler grpc client is not set, we can just copy the old query frontend grpc client to the scheduler grpc client.
+			cfg.Worker.QuerySchedulerGRPCClientConfig = cfg.Worker.OldQueryFrontendGRPCClientConfig
+		}
+	}
+	return nil
+}