Type object | null
File match loki.yml loki.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/loki/latest.json
Source https://www.schemastore.org/loki.json

Validate with Lintel

npx @lintel/lintel check
Type: object | null

Properties

target string

A comma-separated list of components to run. The default value 'all' runs Loki in single binary mode. The value 'read' is an alias to run only read-path related components such as the querier and query-frontend, but all in the same process. The value 'write' is an alias to run only write-path related components such as the distributor and compactor, but all in the same process. Supported values: all, compactor, distributor, ingester, querier, query-scheduler, ingester-querier, query-frontend, index-gateway, ruler, table-manager, read, write. A full list of available targets can be printed when running Loki with the '-list-targets' command line flag.

auth_enabled boolean

Enables authentication through the X-Scope-OrgID header, which must be present if true. If false, the OrgID will always be set to 'fake'.

ballast_bytes integer

The amount of virtual memory in bytes to reserve as ballast in order to optimize garbage collection. Larger ballasts result in fewer garbage collection passes, reducing CPU overhead at the cost of heap size. The ballast will not consume physical memory, because it is never read from. It will, however, distort metrics, because it is counted as live memory. Default: 0.

server object
40 nested properties
http_listen_network string

HTTP server listen network, default tcp

http_listen_address string

HTTP server listen address.

http_listen_port integer

HTTP server listen port. Default: 3100.

http_listen_conn_limit integer

Maximum number of simultaneous http connections, <=0 to disable. Default: 0.

grpc_listen_network string

gRPC server listen network

grpc_listen_address string

gRPC server listen address.

grpc_listen_port integer

gRPC server listen port. Default: 9095.

grpc_listen_conn_limit integer

Maximum number of simultaneous grpc connections, <=0 to disable. Default: 0.

tls_cipher_suites string

Comma-separated list of cipher suites to use. If blank, the default Go cipher suites is used.

tls_min_version string

Minimum TLS version to use. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13. If blank, the Go TLS minimum version is used.

http_tls_config object
7 nested properties
cert string

Server TLS certificate. This configuration parameter is YAML only.

key string

Server TLS key. This configuration parameter is YAML only.

client_ca string

Root certificate authority used to verify client certificates. This configuration parameter is YAML only.

cert_file string

HTTP server cert path.

key_file string

HTTP server key path.

client_auth_type string

HTTP TLS Client Auth type.

client_ca_file string

HTTP TLS Client CA path.

grpc_tls_config object
7 nested properties
cert string

Server TLS certificate. This configuration parameter is YAML only.

key string

Server TLS key. This configuration parameter is YAML only.

client_ca string

Root certificate authority used to verify client certificates. This configuration parameter is YAML only.

cert_file string

GRPC TLS server cert path.

key_file string

GRPC TLS server key path.

client_auth_type string

GRPC TLS Client Auth type.

client_ca_file string

GRPC TLS Client CA path.

register_instrumentation boolean

Register the instrumentation handlers (/metrics etc).

report_grpc_codes_in_instrumentation_label_enabled boolean

If set to true, gRPC statuses will be reported in instrumentation labels with their string representations. Otherwise, they will be reported as "error".

graceful_shutdown_timeout string

Timeout for graceful shutdowns

http_server_read_timeout string

Read timeout for entire HTTP request, including headers and body.

http_server_read_header_timeout string

Read timeout for HTTP request headers. If set to 0, value of -server.http-read-timeout is used.

http_server_write_timeout string

Write timeout for HTTP server

http_server_idle_timeout string

Idle timeout for HTTP server

http_log_closed_connections_without_response_enabled boolean

Log closed connections that did not receive any response, most likely because client didn't send any request within timeout.

grpc_server_max_recv_msg_size integer

Limit on the size of a gRPC message this server can receive (bytes). Default: 4194304.

grpc_server_max_send_msg_size integer

Limit on the size of a gRPC message this server can send (bytes). Default: 4194304.

grpc_server_max_concurrent_streams integer

Limit on the number of concurrent streams for gRPC calls per client connection (0 = unlimited). Default: 100.

grpc_server_max_connection_idle string

The duration after which an idle connection should be closed. Default: infinity

grpc_server_max_connection_age string

The duration for the maximum amount of time a connection may exist before it will be closed. Default: infinity

grpc_server_max_connection_age_grace string

An additive period after max-connection-age after which the connection will be forcibly closed. Default: infinity

grpc_server_keepalive_time string

Duration after which a keepalive probe is sent in case of no activity over the connection., Default: 2h

grpc_server_keepalive_timeout string

After having pinged for keepalive check, the duration after which an idle connection should be closed, Default: 20s

grpc_server_min_time_between_pings string

Minimum amount of time a client should wait before sending a keepalive ping. If client sends keepalive ping more often, server will send GOAWAY and close the connection.

grpc_server_ping_without_stream_allowed boolean

If true, server allows keepalive pings even when there are no active streams(RPCs). If false, and client sends ping when there are no active streams, server will send GOAWAY and close the connection.

grpc_server_num_workers integer

If non-zero, configures the amount of GRPC server workers used to serve the requests. Default: 0.

log_format string

Output log messages in the given format. Valid formats: [logfmt, json]

log_level string

Only log messages with the given severity or above. Valid levels: [debug, info, warn, error]

log_source_ips_enabled boolean

Optionally log the source IPs.

log_source_ips_header string

Header field storing the source IPs. Only used if server.log-source-ips-enabled is true. If not set the default Forwarded, X-Real-IP and X-Forwarded-For headers are used

log_source_ips_regex string

Regex for matching the source IPs. Only used if server.log-source-ips-enabled is true. If not set the default Forwarded, X-Real-IP and X-Forwarded-For headers are used

log_request_headers boolean

Optionally log request headers.

log_request_at_info_level_enabled boolean

Optionally log requests at info level instead of debug level. Applies to request headers as well if server.log-request-headers is enabled.

log_request_exclude_headers_list string

Comma separated list of headers to exclude from logging. Only used if server.log-request-headers is true.

http_path_prefix string

Base path to serve all API routes from (e.g. /v1/)

distributor object
4 nested properties
ring object
4 nested properties
kvstore object
5 nested properties
store string

Backend storage to use for the ring. Supported values are: consul, etcd, inmemory, memberlist, multi.

prefix string

The prefix for the keys in the store. Should end with a /.

consul object
etcd object
multi object
heartbeat_period string

Period at which to heartbeat to the ring. 0 = disabled.

heartbeat_timeout string

The heartbeat timeout after which distributors are considered unhealthy within the ring. 0 = never (timeout disabled).

instance_interface_names array | null

Name of network interface to read address from.

rate_store object
4 nested properties
max_request_parallelism integer

The max number of concurrent requests to make to ingester stream apis. Default: 200.

stream_rate_update_interval string

The interval on which distributors will update current stream rates from ingesters

ingester_request_timeout string

Timeout for communication between distributors and any given ingester when updating rates

debug boolean

If enabled, detailed logs and spans will be emitted.

write_failures_logging object

Customize the logging of write failures.

2 nested properties
rate string

Log volume allowed (per second). Default: 1KB. Default: 1KB.

add_insights_label boolean

Whether a insight=true key should be logged or not. Default: false.

otlp_config object
1 nested properties
default_resource_attributes_as_index_labels array | null

List of default otlp resource attributes to be picked as index labels

querier object
9 nested properties
tail_max_duration string

Maximum duration for which the live tailing requests are served.

extra_query_delay string

Time to wait before sending more than the minimum successful query requests.

query_ingesters_within string

Maximum lookback beyond which queries are not sent to ingester. 0 means all queries are sent to ingester.

engine object
1 nested properties
max_look_back_period string

The maximum amount of time to look back for log lines. Used only for instant log queries.

max_concurrent integer

The maximum number of queries that can be simultaneously processed by the querier. Default: 4.

query_store_only boolean

Only query the store, and not attempt any ingesters. This is useful for running a standalone querier pool operating only against stored data.

query_ingester_only boolean

When true, queriers only query the ingesters, and not stored data. This is useful when the object store is unavailable.

multi_tenant_queries_enabled boolean

When true, allow queries to span multiple tenants.

per_request_limits_enabled boolean

When true, querier limits sent via a header are enforced.

query_scheduler object
6 nested properties
max_outstanding_requests_per_tenant integer

Maximum number of outstanding requests per tenant per query-scheduler. In-flight requests above this limit will fail with HTTP response status code 429. Default: 32000.

max_queue_hierarchy_levels integer

Maximum number of levels of nesting of hierarchical queues. 0 means that hierarchical queues are disabled. Default: 3.

querier_forget_delay string

If a querier disconnects without sending notification about graceful shutdown, the query-scheduler will keep the querier in the tenant's shard until the forget delay has passed. This feature is useful to reduce the blast radius when shuffle-sharding is enabled.

grpc_client_config object
20 nested properties
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
3 nested properties
min_period string

Minimum delay when backing off.

max_period string

Maximum delay when backing off.

max_retries integer

Number of times to backoff and retry before failing. Default: 10.

initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

use_scheduler_ring boolean

Set to true to have the query schedulers create and place themselves in a ring. If no frontend_address or scheduler_address are present anywhere else in the configuration, Loki will toggle this value to true.

scheduler_ring object

The hash ring configuration. This option is required only if use_scheduler_ring is true.

13 nested properties
kvstore object
5 nested properties
store string

Backend storage to use for the ring. Supported values are: consul, etcd, inmemory, memberlist, multi.

prefix string

The prefix for the keys in the store. Should end with a /.

consul object
etcd object
multi object
heartbeat_period string

Period at which to heartbeat to the ring. 0 = disabled.

heartbeat_timeout string

The heartbeat timeout after which compactors are considered unhealthy within the ring. 0 = never (timeout disabled).

tokens_file_path string

File path where tokens are stored. If empty, tokens are not stored at shutdown and restored at startup.

zone_awareness_enabled boolean

True to enable zone-awareness and replicate blocks across different availability zones.

num_tokens
replication_factor
instance_id string

Instance ID to register in the ring.

instance_interface_names array | null

Name of network interface to read address from.

instance_port integer

Port to advertise in the ring (defaults to server.grpc-listen-port). Default: 0.

instance_addr string

IP address to advertise in the ring.

instance_availability_zone string

The availability zone where this instance is running. Required if zone-awareness is enabled.

instance_enable_ipv6 boolean

Enable using a IPv6 instance address.

frontend object
17 nested properties
log_queries_longer_than string

Log queries that are slower than the specified duration. Set to 0 to disable. Set to < 0 to enable on all queries.

log_query_request_headers string

Comma-separated list of request header names to include in query logs. Applies to both query stats and slow queries logs.

max_body_size integer

Max body size for downstream prometheus. Default: 10485760.

query_stats_enabled boolean

True to enable query statistics tracking. When enabled, a message with some statistics is logged for every query.

max_outstanding_per_tenant integer

Maximum number of outstanding requests per tenant per frontend; requests beyond this error with HTTP 429. Default: 2048.

querier_forget_delay string

In the event a tenant is repeatedly sending queries that lead the querier to crash or be killed due to an out-of-memory error, the crashed querier will be disconnected from the query frontend and a new querier will be immediately assigned to the tenant’s shard. This invalidates the assumption that shuffle sharding can be used to reduce the impact on tenants. This option mitigates the impact by configuring a delay between when a querier disconnects because of a crash and when the crashed querier is actually removed from the tenant's shard.

scheduler_address string

DNS hostname used for finding query-schedulers.

scheduler_dns_lookup_period string

How often to resolve the scheduler-address, in order to look for new query-scheduler instances. Also used to determine how often to poll the scheduler-ring for addresses if the scheduler-ring is configured.

scheduler_worker_concurrency integer

Number of concurrent workers forwarding queries to single query-scheduler. Default: 5.

grpc_client_config object
20 nested properties
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
3 nested properties
min_period string

Minimum delay when backing off.

max_period string

Maximum delay when backing off.

max_retries integer

Number of times to backoff and retry before failing. Default: 10.

initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

graceful_shutdown_timeout string

Time to wait for inflight requests to finish before forcefully shutting down. This needs to be aligned with the query timeout and the graceful termination period of the process orchestrator.

instance_interface_names array | null

Name of network interface to read address from. This address is sent to query-scheduler and querier, which uses it to send the query response back to query-frontend.

encoding string

Defines the encoding for requests to and responses from the scheduler and querier. Can be 'json' or 'protobuf' (defaults to 'json').

compress_responses boolean

Compress HTTP responses.

downstream_url string

URL of downstream Loki.

tail_proxy_url string

URL of querier for tail proxy.

tail_tls_config object
7 nested properties
tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

query_range object
17 nested properties
align_queries_with_step boolean

Mutate incoming queries to align their start and end with their step.

results_cache object
2 nested properties
cache object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
memcached object
memcached_client object
redis object
embedded_cache object
compression string

Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.

cache_results boolean

Cache query results.

max_retries integer

Maximum number of retries for a single request; beyond this, the downstream error is returned. Default: 5.

parallelise_shardable_queries boolean

Perform query parallelisations based on storage sharding configuration and query ASTs. This feature is supported only by the chunks storage engine.

shard_aggregations string

A comma-separated list of LogQL vector and range aggregations that should be sharded

cache_index_stats_results boolean

Cache index stats query results.

index_stats_results_cache object

If a cache config is not specified and cache_index_stats_results is true, the config for the results cache is used.

2 nested properties
cache object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
memcached object
memcached_client object
redis object
embedded_cache object
compression string

Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.

cache_volume_results boolean

Cache volume query results.

volume_results_cache object

If a cache config is not specified and cache_volume_results is true, the config for the results cache is used.

2 nested properties
cache object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
memcached object
memcached_client object
redis object
embedded_cache object
compression string

Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.

cache_instant_metric_results boolean

Cache instant metric query results.

instant_metric_results_cache object

If a cache config is not specified and cache_instant_metric_results is true, the config for the results cache is used.

2 nested properties
cache object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
memcached object
memcached_client object
redis object
embedded_cache object
compression string

Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.

instant_metric_query_split_align boolean

Whether to align the splits of instant metric query with splitByInterval and query's exec time. Useful when instant_metric_cache is enabled

cache_series_results boolean

Cache series query results.

series_results_cache object

If series_results_cache is not configured and cache_series_results is true, the config for the results cache is used.

2 nested properties
cache object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
memcached object
memcached_client object
redis object
embedded_cache object
compression string

Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.

cache_label_results boolean

Cache label query results.

label_results_cache object

If label_results_cache is not configured and cache_label_results is true, the config for the results cache is used.

2 nested properties
cache object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
memcached object
memcached_client object
redis object
embedded_cache object
compression string

Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.

ruler object
34 nested properties
external_url string

Base URL of the Grafana instance.

datasource_uid string

Datasource UID for the dashboard.

external_labels array | null

Labels to add to all alerts.

ruler_client object
20 nested properties
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
3 nested properties
min_period string

Minimum delay when backing off.

max_period string

Maximum delay when backing off.

max_retries integer

Number of times to backoff and retry before failing. Default: 10.

initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

evaluation_interval string

How frequently to evaluate rules.

poll_interval string

How frequently to poll for rule changes.

storage object

Deprecated: Use -ruler-storage. CLI flags and their respective YAML config options instead.

9 nested properties
type string

Method to use for backend rule storage (configdb, azure, gcs, s3, swift, local, bos, cos)

azure object
21 nested properties
environment string

Azure Cloud environment. Supported values are: AzureGlobal, AzureChinaCloud, AzureGermanCloud, AzureUSGovernment.

account_name string

Azure storage account name.

account_key string

Azure storage account key.

connection_string string

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.

container_name string

Name of the storage account blob container used to store chunks. This container must be created before running cortex.

endpoint_suffix string

Azure storage endpoint suffix without schema. The storage account name will be prefixed to this value to create the FQDN.

use_managed_identity boolean

Use Managed Identity to authenticate to the Azure storage account.

use_federated_token boolean

Use Federated Token to authenticate to the Azure storage account.

user_assigned_id string

User assigned identity ID to authenticate to the Azure storage account.

use_service_principal boolean

Use Service Principal to authenticate through Azure OAuth.

client_id string

Azure Service Principal ID(GUID).

client_secret string

Azure Service Principal secret key.

tenant_id string

Azure Tenant ID is used to authenticate through Azure OAuth.

chunk_delimiter string

Chunk delimiter for blob ID to be used

download_buffer_size integer

Preallocated buffer size for downloads. Default: 512000.

upload_buffer_size integer

Preallocated buffer size for uploads. Default: 256000.

upload_buffer_count integer

Number of buffers used to used to upload a chunk. Default: 1.

request_timeout string

Timeout for requests made against azure blob storage.

max_retries integer

Number of retries for a request which times out. Default: 5.

min_retry_delay string

Minimum time to wait before retrying a request.

max_retry_delay string

Maximum time to wait before retrying a request.

alibabacloud object
4 nested properties
bucket string

Name of OSS bucket.

endpoint string

oss Endpoint to connect to.

access_key_id string

alibabacloud Access Key ID

secret_access_key string

alibabacloud Secret Access Key

gcs object
7 nested properties
bucket_name string

Name of GCS bucket. Please refer to https://cloud.google.com/docs/authentication/production for more information about how to configure authentication.

service_account string

Service account key content in JSON format, refer to https://cloud.google.com/iam/docs/creating-managing-service-account-keys for creation.

chunk_buffer_size integer

The size of the buffer that GCS client for each PUT request. 0 to disable buffering. Default: 0.

request_timeout string

The duration after which the requests to GCS should be timed out.

enable_opencensus boolean

Enable OpenCensus (OC) instrumentation for all requests.

enable_http2 boolean

Enable HTTP2 connections.

enable_retries boolean

Enable automatic retries of failed idempotent requests.

s3 object
14 nested properties
s3 string

S3 endpoint URL with escaped Key and Secret encoded. If only region is specified as a host, proper endpoint will be deduced. Use inmemory:/// to use a mock in-memory implementation.

s3forcepathstyle boolean

Set this to true to force the request to use path-style addressing.

bucketnames string

Comma separated list of bucket names to evenly distribute chunks over. Overrides any buckets specified in s3.url flag

endpoint string

S3 Endpoint to connect to.

region string

AWS region to use.

access_key_id string

AWS Access Key ID

secret_access_key string

AWS Secret Access Key

session_token string

AWS Session Token

insecure boolean

Disable https on s3 connection.

http_config object
signature_version string

The signature version to use for authenticating against S3. Supported values are: v4.

storage_class string

The S3 storage class which objects will use. Supported values are: GLACIER, DEEP_ARCHIVE, GLACIER_IR, INTELLIGENT_TIERING, ONEZONE_IA, OUTPOSTS, REDUCED_REDUNDANCY, STANDARD, STANDARD_IA.

sse object
backoff_config object

Configures back off when S3 get Object.

bos object
4 nested properties
bucket_name string

Name of BOS bucket.

endpoint string

BOS endpoint to connect to.

access_key_id string

Baidu Cloud Engine (BCE) Access Key ID.

secret_access_key string

Baidu Cloud Engine (BCE) Secret Access Key.

swift object
19 nested properties
auth_version integer

OpenStack Swift authentication API version. 0 to autodetect. Default: 0.

auth_url string

OpenStack Swift authentication URL

internal boolean

Set this to true to use the internal OpenStack Swift endpoint URL

username string

OpenStack Swift username.

user_domain_name string

OpenStack Swift user's domain name.

user_domain_id string

OpenStack Swift user's domain ID.

user_id string

OpenStack Swift user ID.

password string

OpenStack Swift API key.

domain_id string

OpenStack Swift user's domain ID.

domain_name string

OpenStack Swift user's domain name.

project_id string

OpenStack Swift project ID (v2,v3 auth only).

project_name string

OpenStack Swift project name (v2,v3 auth only).

project_domain_id string

ID of the OpenStack Swift project's domain (v3 auth only), only needed if it differs the from user domain.

project_domain_name string

Name of the OpenStack Swift project's domain (v3 auth only), only needed if it differs from the user domain.

region_name string

OpenStack Swift Region to use (v2,v3 auth only).

container_name string

Name of the OpenStack Swift container to put chunks in.

max_retries integer

Max retries on requests error. Default: 3.

connect_timeout string

Time after which a connection attempt is aborted.

request_timeout string

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.

cos object
14 nested properties
forcepathstyle boolean

Set this to true to force the request to use path-style addressing.

bucketnames string

Comma separated list of bucket names to evenly distribute chunks over.

endpoint string

COS Endpoint to connect to.

region string

COS region to use.

access_key_id string

COS HMAC Access Key ID.

secret_access_key string

COS HMAC Secret Access Key.

http_config object
backoff_config object

Configures back off when cos get Object.

api_key string

IAM API key to access COS.

service_instance_id string

COS service instance id to use.

auth_endpoint string

IAM Auth Endpoint for authentication.

cr_token_file_path string

Compute resource token file path.

trusted_profile_name string

Name of the trusted profile.

trusted_profile_id string

ID of the trusted profile.

local object

Configures backend rule storage for a local file system directory.

1 nested properties
directory string

Directory to scan for rules

rule_path string

File path to store temporary rule files.

alertmanager_url string

Comma-separated list of Alertmanager URLs to send notifications to. Each Alertmanager URL is treated as a separate group in the configuration. Multiple Alertmanagers in HA per group can be supported by using DNS resolution via '-ruler.alertmanager-discovery'.

enable_alertmanager_discovery boolean

Use DNS SRV records to discover Alertmanager hosts.

alertmanager_refresh_interval string

How long to wait between refreshing DNS resolutions of Alertmanager hosts.

enable_alertmanager_v2 boolean

If enabled requests to Alertmanager will utilize the V2 API.

alert_relabel_configs array | null

List of alert relabel configs.

notification_queue_capacity integer

Capacity of the queue for notifications to be sent to the Alertmanager. Default: 10000.

notification_timeout string

HTTP timeout duration when sending notifications to the Alertmanager.

alertmanager_client object
12 nested properties
tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

basic_auth_username string

HTTP Basic authentication username. It overrides the username set in the URL (if any).

basic_auth_password string

HTTP Basic authentication password. It overrides the password set in the URL (if any).

type string

HTTP Header authorization type (default: Bearer).

credentials string

HTTP Header authorization credentials.

credentials_file string

HTTP Header authorization credentials file.

for_outage_tolerance string

Max time to tolerate outage for restoring "for" state of alert.

for_grace_period string

Minimum duration between alert and restored "for" state. This is maintained only for alerts with configured "for" time greater than the grace period.

resend_delay string

Minimum amount of time to wait before resending an alert to Alertmanager.

enable_sharding boolean

Distribute rule evaluation using ring backend.

sharding_strategy string

The sharding strategy to use. Supported values are: default, shuffle-sharding.

sharding_algo string

The sharding algorithm to use for deciding how rules & groups are sharded. Supported values are: by-group, by-rule.

search_pending_for string

Time to spend searching for a pending ruler when shutting down.

ring object

Ring used by Loki ruler. The CLI flags prefix for this block configuration is 'ruler.ring'.

5 nested properties
kvstore object
5 nested properties
store string

Backend storage to use for the ring. Supported values are: consul, etcd, inmemory, memberlist, multi.

prefix string

The prefix for the keys in the store. Should end with a /.

consul object
etcd object
multi object
heartbeat_period string

Interval between heartbeats sent to the ring. 0 = disabled.

heartbeat_timeout string

The heartbeat timeout after which ruler ring members are considered unhealthy within the ring. 0 = never (timeout disabled).

instance_interface_names array | null

Name of network interface to read addresses from.

num_tokens integer

The number of tokens the lifecycler will generate and put into the ring if it joined without transferring tokens from another lifecycler. Default: 128.

flush_period string

Period with which to attempt to flush rule groups.

enable_api boolean

Enable the ruler API.

enabled_tenants string

Comma separated list of tenants whose rules this ruler can evaluate. If specified, only these tenants will be handled by ruler, otherwise this ruler can process rules from all tenants. Subject to sharding.

disabled_tenants string

Comma separated list of tenants whose rules this ruler cannot evaluate. If specified, a ruler that would normally pick the specified tenant(s) for processing will ignore them instead. Subject to sharding.

query_stats_enabled boolean

Report the wall time for ruler queries to complete as a per user metric and as an info level log message.

disable_rule_group_label boolean

Disable the rule_group label on exported metrics.

wal object
4 nested properties
dir string

The directory in which to write tenant WAL files. Each tenant will have its own directory one level below this directory.

truncate_frequency string

Frequency with which to run the WAL truncation process.

min_age string

Minimum age that samples must exist in the WAL before being truncated.

max_age string

Maximum age that samples must exist in the WAL before being truncated.

wal_cleaner object
2 nested properties
min_age string

The minimum age of a WAL to consider for cleaning.

period string

How often to run the WAL cleaner. 0 = disabled.

remote_write object

Remote-write configuration to send rule samples to a Prometheus remote-write endpoint.

5 nested properties
client object

Remote-write configuration to send rule samples to a Prometheus remote-write endpoint.

5 nested properties
client object

Remote-write configuration to send rule samples to a Prometheus remote-write endpoint.

clients Record<string, object>

Configure remote write clients. A map with remote client id as key.

enabled boolean

Enable remote-write functionality.

config_refresh_period string

Minimum period to wait between refreshing remote-write reconfigurations. This should be greater than or equivalent to -limits.per-user-override-period.

add_org_id_header boolean

Add X-Scope-OrgID header in remote write requests.

clients Record<string, object>

Configure remote write clients. A map with remote client id as key.

enabled boolean

Enable remote-write functionality.

config_refresh_period string

Minimum period to wait between refreshing remote-write reconfigurations. This should be greater than or equivalent to -limits.per-user-override-period.

add_org_id_header boolean

Add X-Scope-OrgID header in remote write requests.

evaluation object

Configuration for rule evaluation.

3 nested properties
mode string

The evaluation mode for the ruler. Can be either 'local' or 'remote'. If set to 'local', the ruler will evaluate rules locally. If set to 'remote', the ruler will evaluate rules remotely. If unset, the ruler will evaluate rules locally.

max_jitter string

Upper bound of random duration to wait before rule evaluation to avoid contention during concurrent execution of rules. Jitter is calculated consistently for a given rule. Set 0 to disable (default).

query_frontend object
9 nested properties
address string

GRPC listen address of the query-frontend(s). Must be a DNS address (prefixed with dns:///) to enable client side load balancing.

tls_enabled boolean

Set to true if query-frontend connection requires TLS.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

ingester_client object
3 nested properties
pool_config object

Configures how connections are pooled.

3 nested properties
client_cleanup_period string

How frequently to clean up clients for ingesters that have gone away.

health_check_ingesters boolean

Run a health check on each ingester client during periodic cleanup.

remote_timeout string

How quickly a dead client will be removed after it has been detected to disappear. Set this to a value to allow time for a secondary health check to recover the missing client.

remote_timeout string

The remote request timeout on the client side.

grpc_client_config object
20 nested properties
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
3 nested properties
min_period string

Minimum delay when backing off.

max_period string

Maximum delay when backing off.

max_retries integer

Number of times to backoff and retry before failing. Default: 10.

initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

ingester object
19 nested properties
lifecycler object

Configures how the lifecycle of the ingester will operate and where it will register for discovery.

17 nested properties
ring object
5 nested properties
kvstore object
heartbeat_timeout string

The heartbeat timeout after which ingesters are skipped for reads/writes. 0 = never (timeout disabled).

replication_factor integer

The number of ingesters to write to and read from. Default: 3.

zone_awareness_enabled boolean

True to enable the zone-awareness and replicate ingested samples across different availability zones.

excluded_zones string

Comma-separated list of zones to exclude from the ring. Instances in excluded zones will be filtered out from the ring.

num_tokens integer

Number of tokens for each ingester. Default: 128.

heartbeat_period string

Period at which to heartbeat to consul. 0 = disabled.

heartbeat_timeout string

Heartbeat timeout after which instance is assumed to be unhealthy. 0 = disabled.

observe_period string

Observe tokens after generating to resolve collisions. Useful when using gossiping ring.

join_after string

Period to wait for a claim from another member; will join automatically after this.

min_ready_duration string

Minimum duration to wait after the internal readiness checks have passed but before succeeding the readiness endpoint. This is used to slowdown deployment controllers (eg. Kubernetes) after an instance is ready and before they proceed with a rolling update, to give the rest of the cluster instances enough time to receive ring updates.

interface_names array | null

Name of network interface to read address from.

enable_inet6 boolean

Enable IPv6 support. Required to make use of IP addresses from IPv6 interfaces.

final_sleep string

Duration to sleep for before exiting, to ensure metrics are scraped.

tokens_file_path string

File path where tokens are stored. If empty, tokens are not stored at shutdown and restored at startup.

availability_zone string

The availability zone where this instance is running.

unregister_on_shutdown boolean

Unregister from the ring upon clean shutdown. It can be useful to disable for rolling restarts with consistent naming in conjunction with -distributor.extend-writes=false.

readiness_check_ring_health boolean

When enabled the readiness probe succeeds only after all instances are ACTIVE and healthy in the ring, otherwise only the instance itself is checked. This option should be disabled if in your cluster multiple instances can be rolled out simultaneously, otherwise rolling updates may be slowed down.

address string

IP address to advertise in the ring.

port integer

port to advertise in consul (defaults to server.grpc-listen-port). Default: 0.

id string

ID to register in the ring.

concurrent_flushes integer

How many flushes can happen concurrently from each stream. Default: 32.

flush_check_period string

How often should the ingester see if there are any blocks to flush. The first flush check is delayed by a random time up to 0.8x the flush check period. Additionally, there is +/- 1% jitter added to the interval.

flush_op_timeout string

The timeout before a flush is cancelled.

chunk_retain_period string

How long chunks should be retained in-memory after they've been flushed.

chunk_idle_period string

How long chunks should sit in-memory with no updates before being flushed if they don't hit the max block size. This means that half-empty chunks will still be flushed after a certain period as long as they receive no further activity.

chunk_block_size integer

The targeted uncompressed size in bytes of a chunk block When this threshold is exceeded the head block will be cut and compressed inside the chunk. Default: 262144.

chunk_target_size integer

A target compressed size in bytes for chunks. This is a desired size not an exact size, chunks may be slightly bigger or significantly smaller if they get flushed for other reasons (e.g. chunk_idle_period). A value of 0 creates chunks with a fixed 10 blocks, a non zero value will create chunks with a variable number of blocks to meet the target size. Default: 1572864.

chunk_encoding string

The algorithm to use for compressing chunk. (none, gzip, lz4-64k, snappy, lz4-256k, lz4-1M, lz4, flate, zstd)

max_chunk_age string

The maximum duration of a timeseries chunk in memory. If a timeseries runs for longer than this, the current chunk will be flushed to the store and a new chunk created.

autoforget_unhealthy boolean

Forget about ingesters having heartbeat timestamps older than ring.kvstore.heartbeat_timeout. This is equivalent to clicking on the /ring forget button in the UI: the ingester is removed from the ring. This is a useful setting when you are sure that an unhealthy node won't return. An example is when not using stateful sets or the equivalent. Use memberlist.rejoin_interval > 0 to handle network partition cases when using a memberlist.

sync_period string

Parameters used to synchronize ingesters to cut chunks at the same moment. Sync period is used to roll over incoming entry to a new chunk. If chunk's utilization isn't high enough (eg. less than 50% when sync_min_utilization is set to 0.5), then this chunk rollover doesn't happen.

sync_min_utilization number

Minimum utilization of chunk when doing synchronization. Default: 0.1.

max_returned_stream_errors integer

The maximum number of errors a stream will report to the user when a push fails. 0 to make unlimited. Default: 10.

query_store_max_look_back_period string

How far back should an ingester be allowed to query the store for data, for use only with boltdb-shipper/tsdb index and filesystem object store. -1 for infinite.

wal object

The ingester WAL (Write Ahead Log) records incoming logs and stores them on the local file systems in order to guarantee persistence of acknowledged data in the event of a process crash.

5 nested properties
enabled boolean

Enable writing of ingested data into WAL.

dir string

Directory where the WAL data is stored and/or recovered from.

checkpoint_duration string

Interval at which checkpoints should be created.

flush_on_shutdown boolean

When WAL is enabled, should chunks be flushed to long-term storage on shutdown.

replay_memory_ceiling string

Maximum memory size the WAL may use during replay. After hitting this, it will flush data to storage before continuing. A unit suffix (KB, MB, GB) may be applied. Default: 4GB.

index_shards integer

Shard factor used in the ingesters for the in process reverse index. This MUST be evenly divisible by ALL schema shard factors or Loki will not start. Default: 32.

max_dropped_streams integer

Maximum number of dropped streams to keep in memory during tailing. Default: 10.

shutdown_marker_path string

Path where the shutdown marker file is stored. If not set and common.path_prefix is set then common.path_prefix will be used.

pattern_ingester object
5 nested properties
enabled boolean

Whether the pattern ingester is enabled.

lifecycler object

Configures how the lifecycle of the pattern ingester will operate and where it will register for discovery.

17 nested properties
ring object
5 nested properties
kvstore object
heartbeat_timeout string

The heartbeat timeout after which ingesters are skipped for reads/writes. 0 = never (timeout disabled).

replication_factor integer

The number of ingesters to write to and read from. Default: 1.

zone_awareness_enabled boolean

True to enable the zone-awareness and replicate ingested samples across different availability zones.

excluded_zones string

Comma-separated list of zones to exclude from the ring. Instances in excluded zones will be filtered out from the ring.

num_tokens integer

Number of tokens for each ingester. Default: 128.

heartbeat_period string

Period at which to heartbeat to consul. 0 = disabled.

heartbeat_timeout string

Heartbeat timeout after which instance is assumed to be unhealthy. 0 = disabled.

observe_period string

Observe tokens after generating to resolve collisions. Useful when using gossiping ring.

join_after string

Period to wait for a claim from another member; will join automatically after this.

min_ready_duration string

Minimum duration to wait after the internal readiness checks have passed but before succeeding the readiness endpoint. This is used to slowdown deployment controllers (eg. Kubernetes) after an instance is ready and before they proceed with a rolling update, to give the rest of the cluster instances enough time to receive ring updates.

interface_names array | null

Name of network interface to read address from.

enable_inet6 boolean

Enable IPv6 support. Required to make use of IP addresses from IPv6 interfaces.

final_sleep string

Duration to sleep for before exiting, to ensure metrics are scraped.

tokens_file_path string

File path where tokens are stored. If empty, tokens are not stored at shutdown and restored at startup.

availability_zone string

The availability zone where this instance is running.

unregister_on_shutdown boolean

Unregister from the ring upon clean shutdown. It can be useful to disable for rolling restarts with consistent naming in conjunction with -distributor.extend-writes=false.

readiness_check_ring_health boolean

When enabled the readiness probe succeeds only after all instances are ACTIVE and healthy in the ring, otherwise only the instance itself is checked. This option should be disabled if in your cluster multiple instances can be rolled out simultaneously, otherwise rolling updates may be slowed down.

address string

IP address to advertise in the ring.

port integer

port to advertise in consul (defaults to server.grpc-listen-port). Default: 0.

id string

ID to register in the ring.

client_config object

Configures how the pattern ingester will connect to the ingesters.

3 nested properties
pool_config object

Configures how connections are pooled.

3 nested properties
client_cleanup_period string

How frequently to clean up clients for ingesters that have gone away.

health_check_ingesters boolean

Run a health check on each ingester client during periodic cleanup.

remote_timeout string

Timeout for the health check.

remote_timeout string

The remote request timeout on the client side.

grpc_client_config object
20 nested properties
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

concurrent_flushes integer

How many flushes can happen concurrently from each stream. Default: 32.

flush_check_period string

How often should the ingester see if there are any blocks to flush. The first flush check is delayed by a random time up to 0.8x the flush check period. Additionally, there is +/- 1% jitter added to the interval.

index_gateway object
2 nested properties
mode string

Defines in which mode the index gateway server will operate (default to 'simple'). It supports two modes:

  • 'simple': an index gateway server instance is responsible for handling, storing and returning requests for all indices for all tenants.
  • 'ring': an index gateway server instance is responsible for a subset of tenants instead of all tenants.
ring object

Defines the ring to be used by the index gateway servers and clients in case the servers are configured to run in 'ring' mode. In case this isn't configured, this block supports inheriting configuration from the common ring section.

13 nested properties
kvstore object
5 nested properties
store string

Backend storage to use for the ring. Supported values are: consul, etcd, inmemory, memberlist, multi.

prefix string

The prefix for the keys in the store. Should end with a /.

consul object
etcd object
multi object
heartbeat_period string

Period at which to heartbeat to the ring. 0 = disabled.

heartbeat_timeout string

The heartbeat timeout after which compactors are considered unhealthy within the ring. 0 = never (timeout disabled).

tokens_file_path string

File path where tokens are stored. If empty, tokens are not stored at shutdown and restored at startup.

zone_awareness_enabled boolean

True to enable zone-awareness and replicate blocks across different availability zones.

num_tokens
replication_factor integer

Deprecated: How many index gateway instances are assigned to each tenant. Use -index-gateway.shard-size instead. The shard size is also a per-tenant setting. Default: 3.

instance_id string

Instance ID to register in the ring.

instance_interface_names array | null

Name of network interface to read address from.

instance_port integer

Port to advertise in the ring (defaults to server.grpc-listen-port). Default: 0.

instance_addr string

IP address to advertise in the ring.

instance_availability_zone string

The availability zone where this instance is running. Required if zone-awareness is enabled.

instance_enable_ipv6 boolean

Enable using a IPv6 instance address.

bloom_compactor object
11 nested properties
ring object

Defines the ring to be used by the bloom-compactor servers. In case this isn't configured, this block supports inheriting configuration from the common ring section.

13 nested properties
kvstore object
5 nested properties
store string

Backend storage to use for the ring. Supported values are: consul, etcd, inmemory, memberlist, multi.

prefix string

The prefix for the keys in the store. Should end with a /.

consul object
etcd object
multi object
heartbeat_period string

Period at which to heartbeat to the ring. 0 = disabled.

heartbeat_timeout string

The heartbeat timeout after which compactors are considered unhealthy within the ring. 0 = never (timeout disabled).

tokens_file_path string

File path where tokens are stored. If empty, tokens are not stored at shutdown and restored at startup.

zone_awareness_enabled boolean

True to enable zone-awareness and replicate blocks across different availability zones.

num_tokens integer

Number of tokens to use in the ring per compactor. Higher number of tokens will result in more and smaller files (metas and blocks.). Default: 10.

replication_factor
instance_id string

Instance ID to register in the ring.

instance_interface_names array | null

Name of network interface to read address from.

instance_port integer

Port to advertise in the ring (defaults to server.grpc-listen-port). Default: 0.

instance_addr string

IP address to advertise in the ring.

instance_availability_zone string

The availability zone where this instance is running. Required if zone-awareness is enabled.

instance_enable_ipv6 boolean

Enable using a IPv6 instance address.

enabled boolean

Flag to enable or disable the usage of the bloom-compactor component.

compaction_interval string

Interval at which to re-run the compaction operation.

min_table_offset integer

Newest day-table offset (from today, inclusive) to compact. Increase to lower cost by not re-writing data to object storage too frequently since recent data changes more often at the cost of not having blooms available as quickly. Default: 1.

max_table_offset integer

Oldest day-table offset (from today, inclusive) to compact. This can be used to lower cost by not trying to compact older data which doesn't change. This can be optimized by aligning it with the maximum reject_old_samples_max_age setting of any tenant. Default: 2.

worker_parallelism integer

Number of workers to run in parallel for compaction. Default: 1.

compaction_retries_min_backoff string

Minimum backoff time between retries.

compaction_retries_max_backoff string

Maximum backoff time between retries.

compaction_retries integer

Number of retries to perform when compaction fails. Default: 3.

max_compaction_parallelism integer

Maximum number of tables to compact in parallel. While increasing this value, please make sure compactor has enough disk space allocated to be able to store and compact as many tables. Default: 1.

retention object
2 nested properties
enabled boolean

Enable bloom retention.

max_lookback_days integer

Max lookback days for retention. Default: 365.

bloom_gateway object
6 nested properties
enabled boolean

Flag to enable or disable the bloom gateway component globally.

client object
5 nested properties
pool_config object

Configures the behavior of the connection pool.

3 nested properties
check_interval string

How frequently to clean up clients for servers that have gone away or are unhealthy.

enable_health_check boolean

Run a health check on each server during periodic cleanup.

health_check_timeout string

Timeout for the health check if health check is enabled.

grpc_client_config object
20 nested properties
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

results_cache object
2 nested properties
cache object
compression string

Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.

cache_results boolean

Flag to control whether to cache bloom gateway client requests/responses.

addresses string
worker_concurrency integer

Number of workers to use for filtering chunks concurrently. Usually set to 1x number of CPU cores. Default: 4.

block_query_concurrency integer

Number of blocks processed concurrently on a single worker. Usually set to 2x number of CPU cores. Default: 8.

max_outstanding_per_tenant integer

Maximum number of outstanding tasks per tenant. Default: 1024.

num_multiplex_tasks integer

How many tasks are multiplexed at once. Default: 512.

storage_config object
24 nested properties
alibabacloud object
4 nested properties
bucket string

Name of OSS bucket.

endpoint string

oss Endpoint to connect to.

access_key_id string

alibabacloud Access Key ID

secret_access_key string

alibabacloud Secret Access Key

aws object
15 nested properties
dynamodb object

Deprecated: Configures storing indexes in DynamoDB.

8 nested properties
dynamodb_url string

DynamoDB endpoint URL with escaped Key and Secret encoded. If only region is specified as a host, proper endpoint will be deduced. Use inmemory:/// to use a mock in-memory implementation.

api_limit number

DynamoDB table management requests per second limit. Default: 2.

throttle_limit number

DynamoDB rate cap to back off when throttled. Default: 10.

metrics object
chunk_gang_size integer

Number of chunks to group together to parallelise fetches (zero to disable). Default: 10.

chunk_get_max_parallelism integer

Max number of chunk-get operations to start in parallel. Default: 32.

backoff_config object
kms_key_id string

KMS key used for encrypting DynamoDB items. DynamoDB will use an Amazon owned KMS key if not provided.

s3 string

S3 endpoint URL with escaped Key and Secret encoded. If only region is specified as a host, proper endpoint will be deduced. Use inmemory:/// to use a mock in-memory implementation.

s3forcepathstyle boolean

Set this to true to force the request to use path-style addressing.

bucketnames string

Comma separated list of bucket names to evenly distribute chunks over. Overrides any buckets specified in s3.url flag

endpoint string

S3 Endpoint to connect to.

region string

AWS region to use.

access_key_id string

AWS Access Key ID

secret_access_key string

AWS Secret Access Key

session_token string

AWS Session Token

insecure boolean

Disable https on s3 connection.

http_config object
5 nested properties
timeout string

Timeout specifies a time limit for requests made by s3 Client.

idle_conn_timeout string

The maximum amount of time an idle connection will be held open.

response_header_timeout string

If non-zero, specifies the amount of time to wait for a server's response headers after fully writing the request.

insecure_skip_verify boolean

Set to true to skip verifying the certificate chain and hostname.

ca_file string

Path to the trusted CA file that signed the SSL certificate of the S3 endpoint.

signature_version string

The signature version to use for authenticating against S3. Supported values are: v4.

storage_class string

The S3 storage class which objects will use. Supported values are: GLACIER, DEEP_ARCHIVE, GLACIER_IR, INTELLIGENT_TIERING, ONEZONE_IA, OUTPOSTS, REDUCED_REDUNDANCY, STANDARD, STANDARD_IA.

sse object
3 nested properties
type string

Enable AWS Server Side Encryption. Supported values: SSE-KMS, SSE-S3.

kms_key_id string

KMS Key ID used to encrypt objects in S3

kms_encryption_context string

KMS Encryption Context used for object encryption. It expects JSON formatted string.

backoff_config object

Configures back off when S3 get Object.

3 nested properties
min_period string

Minimum backoff time when s3 get Object

max_period string

Maximum backoff time when s3 get Object

max_retries integer

Maximum number of times to retry when s3 get Object. Default: 5.

azure object
21 nested properties
environment string

Azure Cloud environment. Supported values are: AzureGlobal, AzureChinaCloud, AzureGermanCloud, AzureUSGovernment.

account_name string

Azure storage account name.

account_key string

Azure storage account key.

connection_string string

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.

container_name string

Name of the storage account blob container used to store chunks. This container must be created before running cortex.

endpoint_suffix string

Azure storage endpoint suffix without schema. The storage account name will be prefixed to this value to create the FQDN.

use_managed_identity boolean

Use Managed Identity to authenticate to the Azure storage account.

use_federated_token boolean

Use Federated Token to authenticate to the Azure storage account.

user_assigned_id string

User assigned identity ID to authenticate to the Azure storage account.

use_service_principal boolean

Use Service Principal to authenticate through Azure OAuth.

client_id string

Azure Service Principal ID(GUID).

client_secret string

Azure Service Principal secret key.

tenant_id string

Azure Tenant ID is used to authenticate through Azure OAuth.

chunk_delimiter string

Chunk delimiter for blob ID to be used

download_buffer_size integer

Preallocated buffer size for downloads. Default: 512000.

upload_buffer_size integer

Preallocated buffer size for uploads. Default: 256000.

upload_buffer_count integer

Number of buffers used to used to upload a chunk. Default: 1.

request_timeout string

Timeout for requests made against azure blob storage.

max_retries integer

Number of retries for a request which times out. Default: 5.

min_retry_delay string

Minimum time to wait before retrying a request.

max_retry_delay string

Maximum time to wait before retrying a request.

bos object
4 nested properties
bucket_name string

Name of BOS bucket.

endpoint string

BOS endpoint to connect to.

access_key_id string

Baidu Cloud Engine (BCE) Access Key ID.

secret_access_key string

Baidu Cloud Engine (BCE) Secret Access Key.

bigtable object

Deprecated: Configures storing indexes in Bigtable. Required fields only required when bigtable is defined in config.

5 nested properties
project string

Bigtable project ID.

instance string

Bigtable instance ID. Please refer to https://cloud.google.com/docs/authentication/production for more information about how to configure authentication.

grpc_client_config object
20 nested properties
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

table_cache_enabled boolean

If enabled, once a tables info is fetched, it is cached.

table_cache_expiration string

Duration to cache tables before checking again.

gcs object
7 nested properties
bucket_name string

Name of GCS bucket. Please refer to https://cloud.google.com/docs/authentication/production for more information about how to configure authentication.

service_account string

Service account key content in JSON format, refer to https://cloud.google.com/iam/docs/creating-managing-service-account-keys for creation.

chunk_buffer_size integer

The size of the buffer that GCS client for each PUT request. 0 to disable buffering. Default: 0.

request_timeout string

The duration after which the requests to GCS should be timed out.

enable_opencensus boolean

Enable OpenCensus (OC) instrumentation for all requests.

enable_http2 boolean

Enable HTTP2 connections.

enable_retries boolean

Enable automatic retries of failed idempotent requests.

cassandra object

Deprecated: Configures storing chunks and/or the index in Cassandra.

27 nested properties
addresses string

Comma-separated hostnames or IPs of Cassandra instances.

port integer

Port that Cassandra is running on. Default: 9042.

keyspace string

Keyspace to use in Cassandra.

consistency string

Consistency level for Cassandra.

replication_factor integer

Replication factor to use in Cassandra. Default: 3.

disable_initial_host_lookup boolean

Instruct the cassandra driver to not attempt to get host info from the system.peers table.

SSL boolean

Use SSL when connecting to cassandra instances.

host_verification boolean

Require SSL certificate validation.

host_selection_policy string

Policy for selecting Cassandra host. Supported values are: round-robin, token-aware.

CA_path string

Path to certificate file to verify the peer.

tls_cert_path string

Path to certificate file used by TLS.

tls_key_path string

Path to private key file used by TLS.

auth boolean

Enable password authentication when connecting to cassandra.

username string

Username to use when connecting to cassandra.

password string

Password to use when connecting to cassandra.

password_file string

File containing password to use when connecting to cassandra.

custom_authenticators array | null

If set, when authenticating with cassandra a custom authenticator will be expected during the handshake. This flag can be set multiple times.

timeout string

Timeout when connecting to cassandra.

connect_timeout string

Initial connection timeout, used during initial dial to server.

reconnect_interval string

Interval to retry connecting to cassandra nodes marked as DOWN.

max_retries integer

Number of retries to perform on a request. Set to 0 to disable retries. Default: 0.

retry_max_backoff string

Maximum time to wait before retrying a failed request.

retry_min_backoff string

Minimum time to wait before retrying a failed request.

query_concurrency integer

Limit number of concurrent queries to Cassandra. Set to 0 to disable the limit. Default: 0.

num_connections integer

Number of TCP connections per host. Default: 2.

convict_hosts_on_failure boolean

Convict hosts of being down on failure.

table_options string

Table options used to create index or chunk tables. This value is used as plain text in the table WITH like this, "CREATE TABLE <generated_by_cortex> (...) WITH <cassandra.table-options>". For details, see https://cortexmetrics.io/docs/production/cassandra. By default it will use the default table options of your Cassandra cluster.

boltdb object

Deprecated: Configures storing index in BoltDB. Required fields only required when boltdb is present in the configuration.

1 nested properties
directory string

Location of BoltDB index files.

filesystem object
1 nested properties
directory string

Directory to store chunks in.

swift object
19 nested properties
auth_version integer

OpenStack Swift authentication API version. 0 to autodetect. Default: 0.

auth_url string

OpenStack Swift authentication URL

internal boolean

Set this to true to use the internal OpenStack Swift endpoint URL

username string

OpenStack Swift username.

user_domain_name string

OpenStack Swift user's domain name.

user_domain_id string

OpenStack Swift user's domain ID.

user_id string

OpenStack Swift user ID.

password string

OpenStack Swift API key.

domain_id string

OpenStack Swift user's domain ID.

domain_name string

OpenStack Swift user's domain name.

project_id string

OpenStack Swift project ID (v2,v3 auth only).

project_name string

OpenStack Swift project name (v2,v3 auth only).

project_domain_id string

ID of the OpenStack Swift project's domain (v3 auth only), only needed if it differs the from user domain.

project_domain_name string

Name of the OpenStack Swift project's domain (v3 auth only), only needed if it differs from the user domain.

region_name string

OpenStack Swift Region to use (v2,v3 auth only).

container_name string

Name of the OpenStack Swift container to put chunks in.

max_retries integer

Max retries on requests error. Default: 3.

connect_timeout string

Time after which a connection attempt is aborted.

request_timeout string

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.

grpc_store object

Deprecated:

1 nested properties
server_address string

Hostname or IP of the gRPC store instance.

hedging object
3 nested properties
at string

If set to a non-zero value a second request will be issued at the provided duration. Default is 0 (disabled)

up_to integer

The maximum of hedge requests allowed. Default: 2.

max_per_second integer

The maximum of hedge requests allowed per seconds. Default: 5.

named_stores object
8 nested properties
aws Record<string, object>
azure Record<string, object>
bos Record<string, object>
filesystem Record<string, object>
gcs Record<string, object>
alibabacloud Record<string, object>
swift Record<string, object>
cos Record<string, object>
cos object
14 nested properties
forcepathstyle boolean

Set this to true to force the request to use path-style addressing.

bucketnames string

Comma separated list of bucket names to evenly distribute chunks over.

endpoint string

COS Endpoint to connect to.

region string

COS region to use.

access_key_id string

COS HMAC Access Key ID.

secret_access_key string

COS HMAC Secret Access Key.

http_config object
2 nested properties
idle_conn_timeout string

The maximum amount of time an idle connection will be held open.

response_header_timeout string

If non-zero, specifies the amount of time to wait for a server's response headers after fully writing the request.

backoff_config object

Configures back off when cos get Object.

3 nested properties
min_period string

Minimum backoff time when cos get Object.

max_period string

Maximum backoff time when cos get Object.

max_retries integer

Maximum number of times to retry when cos get Object. Default: 5.

api_key string

IAM API key to access COS.

service_instance_id string

COS service instance id to use.

auth_endpoint string

IAM Auth Endpoint for authentication.

cr_token_file_path string

Compute resource token file path.

trusted_profile_name string

Name of the trusted profile.

trusted_profile_id string

ID of the trusted profile.

index_cache_validity string

Cache validity for active index entries. Should be no higher than -ingester.max-chunk-idle.

congestion_control object
4 nested properties
enabled boolean

Use storage congestion control (default: disabled).

controller object
2 nested properties
strategy string

Congestion control strategy to use (default: none, options: 'aimd').

aimd object
retry object
2 nested properties
strategy string

Congestion control retry strategy to use (default: none, options: 'limited').

limit integer

Maximum number of retries allowed. Default: 2.

hedging object
2 nested properties
config object
strategy string

Congestion control hedge strategy to use (default: none, options: 'limited').

object_prefix string

Experimental. Sets a constant prefix for all keys inserted into object storage. Example: loki/

index_queries_cache_config object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
3 nested properties
writeback_goroutines integer

At what concurrency to write back to cache. Default: 1.

writeback_buffer integer

How many key batches to buffer for background write-back. Default is large to prefer size based limiting. Default: 500000.

writeback_size_limit string

Size limit in bytes for background write-back. Default: 500MB.

memcached object
3 nested properties
expiration string

How long keys stay in the memcache.

batch_size integer

How many keys to fetch in each batch. Default: 4.

parallelism integer

Maximum active requests to memcache. Default: 5.

memcached_client object
19 nested properties
host string

Hostname for memcached service to use. If empty and if addresses is unset, no memcached will be used.

service string

SRV service used to discover memcache servers.

addresses string
timeout string

Maximum time to wait before giving up on memcached requests.

max_idle_conns integer

Maximum number of idle connections in pool. Default: 16.

max_item_size integer

The maximum size of an item stored in memcached. Bigger items are not stored. If set to 0, no maximum size is enforced. Default: 0.

update_interval string

Period with which to poll DNS for memcache servers.

consistent_hash boolean

Use consistent hashing to distribute to memcache servers.

circuit_breaker_consecutive_failures integer

Trip circuit-breaker after this number of consecutive dial failures (if zero then circuit-breaker is disabled). Default: 10.

circuit_breaker_timeout string

Duration circuit-breaker remains open after tripping (if zero then 60 seconds is used).

circuit_breaker_interval string

Reset circuit-breaker counts after this long (if zero then never reset).

tls_enabled boolean

Enable connecting to Memcached with TLS.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

redis object
13 nested properties
endpoint string

Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. If empty, no redis will be used.

master_name string

Redis Sentinel master name. An empty string for Redis Server or Redis Cluster.

timeout string

Maximum time to wait before giving up on redis requests.

expiration string

How long keys stay in the redis.

db integer

Database index. Default: 0.

pool_size integer

Maximum number of connections in the pool. Default: 0.

username string

Username to use when connecting to redis.

password string

Password to use when connecting to redis.

tls_enabled boolean

Enable connecting to redis with TLS.

tls_insecure_skip_verify boolean

Skip validating server certificate.

idle_timeout string

Close connections after remaining idle for this duration. If the value is zero, then idle connections are not closed.

max_connection_age string

Close connections older than this duration. If the value is zero, then the pool does not close connections based on age.

route_randomly boolean

By default, the Redis client only reads from the master node. Enabling this option can lower pressure on the master node by randomly routing read-only commands to the master and any available replicas.

embedded_cache object
4 nested properties
enabled boolean

Whether embedded cache is enabled.

max_size_mb integer

Maximum memory size of the cache in MB. Default: 100.

max_size_items integer

Maximum number of entries in the cache. Default: 0.

ttl string

The time to live for items in the cache before they get purged.

disable_broad_index_queries boolean

Disable broad index queries which results in reduced cache usage and faster query performance at the expense of somewhat higher QPS on the index store.

max_parallel_get_chunk integer

Maximum number of parallel chunk reads. Default: 150.

max_chunk_batch_size integer

The maximum number of chunks to fetch per batch. Default: 50.

boltdb_shipper object

Configures storing index in an Object Store (GCS/S3/Azure/Swift/COS/Filesystem) in the form of boltdb files. Required fields only required when boltdb-shipper is defined in config.

10 nested properties
active_index_directory string

Directory where ingesters would write index files which would then be uploaded by shipper to configured storage

cache_location string

Cache location for restoring index files from storage for queries

cache_ttl string

TTL for index files restored in cache for queries

resync_interval string

Resync downloaded files with the storage

query_ready_num_days integer

Number of days of common index to be kept downloaded for queries. For per tenant index query readiness, use limits overrides config. Default: 0.

index_gateway_client object
3 nested properties
grpc_client_config object
server_address string

Hostname or IP of the Index Gateway gRPC server running in simple mode. Can also be prefixed with dns+, dnssrv+, or dnssrvnoa+ to resolve a DNS A record with multiple IP's, a DNS SRV record with a followup A record lookup, or a DNS SRV record without a followup A record lookup, respectively.

log_gateway_requests boolean

Whether requests sent to the gateway should be logged or not.

ingestername string
mode string
ingesterdbretainperiod string
build_per_tenant_index boolean

Build per tenant index files

tsdb_shipper object

Configures storing index in an Object Store (GCS/S3/Azure/Swift/COS/Filesystem) in a prometheus TSDB-like format. Required fields only required when TSDB is defined in config.

9 nested properties
active_index_directory string

Directory where ingesters would write index files which would then be uploaded by shipper to configured storage

cache_location string

Cache location for restoring index files from storage for queries

cache_ttl string

TTL for index files restored in cache for queries

resync_interval string

Resync downloaded files with the storage

query_ready_num_days integer

Number of days of common index to be kept downloaded for queries. For per tenant index query readiness, use limits overrides config. Default: 0.

index_gateway_client object
3 nested properties
grpc_client_config object
server_address string

Hostname or IP of the Index Gateway gRPC server running in simple mode. Can also be prefixed with dns+, dnssrv+, or dnssrvnoa+ to resolve a DNS A record with multiple IP's, a DNS SRV record with a followup A record lookup, or a DNS SRV record without a followup A record lookup, respectively.

log_gateway_requests boolean

Whether requests sent to the gateway should be logged or not.

ingestername string
mode string
ingesterdbretainperiod string
bloom_shipper object

Experimental: Configures the bloom shipper component, which contains the store abstraction to fetch bloom filters from and put them to object storage.

5 nested properties
working_directory string

Working directory to store downloaded bloom blocks. Supports multiple directories, separated by comma.

max_query_page_size string

Maximum size of bloom pages that should be queried. Larger pages than this limit are skipped when querying blooms to limit memory usage. Default: 64MiB.

download_parallelism integer

The amount of maximum concurrent bloom blocks downloads. Usually set to 2x number of CPU cores. Default: 8.

blocks_cache object
3 nested properties
soft_limit string

Cache for bloom blocks. Soft limit of the cache in bytes. Exceeding this limit will trigger evictions of least recently used items in the background. Default: 32GiB.

hard_limit string

Cache for bloom blocks. Hard limit of the cache in bytes. Exceeding this limit will block execution until soft limit is deceeded. Default: 64GiB.

ttl string

Cache for bloom blocks. The time to live for items in the cache before they get purged.

metas_cache object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
memcached object
memcached_client object
redis object
embedded_cache object
chunk_store_config object
5 nested properties
chunk_cache_config object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
3 nested properties
writeback_goroutines integer

At what concurrency to write back to cache. Default: 1.

writeback_buffer integer

How many key batches to buffer for background write-back. Default is large to prefer size based limiting. Default: 500000.

writeback_size_limit string

Size limit in bytes for background write-back. Default: 500MB.

memcached object
3 nested properties
expiration string

How long keys stay in the memcache.

batch_size integer

How many keys to fetch in each batch. Default: 4.

parallelism integer

Maximum active requests to memcache. Default: 5.

memcached_client object
19 nested properties
host string

Hostname for memcached service to use. If empty and if addresses is unset, no memcached will be used.

service string

SRV service used to discover memcache servers.

addresses string
timeout string

Maximum time to wait before giving up on memcached requests.

max_idle_conns integer

Maximum number of idle connections in pool. Default: 16.

max_item_size integer

The maximum size of an item stored in memcached. Bigger items are not stored. If set to 0, no maximum size is enforced. Default: 0.

update_interval string

Period with which to poll DNS for memcache servers.

consistent_hash boolean

Use consistent hashing to distribute to memcache servers.

circuit_breaker_consecutive_failures integer

Trip circuit-breaker after this number of consecutive dial failures (if zero then circuit-breaker is disabled). Default: 10.

circuit_breaker_timeout string

Duration circuit-breaker remains open after tripping (if zero then 60 seconds is used).

circuit_breaker_interval string

Reset circuit-breaker counts after this long (if zero then never reset).

tls_enabled boolean

Enable connecting to Memcached with TLS.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

redis object
13 nested properties
endpoint string

Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. If empty, no redis will be used.

master_name string

Redis Sentinel master name. An empty string for Redis Server or Redis Cluster.

timeout string

Maximum time to wait before giving up on redis requests.

expiration string

How long keys stay in the redis.

db integer

Database index. Default: 0.

pool_size integer

Maximum number of connections in the pool. Default: 0.

username string

Username to use when connecting to redis.

password string

Password to use when connecting to redis.

tls_enabled boolean

Enable connecting to redis with TLS.

tls_insecure_skip_verify boolean

Skip validating server certificate.

idle_timeout string

Close connections after remaining idle for this duration. If the value is zero, then idle connections are not closed.

max_connection_age string

Close connections older than this duration. If the value is zero, then the pool does not close connections based on age.

route_randomly boolean

By default, the Redis client only reads from the master node. Enabling this option can lower pressure on the master node by randomly routing read-only commands to the master and any available replicas.

embedded_cache object
4 nested properties
enabled boolean

Whether embedded cache is enabled.

max_size_mb integer

Maximum memory size of the cache in MB. Default: 100.

max_size_items integer

Maximum number of entries in the cache. Default: 0.

ttl string

The time to live for items in the cache before they get purged.

chunk_cache_config_l2 object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
3 nested properties
writeback_goroutines integer

At what concurrency to write back to cache. Default: 1.

writeback_buffer integer

How many key batches to buffer for background write-back. Default is large to prefer size based limiting. Default: 500000.

writeback_size_limit string

Size limit in bytes for background write-back. Default: 500MB.

memcached object
3 nested properties
expiration string

How long keys stay in the memcache.

batch_size integer

How many keys to fetch in each batch. Default: 4.

parallelism integer

Maximum active requests to memcache. Default: 5.

memcached_client object
19 nested properties
host string

Hostname for memcached service to use. If empty and if addresses is unset, no memcached will be used.

service string

SRV service used to discover memcache servers.

addresses string
timeout string

Maximum time to wait before giving up on memcached requests.

max_idle_conns integer

Maximum number of idle connections in pool. Default: 16.

max_item_size integer

The maximum size of an item stored in memcached. Bigger items are not stored. If set to 0, no maximum size is enforced. Default: 0.

update_interval string

Period with which to poll DNS for memcache servers.

consistent_hash boolean

Use consistent hashing to distribute to memcache servers.

circuit_breaker_consecutive_failures integer

Trip circuit-breaker after this number of consecutive dial failures (if zero then circuit-breaker is disabled). Default: 10.

circuit_breaker_timeout string

Duration circuit-breaker remains open after tripping (if zero then 60 seconds is used).

circuit_breaker_interval string

Reset circuit-breaker counts after this long (if zero then never reset).

tls_enabled boolean

Enable connecting to Memcached with TLS.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

redis object
13 nested properties
endpoint string

Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. If empty, no redis will be used.

master_name string

Redis Sentinel master name. An empty string for Redis Server or Redis Cluster.

timeout string

Maximum time to wait before giving up on redis requests.

expiration string

How long keys stay in the redis.

db integer

Database index. Default: 0.

pool_size integer

Maximum number of connections in the pool. Default: 0.

username string

Username to use when connecting to redis.

password string

Password to use when connecting to redis.

tls_enabled boolean

Enable connecting to redis with TLS.

tls_insecure_skip_verify boolean

Skip validating server certificate.

idle_timeout string

Close connections after remaining idle for this duration. If the value is zero, then idle connections are not closed.

max_connection_age string

Close connections older than this duration. If the value is zero, then the pool does not close connections based on age.

route_randomly boolean

By default, the Redis client only reads from the master node. Enabling this option can lower pressure on the master node by randomly routing read-only commands to the master and any available replicas.

embedded_cache object
4 nested properties
enabled boolean

Whether embedded cache is enabled.

max_size_mb integer

Maximum memory size of the cache in MB. Default: 100.

max_size_items integer

Maximum number of entries in the cache. Default: 0.

ttl string

The time to live for items in the cache before they get purged.

write_dedupe_cache_config object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
3 nested properties
writeback_goroutines integer

At what concurrency to write back to cache. Default: 1.

writeback_buffer integer

How many key batches to buffer for background write-back. Default is large to prefer size based limiting. Default: 500000.

writeback_size_limit string

Size limit in bytes for background write-back. Default: 500MB.

memcached object
3 nested properties
expiration string

How long keys stay in the memcache.

batch_size integer

How many keys to fetch in each batch. Default: 4.

parallelism integer

Maximum active requests to memcache. Default: 5.

memcached_client object
19 nested properties
host string

Hostname for memcached service to use. If empty and if addresses is unset, no memcached will be used.

service string

SRV service used to discover memcache servers.

addresses string
timeout string

Maximum time to wait before giving up on memcached requests.

max_idle_conns integer

Maximum number of idle connections in pool. Default: 16.

max_item_size integer

The maximum size of an item stored in memcached. Bigger items are not stored. If set to 0, no maximum size is enforced. Default: 0.

update_interval string

Period with which to poll DNS for memcache servers.

consistent_hash boolean

Use consistent hashing to distribute to memcache servers.

circuit_breaker_consecutive_failures integer

Trip circuit-breaker after this number of consecutive dial failures (if zero then circuit-breaker is disabled). Default: 10.

circuit_breaker_timeout string

Duration circuit-breaker remains open after tripping (if zero then 60 seconds is used).

circuit_breaker_interval string

Reset circuit-breaker counts after this long (if zero then never reset).

tls_enabled boolean

Enable connecting to Memcached with TLS.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

redis object
13 nested properties
endpoint string

Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. If empty, no redis will be used.

master_name string

Redis Sentinel master name. An empty string for Redis Server or Redis Cluster.

timeout string

Maximum time to wait before giving up on redis requests.

expiration string

How long keys stay in the redis.

db integer

Database index. Default: 0.

pool_size integer

Maximum number of connections in the pool. Default: 0.

username string

Username to use when connecting to redis.

password string

Password to use when connecting to redis.

tls_enabled boolean

Enable connecting to redis with TLS.

tls_insecure_skip_verify boolean

Skip validating server certificate.

idle_timeout string

Close connections after remaining idle for this duration. If the value is zero, then idle connections are not closed.

max_connection_age string

Close connections older than this duration. If the value is zero, then the pool does not close connections based on age.

route_randomly boolean

By default, the Redis client only reads from the master node. Enabling this option can lower pressure on the master node by randomly routing read-only commands to the master and any available replicas.

embedded_cache object
4 nested properties
enabled boolean

Whether embedded cache is enabled.

max_size_mb integer

Maximum memory size of the cache in MB. Default: 100.

max_size_items integer

Maximum number of entries in the cache. Default: 0.

ttl string

The time to live for items in the cache before they get purged.

l2_chunk_cache_handoff string

Chunks will be handed off to the L2 cache after this duration. 0 to disable L2 cache.

cache_lookups_older_than string

Cache index entries older than this period. 0 to disable.

schema_config object
1 nested properties
configs array | null
compactor object
17 nested properties
working_directory string

Directory where files can be downloaded for compaction.

compaction_interval string

Interval at which to re-run the compaction operation.

apply_retention_interval string

Interval at which to apply/enforce retention. 0 means run at same interval as compaction. If non-zero, it should always be a multiple of compaction interval.

retention_enabled boolean

Activate custom (per-stream,per-tenant) retention.

retention_delete_delay string

Delay after which chunks will be fully deleted during retention.

retention_delete_worker_count integer

The total amount of worker to use to delete chunks. Default: 150.

retention_table_timeout string

The maximum amount of time to spend running retention and deletion on any given table in the index.

delete_request_store string

Store used for managing delete requests.

delete_request_store_key_prefix string

Path prefix for storing delete requests.

delete_batch_size integer

The max number of delete requests to run per compaction cycle. Default: 70.

delete_request_cancel_period string

Allow cancellation of delete request until duration after they are created. Data would be deleted only after delete requests have been older than this duration. Ideally this should be set to at least 24h.

delete_max_interval string

Constrain the size of any single delete request with line filters. When a delete request > delete_max_interval is input, the request is sharded into smaller requests of no more than delete_max_interval

max_compaction_parallelism integer

Maximum number of tables to compact in parallel. While increasing this value, please make sure compactor has enough disk space allocated to be able to store and compact as many tables. Default: 1.

upload_parallelism integer

Number of upload/remove operations to execute in parallel when finalizing a compaction. NOTE: This setting is per compaction operation, which can be executed in parallel. The upper bound on the number of concurrent uploads is upload_parallelism * max_compaction_parallelism. Default: 10.

compactor_ring object

The hash ring configuration used by compactors to elect a single instance for running compactions. The CLI flags prefix for this block config is: compactor.ring

13 nested properties
kvstore object
5 nested properties
store string

Backend storage to use for the ring. Supported values are: consul, etcd, inmemory, memberlist, multi.

prefix string

The prefix for the keys in the store. Should end with a /.

consul object
etcd object
multi object
heartbeat_period string

Period at which to heartbeat to the ring. 0 = disabled.

heartbeat_timeout string

The heartbeat timeout after which compactors are considered unhealthy within the ring. 0 = never (timeout disabled).

tokens_file_path string

File path where tokens are stored. If empty, tokens are not stored at shutdown and restored at startup.

zone_awareness_enabled boolean

True to enable zone-awareness and replicate blocks across different availability zones.

num_tokens
replication_factor
instance_id string

Instance ID to register in the ring.

instance_interface_names array | null

Name of network interface to read address from.

instance_port integer

Port to advertise in the ring (defaults to server.grpc-listen-port). Default: 0.

instance_addr string

IP address to advertise in the ring.

instance_availability_zone string

The availability zone where this instance is running. Required if zone-awareness is enabled.

instance_enable_ipv6 boolean

Enable using a IPv6 instance address.

tables_to_compact integer

Number of tables that compactor will try to compact. Newer tables are chosen when this is less than the number of tables available. Default: 0.

skip_latest_n_tables integer

Do not compact N latest tables. Together with -compactor.run-once and -compactor.tables-to-compact, this is useful when clearing compactor backlogs. Default: 0.

compactor_grpc_client object
20 nested properties
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
3 nested properties
min_period string

Minimum delay when backing off.

max_period string

Maximum delay when backing off.

max_retries integer

Number of times to backoff and retry before failing. Default: 10.

initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

limits_config object
96 nested properties
ingestion_rate_strategy string

Whether the ingestion rate limit should be applied individually to each distributor instance (local), or evenly shared across the cluster (global). The ingestion rate strategy cannot be overridden on a per-tenant basis.

  • local: enforces the limit on a per distributor basis. The actual effective rate limit will be N times higher, where N is the number of distributor replicas.
  • global: enforces the limit globally, configuring a per-distributor local rate limiter as 'ingestion_rate / N', where N is the number of distributor replicas (it's automatically adjusted if the number of replicas change). The global strategy requires the distributors to form their own ring, which is used to keep track of the current number of healthy distributor replicas.
ingestion_rate_mb number

Per-user ingestion rate limit in sample size per second. Units in MB. Default: 4.

ingestion_burst_size_mb number

Per-user allowed ingestion burst size (in sample size). Units in MB. The burst size refers to the per-distributor local rate limiter even in the case of the 'global' strategy, and should be set at least to the maximum logs size expected in a single push request. Default: 6.

max_label_name_length integer

Maximum length accepted for label names. Default: 1024.

max_label_value_length integer

Maximum length accepted for label value. This setting also applies to the metric name. Default: 2048.

max_label_names_per_series integer

Maximum number of label names per series. Default: 15.

reject_old_samples boolean

Whether or not old samples will be rejected.

reject_old_samples_max_age string

Maximum accepted sample age before rejecting.

creation_grace_period string

Duration which table will be created/deleted before/after it's needed; we won't accept sample from before this time.

max_line_size string

Maximum line size on ingestion path. Example: 256kb. Any log line exceeding this limit will be discarded unless distributor.max-line-size-truncate is set which in case it is truncated instead of discarding it completely. There is no limit when unset or set to 0. Default: 256KB.

max_line_size_truncate boolean

Whether to truncate lines that exceed max_line_size.

increment_duplicate_timestamp boolean

Alter the log line timestamp during ingestion when the timestamp is the same as the previous entry for the same stream. When enabled, if a log line in a push request has the same timestamp as the previous line for the same stream, one nanosecond is added to the log line. This will preserve the received order of log lines with the exact same timestamp when they are queried, by slightly altering their stored timestamp. NOTE: This is imperfect, because Loki accepts out of order writes, and another push request for the same stream could contain duplicate timestamps to existing entries and they will not be incremented.

discover_service_name array | null

If no service_name label exists, Loki maps a single label from the configured list to service_name. If none of the configured labels exist in the stream, label is set to unknown_service. Empty list disables setting the label.

discover_log_levels boolean

Discover and add log levels during ingestion, if not present already. Levels would be added to Structured Metadata with name 'level' and one of the values from 'debug', 'info', 'warn', 'error', 'critical', 'fatal'.

max_streams_per_user integer

Maximum number of active streams per user, per ingester. 0 to disable. Default: 0.

max_global_streams_per_user integer

Maximum number of active streams per user, across the cluster. 0 to disable. When the global limit is enabled, each ingester is configured with a dynamic local limit based on the replication factor and the current number of healthy ingesters, and is kept updated whenever the number of ingesters change. Default: 5000.

unordered_writes boolean

Deprecated. When true, out-of-order writes are accepted.

per_stream_rate_limit string

Maximum byte rate per second per stream, also expressible in human readable forms (1MB, 256KB, etc). Default: 3MB.

per_stream_rate_limit_burst string

Maximum burst bytes per stream, also expressible in human readable forms (1MB, 256KB, etc). This is how far above the rate limit a stream can 'burst' before the stream is limited. Default: 15MB.

max_chunks_per_query integer

Maximum number of chunks that can be fetched in a single query. Default: 2000000.

max_query_series integer

Limit the maximum of unique series that is returned by a metric query. When the limit is reached an error is returned. Default: 500.

max_query_lookback string

Limit how far back in time series data and metadata can be queried, up until lookback duration ago. This limit is enforced in the query frontend, the querier and the ruler. If the requested time range is outside the allowed range, the request will not fail, but will be modified to only query data within the allowed time range. The default value of 0 does not set a limit.

max_query_length string

The limit to length of chunk store queries. 0 to disable.

max_query_range string

Limit the length of the [range] inside a range query. Default is 0 or unlimited

max_query_parallelism integer

Maximum number of queries that will be scheduled in parallel by the frontend. Default: 32.

tsdb_max_query_parallelism integer

Maximum number of queries will be scheduled in parallel by the frontend for TSDB schemas. Default: 128.

tsdb_max_bytes_per_shard string

Target maximum number of bytes assigned to a single sharded query. Also expressible in human readable forms (1GB, etc). Note: This is a target and not an absolute limit. The actual limit can be higher, but the query planner will try to build shards up to this limit. Default: 600MB.

tsdb_sharding_strategy string

sharding strategy to use in query planning. Suggested to use bounded once all nodes can recognize it.

cardinality_limit integer

Cardinality limit for index queries. Default: 100000.

max_streams_matchers_per_query integer

Maximum number of stream matchers per query. Default: 1000.

max_concurrent_tail_requests integer

Maximum number of concurrent tail requests. Default: 10.

max_entries_limit_per_query integer

Maximum number of log entries that will be returned for a query. Default: 5000.

max_cache_freshness_per_query string

Most recent allowed cacheable result per-tenant, to prevent caching very recent results that might still be in flux.

max_metadata_cache_freshness string

Do not cache metadata request if the end time is within the frontend.max-metadata-cache-freshness window. Set this to 0 to apply no such limits. Defaults to 24h.

max_stats_cache_freshness string

Do not cache requests with an end time that falls within Now minus this duration. 0 disables this feature (default).

max_queriers_per_tenant integer

Maximum number of queriers that can handle requests for a single tenant. If set to 0 or value higher than number of available queriers, all queriers will handle requests for the tenant. Each frontend (or query-scheduler, if used) will select the same set of queriers for the same tenant (given that all queriers are connected to all frontends / query-schedulers). This option only works with queriers connecting to the query-frontend / query-scheduler, not when using downstream URL. Default: 0.

max_query_capacity number

How much of the available query capacity ("querier" components in distributed mode, "read" components in SSD mode) can be used by a single tenant. Allowed values are 0.0 to 1.0. For example, setting this to 0.5 would allow a tenant to use half of the available queriers for processing the query workload. If set to 0, query capacity is determined by frontend.max-queriers-per-tenant. When both frontend.max-queriers-per-tenant and frontend.max-query-capacity are configured, smaller value of the resulting querier replica count is considered: min(frontend.max-queriers-per-tenant, ceil(querier_replicas * frontend.max-query-capacity)). All queriers will handle requests for the tenant if neither limits are applied. This option only works with queriers connecting to the query-frontend / query-scheduler, not when using downstream URL. Use this feature in a multi-tenant setup where you need to limit query capacity for certain tenants. Default: 0.

query_ready_index_num_days integer

Number of days of index to be kept always downloaded for queries. Applies only to per user index in boltdb-shipper index store. 0 to disable. Default: 0.

query_timeout string

Timeout when querying backends (ingesters or storage) during the execution of a query request. When a specific per-tenant timeout is used, the global timeout is ignored.

split_queries_by_interval string

Split queries by a time interval and execute in parallel. The value 0 disables splitting by time. This also determines how cache keys are chosen when result caching is enabled.

split_metadata_queries_by_interval string

Split metadata queries by a time interval and execute in parallel. The value 0 disables splitting metadata queries by time. This also determines how cache keys are chosen when label/series result caching is enabled.

split_recent_metadata_queries_by_interval string

Experimental. Split interval to use for the portion of metadata request that falls within recent_metadata_query_window. Rest of the request which is outside the window still uses split_metadata_queries_by_interval. If set to 0, the entire request defaults to using a split interval of split_metadata_queries_by_interval..

recent_metadata_query_window string

Experimental. Metadata query window inside which split_recent_metadata_queries_by_interval gets applied, portion of the metadata request that falls in this window is split using split_recent_metadata_queries_by_interval. The value 0 disables using a different split interval for recent metadata queries.

This is added to improve cacheability of recent metadata queries. Query split interval also determines the interval used in cache key. The default split interval of 24h is useful for caching long queries, each cache key holding 1 day's results. But metadata queries are often shorter than 24h, to cache them effectively we need a smaller split interval. recent_metadata_query_window along with split_recent_metadata_queries_by_interval help configure a shorter split interval for recent metadata queries.

split_instant_metric_queries_by_interval string

Split instant metric queries by a time interval and execute in parallel. The value 0 disables splitting instant metric queries by time. This also determines how cache keys are chosen when instant metric query result caching is enabled.

split_ingester_queries_by_interval string

Interval to use for time-based splitting when a request is within the query_ingesters_within window; defaults to split-queries-by-interval by setting to 0.

min_sharding_lookback string

Limit queries that can be sharded. Queries within the time range of now and now minus this sharding lookback are not sharded. The default value of 0s disables the lookback, causing sharding of all queries at all times.

max_query_bytes_read string

Max number of bytes a query can fetch. Enforced in log and metric queries only when TSDB is used. The default value of 0 disables this limit. Default: 0B.

max_querier_bytes_read string

Max number of bytes a query can fetch after splitting and sharding. Enforced in log and metric queries only when TSDB is used. The default value of 0 disables this limit. Default: 150GB.

volume_enabled boolean

Enable log-volume endpoints.

volume_max_series integer

The maximum number of aggregated series in a log-volume response. Default: 1000.

ruler_max_rules_per_rule_group integer

Maximum number of rules per rule group per-tenant. 0 to disable. Default: 0.

ruler_max_rule_groups_per_tenant integer

Maximum number of rule groups per-tenant. 0 to disable. Default: 0.

ruler_tenant_shard_size integer

The default tenant's shard size when shuffle-sharding is enabled in the ruler. When this setting is specified in the per-tenant overrides, a value of 0 disables shuffle sharding for the tenant. Default: 0.

ruler_remote_write_disabled boolean

Disable recording rules remote-write.

ruler_remote_write_url string

Deprecated: Use 'ruler_remote_write_config' instead. The URL of the endpoint to send samples to.

ruler_remote_write_timeout string

Deprecated: Use 'ruler_remote_write_config' instead. Timeout for requests to the remote write endpoint.

ruler_remote_write_headers object

Deprecated: Use 'ruler_remote_write_config' instead. Custom HTTP headers to be sent along with each remote write request. Be aware that headers that are set by Loki itself can't be overwritten.

ruler_remote_write_relabel_configs array | null

Deprecated: Use 'ruler_remote_write_config' instead. List of remote write relabel configurations.

ruler_remote_write_queue_capacity integer

Deprecated: Use 'ruler_remote_write_config' instead. Number of samples to buffer per shard before we block reading of more samples from the WAL. It is recommended to have enough capacity in each shard to buffer several requests to keep throughput up while processing occasional slow remote requests.

ruler_remote_write_queue_min_shards integer

Deprecated: Use 'ruler_remote_write_config' instead. Minimum number of shards, i.e. amount of concurrency.

ruler_remote_write_queue_max_shards integer

Deprecated: Use 'ruler_remote_write_config' instead. Maximum number of shards, i.e. amount of concurrency.

ruler_remote_write_queue_max_samples_per_send integer

Deprecated: Use 'ruler_remote_write_config' instead. Maximum number of samples per send.

ruler_remote_write_queue_batch_send_deadline string

Deprecated: Use 'ruler_remote_write_config' instead. Maximum time a sample will wait in buffer.

ruler_remote_write_queue_min_backoff string

Deprecated: Use 'ruler_remote_write_config' instead. Initial retry delay. Gets doubled for every retry.

ruler_remote_write_queue_max_backoff string

Deprecated: Use 'ruler_remote_write_config' instead. Maximum retry delay.

ruler_remote_write_queue_retry_on_ratelimit boolean

Deprecated: Use 'ruler_remote_write_config' instead. Retry upon receiving a 429 status code from the remote-write storage. This is experimental and might change in the future.

ruler_remote_write_sigv4_config object

Deprecated: Use 'ruler_remote_write_config' instead. Configures AWS's Signature Verification 4 signing process to sign every remote write request.

5 nested properties
region string
access_key string
secret_key string
profile string
role_arn string
ruler_remote_write_config Record<string, object>

Configures global and per-tenant limits for remote write clients. A map with remote client id as key.

ruler_remote_evaluation_timeout string

Timeout for a remote rule evaluation. Defaults to the value of 'querier.query-timeout'.

ruler_remote_evaluation_max_response_size integer

Maximum size (in bytes) of the allowable response size from a remote rule evaluation. Set to 0 to allow any response size (default).

deletion_mode string

Deletion mode. Can be one of 'disabled', 'filter-only', or 'filter-and-delete'. When set to 'filter-only' or 'filter-and-delete', and if retention_enabled is true, then the log entry deletion API endpoints are available.

retention_period string

Retention period to apply to stored data, only applies if retention_enabled is true in the compactor config. As of version 2.8.0, a zero value of 0 or 0s disables retention. In previous releases, Loki did not properly honor a zero value to disable retention and a really large value should be used instead.

retention_stream array | null

Per-stream retention to apply, if the retention is enable on the compactor side. Example: retention_stream:

  • selector: '{namespace="dev"}' priority: 1 period: 24h
  • selector: '{container="nginx"}' priority: 1 period: 744h Selector is a Prometheus labels matchers that will apply the 'period' retention only if the stream is matching. In case multiple stream are matching, the highest priority will be picked. If no rule is matched the 'retention_period' is used.
per_tenant_override_config string

Feature renamed to 'runtime configuration', flag deprecated in favor of -runtime-config.file (runtime_config.file in YAML).

per_tenant_override_period string

Feature renamed to 'runtime configuration'; flag deprecated in favor of -runtime-config.reload-period (runtime_config.period in YAML).

allow_deletes boolean

Deprecated: Use deletion_mode per tenant configuration instead.

shard_streams object
3 nested properties
enabled boolean
logging_enabled boolean
desired_rate integer
blocked_queries array | null
required_labels array | null

Define a list of required selector labels.

minimum_labels_number integer

Minimum number of label matchers a query should contain.

index_gateway_shard_size integer

The shard size defines how many index gateways should be used by a tenant for querying. If the global shard factor is 0, the global shard factor is set to the deprecated -replication-factor for backwards compatibility reasons. Default: 0.

bloom_gateway_shard_size integer

Experimental. The shard size defines how many bloom gateways should be used by a tenant for querying. Default: 0.

bloom_gateway_enable_filtering boolean

Experimental. Whether to use the bloom gateway component in the read path to filter chunks.

bloom_gateway_cache_key_interval string

Experimental. Interval for computing the cache key in the Bloom Gateway.

bloom_compactor_shard_size integer

Experimental. The shard size defines how many bloom compactors should be used by a tenant when computing blooms. If it's set to 0, shuffle sharding is disabled. Default: 0.

bloom_compactor_enable_compaction boolean

Experimental. Whether to compact chunks into bloom filters.

bloom_compactor_max_block_size string

Experimental. The maximum bloom block size. A value of 0 sets an unlimited size. Default is 200MB. The actual block size might exceed this limit since blooms will be added to blocks until the block exceeds the maximum block size. Default: 200MB.

bloom_compactor_max_bloom_size string

Experimental. The maximum bloom size per log stream. A log stream whose generated bloom filter exceeds this size will be discarded. A value of 0 sets an unlimited size. Default is 128MB. Default: 128MB.

bloom_ngram_length integer

Experimental. Length of the n-grams created when computing blooms from log lines. Default: 4.

bloom_ngram_skip integer

Experimental. Skip factor for the n-grams created when computing blooms from log lines. Default: 1.

bloom_false_positive_rate number

Experimental. Scalable Bloom Filter desired false-positive rate. Default: 0.01.

bloom_block_encoding string

Experimental. Compression algorithm for bloom block pages.

allow_structured_metadata boolean

Allow user to send structured metadata in push payload.

max_structured_metadata_size string

Maximum size accepted for structured metadata per log line. Default: 64KB.

max_structured_metadata_entries_count integer

Maximum number of structured metadata entries per log line. Default: 128.

otlp_config object

OTLP log ingestion configurations

3 nested properties
resource_attributes object

Configuration for resource attributes to store them as index labels or Structured Metadata or drop them altogether

2 nested properties
ignore_defaults boolean

Configure whether to ignore the default list of resource attributes set in 'distributor.otlp.default_resource_attributes_as_index_labels' to be stored as index labels and only use the given resource attributes config

attributes_config array | null
scope_attributes array | null

Configuration for scope attributes to store them as Structured Metadata or drop them altogether

log_attributes array | null

Configuration for log attributes to store them as Structured Metadata or drop them altogether

frontend_worker object
5 nested properties
frontend_address string

Address of query frontend service, in host:port format. If -querier.scheduler-address is set as well, querier will use scheduler instead. Only one of -querier.frontend-address or -querier.scheduler-address can be set. If neither is set, queries are only received via HTTP endpoint.

scheduler_address string

Hostname (and port) of scheduler that querier will periodically resolve, connect to and receive queries from. Only one of -querier.frontend-address or -querier.scheduler-address can be set. If neither is set, queries are only received via HTTP endpoint.

dns_lookup_duration string

How often to query DNS for query-frontend or query-scheduler address. Also used to determine how often to poll the scheduler-ring for addresses if the scheduler-ring is configured.

id string

Querier ID, sent to frontend service to identify requests from the same querier. Defaults to hostname.

grpc_client_config object
20 nested properties
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
3 nested properties
min_period string

Minimum delay when backing off.

max_period string

Maximum delay when backing off.

max_retries integer

Number of times to backoff and retry before failing. Default: 10.

initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

table_manager object
7 nested properties
throughput_updates_disabled boolean

If true, disable all changes to DB capacity

retention_deletes_enabled boolean

If true, enables retention deletes of DB tables

retention_period string

Tables older than this retention period are deleted. Must be either 0 (disabled) or a multiple of 24h. When enabled, be aware this setting is destructive to data!

poll_interval string

How frequently to poll backend to learn our capacity.

creation_grace_period string

Periodic tables grace period (duration which table will be created/deleted before/after it's needed).

index_tables_provisioning object
12 nested properties
enable_ondemand_throughput_mode boolean

Enables on demand throughput provisioning for the storage provider (if supported). Applies only to tables which are not autoscaled. Supported by DynamoDB

provisioned_write_throughput integer

Table default write throughput. Supported by DynamoDB. Default: 1000.

provisioned_read_throughput integer

Table default read throughput. Supported by DynamoDB. Default: 300.

write_scale object
7 nested properties
enabled boolean

Should we enable autoscale for the table.

role_arn string

AWS AutoScaling role ARN

min_capacity integer

DynamoDB minimum provision capacity. Default: 3000.

max_capacity integer

DynamoDB maximum provision capacity. Default: 6000.

out_cooldown integer

DynamoDB minimum seconds between each autoscale up. Default: 1800.

in_cooldown integer

DynamoDB minimum seconds between each autoscale down. Default: 1800.

target number

DynamoDB target ratio of consumed capacity to provisioned capacity. Default: 80.

read_scale object
7 nested properties
enabled boolean

Should we enable autoscale for the table.

role_arn string

AWS AutoScaling role ARN

min_capacity integer

DynamoDB minimum provision capacity. Default: 3000.

max_capacity integer

DynamoDB maximum provision capacity. Default: 6000.

out_cooldown integer

DynamoDB minimum seconds between each autoscale up. Default: 1800.

in_cooldown integer

DynamoDB minimum seconds between each autoscale down. Default: 1800.

target number

DynamoDB target ratio of consumed capacity to provisioned capacity. Default: 80.

enable_inactive_throughput_on_demand_mode boolean

Enables on demand throughput provisioning for the storage provider (if supported). Applies only to tables which are not autoscaled. Supported by DynamoDB

inactive_write_throughput integer

Table write throughput for inactive tables. Supported by DynamoDB. Default: 1.

inactive_read_throughput integer

Table read throughput for inactive tables. Supported by DynamoDB. Default: 300.

inactive_write_scale object
7 nested properties
enabled boolean

Should we enable autoscale for the table.

role_arn string

AWS AutoScaling role ARN

min_capacity integer

DynamoDB minimum provision capacity. Default: 3000.

max_capacity integer

DynamoDB maximum provision capacity. Default: 6000.

out_cooldown integer

DynamoDB minimum seconds between each autoscale up. Default: 1800.

in_cooldown integer

DynamoDB minimum seconds between each autoscale down. Default: 1800.

target number

DynamoDB target ratio of consumed capacity to provisioned capacity. Default: 80.

inactive_read_scale object
7 nested properties
enabled boolean

Should we enable autoscale for the table.

role_arn string

AWS AutoScaling role ARN

min_capacity integer

DynamoDB minimum provision capacity. Default: 3000.

max_capacity integer

DynamoDB maximum provision capacity. Default: 6000.

out_cooldown integer

DynamoDB minimum seconds between each autoscale up. Default: 1800.

in_cooldown integer

DynamoDB minimum seconds between each autoscale down. Default: 1800.

target number

DynamoDB target ratio of consumed capacity to provisioned capacity. Default: 80.

inactive_write_scale_lastn integer

Number of last inactive tables to enable write autoscale. Default: 4.

inactive_read_scale_lastn integer

Number of last inactive tables to enable read autoscale. Default: 4.

chunk_tables_provisioning object
12 nested properties
enable_ondemand_throughput_mode boolean

Enables on demand throughput provisioning for the storage provider (if supported). Applies only to tables which are not autoscaled. Supported by DynamoDB

provisioned_write_throughput integer

Table default write throughput. Supported by DynamoDB. Default: 1000.

provisioned_read_throughput integer

Table default read throughput. Supported by DynamoDB. Default: 300.

write_scale object
7 nested properties
enabled boolean

Should we enable autoscale for the table.

role_arn string

AWS AutoScaling role ARN

min_capacity integer

DynamoDB minimum provision capacity. Default: 3000.

max_capacity integer

DynamoDB maximum provision capacity. Default: 6000.

out_cooldown integer

DynamoDB minimum seconds between each autoscale up. Default: 1800.

in_cooldown integer

DynamoDB minimum seconds between each autoscale down. Default: 1800.

target number

DynamoDB target ratio of consumed capacity to provisioned capacity. Default: 80.

read_scale object
7 nested properties
enabled boolean

Should we enable autoscale for the table.

role_arn string

AWS AutoScaling role ARN

min_capacity integer

DynamoDB minimum provision capacity. Default: 3000.

max_capacity integer

DynamoDB maximum provision capacity. Default: 6000.

out_cooldown integer

DynamoDB minimum seconds between each autoscale up. Default: 1800.

in_cooldown integer

DynamoDB minimum seconds between each autoscale down. Default: 1800.

target number

DynamoDB target ratio of consumed capacity to provisioned capacity. Default: 80.

enable_inactive_throughput_on_demand_mode boolean

Enables on demand throughput provisioning for the storage provider (if supported). Applies only to tables which are not autoscaled. Supported by DynamoDB

inactive_write_throughput integer

Table write throughput for inactive tables. Supported by DynamoDB. Default: 1.

inactive_read_throughput integer

Table read throughput for inactive tables. Supported by DynamoDB. Default: 300.

inactive_write_scale object
7 nested properties
enabled boolean

Should we enable autoscale for the table.

role_arn string

AWS AutoScaling role ARN

min_capacity integer

DynamoDB minimum provision capacity. Default: 3000.

max_capacity integer

DynamoDB maximum provision capacity. Default: 6000.

out_cooldown integer

DynamoDB minimum seconds between each autoscale up. Default: 1800.

in_cooldown integer

DynamoDB minimum seconds between each autoscale down. Default: 1800.

target number

DynamoDB target ratio of consumed capacity to provisioned capacity. Default: 80.

inactive_read_scale object
7 nested properties
enabled boolean

Should we enable autoscale for the table.

role_arn string

AWS AutoScaling role ARN

min_capacity integer

DynamoDB minimum provision capacity. Default: 3000.

max_capacity integer

DynamoDB maximum provision capacity. Default: 6000.

out_cooldown integer

DynamoDB minimum seconds between each autoscale up. Default: 1800.

in_cooldown integer

DynamoDB minimum seconds between each autoscale down. Default: 1800.

target number

DynamoDB target ratio of consumed capacity to provisioned capacity. Default: 80.

inactive_write_scale_lastn integer

Number of last inactive tables to enable write autoscale. Default: 4.

inactive_read_scale_lastn integer

Number of last inactive tables to enable read autoscale. Default: 4.

memberlist object
35 nested properties
node_name string

Name of the node in memberlist cluster. Defaults to hostname.

randomize_node_name boolean

Add random suffix to the node name.

stream_timeout string

The timeout for establishing a connection with a remote node, and for read/write operations.

retransmit_factor integer

Multiplication factor used when sending out messages (factor * log(N+1)). Default: 4.

pull_push_interval string

How often to use pull/push sync.

gossip_interval string

How often to gossip.

gossip_nodes integer

How many nodes to gossip to. Default: 3.

gossip_to_dead_nodes_time string

How long to keep gossiping to dead nodes, to give them chance to refute their death.

dead_node_reclaim_time string

How soon can dead node's name be reclaimed with new address. 0 to disable.

compression_enabled boolean

Enable message compression. This can be used to reduce bandwidth usage at the cost of slightly more CPU utilization.

advertise_addr string

Gossip address to advertise to other members in the cluster. Used for NAT traversal.

advertise_port integer

Gossip port to advertise to other members in the cluster. Used for NAT traversal. Default: 7946.

cluster_label string

The cluster label is an optional string to include in outbound packets and gossip streams. Other members in the memberlist cluster will discard any message whose label doesn't match the configured one, unless the 'cluster-label-verification-disabled' configuration option is set to true.

cluster_label_verification_disabled boolean

When true, memberlist doesn't verify that inbound packets and gossip streams have the cluster label matching the configured one. This verification should be disabled while rolling out the change to the configured cluster label in a live memberlist cluster.

join_members array | null

Other cluster members to join. Can be specified multiple times. It can be an IP, hostname or an entry specified in the DNS Service Discovery format.

min_join_backoff string

Min backoff duration to join other cluster members.

max_join_backoff string

Max backoff duration to join other cluster members.

max_join_retries integer

Max number of retries to join other cluster members. Default: 10.

abort_if_cluster_join_fails boolean

If this node fails to join memberlist cluster, abort.

rejoin_interval string

If not 0, how often to rejoin the cluster. Occasional rejoin can help to fix the cluster split issue, and is harmless otherwise. For example when using only few components as a seed nodes (via -memberlist.join), then it's recommended to use rejoin. If -memberlist.join points to dynamic service that resolves to all gossiping nodes (eg. Kubernetes headless service), then rejoin is not needed.

left_ingesters_timeout string

How long to keep LEFT ingesters in the ring.

leave_timeout string

Timeout for leaving memberlist cluster.

message_history_buffer_bytes integer

How much space to use for keeping received and sent messages in memory for troubleshooting (two buffers). 0 to disable. Default: 0.

bind_addr array | null

IP address to listen on for gossip messages. Multiple addresses may be specified. Defaults to 0.0.0.0

bind_port integer

Port to listen on for gossip messages. Default: 7946.

packet_dial_timeout string

Timeout used when connecting to other nodes to send packet.

packet_write_timeout string

Timeout for writing 'packet' data.

tls_enabled boolean

Enable TLS on the memberlist transport layer.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

runtime_config object
2 nested properties
period string

How often to check runtime config files.

file string

Comma separated list of yaml files with the configuration that can be updated at runtime. Runtime config files will be merged from left to right.

operational_config object
4 nested properties
log_stream_creation boolean

Log every new stream created by a push request (very verbose, recommend to enable via runtime config only).

log_push_request boolean

Log every push request (very verbose, recommend to enable via runtime config only).

log_push_request_streams boolean

Log every stream in a push request (very verbose, recommend to enable via runtime config only).

limited_log_push_errors boolean

Log push errors with a rate limited logger, will show client push errors without overly spamming logs.

tracing object
1 nested properties
enabled boolean

Set to false to disable tracing.

analytics object
2 nested properties
reporting_enabled boolean

Enable anonymous usage reporting.

usage_stats_url string

URL to which reports are sent

common object
9 nested properties
path_prefix string
storage object
10 nested properties
s3 object
14 nested properties
s3 string

S3 endpoint URL with escaped Key and Secret encoded. If only region is specified as a host, proper endpoint will be deduced. Use inmemory:/// to use a mock in-memory implementation.

s3forcepathstyle boolean

Set this to true to force the request to use path-style addressing.

bucketnames string

Comma separated list of bucket names to evenly distribute chunks over. Overrides any buckets specified in s3.url flag

endpoint string

S3 Endpoint to connect to.

region string

AWS region to use.

access_key_id string

AWS Access Key ID

secret_access_key string

AWS Secret Access Key

session_token string

AWS Session Token

insecure boolean

Disable https on s3 connection.

http_config object
signature_version string

The signature version to use for authenticating against S3. Supported values are: v4.

storage_class string

The S3 storage class which objects will use. Supported values are: GLACIER, DEEP_ARCHIVE, GLACIER_IR, INTELLIGENT_TIERING, ONEZONE_IA, OUTPOSTS, REDUCED_REDUNDANCY, STANDARD, STANDARD_IA.

sse object
backoff_config object

Configures back off when S3 get Object.

gcs object
7 nested properties
bucket_name string

Name of GCS bucket. Please refer to https://cloud.google.com/docs/authentication/production for more information about how to configure authentication.

service_account string

Service account key content in JSON format, refer to https://cloud.google.com/iam/docs/creating-managing-service-account-keys for creation.

chunk_buffer_size integer

The size of the buffer that GCS client for each PUT request. 0 to disable buffering. Default: 0.

request_timeout string

The duration after which the requests to GCS should be timed out.

enable_opencensus boolean

Enable OpenCensus (OC) instrumentation for all requests.

enable_http2 boolean

Enable HTTP2 connections.

enable_retries boolean

Enable automatic retries of failed idempotent requests.

azure object
21 nested properties
environment string

Azure Cloud environment. Supported values are: AzureGlobal, AzureChinaCloud, AzureGermanCloud, AzureUSGovernment.

account_name string

Azure storage account name.

account_key string

Azure storage account key.

connection_string string

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.

container_name string

Name of the storage account blob container used to store chunks. This container must be created before running cortex.

endpoint_suffix string

Azure storage endpoint suffix without schema. The storage account name will be prefixed to this value to create the FQDN.

use_managed_identity boolean

Use Managed Identity to authenticate to the Azure storage account.

use_federated_token boolean

Use Federated Token to authenticate to the Azure storage account.

user_assigned_id string

User assigned identity ID to authenticate to the Azure storage account.

use_service_principal boolean

Use Service Principal to authenticate through Azure OAuth.

client_id string

Azure Service Principal ID(GUID).

client_secret string

Azure Service Principal secret key.

tenant_id string

Azure Tenant ID is used to authenticate through Azure OAuth.

chunk_delimiter string

Chunk delimiter for blob ID to be used

download_buffer_size integer

Preallocated buffer size for downloads. Default: 512000.

upload_buffer_size integer

Preallocated buffer size for uploads. Default: 256000.

upload_buffer_count integer

Number of buffers used to used to upload a chunk. Default: 1.

request_timeout string

Timeout for requests made against azure blob storage.

max_retries integer

Number of retries for a request which times out. Default: 5.

min_retry_delay string

Minimum time to wait before retrying a request.

max_retry_delay string

Maximum time to wait before retrying a request.

alibabacloud object
4 nested properties
bucket string

Name of OSS bucket.

endpoint string

oss Endpoint to connect to.

access_key_id string

alibabacloud Access Key ID

secret_access_key string

alibabacloud Secret Access Key

bos object
4 nested properties
bucket_name string

Name of BOS bucket.

endpoint string

BOS endpoint to connect to.

access_key_id string

Baidu Cloud Engine (BCE) Access Key ID.

secret_access_key string

Baidu Cloud Engine (BCE) Secret Access Key.

swift object
19 nested properties
auth_version integer

OpenStack Swift authentication API version. 0 to autodetect. Default: 0.

auth_url string

OpenStack Swift authentication URL

internal boolean

Set this to true to use the internal OpenStack Swift endpoint URL

username string

OpenStack Swift username.

user_domain_name string

OpenStack Swift user's domain name.

user_domain_id string

OpenStack Swift user's domain ID.

user_id string

OpenStack Swift user ID.

password string

OpenStack Swift API key.

domain_id string

OpenStack Swift user's domain ID.

domain_name string

OpenStack Swift user's domain name.

project_id string

OpenStack Swift project ID (v2,v3 auth only).

project_name string

OpenStack Swift project name (v2,v3 auth only).

project_domain_id string

ID of the OpenStack Swift project's domain (v3 auth only), only needed if it differs the from user domain.

project_domain_name string

Name of the OpenStack Swift project's domain (v3 auth only), only needed if it differs from the user domain.

region_name string

OpenStack Swift Region to use (v2,v3 auth only).

container_name string

Name of the OpenStack Swift container to put chunks in.

max_retries integer

Max retries on requests error. Default: 3.

connect_timeout string

Time after which a connection attempt is aborted.

request_timeout string

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.

filesystem object
2 nested properties
chunks_directory string

Directory to store chunks in.

rules_directory string

Directory to store rules in.

hedging object
3 nested properties
at string

If set to a non-zero value a second request will be issued at the provided duration. Default is 0 (disabled)

up_to integer

The maximum of hedge requests allowed. Default: 2.

max_per_second integer

The maximum of hedge requests allowed per seconds. Default: 5.

cos object
14 nested properties
forcepathstyle boolean

Set this to true to force the request to use path-style addressing.

bucketnames string

Comma separated list of bucket names to evenly distribute chunks over.

endpoint string

COS Endpoint to connect to.

region string

COS region to use.

access_key_id string

COS HMAC Access Key ID.

secret_access_key string

COS HMAC Secret Access Key.

http_config object
backoff_config object

Configures back off when cos get Object.

api_key string

IAM API key to access COS.

service_instance_id string

COS service instance id to use.

auth_endpoint string

IAM Auth Endpoint for authentication.

cr_token_file_path string

Compute resource token file path.

trusted_profile_name string

Name of the trusted profile.

trusted_profile_id string

ID of the trusted profile.

congestion_control object
4 nested properties
enabled boolean

Use storage congestion control (default: disabled).

controller object
retry object
hedging object
persist_tokens boolean
replication_factor integer
ring object
13 nested properties
kvstore object
5 nested properties
store string

Backend storage to use for the ring. Supported values are: consul, etcd, inmemory, memberlist, multi.

prefix string

The prefix for the keys in the store. Should end with a /.

consul object
etcd object
multi object
heartbeat_period string

Period at which to heartbeat to the ring. 0 = disabled.

heartbeat_timeout string

The heartbeat timeout after which compactors are considered unhealthy within the ring. 0 = never (timeout disabled).

tokens_file_path string

File path where tokens are stored. If empty, tokens are not stored at shutdown and restored at startup.

zone_awareness_enabled boolean

True to enable zone-awareness and replicate blocks across different availability zones.

num_tokens integer

Number of tokens to own in the ring. Default: 128.

replication_factor integer

Factor for data replication. Default: 3.

instance_id string

Instance ID to register in the ring.

instance_interface_names array | null

Name of network interface to read address from.

instance_port integer

Port to advertise in the ring (defaults to server.grpc-listen-port). Default: 0.

instance_addr string

IP address to advertise in the ring.

instance_availability_zone string

The availability zone where this instance is running. Required if zone-awareness is enabled.

instance_enable_ipv6 boolean

Enable using a IPv6 instance address.

instance_interface_names array | null
instance_addr string
compactor_address string

the http address of the compactor in the form http://host:port

compactor_grpc_address string

the grpc address of the compactor in the form host:port

shutdown_delay string

How long to wait between SIGTERM and shutdown. After receiving SIGTERM, Loki will report 503 Service Unavailable status via /ready endpoint.

metrics_namespace string

Namespace of the metrics that in previous releases had cortex as namespace. This setting is deprecated and will be removed in the next minor release.

Definitions

alibabacloud_storage_config object
bucket string

Name of OSS bucket.

endpoint string

oss Endpoint to connect to.

access_key_id string

alibabacloud Access Key ID

secret_access_key string

alibabacloud Secret Access Key

analytics object
reporting_enabled boolean

Enable anonymous usage reporting.

usage_stats_url string

URL to which reports are sent

attributes_config object
action string

Configures action to take on matching attributes. It allows one of [structured_metadata, drop] for all attribute types. It additionally allows index_label action for resource attributes

attributes array | null

List of attributes to configure how to store them or drop them altogether

regex string

Regex to choose attributes to configure how to store them or drop them altogether

aws_storage_config object
dynamodb object

Deprecated: Configures storing indexes in DynamoDB.

8 nested properties
dynamodb_url string

DynamoDB endpoint URL with escaped Key and Secret encoded. If only region is specified as a host, proper endpoint will be deduced. Use inmemory:/// to use a mock in-memory implementation.

api_limit number

DynamoDB table management requests per second limit. Default: 2.

throttle_limit number

DynamoDB rate cap to back off when throttled. Default: 10.

metrics object
9 nested properties
url string

Use metrics-based autoscaling, via this query URL

target_queue_length integer

Queue length above which we will scale up capacity. Default: 100000.

scale_up_factor number

Scale up capacity by this multiple. Default: 1.3.

ignore_throttle_below number

Ignore throttling below this level (rate per second). Default: 1.

queue_length_query string

query to fetch ingester queue length

write_throttle_query string

query to fetch throttle rates per table

write_usage_query string

query to fetch write capacity usage per table

read_usage_query string

query to fetch read capacity usage per table

read_error_query string

query to fetch read errors per table

chunk_gang_size integer

Number of chunks to group together to parallelise fetches (zero to disable). Default: 10.

chunk_get_max_parallelism integer

Max number of chunk-get operations to start in parallel. Default: 32.

backoff_config object
3 nested properties
min_period string

Minimum backoff time

max_period string

Maximum backoff time

max_retries integer

Maximum number of times to retry an operation. Default: 20.

kms_key_id string

KMS key used for encrypting DynamoDB items. DynamoDB will use an Amazon owned KMS key if not provided.

s3 string

S3 endpoint URL with escaped Key and Secret encoded. If only region is specified as a host, proper endpoint will be deduced. Use inmemory:/// to use a mock in-memory implementation.

s3forcepathstyle boolean

Set this to true to force the request to use path-style addressing.

bucketnames string

Comma separated list of bucket names to evenly distribute chunks over. Overrides any buckets specified in s3.url flag

endpoint string

S3 Endpoint to connect to.

region string

AWS region to use.

access_key_id string

AWS Access Key ID

secret_access_key string

AWS Secret Access Key

session_token string

AWS Session Token

insecure boolean

Disable https on s3 connection.

http_config object
5 nested properties
timeout string

Timeout specifies a time limit for requests made by s3 Client.

idle_conn_timeout string

The maximum amount of time an idle connection will be held open.

response_header_timeout string

If non-zero, specifies the amount of time to wait for a server's response headers after fully writing the request.

insecure_skip_verify boolean

Set to true to skip verifying the certificate chain and hostname.

ca_file string

Path to the trusted CA file that signed the SSL certificate of the S3 endpoint.

signature_version string

The signature version to use for authenticating against S3. Supported values are: v4.

storage_class string

The S3 storage class which objects will use. Supported values are: GLACIER, DEEP_ARCHIVE, GLACIER_IR, INTELLIGENT_TIERING, ONEZONE_IA, OUTPOSTS, REDUCED_REDUNDANCY, STANDARD, STANDARD_IA.

sse object
3 nested properties
type string

Enable AWS Server Side Encryption. Supported values: SSE-KMS, SSE-S3.

kms_key_id string

KMS Key ID used to encrypt objects in S3

kms_encryption_context string

KMS Encryption Context used for object encryption. It expects JSON formatted string.

backoff_config object

Configures back off when S3 get Object.

3 nested properties
min_period string

Minimum backoff time when s3 get Object

max_period string

Maximum backoff time when s3 get Object

max_retries integer

Maximum number of times to retry when s3 get Object. Default: 5.

azure_storage_config object
environment string

Azure Cloud environment. Supported values are: AzureGlobal, AzureChinaCloud, AzureGermanCloud, AzureUSGovernment.

account_name string

Azure storage account name.

account_key string

Azure storage account key.

connection_string string

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.

container_name string

Name of the storage account blob container used to store chunks. This container must be created before running cortex.

endpoint_suffix string

Azure storage endpoint suffix without schema. The storage account name will be prefixed to this value to create the FQDN.

use_managed_identity boolean

Use Managed Identity to authenticate to the Azure storage account.

use_federated_token boolean

Use Federated Token to authenticate to the Azure storage account.

user_assigned_id string

User assigned identity ID to authenticate to the Azure storage account.

use_service_principal boolean

Use Service Principal to authenticate through Azure OAuth.

client_id string

Azure Service Principal ID(GUID).

client_secret string

Azure Service Principal secret key.

tenant_id string

Azure Tenant ID is used to authenticate through Azure OAuth.

chunk_delimiter string

Chunk delimiter for blob ID to be used

download_buffer_size integer

Preallocated buffer size for downloads. Default: 512000.

upload_buffer_size integer

Preallocated buffer size for uploads. Default: 256000.

upload_buffer_count integer

Number of buffers used to used to upload a chunk. Default: 1.

request_timeout string

Timeout for requests made against azure blob storage.

max_retries integer

Number of retries for a request which times out. Default: 5.

min_retry_delay string

Minimum time to wait before retrying a request.

max_retry_delay string

Maximum time to wait before retrying a request.

bloom_compactor object
ring object

Defines the ring to be used by the bloom-compactor servers. In case this isn't configured, this block supports inheriting configuration from the common ring section.

13 nested properties
kvstore object
5 nested properties
store string

Backend storage to use for the ring. Supported values are: consul, etcd, inmemory, memberlist, multi.

prefix string

The prefix for the keys in the store. Should end with a /.

consul object
etcd object
multi object
heartbeat_period string

Period at which to heartbeat to the ring. 0 = disabled.

heartbeat_timeout string

The heartbeat timeout after which compactors are considered unhealthy within the ring. 0 = never (timeout disabled).

tokens_file_path string

File path where tokens are stored. If empty, tokens are not stored at shutdown and restored at startup.

zone_awareness_enabled boolean

True to enable zone-awareness and replicate blocks across different availability zones.

num_tokens integer

Number of tokens to use in the ring per compactor. Higher number of tokens will result in more and smaller files (metas and blocks.). Default: 10.

replication_factor
instance_id string

Instance ID to register in the ring.

instance_interface_names array | null

Name of network interface to read address from.

instance_port integer

Port to advertise in the ring (defaults to server.grpc-listen-port). Default: 0.

instance_addr string

IP address to advertise in the ring.

instance_availability_zone string

The availability zone where this instance is running. Required if zone-awareness is enabled.

instance_enable_ipv6 boolean

Enable using a IPv6 instance address.

enabled boolean

Flag to enable or disable the usage of the bloom-compactor component.

compaction_interval string

Interval at which to re-run the compaction operation.

min_table_offset integer

Newest day-table offset (from today, inclusive) to compact. Increase to lower cost by not re-writing data to object storage too frequently since recent data changes more often at the cost of not having blooms available as quickly. Default: 1.

max_table_offset integer

Oldest day-table offset (from today, inclusive) to compact. This can be used to lower cost by not trying to compact older data which doesn't change. This can be optimized by aligning it with the maximum reject_old_samples_max_age setting of any tenant. Default: 2.

worker_parallelism integer

Number of workers to run in parallel for compaction. Default: 1.

compaction_retries_min_backoff string

Minimum backoff time between retries.

compaction_retries_max_backoff string

Maximum backoff time between retries.

compaction_retries integer

Number of retries to perform when compaction fails. Default: 3.

max_compaction_parallelism integer

Maximum number of tables to compact in parallel. While increasing this value, please make sure compactor has enough disk space allocated to be able to store and compact as many tables. Default: 1.

retention object
2 nested properties
enabled boolean

Enable bloom retention.

max_lookback_days integer

Max lookback days for retention. Default: 365.

bloom_gateway object
enabled boolean

Flag to enable or disable the bloom gateway component globally.

client object
5 nested properties
pool_config object

Configures the behavior of the connection pool.

3 nested properties
check_interval string

How frequently to clean up clients for servers that have gone away or are unhealthy.

enable_health_check boolean

Run a health check on each server during periodic cleanup.

health_check_timeout string

Timeout for the health check if health check is enabled.

grpc_client_config object
20 nested properties
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

results_cache object
2 nested properties
cache object
compression string

Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.

cache_results boolean

Flag to control whether to cache bloom gateway client requests/responses.

addresses string
worker_concurrency integer

Number of workers to use for filtering chunks concurrently. Usually set to 1x number of CPU cores. Default: 4.

block_query_concurrency integer

Number of blocks processed concurrently on a single worker. Usually set to 2x number of CPU cores. Default: 8.

max_outstanding_per_tenant integer

Maximum number of outstanding tasks per tenant. Default: 1024.

num_multiplex_tasks integer

How many tasks are multiplexed at once. Default: 512.

bos_storage_config object
bucket_name string

Name of BOS bucket.

endpoint string

BOS endpoint to connect to.

access_key_id string

Baidu Cloud Engine (BCE) Access Key ID.

secret_access_key string

Baidu Cloud Engine (BCE) Secret Access Key.

cache_config object
default_validity string

The default validity of entries for caches unless overridden.

background object
3 nested properties
writeback_goroutines integer

At what concurrency to write back to cache. Default: 1.

writeback_buffer integer

How many key batches to buffer for background write-back. Default is large to prefer size based limiting. Default: 500000.

writeback_size_limit string

Size limit in bytes for background write-back. Default: 500MB.

memcached object
3 nested properties
expiration string

How long keys stay in the memcache.

batch_size integer

How many keys to fetch in each batch. Default: 4.

parallelism integer

Maximum active requests to memcache. Default: 5.

memcached_client object
19 nested properties
host string

Hostname for memcached service to use. If empty and if addresses is unset, no memcached will be used.

service string

SRV service used to discover memcache servers.

addresses string
timeout string

Maximum time to wait before giving up on memcached requests.

max_idle_conns integer

Maximum number of idle connections in pool. Default: 16.

max_item_size integer

The maximum size of an item stored in memcached. Bigger items are not stored. If set to 0, no maximum size is enforced. Default: 0.

update_interval string

Period with which to poll DNS for memcache servers.

consistent_hash boolean

Use consistent hashing to distribute to memcache servers.

circuit_breaker_consecutive_failures integer

Trip circuit-breaker after this number of consecutive dial failures (if zero then circuit-breaker is disabled). Default: 10.

circuit_breaker_timeout string

Duration circuit-breaker remains open after tripping (if zero then 60 seconds is used).

circuit_breaker_interval string

Reset circuit-breaker counts after this long (if zero then never reset).

tls_enabled boolean

Enable connecting to Memcached with TLS.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

redis object
13 nested properties
endpoint string

Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. If empty, no redis will be used.

master_name string

Redis Sentinel master name. An empty string for Redis Server or Redis Cluster.

timeout string

Maximum time to wait before giving up on redis requests.

expiration string

How long keys stay in the redis.

db integer

Database index. Default: 0.

pool_size integer

Maximum number of connections in the pool. Default: 0.

username string

Username to use when connecting to redis.

password string

Password to use when connecting to redis.

tls_enabled boolean

Enable connecting to redis with TLS.

tls_insecure_skip_verify boolean

Skip validating server certificate.

idle_timeout string

Close connections after remaining idle for this duration. If the value is zero, then idle connections are not closed.

max_connection_age string

Close connections older than this duration. If the value is zero, then the pool does not close connections based on age.

route_randomly boolean

By default, the Redis client only reads from the master node. Enabling this option can lower pressure on the master node by randomly routing read-only commands to the master and any available replicas.

embedded_cache object
4 nested properties
enabled boolean

Whether embedded cache is enabled.

max_size_mb integer

Maximum memory size of the cache in MB. Default: 100.

max_size_items integer

Maximum number of entries in the cache. Default: 0.

ttl string

The time to live for items in the cache before they get purged.

chunk_store_config object
chunk_cache_config object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
3 nested properties
writeback_goroutines integer

At what concurrency to write back to cache. Default: 1.

writeback_buffer integer

How many key batches to buffer for background write-back. Default is large to prefer size based limiting. Default: 500000.

writeback_size_limit string

Size limit in bytes for background write-back. Default: 500MB.

memcached object
3 nested properties
expiration string

How long keys stay in the memcache.

batch_size integer

How many keys to fetch in each batch. Default: 4.

parallelism integer

Maximum active requests to memcache. Default: 5.

memcached_client object
19 nested properties
host string

Hostname for memcached service to use. If empty and if addresses is unset, no memcached will be used.

service string

SRV service used to discover memcache servers.

addresses string
timeout string

Maximum time to wait before giving up on memcached requests.

max_idle_conns integer

Maximum number of idle connections in pool. Default: 16.

max_item_size integer

The maximum size of an item stored in memcached. Bigger items are not stored. If set to 0, no maximum size is enforced. Default: 0.

update_interval string

Period with which to poll DNS for memcache servers.

consistent_hash boolean

Use consistent hashing to distribute to memcache servers.

circuit_breaker_consecutive_failures integer

Trip circuit-breaker after this number of consecutive dial failures (if zero then circuit-breaker is disabled). Default: 10.

circuit_breaker_timeout string

Duration circuit-breaker remains open after tripping (if zero then 60 seconds is used).

circuit_breaker_interval string

Reset circuit-breaker counts after this long (if zero then never reset).

tls_enabled boolean

Enable connecting to Memcached with TLS.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

redis object
13 nested properties
endpoint string

Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. If empty, no redis will be used.

master_name string

Redis Sentinel master name. An empty string for Redis Server or Redis Cluster.

timeout string

Maximum time to wait before giving up on redis requests.

expiration string

How long keys stay in the redis.

db integer

Database index. Default: 0.

pool_size integer

Maximum number of connections in the pool. Default: 0.

username string

Username to use when connecting to redis.

password string

Password to use when connecting to redis.

tls_enabled boolean

Enable connecting to redis with TLS.

tls_insecure_skip_verify boolean

Skip validating server certificate.

idle_timeout string

Close connections after remaining idle for this duration. If the value is zero, then idle connections are not closed.

max_connection_age string

Close connections older than this duration. If the value is zero, then the pool does not close connections based on age.

route_randomly boolean

By default, the Redis client only reads from the master node. Enabling this option can lower pressure on the master node by randomly routing read-only commands to the master and any available replicas.

embedded_cache object
4 nested properties
enabled boolean

Whether embedded cache is enabled.

max_size_mb integer

Maximum memory size of the cache in MB. Default: 100.

max_size_items integer

Maximum number of entries in the cache. Default: 0.

ttl string

The time to live for items in the cache before they get purged.

chunk_cache_config_l2 object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
3 nested properties
writeback_goroutines integer

At what concurrency to write back to cache. Default: 1.

writeback_buffer integer

How many key batches to buffer for background write-back. Default is large to prefer size based limiting. Default: 500000.

writeback_size_limit string

Size limit in bytes for background write-back. Default: 500MB.

memcached object
3 nested properties
expiration string

How long keys stay in the memcache.

batch_size integer

How many keys to fetch in each batch. Default: 4.

parallelism integer

Maximum active requests to memcache. Default: 5.

memcached_client object
19 nested properties
host string

Hostname for memcached service to use. If empty and if addresses is unset, no memcached will be used.

service string

SRV service used to discover memcache servers.

addresses string
timeout string

Maximum time to wait before giving up on memcached requests.

max_idle_conns integer

Maximum number of idle connections in pool. Default: 16.

max_item_size integer

The maximum size of an item stored in memcached. Bigger items are not stored. If set to 0, no maximum size is enforced. Default: 0.

update_interval string

Period with which to poll DNS for memcache servers.

consistent_hash boolean

Use consistent hashing to distribute to memcache servers.

circuit_breaker_consecutive_failures integer

Trip circuit-breaker after this number of consecutive dial failures (if zero then circuit-breaker is disabled). Default: 10.

circuit_breaker_timeout string

Duration circuit-breaker remains open after tripping (if zero then 60 seconds is used).

circuit_breaker_interval string

Reset circuit-breaker counts after this long (if zero then never reset).

tls_enabled boolean

Enable connecting to Memcached with TLS.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

redis object
13 nested properties
endpoint string

Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. If empty, no redis will be used.

master_name string

Redis Sentinel master name. An empty string for Redis Server or Redis Cluster.

timeout string

Maximum time to wait before giving up on redis requests.

expiration string

How long keys stay in the redis.

db integer

Database index. Default: 0.

pool_size integer

Maximum number of connections in the pool. Default: 0.

username string

Username to use when connecting to redis.

password string

Password to use when connecting to redis.

tls_enabled boolean

Enable connecting to redis with TLS.

tls_insecure_skip_verify boolean

Skip validating server certificate.

idle_timeout string

Close connections after remaining idle for this duration. If the value is zero, then idle connections are not closed.

max_connection_age string

Close connections older than this duration. If the value is zero, then the pool does not close connections based on age.

route_randomly boolean

By default, the Redis client only reads from the master node. Enabling this option can lower pressure on the master node by randomly routing read-only commands to the master and any available replicas.

embedded_cache object
4 nested properties
enabled boolean

Whether embedded cache is enabled.

max_size_mb integer

Maximum memory size of the cache in MB. Default: 100.

max_size_items integer

Maximum number of entries in the cache. Default: 0.

ttl string

The time to live for items in the cache before they get purged.

write_dedupe_cache_config object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
3 nested properties
writeback_goroutines integer

At what concurrency to write back to cache. Default: 1.

writeback_buffer integer

How many key batches to buffer for background write-back. Default is large to prefer size based limiting. Default: 500000.

writeback_size_limit string

Size limit in bytes for background write-back. Default: 500MB.

memcached object
3 nested properties
expiration string

How long keys stay in the memcache.

batch_size integer

How many keys to fetch in each batch. Default: 4.

parallelism integer

Maximum active requests to memcache. Default: 5.

memcached_client object
19 nested properties
host string

Hostname for memcached service to use. If empty and if addresses is unset, no memcached will be used.

service string

SRV service used to discover memcache servers.

addresses string
timeout string

Maximum time to wait before giving up on memcached requests.

max_idle_conns integer

Maximum number of idle connections in pool. Default: 16.

max_item_size integer

The maximum size of an item stored in memcached. Bigger items are not stored. If set to 0, no maximum size is enforced. Default: 0.

update_interval string

Period with which to poll DNS for memcache servers.

consistent_hash boolean

Use consistent hashing to distribute to memcache servers.

circuit_breaker_consecutive_failures integer

Trip circuit-breaker after this number of consecutive dial failures (if zero then circuit-breaker is disabled). Default: 10.

circuit_breaker_timeout string

Duration circuit-breaker remains open after tripping (if zero then 60 seconds is used).

circuit_breaker_interval string

Reset circuit-breaker counts after this long (if zero then never reset).

tls_enabled boolean

Enable connecting to Memcached with TLS.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

redis object
13 nested properties
endpoint string

Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. If empty, no redis will be used.

master_name string

Redis Sentinel master name. An empty string for Redis Server or Redis Cluster.

timeout string

Maximum time to wait before giving up on redis requests.

expiration string

How long keys stay in the redis.

db integer

Database index. Default: 0.

pool_size integer

Maximum number of connections in the pool. Default: 0.

username string

Username to use when connecting to redis.

password string

Password to use when connecting to redis.

tls_enabled boolean

Enable connecting to redis with TLS.

tls_insecure_skip_verify boolean

Skip validating server certificate.

idle_timeout string

Close connections after remaining idle for this duration. If the value is zero, then idle connections are not closed.

max_connection_age string

Close connections older than this duration. If the value is zero, then the pool does not close connections based on age.

route_randomly boolean

By default, the Redis client only reads from the master node. Enabling this option can lower pressure on the master node by randomly routing read-only commands to the master and any available replicas.

embedded_cache object
4 nested properties
enabled boolean

Whether embedded cache is enabled.

max_size_mb integer

Maximum memory size of the cache in MB. Default: 100.

max_size_items integer

Maximum number of entries in the cache. Default: 0.

ttl string

The time to live for items in the cache before they get purged.

l2_chunk_cache_handoff string

Chunks will be handed off to the L2 cache after this duration. 0 to disable L2 cache.

cache_lookups_older_than string

Cache index entries older than this period. 0 to disable.

common object
path_prefix string
storage object
10 nested properties
s3 object
14 nested properties
s3 string

S3 endpoint URL with escaped Key and Secret encoded. If only region is specified as a host, proper endpoint will be deduced. Use inmemory:/// to use a mock in-memory implementation.

s3forcepathstyle boolean

Set this to true to force the request to use path-style addressing.

bucketnames string

Comma separated list of bucket names to evenly distribute chunks over. Overrides any buckets specified in s3.url flag

endpoint string

S3 Endpoint to connect to.

region string

AWS region to use.

access_key_id string

AWS Access Key ID

secret_access_key string

AWS Secret Access Key

session_token string

AWS Session Token

insecure boolean

Disable https on s3 connection.

http_config object
signature_version string

The signature version to use for authenticating against S3. Supported values are: v4.

storage_class string

The S3 storage class which objects will use. Supported values are: GLACIER, DEEP_ARCHIVE, GLACIER_IR, INTELLIGENT_TIERING, ONEZONE_IA, OUTPOSTS, REDUCED_REDUNDANCY, STANDARD, STANDARD_IA.

sse object
backoff_config object

Configures back off when S3 get Object.

gcs object
7 nested properties
bucket_name string

Name of GCS bucket. Please refer to https://cloud.google.com/docs/authentication/production for more information about how to configure authentication.

service_account string

Service account key content in JSON format, refer to https://cloud.google.com/iam/docs/creating-managing-service-account-keys for creation.

chunk_buffer_size integer

The size of the buffer that GCS client for each PUT request. 0 to disable buffering. Default: 0.

request_timeout string

The duration after which the requests to GCS should be timed out.

enable_opencensus boolean

Enable OpenCensus (OC) instrumentation for all requests.

enable_http2 boolean

Enable HTTP2 connections.

enable_retries boolean

Enable automatic retries of failed idempotent requests.

azure object
21 nested properties
environment string

Azure Cloud environment. Supported values are: AzureGlobal, AzureChinaCloud, AzureGermanCloud, AzureUSGovernment.

account_name string

Azure storage account name.

account_key string

Azure storage account key.

connection_string string

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.

container_name string

Name of the storage account blob container used to store chunks. This container must be created before running cortex.

endpoint_suffix string

Azure storage endpoint suffix without schema. The storage account name will be prefixed to this value to create the FQDN.

use_managed_identity boolean

Use Managed Identity to authenticate to the Azure storage account.

use_federated_token boolean

Use Federated Token to authenticate to the Azure storage account.

user_assigned_id string

User assigned identity ID to authenticate to the Azure storage account.

use_service_principal boolean

Use Service Principal to authenticate through Azure OAuth.

client_id string

Azure Service Principal ID(GUID).

client_secret string

Azure Service Principal secret key.

tenant_id string

Azure Tenant ID is used to authenticate through Azure OAuth.

chunk_delimiter string

Chunk delimiter for blob ID to be used

download_buffer_size integer

Preallocated buffer size for downloads. Default: 512000.

upload_buffer_size integer

Preallocated buffer size for uploads. Default: 256000.

upload_buffer_count integer

Number of buffers used to used to upload a chunk. Default: 1.

request_timeout string

Timeout for requests made against azure blob storage.

max_retries integer

Number of retries for a request which times out. Default: 5.

min_retry_delay string

Minimum time to wait before retrying a request.

max_retry_delay string

Maximum time to wait before retrying a request.

alibabacloud object
4 nested properties
bucket string

Name of OSS bucket.

endpoint string

oss Endpoint to connect to.

access_key_id string

alibabacloud Access Key ID

secret_access_key string

alibabacloud Secret Access Key

bos object
4 nested properties
bucket_name string

Name of BOS bucket.

endpoint string

BOS endpoint to connect to.

access_key_id string

Baidu Cloud Engine (BCE) Access Key ID.

secret_access_key string

Baidu Cloud Engine (BCE) Secret Access Key.

swift object
19 nested properties
auth_version integer

OpenStack Swift authentication API version. 0 to autodetect. Default: 0.

auth_url string

OpenStack Swift authentication URL

internal boolean

Set this to true to use the internal OpenStack Swift endpoint URL

username string

OpenStack Swift username.

user_domain_name string

OpenStack Swift user's domain name.

user_domain_id string

OpenStack Swift user's domain ID.

user_id string

OpenStack Swift user ID.

password string

OpenStack Swift API key.

domain_id string

OpenStack Swift user's domain ID.

domain_name string

OpenStack Swift user's domain name.

project_id string

OpenStack Swift project ID (v2,v3 auth only).

project_name string

OpenStack Swift project name (v2,v3 auth only).

project_domain_id string

ID of the OpenStack Swift project's domain (v3 auth only), only needed if it differs the from user domain.

project_domain_name string

Name of the OpenStack Swift project's domain (v3 auth only), only needed if it differs from the user domain.

region_name string

OpenStack Swift Region to use (v2,v3 auth only).

container_name string

Name of the OpenStack Swift container to put chunks in.

max_retries integer

Max retries on requests error. Default: 3.

connect_timeout string

Time after which a connection attempt is aborted.

request_timeout string

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.

filesystem object
2 nested properties
chunks_directory string

Directory to store chunks in.

rules_directory string

Directory to store rules in.

hedging object
3 nested properties
at string

If set to a non-zero value a second request will be issued at the provided duration. Default is 0 (disabled)

up_to integer

The maximum of hedge requests allowed. Default: 2.

max_per_second integer

The maximum of hedge requests allowed per seconds. Default: 5.

cos object
14 nested properties
forcepathstyle boolean

Set this to true to force the request to use path-style addressing.

bucketnames string

Comma separated list of bucket names to evenly distribute chunks over.

endpoint string

COS Endpoint to connect to.

region string

COS region to use.

access_key_id string

COS HMAC Access Key ID.

secret_access_key string

COS HMAC Secret Access Key.

http_config object
backoff_config object

Configures back off when cos get Object.

api_key string

IAM API key to access COS.

service_instance_id string

COS service instance id to use.

auth_endpoint string

IAM Auth Endpoint for authentication.

cr_token_file_path string

Compute resource token file path.

trusted_profile_name string

Name of the trusted profile.

trusted_profile_id string

ID of the trusted profile.

congestion_control object
4 nested properties
enabled boolean

Use storage congestion control (default: disabled).

controller object
retry object
hedging object
persist_tokens boolean
replication_factor integer
ring object
13 nested properties
kvstore object
5 nested properties
store string

Backend storage to use for the ring. Supported values are: consul, etcd, inmemory, memberlist, multi.

prefix string

The prefix for the keys in the store. Should end with a /.

consul object
etcd object
multi object
heartbeat_period string

Period at which to heartbeat to the ring. 0 = disabled.

heartbeat_timeout string

The heartbeat timeout after which compactors are considered unhealthy within the ring. 0 = never (timeout disabled).

tokens_file_path string

File path where tokens are stored. If empty, tokens are not stored at shutdown and restored at startup.

zone_awareness_enabled boolean

True to enable zone-awareness and replicate blocks across different availability zones.

num_tokens integer

Number of tokens to own in the ring. Default: 128.

replication_factor integer

Factor for data replication. Default: 3.

instance_id string

Instance ID to register in the ring.

instance_interface_names array | null

Name of network interface to read address from.

instance_port integer

Port to advertise in the ring (defaults to server.grpc-listen-port). Default: 0.

instance_addr string

IP address to advertise in the ring.

instance_availability_zone string

The availability zone where this instance is running. Required if zone-awareness is enabled.

instance_enable_ipv6 boolean

Enable using a IPv6 instance address.

instance_interface_names array | null
instance_addr string
compactor_address string

the http address of the compactor in the form http://host:port

compactor_grpc_address string

the grpc address of the compactor in the form host:port

compactor object
working_directory string

Directory where files can be downloaded for compaction.

compaction_interval string

Interval at which to re-run the compaction operation.

apply_retention_interval string

Interval at which to apply/enforce retention. 0 means run at same interval as compaction. If non-zero, it should always be a multiple of compaction interval.

retention_enabled boolean

Activate custom (per-stream,per-tenant) retention.

retention_delete_delay string

Delay after which chunks will be fully deleted during retention.

retention_delete_worker_count integer

The total amount of worker to use to delete chunks. Default: 150.

retention_table_timeout string

The maximum amount of time to spend running retention and deletion on any given table in the index.

delete_request_store string

Store used for managing delete requests.

delete_request_store_key_prefix string

Path prefix for storing delete requests.

delete_batch_size integer

The max number of delete requests to run per compaction cycle. Default: 70.

delete_request_cancel_period string

Allow cancellation of delete request until duration after they are created. Data would be deleted only after delete requests have been older than this duration. Ideally this should be set to at least 24h.

delete_max_interval string

Constrain the size of any single delete request with line filters. When a delete request > delete_max_interval is input, the request is sharded into smaller requests of no more than delete_max_interval

max_compaction_parallelism integer

Maximum number of tables to compact in parallel. While increasing this value, please make sure compactor has enough disk space allocated to be able to store and compact as many tables. Default: 1.

upload_parallelism integer

Number of upload/remove operations to execute in parallel when finalizing a compaction. NOTE: This setting is per compaction operation, which can be executed in parallel. The upper bound on the number of concurrent uploads is upload_parallelism * max_compaction_parallelism. Default: 10.

compactor_ring object

The hash ring configuration used by compactors to elect a single instance for running compactions. The CLI flags prefix for this block config is: compactor.ring

13 nested properties
kvstore object
5 nested properties
store string

Backend storage to use for the ring. Supported values are: consul, etcd, inmemory, memberlist, multi.

prefix string

The prefix for the keys in the store. Should end with a /.

consul object
etcd object
multi object
heartbeat_period string

Period at which to heartbeat to the ring. 0 = disabled.

heartbeat_timeout string

The heartbeat timeout after which compactors are considered unhealthy within the ring. 0 = never (timeout disabled).

tokens_file_path string

File path where tokens are stored. If empty, tokens are not stored at shutdown and restored at startup.

zone_awareness_enabled boolean

True to enable zone-awareness and replicate blocks across different availability zones.

num_tokens
replication_factor
instance_id string

Instance ID to register in the ring.

instance_interface_names array | null

Name of network interface to read address from.

instance_port integer

Port to advertise in the ring (defaults to server.grpc-listen-port). Default: 0.

instance_addr string

IP address to advertise in the ring.

instance_availability_zone string

The availability zone where this instance is running. Required if zone-awareness is enabled.

instance_enable_ipv6 boolean

Enable using a IPv6 instance address.

tables_to_compact integer

Number of tables that compactor will try to compact. Newer tables are chosen when this is less than the number of tables available. Default: 0.

skip_latest_n_tables integer

Do not compact N latest tables. Together with -compactor.run-once and -compactor.tables-to-compact, this is useful when clearing compactor backlogs. Default: 0.

consul object
host string

Hostname and port of Consul.

acl_token string

ACL Token used to interact with Consul.

http_client_timeout string

HTTP timeout when talking to Consul

consistent_reads boolean

Enable consistent reads to Consul.

watch_rate_limit number

Rate limit when watching key or prefix in Consul, in requests per second. 0 disables the rate limit. Default: 1.

watch_burst_size integer

Burst size used in rate limit. Values less than 1 are treated as 1. Default: 1.

cas_retry_delay string

Maximum duration to wait before retrying a Compare And Swap (CAS) operation.

cos_storage_config object
forcepathstyle boolean

Set this to true to force the request to use path-style addressing.

bucketnames string

Comma separated list of bucket names to evenly distribute chunks over.

endpoint string

COS Endpoint to connect to.

region string

COS region to use.

access_key_id string

COS HMAC Access Key ID.

secret_access_key string

COS HMAC Secret Access Key.

http_config object
2 nested properties
idle_conn_timeout string

The maximum amount of time an idle connection will be held open.

response_header_timeout string

If non-zero, specifies the amount of time to wait for a server's response headers after fully writing the request.

backoff_config object

Configures back off when cos get Object.

3 nested properties
min_period string

Minimum backoff time when cos get Object.

max_period string

Maximum backoff time when cos get Object.

max_retries integer

Maximum number of times to retry when cos get Object. Default: 5.

api_key string

IAM API key to access COS.

service_instance_id string

COS service instance id to use.

auth_endpoint string

IAM Auth Endpoint for authentication.

cr_token_file_path string

Compute resource token file path.

trusted_profile_name string

Name of the trusted profile.

trusted_profile_id string

ID of the trusted profile.

distributor object
ring object
4 nested properties
kvstore object
5 nested properties
store string

Backend storage to use for the ring. Supported values are: consul, etcd, inmemory, memberlist, multi.

prefix string

The prefix for the keys in the store. Should end with a /.

consul object
etcd object
multi object
heartbeat_period string

Period at which to heartbeat to the ring. 0 = disabled.

heartbeat_timeout string

The heartbeat timeout after which distributors are considered unhealthy within the ring. 0 = never (timeout disabled).

instance_interface_names array | null

Name of network interface to read address from.

rate_store object
4 nested properties
max_request_parallelism integer

The max number of concurrent requests to make to ingester stream apis. Default: 200.

stream_rate_update_interval string

The interval on which distributors will update current stream rates from ingesters

ingester_request_timeout string

Timeout for communication between distributors and any given ingester when updating rates

debug boolean

If enabled, detailed logs and spans will be emitted.

write_failures_logging object

Customize the logging of write failures.

2 nested properties
rate string

Log volume allowed (per second). Default: 1KB. Default: 1KB.

add_insights_label boolean

Whether a insight=true key should be logged or not. Default: false.

otlp_config object
1 nested properties
default_resource_attributes_as_index_labels array | null

List of default otlp resource attributes to be picked as index labels

etcd object
endpoints array | null

The etcd endpoints to connect to.

dial_timeout string

The dial timeout for the etcd connection.

max_retries integer

The maximum number of retries to do for failed ops. Default: 10.

tls_enabled boolean

Enable TLS.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

username string

Etcd username.

password string

Etcd password.

frontend object
log_queries_longer_than string

Log queries that are slower than the specified duration. Set to 0 to disable. Set to < 0 to enable on all queries.

log_query_request_headers string

Comma-separated list of request header names to include in query logs. Applies to both query stats and slow queries logs.

max_body_size integer

Max body size for downstream prometheus. Default: 10485760.

query_stats_enabled boolean

True to enable query statistics tracking. When enabled, a message with some statistics is logged for every query.

max_outstanding_per_tenant integer

Maximum number of outstanding requests per tenant per frontend; requests beyond this error with HTTP 429. Default: 2048.

querier_forget_delay string

In the event a tenant is repeatedly sending queries that lead the querier to crash or be killed due to an out-of-memory error, the crashed querier will be disconnected from the query frontend and a new querier will be immediately assigned to the tenant’s shard. This invalidates the assumption that shuffle sharding can be used to reduce the impact on tenants. This option mitigates the impact by configuring a delay between when a querier disconnects because of a crash and when the crashed querier is actually removed from the tenant's shard.

scheduler_address string

DNS hostname used for finding query-schedulers.

scheduler_dns_lookup_period string

How often to resolve the scheduler-address, in order to look for new query-scheduler instances. Also used to determine how often to poll the scheduler-ring for addresses if the scheduler-ring is configured.

scheduler_worker_concurrency integer

Number of concurrent workers forwarding queries to single query-scheduler. Default: 5.

grpc_client_config object
20 nested properties
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
3 nested properties
min_period string

Minimum delay when backing off.

max_period string

Maximum delay when backing off.

max_retries integer

Number of times to backoff and retry before failing. Default: 10.

initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

graceful_shutdown_timeout string

Time to wait for inflight requests to finish before forcefully shutting down. This needs to be aligned with the query timeout and the graceful termination period of the process orchestrator.

instance_interface_names array | null

Name of network interface to read address from. This address is sent to query-scheduler and querier, which uses it to send the query response back to query-frontend.

encoding string

Defines the encoding for requests to and responses from the scheduler and querier. Can be 'json' or 'protobuf' (defaults to 'json').

compress_responses boolean

Compress HTTP responses.

downstream_url string

URL of downstream Loki.

tail_proxy_url string

URL of querier for tail proxy.

tail_tls_config object
7 nested properties
tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

frontend_worker object
frontend_address string

Address of query frontend service, in host:port format. If -querier.scheduler-address is set as well, querier will use scheduler instead. Only one of -querier.frontend-address or -querier.scheduler-address can be set. If neither is set, queries are only received via HTTP endpoint.

scheduler_address string

Hostname (and port) of scheduler that querier will periodically resolve, connect to and receive queries from. Only one of -querier.frontend-address or -querier.scheduler-address can be set. If neither is set, queries are only received via HTTP endpoint.

dns_lookup_duration string

How often to query DNS for query-frontend or query-scheduler address. Also used to determine how often to poll the scheduler-ring for addresses if the scheduler-ring is configured.

id string

Querier ID, sent to frontend service to identify requests from the same querier. Defaults to hostname.

grpc_client_config object
20 nested properties
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
3 nested properties
min_period string

Minimum delay when backing off.

max_period string

Maximum delay when backing off.

max_retries integer

Number of times to backoff and retry before failing. Default: 10.

initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

gcs_storage_config object
bucket_name string

Name of GCS bucket. Please refer to https://cloud.google.com/docs/authentication/production for more information about how to configure authentication.

service_account string

Service account key content in JSON format, refer to https://cloud.google.com/iam/docs/creating-managing-service-account-keys for creation.

chunk_buffer_size integer

The size of the buffer that GCS client for each PUT request. 0 to disable buffering. Default: 0.

request_timeout string

The duration after which the requests to GCS should be timed out.

enable_opencensus boolean

Enable OpenCensus (OC) instrumentation for all requests.

enable_http2 boolean

Enable HTTP2 connections.

enable_retries boolean

Enable automatic retries of failed idempotent requests.

grpc_client object
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
3 nested properties
min_period string

Minimum delay when backing off.

max_period string

Maximum delay when backing off.

max_retries integer

Number of times to backoff and retry before failing. Default: 10.

initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

index_gateway object
mode string

Defines in which mode the index gateway server will operate (default to 'simple'). It supports two modes:

  • 'simple': an index gateway server instance is responsible for handling, storing and returning requests for all indices for all tenants.
  • 'ring': an index gateway server instance is responsible for a subset of tenants instead of all tenants.
ring object

Defines the ring to be used by the index gateway servers and clients in case the servers are configured to run in 'ring' mode. In case this isn't configured, this block supports inheriting configuration from the common ring section.

13 nested properties
kvstore object
5 nested properties
store string

Backend storage to use for the ring. Supported values are: consul, etcd, inmemory, memberlist, multi.

prefix string

The prefix for the keys in the store. Should end with a /.

consul object
etcd object
multi object
heartbeat_period string

Period at which to heartbeat to the ring. 0 = disabled.

heartbeat_timeout string

The heartbeat timeout after which compactors are considered unhealthy within the ring. 0 = never (timeout disabled).

tokens_file_path string

File path where tokens are stored. If empty, tokens are not stored at shutdown and restored at startup.

zone_awareness_enabled boolean

True to enable zone-awareness and replicate blocks across different availability zones.

num_tokens
replication_factor integer

Deprecated: How many index gateway instances are assigned to each tenant. Use -index-gateway.shard-size instead. The shard size is also a per-tenant setting. Default: 3.

instance_id string

Instance ID to register in the ring.

instance_interface_names array | null

Name of network interface to read address from.

instance_port integer

Port to advertise in the ring (defaults to server.grpc-listen-port). Default: 0.

instance_addr string

IP address to advertise in the ring.

instance_availability_zone string

The availability zone where this instance is running. Required if zone-awareness is enabled.

instance_enable_ipv6 boolean

Enable using a IPv6 instance address.

ingester object
lifecycler object

Configures how the lifecycle of the ingester will operate and where it will register for discovery.

17 nested properties
ring object
5 nested properties
kvstore object
heartbeat_timeout string

The heartbeat timeout after which ingesters are skipped for reads/writes. 0 = never (timeout disabled).

replication_factor integer

The number of ingesters to write to and read from. Default: 3.

zone_awareness_enabled boolean

True to enable the zone-awareness and replicate ingested samples across different availability zones.

excluded_zones string

Comma-separated list of zones to exclude from the ring. Instances in excluded zones will be filtered out from the ring.

num_tokens integer

Number of tokens for each ingester. Default: 128.

heartbeat_period string

Period at which to heartbeat to consul. 0 = disabled.

heartbeat_timeout string

Heartbeat timeout after which instance is assumed to be unhealthy. 0 = disabled.

observe_period string

Observe tokens after generating to resolve collisions. Useful when using gossiping ring.

join_after string

Period to wait for a claim from another member; will join automatically after this.

min_ready_duration string

Minimum duration to wait after the internal readiness checks have passed but before succeeding the readiness endpoint. This is used to slowdown deployment controllers (eg. Kubernetes) after an instance is ready and before they proceed with a rolling update, to give the rest of the cluster instances enough time to receive ring updates.

interface_names array | null

Name of network interface to read address from.

enable_inet6 boolean

Enable IPv6 support. Required to make use of IP addresses from IPv6 interfaces.

final_sleep string

Duration to sleep for before exiting, to ensure metrics are scraped.

tokens_file_path string

File path where tokens are stored. If empty, tokens are not stored at shutdown and restored at startup.

availability_zone string

The availability zone where this instance is running.

unregister_on_shutdown boolean

Unregister from the ring upon clean shutdown. It can be useful to disable for rolling restarts with consistent naming in conjunction with -distributor.extend-writes=false.

readiness_check_ring_health boolean

When enabled the readiness probe succeeds only after all instances are ACTIVE and healthy in the ring, otherwise only the instance itself is checked. This option should be disabled if in your cluster multiple instances can be rolled out simultaneously, otherwise rolling updates may be slowed down.

address string

IP address to advertise in the ring.

port integer

port to advertise in consul (defaults to server.grpc-listen-port). Default: 0.

id string

ID to register in the ring.

concurrent_flushes integer

How many flushes can happen concurrently from each stream. Default: 32.

flush_check_period string

How often should the ingester see if there are any blocks to flush. The first flush check is delayed by a random time up to 0.8x the flush check period. Additionally, there is +/- 1% jitter added to the interval.

flush_op_timeout string

The timeout before a flush is cancelled.

chunk_retain_period string

How long chunks should be retained in-memory after they've been flushed.

chunk_idle_period string

How long chunks should sit in-memory with no updates before being flushed if they don't hit the max block size. This means that half-empty chunks will still be flushed after a certain period as long as they receive no further activity.

chunk_block_size integer

The targeted uncompressed size in bytes of a chunk block When this threshold is exceeded the head block will be cut and compressed inside the chunk. Default: 262144.

chunk_target_size integer

A target compressed size in bytes for chunks. This is a desired size not an exact size, chunks may be slightly bigger or significantly smaller if they get flushed for other reasons (e.g. chunk_idle_period). A value of 0 creates chunks with a fixed 10 blocks, a non zero value will create chunks with a variable number of blocks to meet the target size. Default: 1572864.

chunk_encoding string

The algorithm to use for compressing chunk. (none, gzip, lz4-64k, snappy, lz4-256k, lz4-1M, lz4, flate, zstd)

max_chunk_age string

The maximum duration of a timeseries chunk in memory. If a timeseries runs for longer than this, the current chunk will be flushed to the store and a new chunk created.

autoforget_unhealthy boolean

Forget about ingesters having heartbeat timestamps older than ring.kvstore.heartbeat_timeout. This is equivalent to clicking on the /ring forget button in the UI: the ingester is removed from the ring. This is a useful setting when you are sure that an unhealthy node won't return. An example is when not using stateful sets or the equivalent. Use memberlist.rejoin_interval > 0 to handle network partition cases when using a memberlist.

sync_period string

Parameters used to synchronize ingesters to cut chunks at the same moment. Sync period is used to roll over incoming entry to a new chunk. If chunk's utilization isn't high enough (eg. less than 50% when sync_min_utilization is set to 0.5), then this chunk rollover doesn't happen.

sync_min_utilization number

Minimum utilization of chunk when doing synchronization. Default: 0.1.

max_returned_stream_errors integer

The maximum number of errors a stream will report to the user when a push fails. 0 to make unlimited. Default: 10.

query_store_max_look_back_period string

How far back should an ingester be allowed to query the store for data, for use only with boltdb-shipper/tsdb index and filesystem object store. -1 for infinite.

wal object

The ingester WAL (Write Ahead Log) records incoming logs and stores them on the local file systems in order to guarantee persistence of acknowledged data in the event of a process crash.

5 nested properties
enabled boolean

Enable writing of ingested data into WAL.

dir string

Directory where the WAL data is stored and/or recovered from.

checkpoint_duration string

Interval at which checkpoints should be created.

flush_on_shutdown boolean

When WAL is enabled, should chunks be flushed to long-term storage on shutdown.

replay_memory_ceiling string

Maximum memory size the WAL may use during replay. After hitting this, it will flush data to storage before continuing. A unit suffix (KB, MB, GB) may be applied. Default: 4GB.

index_shards integer

Shard factor used in the ingesters for the in process reverse index. This MUST be evenly divisible by ALL schema shard factors or Loki will not start. Default: 32.

max_dropped_streams integer

Maximum number of dropped streams to keep in memory during tailing. Default: 10.

shutdown_marker_path string

Path where the shutdown marker file is stored. If not set and common.path_prefix is set then common.path_prefix will be used.

ingester_client object
pool_config object

Configures how connections are pooled.

3 nested properties
client_cleanup_period string

How frequently to clean up clients for ingesters that have gone away.

health_check_ingesters boolean

Run a health check on each ingester client during periodic cleanup.

remote_timeout string

How quickly a dead client will be removed after it has been detected to disappear. Set this to a value to allow time for a secondary health check to recover the missing client.

remote_timeout string

The remote request timeout on the client side.

grpc_client_config object
20 nested properties
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
3 nested properties
min_period string

Minimum delay when backing off.

max_period string

Maximum delay when backing off.

max_retries integer

Number of times to backoff and retry before failing. Default: 10.

initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

limits_config object
ingestion_rate_strategy string

Whether the ingestion rate limit should be applied individually to each distributor instance (local), or evenly shared across the cluster (global). The ingestion rate strategy cannot be overridden on a per-tenant basis.

  • local: enforces the limit on a per distributor basis. The actual effective rate limit will be N times higher, where N is the number of distributor replicas.
  • global: enforces the limit globally, configuring a per-distributor local rate limiter as 'ingestion_rate / N', where N is the number of distributor replicas (it's automatically adjusted if the number of replicas change). The global strategy requires the distributors to form their own ring, which is used to keep track of the current number of healthy distributor replicas.
ingestion_rate_mb number

Per-user ingestion rate limit in sample size per second. Units in MB. Default: 4.

ingestion_burst_size_mb number

Per-user allowed ingestion burst size (in sample size). Units in MB. The burst size refers to the per-distributor local rate limiter even in the case of the 'global' strategy, and should be set at least to the maximum logs size expected in a single push request. Default: 6.

max_label_name_length integer

Maximum length accepted for label names. Default: 1024.

max_label_value_length integer

Maximum length accepted for label value. This setting also applies to the metric name. Default: 2048.

max_label_names_per_series integer

Maximum number of label names per series. Default: 15.

reject_old_samples boolean

Whether or not old samples will be rejected.

reject_old_samples_max_age string

Maximum accepted sample age before rejecting.

creation_grace_period string

Duration which table will be created/deleted before/after it's needed; we won't accept sample from before this time.

max_line_size string

Maximum line size on ingestion path. Example: 256kb. Any log line exceeding this limit will be discarded unless distributor.max-line-size-truncate is set which in case it is truncated instead of discarding it completely. There is no limit when unset or set to 0. Default: 256KB.

max_line_size_truncate boolean

Whether to truncate lines that exceed max_line_size.

increment_duplicate_timestamp boolean

Alter the log line timestamp during ingestion when the timestamp is the same as the previous entry for the same stream. When enabled, if a log line in a push request has the same timestamp as the previous line for the same stream, one nanosecond is added to the log line. This will preserve the received order of log lines with the exact same timestamp when they are queried, by slightly altering their stored timestamp. NOTE: This is imperfect, because Loki accepts out of order writes, and another push request for the same stream could contain duplicate timestamps to existing entries and they will not be incremented.

discover_service_name array | null

If no service_name label exists, Loki maps a single label from the configured list to service_name. If none of the configured labels exist in the stream, label is set to unknown_service. Empty list disables setting the label.

discover_log_levels boolean

Discover and add log levels during ingestion, if not present already. Levels would be added to Structured Metadata with name 'level' and one of the values from 'debug', 'info', 'warn', 'error', 'critical', 'fatal'.

max_streams_per_user integer

Maximum number of active streams per user, per ingester. 0 to disable. Default: 0.

max_global_streams_per_user integer

Maximum number of active streams per user, across the cluster. 0 to disable. When the global limit is enabled, each ingester is configured with a dynamic local limit based on the replication factor and the current number of healthy ingesters, and is kept updated whenever the number of ingesters change. Default: 5000.

unordered_writes boolean

Deprecated. When true, out-of-order writes are accepted.

per_stream_rate_limit string

Maximum byte rate per second per stream, also expressible in human readable forms (1MB, 256KB, etc). Default: 3MB.

per_stream_rate_limit_burst string

Maximum burst bytes per stream, also expressible in human readable forms (1MB, 256KB, etc). This is how far above the rate limit a stream can 'burst' before the stream is limited. Default: 15MB.

max_chunks_per_query integer

Maximum number of chunks that can be fetched in a single query. Default: 2000000.

max_query_series integer

Limit the maximum of unique series that is returned by a metric query. When the limit is reached an error is returned. Default: 500.

max_query_lookback string

Limit how far back in time series data and metadata can be queried, up until lookback duration ago. This limit is enforced in the query frontend, the querier and the ruler. If the requested time range is outside the allowed range, the request will not fail, but will be modified to only query data within the allowed time range. The default value of 0 does not set a limit.

max_query_length string

The limit to length of chunk store queries. 0 to disable.

max_query_range string

Limit the length of the [range] inside a range query. Default is 0 or unlimited

max_query_parallelism integer

Maximum number of queries that will be scheduled in parallel by the frontend. Default: 32.

tsdb_max_query_parallelism integer

Maximum number of queries will be scheduled in parallel by the frontend for TSDB schemas. Default: 128.

tsdb_max_bytes_per_shard string

Target maximum number of bytes assigned to a single sharded query. Also expressible in human readable forms (1GB, etc). Note: This is a target and not an absolute limit. The actual limit can be higher, but the query planner will try to build shards up to this limit. Default: 600MB.

tsdb_sharding_strategy string

sharding strategy to use in query planning. Suggested to use bounded once all nodes can recognize it.

cardinality_limit integer

Cardinality limit for index queries. Default: 100000.

max_streams_matchers_per_query integer

Maximum number of stream matchers per query. Default: 1000.

max_concurrent_tail_requests integer

Maximum number of concurrent tail requests. Default: 10.

max_entries_limit_per_query integer

Maximum number of log entries that will be returned for a query. Default: 5000.

max_cache_freshness_per_query string

Most recent allowed cacheable result per-tenant, to prevent caching very recent results that might still be in flux.

max_metadata_cache_freshness string

Do not cache metadata request if the end time is within the frontend.max-metadata-cache-freshness window. Set this to 0 to apply no such limits. Defaults to 24h.

max_stats_cache_freshness string

Do not cache requests with an end time that falls within Now minus this duration. 0 disables this feature (default).

max_queriers_per_tenant integer

Maximum number of queriers that can handle requests for a single tenant. If set to 0 or value higher than number of available queriers, all queriers will handle requests for the tenant. Each frontend (or query-scheduler, if used) will select the same set of queriers for the same tenant (given that all queriers are connected to all frontends / query-schedulers). This option only works with queriers connecting to the query-frontend / query-scheduler, not when using downstream URL. Default: 0.

max_query_capacity number

How much of the available query capacity ("querier" components in distributed mode, "read" components in SSD mode) can be used by a single tenant. Allowed values are 0.0 to 1.0. For example, setting this to 0.5 would allow a tenant to use half of the available queriers for processing the query workload. If set to 0, query capacity is determined by frontend.max-queriers-per-tenant. When both frontend.max-queriers-per-tenant and frontend.max-query-capacity are configured, smaller value of the resulting querier replica count is considered: min(frontend.max-queriers-per-tenant, ceil(querier_replicas * frontend.max-query-capacity)). All queriers will handle requests for the tenant if neither limits are applied. This option only works with queriers connecting to the query-frontend / query-scheduler, not when using downstream URL. Use this feature in a multi-tenant setup where you need to limit query capacity for certain tenants. Default: 0.

query_ready_index_num_days integer

Number of days of index to be kept always downloaded for queries. Applies only to per user index in boltdb-shipper index store. 0 to disable. Default: 0.

query_timeout string

Timeout when querying backends (ingesters or storage) during the execution of a query request. When a specific per-tenant timeout is used, the global timeout is ignored.

split_queries_by_interval string

Split queries by a time interval and execute in parallel. The value 0 disables splitting by time. This also determines how cache keys are chosen when result caching is enabled.

split_metadata_queries_by_interval string

Split metadata queries by a time interval and execute in parallel. The value 0 disables splitting metadata queries by time. This also determines how cache keys are chosen when label/series result caching is enabled.

split_recent_metadata_queries_by_interval string

Experimental. Split interval to use for the portion of metadata request that falls within recent_metadata_query_window. Rest of the request which is outside the window still uses split_metadata_queries_by_interval. If set to 0, the entire request defaults to using a split interval of split_metadata_queries_by_interval..

recent_metadata_query_window string

Experimental. Metadata query window inside which split_recent_metadata_queries_by_interval gets applied, portion of the metadata request that falls in this window is split using split_recent_metadata_queries_by_interval. The value 0 disables using a different split interval for recent metadata queries.

This is added to improve cacheability of recent metadata queries. Query split interval also determines the interval used in cache key. The default split interval of 24h is useful for caching long queries, each cache key holding 1 day's results. But metadata queries are often shorter than 24h, to cache them effectively we need a smaller split interval. recent_metadata_query_window along with split_recent_metadata_queries_by_interval help configure a shorter split interval for recent metadata queries.

split_instant_metric_queries_by_interval string

Split instant metric queries by a time interval and execute in parallel. The value 0 disables splitting instant metric queries by time. This also determines how cache keys are chosen when instant metric query result caching is enabled.

split_ingester_queries_by_interval string

Interval to use for time-based splitting when a request is within the query_ingesters_within window; defaults to split-queries-by-interval by setting to 0.

min_sharding_lookback string

Limit queries that can be sharded. Queries within the time range of now and now minus this sharding lookback are not sharded. The default value of 0s disables the lookback, causing sharding of all queries at all times.

max_query_bytes_read string

Max number of bytes a query can fetch. Enforced in log and metric queries only when TSDB is used. The default value of 0 disables this limit. Default: 0B.

max_querier_bytes_read string

Max number of bytes a query can fetch after splitting and sharding. Enforced in log and metric queries only when TSDB is used. The default value of 0 disables this limit. Default: 150GB.

volume_enabled boolean

Enable log-volume endpoints.

volume_max_series integer

The maximum number of aggregated series in a log-volume response. Default: 1000.

ruler_max_rules_per_rule_group integer

Maximum number of rules per rule group per-tenant. 0 to disable. Default: 0.

ruler_max_rule_groups_per_tenant integer

Maximum number of rule groups per-tenant. 0 to disable. Default: 0.

ruler_tenant_shard_size integer

The default tenant's shard size when shuffle-sharding is enabled in the ruler. When this setting is specified in the per-tenant overrides, a value of 0 disables shuffle sharding for the tenant. Default: 0.

ruler_remote_write_disabled boolean

Disable recording rules remote-write.

ruler_remote_write_url string

Deprecated: Use 'ruler_remote_write_config' instead. The URL of the endpoint to send samples to.

ruler_remote_write_timeout string

Deprecated: Use 'ruler_remote_write_config' instead. Timeout for requests to the remote write endpoint.

ruler_remote_write_headers object

Deprecated: Use 'ruler_remote_write_config' instead. Custom HTTP headers to be sent along with each remote write request. Be aware that headers that are set by Loki itself can't be overwritten.

ruler_remote_write_relabel_configs array | null

Deprecated: Use 'ruler_remote_write_config' instead. List of remote write relabel configurations.

ruler_remote_write_queue_capacity integer

Deprecated: Use 'ruler_remote_write_config' instead. Number of samples to buffer per shard before we block reading of more samples from the WAL. It is recommended to have enough capacity in each shard to buffer several requests to keep throughput up while processing occasional slow remote requests.

ruler_remote_write_queue_min_shards integer

Deprecated: Use 'ruler_remote_write_config' instead. Minimum number of shards, i.e. amount of concurrency.

ruler_remote_write_queue_max_shards integer

Deprecated: Use 'ruler_remote_write_config' instead. Maximum number of shards, i.e. amount of concurrency.

ruler_remote_write_queue_max_samples_per_send integer

Deprecated: Use 'ruler_remote_write_config' instead. Maximum number of samples per send.

ruler_remote_write_queue_batch_send_deadline string

Deprecated: Use 'ruler_remote_write_config' instead. Maximum time a sample will wait in buffer.

ruler_remote_write_queue_min_backoff string

Deprecated: Use 'ruler_remote_write_config' instead. Initial retry delay. Gets doubled for every retry.

ruler_remote_write_queue_max_backoff string

Deprecated: Use 'ruler_remote_write_config' instead. Maximum retry delay.

ruler_remote_write_queue_retry_on_ratelimit boolean

Deprecated: Use 'ruler_remote_write_config' instead. Retry upon receiving a 429 status code from the remote-write storage. This is experimental and might change in the future.

ruler_remote_write_sigv4_config object

Deprecated: Use 'ruler_remote_write_config' instead. Configures AWS's Signature Verification 4 signing process to sign every remote write request.

5 nested properties
region string
access_key string
secret_key string
profile string
role_arn string
ruler_remote_write_config Record<string, object>

Configures global and per-tenant limits for remote write clients. A map with remote client id as key.

ruler_remote_evaluation_timeout string

Timeout for a remote rule evaluation. Defaults to the value of 'querier.query-timeout'.

ruler_remote_evaluation_max_response_size integer

Maximum size (in bytes) of the allowable response size from a remote rule evaluation. Set to 0 to allow any response size (default).

deletion_mode string

Deletion mode. Can be one of 'disabled', 'filter-only', or 'filter-and-delete'. When set to 'filter-only' or 'filter-and-delete', and if retention_enabled is true, then the log entry deletion API endpoints are available.

retention_period string

Retention period to apply to stored data, only applies if retention_enabled is true in the compactor config. As of version 2.8.0, a zero value of 0 or 0s disables retention. In previous releases, Loki did not properly honor a zero value to disable retention and a really large value should be used instead.

retention_stream array | null

Per-stream retention to apply, if the retention is enable on the compactor side. Example: retention_stream:

  • selector: '{namespace="dev"}' priority: 1 period: 24h
  • selector: '{container="nginx"}' priority: 1 period: 744h Selector is a Prometheus labels matchers that will apply the 'period' retention only if the stream is matching. In case multiple stream are matching, the highest priority will be picked. If no rule is matched the 'retention_period' is used.
per_tenant_override_config string

Feature renamed to 'runtime configuration', flag deprecated in favor of -runtime-config.file (runtime_config.file in YAML).

per_tenant_override_period string

Feature renamed to 'runtime configuration'; flag deprecated in favor of -runtime-config.reload-period (runtime_config.period in YAML).

allow_deletes boolean

Deprecated: Use deletion_mode per tenant configuration instead.

shard_streams object
3 nested properties
enabled boolean
logging_enabled boolean
desired_rate integer
blocked_queries array | null
required_labels array | null

Define a list of required selector labels.

minimum_labels_number integer

Minimum number of label matchers a query should contain.

index_gateway_shard_size integer

The shard size defines how many index gateways should be used by a tenant for querying. If the global shard factor is 0, the global shard factor is set to the deprecated -replication-factor for backwards compatibility reasons. Default: 0.

bloom_gateway_shard_size integer

Experimental. The shard size defines how many bloom gateways should be used by a tenant for querying. Default: 0.

bloom_gateway_enable_filtering boolean

Experimental. Whether to use the bloom gateway component in the read path to filter chunks.

bloom_gateway_cache_key_interval string

Experimental. Interval for computing the cache key in the Bloom Gateway.

bloom_compactor_shard_size integer

Experimental. The shard size defines how many bloom compactors should be used by a tenant when computing blooms. If it's set to 0, shuffle sharding is disabled. Default: 0.

bloom_compactor_enable_compaction boolean

Experimental. Whether to compact chunks into bloom filters.

bloom_compactor_max_block_size string

Experimental. The maximum bloom block size. A value of 0 sets an unlimited size. Default is 200MB. The actual block size might exceed this limit since blooms will be added to blocks until the block exceeds the maximum block size. Default: 200MB.

bloom_compactor_max_bloom_size string

Experimental. The maximum bloom size per log stream. A log stream whose generated bloom filter exceeds this size will be discarded. A value of 0 sets an unlimited size. Default is 128MB. Default: 128MB.

bloom_ngram_length integer

Experimental. Length of the n-grams created when computing blooms from log lines. Default: 4.

bloom_ngram_skip integer

Experimental. Skip factor for the n-grams created when computing blooms from log lines. Default: 1.

bloom_false_positive_rate number

Experimental. Scalable Bloom Filter desired false-positive rate. Default: 0.01.

bloom_block_encoding string

Experimental. Compression algorithm for bloom block pages.

allow_structured_metadata boolean

Allow user to send structured metadata in push payload.

max_structured_metadata_size string

Maximum size accepted for structured metadata per log line. Default: 64KB.

max_structured_metadata_entries_count integer

Maximum number of structured metadata entries per log line. Default: 128.

otlp_config object

OTLP log ingestion configurations

3 nested properties
resource_attributes object

Configuration for resource attributes to store them as index labels or Structured Metadata or drop them altogether

2 nested properties
ignore_defaults boolean

Configure whether to ignore the default list of resource attributes set in 'distributor.otlp.default_resource_attributes_as_index_labels' to be stored as index labels and only use the given resource attributes config

attributes_config array | null
scope_attributes array | null

Configuration for scope attributes to store them as Structured Metadata or drop them altogether

log_attributes array | null

Configuration for log attributes to store them as Structured Metadata or drop them altogether

local_storage_config object
directory string

Directory to store chunks in.

memberlist object
node_name string

Name of the node in memberlist cluster. Defaults to hostname.

randomize_node_name boolean

Add random suffix to the node name.

stream_timeout string

The timeout for establishing a connection with a remote node, and for read/write operations.

retransmit_factor integer

Multiplication factor used when sending out messages (factor * log(N+1)). Default: 4.

pull_push_interval string

How often to use pull/push sync.

gossip_interval string

How often to gossip.

gossip_nodes integer

How many nodes to gossip to. Default: 3.

gossip_to_dead_nodes_time string

How long to keep gossiping to dead nodes, to give them chance to refute their death.

dead_node_reclaim_time string

How soon can dead node's name be reclaimed with new address. 0 to disable.

compression_enabled boolean

Enable message compression. This can be used to reduce bandwidth usage at the cost of slightly more CPU utilization.

advertise_addr string

Gossip address to advertise to other members in the cluster. Used for NAT traversal.

advertise_port integer

Gossip port to advertise to other members in the cluster. Used for NAT traversal. Default: 7946.

cluster_label string

The cluster label is an optional string to include in outbound packets and gossip streams. Other members in the memberlist cluster will discard any message whose label doesn't match the configured one, unless the 'cluster-label-verification-disabled' configuration option is set to true.

cluster_label_verification_disabled boolean

When true, memberlist doesn't verify that inbound packets and gossip streams have the cluster label matching the configured one. This verification should be disabled while rolling out the change to the configured cluster label in a live memberlist cluster.

join_members array | null

Other cluster members to join. Can be specified multiple times. It can be an IP, hostname or an entry specified in the DNS Service Discovery format.

min_join_backoff string

Min backoff duration to join other cluster members.

max_join_backoff string

Max backoff duration to join other cluster members.

max_join_retries integer

Max number of retries to join other cluster members. Default: 10.

abort_if_cluster_join_fails boolean

If this node fails to join memberlist cluster, abort.

rejoin_interval string

If not 0, how often to rejoin the cluster. Occasional rejoin can help to fix the cluster split issue, and is harmless otherwise. For example when using only few components as a seed nodes (via -memberlist.join), then it's recommended to use rejoin. If -memberlist.join points to dynamic service that resolves to all gossiping nodes (eg. Kubernetes headless service), then rejoin is not needed.

left_ingesters_timeout string

How long to keep LEFT ingesters in the ring.

leave_timeout string

Timeout for leaving memberlist cluster.

message_history_buffer_bytes integer

How much space to use for keeping received and sent messages in memory for troubleshooting (two buffers). 0 to disable. Default: 0.

bind_addr array | null

IP address to listen on for gossip messages. Multiple addresses may be specified. Defaults to 0.0.0.0

bind_port integer

Port to listen on for gossip messages. Default: 7946.

packet_dial_timeout string

Timeout used when connecting to other nodes to send packet.

packet_write_timeout string

Timeout for writing 'packet' data.

tls_enabled boolean

Enable TLS on the memberlist transport layer.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

named_stores_config object
aws Record<string, object>
azure Record<string, object>
bos Record<string, object>
filesystem Record<string, object>
gcs Record<string, object>
alibabacloud Record<string, object>
swift Record<string, object>
cos Record<string, object>
operational_config object
log_stream_creation boolean

Log every new stream created by a push request (very verbose, recommend to enable via runtime config only).

log_push_request boolean

Log every push request (very verbose, recommend to enable via runtime config only).

log_push_request_streams boolean

Log every stream in a push request (very verbose, recommend to enable via runtime config only).

limited_log_push_errors boolean

Log push errors with a rate limited logger, will show client push errors without overly spamming logs.

period_config object
from string

The date of the first day that index buckets should be created. Use a date in the past if this is your only period_config, otherwise use a date when you want the schema to switch over. In YYYY-MM-DD format, for example: 2018-04-15.

store string

store and object_store below affect which <storage_config> key is used. Which index to use. Either tsdb or boltdb-shipper. Following stores are deprecated: aws, aws-dynamo, gcp, gcp-columnkey, bigtable, bigtable-hashed, cassandra, grpc.

object_store string

Which store to use for the chunks. Either aws (alias s3), azure, gcs, alibabacloud, bos, cos, swift, filesystem, or a named_store (refer to named_stores_config). Following stores are deprecated: aws-dynamo, gcp, gcp-columnkey, bigtable, bigtable-hashed, cassandra, grpc.

schema string

The schema version to use, current recommended schema is v13.

index object

Configures how the index is updated and stored.

4 nested properties
path_prefix string

Path prefix for index tables. Prefix always needs to end with a path delimiter '/', except when the prefix is empty.

prefix string

Table prefix for all period tables.

period string

Table period.

tags Record<string, string>

A map to be added to all managed tables.

chunks object

Configured how the chunks are updated and stored.

3 nested properties
prefix string

Table prefix for all period tables.

period string

Table period.

tags Record<string, string>

A map to be added to all managed tables.

row_shards integer

How many shards will be created. Only used if schema is v10 or greater. Default: 16.

querier object
tail_max_duration string

Maximum duration for which the live tailing requests are served.

extra_query_delay string

Time to wait before sending more than the minimum successful query requests.

query_ingesters_within string

Maximum lookback beyond which queries are not sent to ingester. 0 means all queries are sent to ingester.

engine object
1 nested properties
max_look_back_period string

The maximum amount of time to look back for log lines. Used only for instant log queries.

max_concurrent integer

The maximum number of queries that can be simultaneously processed by the querier. Default: 4.

query_store_only boolean

Only query the store, and not attempt any ingesters. This is useful for running a standalone querier pool operating only against stored data.

query_ingester_only boolean

When true, queriers only query the ingesters, and not stored data. This is useful when the object store is unavailable.

multi_tenant_queries_enabled boolean

When true, allow queries to span multiple tenants.

per_request_limits_enabled boolean

When true, querier limits sent via a header are enforced.

query_range object
align_queries_with_step boolean

Mutate incoming queries to align their start and end with their step.

results_cache object
2 nested properties
cache object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
memcached object
memcached_client object
redis object
embedded_cache object
compression string

Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.

cache_results boolean

Cache query results.

max_retries integer

Maximum number of retries for a single request; beyond this, the downstream error is returned. Default: 5.

parallelise_shardable_queries boolean

Perform query parallelisations based on storage sharding configuration and query ASTs. This feature is supported only by the chunks storage engine.

shard_aggregations string

A comma-separated list of LogQL vector and range aggregations that should be sharded

cache_index_stats_results boolean

Cache index stats query results.

index_stats_results_cache object

If a cache config is not specified and cache_index_stats_results is true, the config for the results cache is used.

2 nested properties
cache object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
memcached object
memcached_client object
redis object
embedded_cache object
compression string

Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.

cache_volume_results boolean

Cache volume query results.

volume_results_cache object

If a cache config is not specified and cache_volume_results is true, the config for the results cache is used.

2 nested properties
cache object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
memcached object
memcached_client object
redis object
embedded_cache object
compression string

Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.

cache_instant_metric_results boolean

Cache instant metric query results.

instant_metric_results_cache object

If a cache config is not specified and cache_instant_metric_results is true, the config for the results cache is used.

2 nested properties
cache object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
memcached object
memcached_client object
redis object
embedded_cache object
compression string

Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.

instant_metric_query_split_align boolean

Whether to align the splits of instant metric query with splitByInterval and query's exec time. Useful when instant_metric_cache is enabled

cache_series_results boolean

Cache series query results.

series_results_cache object

If series_results_cache is not configured and cache_series_results is true, the config for the results cache is used.

2 nested properties
cache object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
memcached object
memcached_client object
redis object
embedded_cache object
compression string

Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.

cache_label_results boolean

Cache label query results.

label_results_cache object

If label_results_cache is not configured and cache_label_results is true, the config for the results cache is used.

2 nested properties
cache object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
memcached object
memcached_client object
redis object
embedded_cache object
compression string

Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.

query_scheduler object
max_outstanding_requests_per_tenant integer

Maximum number of outstanding requests per tenant per query-scheduler. In-flight requests above this limit will fail with HTTP response status code 429. Default: 32000.

max_queue_hierarchy_levels integer

Maximum number of levels of nesting of hierarchical queues. 0 means that hierarchical queues are disabled. Default: 3.

querier_forget_delay string

If a querier disconnects without sending notification about graceful shutdown, the query-scheduler will keep the querier in the tenant's shard until the forget delay has passed. This feature is useful to reduce the blast radius when shuffle-sharding is enabled.

grpc_client_config object
20 nested properties
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
3 nested properties
min_period string

Minimum delay when backing off.

max_period string

Maximum delay when backing off.

max_retries integer

Number of times to backoff and retry before failing. Default: 10.

initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

use_scheduler_ring boolean

Set to true to have the query schedulers create and place themselves in a ring. If no frontend_address or scheduler_address are present anywhere else in the configuration, Loki will toggle this value to true.

scheduler_ring object

The hash ring configuration. This option is required only if use_scheduler_ring is true.

13 nested properties
kvstore object
5 nested properties
store string

Backend storage to use for the ring. Supported values are: consul, etcd, inmemory, memberlist, multi.

prefix string

The prefix for the keys in the store. Should end with a /.

consul object
etcd object
multi object
heartbeat_period string

Period at which to heartbeat to the ring. 0 = disabled.

heartbeat_timeout string

The heartbeat timeout after which compactors are considered unhealthy within the ring. 0 = never (timeout disabled).

tokens_file_path string

File path where tokens are stored. If empty, tokens are not stored at shutdown and restored at startup.

zone_awareness_enabled boolean

True to enable zone-awareness and replicate blocks across different availability zones.

num_tokens
replication_factor
instance_id string

Instance ID to register in the ring.

instance_interface_names array | null

Name of network interface to read address from.

instance_port integer

Port to advertise in the ring (defaults to server.grpc-listen-port). Default: 0.

instance_addr string

IP address to advertise in the ring.

instance_availability_zone string

The availability zone where this instance is running. Required if zone-awareness is enabled.

instance_enable_ipv6 boolean

Enable using a IPv6 instance address.

ruler object
external_url string

Base URL of the Grafana instance.

datasource_uid string

Datasource UID for the dashboard.

external_labels array | null

Labels to add to all alerts.

ruler_client object
20 nested properties
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
3 nested properties
min_period string

Minimum delay when backing off.

max_period string

Maximum delay when backing off.

max_retries integer

Number of times to backoff and retry before failing. Default: 10.

initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

evaluation_interval string

How frequently to evaluate rules.

poll_interval string

How frequently to poll for rule changes.

storage object

Deprecated: Use -ruler-storage. CLI flags and their respective YAML config options instead.

9 nested properties
type string

Method to use for backend rule storage (configdb, azure, gcs, s3, swift, local, bos, cos)

azure object
21 nested properties
environment string

Azure Cloud environment. Supported values are: AzureGlobal, AzureChinaCloud, AzureGermanCloud, AzureUSGovernment.

account_name string

Azure storage account name.

account_key string

Azure storage account key.

connection_string string

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.

container_name string

Name of the storage account blob container used to store chunks. This container must be created before running cortex.

endpoint_suffix string

Azure storage endpoint suffix without schema. The storage account name will be prefixed to this value to create the FQDN.

use_managed_identity boolean

Use Managed Identity to authenticate to the Azure storage account.

use_federated_token boolean

Use Federated Token to authenticate to the Azure storage account.

user_assigned_id string

User assigned identity ID to authenticate to the Azure storage account.

use_service_principal boolean

Use Service Principal to authenticate through Azure OAuth.

client_id string

Azure Service Principal ID(GUID).

client_secret string

Azure Service Principal secret key.

tenant_id string

Azure Tenant ID is used to authenticate through Azure OAuth.

chunk_delimiter string

Chunk delimiter for blob ID to be used

download_buffer_size integer

Preallocated buffer size for downloads. Default: 512000.

upload_buffer_size integer

Preallocated buffer size for uploads. Default: 256000.

upload_buffer_count integer

Number of buffers used to used to upload a chunk. Default: 1.

request_timeout string

Timeout for requests made against azure blob storage.

max_retries integer

Number of retries for a request which times out. Default: 5.

min_retry_delay string

Minimum time to wait before retrying a request.

max_retry_delay string

Maximum time to wait before retrying a request.

alibabacloud object
4 nested properties
bucket string

Name of OSS bucket.

endpoint string

oss Endpoint to connect to.

access_key_id string

alibabacloud Access Key ID

secret_access_key string

alibabacloud Secret Access Key

gcs object
7 nested properties
bucket_name string

Name of GCS bucket. Please refer to https://cloud.google.com/docs/authentication/production for more information about how to configure authentication.

service_account string

Service account key content in JSON format, refer to https://cloud.google.com/iam/docs/creating-managing-service-account-keys for creation.

chunk_buffer_size integer

The size of the buffer that GCS client for each PUT request. 0 to disable buffering. Default: 0.

request_timeout string

The duration after which the requests to GCS should be timed out.

enable_opencensus boolean

Enable OpenCensus (OC) instrumentation for all requests.

enable_http2 boolean

Enable HTTP2 connections.

enable_retries boolean

Enable automatic retries of failed idempotent requests.

s3 object
14 nested properties
s3 string

S3 endpoint URL with escaped Key and Secret encoded. If only region is specified as a host, proper endpoint will be deduced. Use inmemory:/// to use a mock in-memory implementation.

s3forcepathstyle boolean

Set this to true to force the request to use path-style addressing.

bucketnames string

Comma separated list of bucket names to evenly distribute chunks over. Overrides any buckets specified in s3.url flag

endpoint string

S3 Endpoint to connect to.

region string

AWS region to use.

access_key_id string

AWS Access Key ID

secret_access_key string

AWS Secret Access Key

session_token string

AWS Session Token

insecure boolean

Disable https on s3 connection.

http_config object
signature_version string

The signature version to use for authenticating against S3. Supported values are: v4.

storage_class string

The S3 storage class which objects will use. Supported values are: GLACIER, DEEP_ARCHIVE, GLACIER_IR, INTELLIGENT_TIERING, ONEZONE_IA, OUTPOSTS, REDUCED_REDUNDANCY, STANDARD, STANDARD_IA.

sse object
backoff_config object

Configures back off when S3 get Object.

bos object
4 nested properties
bucket_name string

Name of BOS bucket.

endpoint string

BOS endpoint to connect to.

access_key_id string

Baidu Cloud Engine (BCE) Access Key ID.

secret_access_key string

Baidu Cloud Engine (BCE) Secret Access Key.

swift object
19 nested properties
auth_version integer

OpenStack Swift authentication API version. 0 to autodetect. Default: 0.

auth_url string

OpenStack Swift authentication URL

internal boolean

Set this to true to use the internal OpenStack Swift endpoint URL

username string

OpenStack Swift username.

user_domain_name string

OpenStack Swift user's domain name.

user_domain_id string

OpenStack Swift user's domain ID.

user_id string

OpenStack Swift user ID.

password string

OpenStack Swift API key.

domain_id string

OpenStack Swift user's domain ID.

domain_name string

OpenStack Swift user's domain name.

project_id string

OpenStack Swift project ID (v2,v3 auth only).

project_name string

OpenStack Swift project name (v2,v3 auth only).

project_domain_id string

ID of the OpenStack Swift project's domain (v3 auth only), only needed if it differs the from user domain.

project_domain_name string

Name of the OpenStack Swift project's domain (v3 auth only), only needed if it differs from the user domain.

region_name string

OpenStack Swift Region to use (v2,v3 auth only).

container_name string

Name of the OpenStack Swift container to put chunks in.

max_retries integer

Max retries on requests error. Default: 3.

connect_timeout string

Time after which a connection attempt is aborted.

request_timeout string

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.

cos object
14 nested properties
forcepathstyle boolean

Set this to true to force the request to use path-style addressing.

bucketnames string

Comma separated list of bucket names to evenly distribute chunks over.

endpoint string

COS Endpoint to connect to.

region string

COS region to use.

access_key_id string

COS HMAC Access Key ID.

secret_access_key string

COS HMAC Secret Access Key.

http_config object
backoff_config object

Configures back off when cos get Object.

api_key string

IAM API key to access COS.

service_instance_id string

COS service instance id to use.

auth_endpoint string

IAM Auth Endpoint for authentication.

cr_token_file_path string

Compute resource token file path.

trusted_profile_name string

Name of the trusted profile.

trusted_profile_id string

ID of the trusted profile.

local object

Configures backend rule storage for a local file system directory.

1 nested properties
directory string

Directory to scan for rules

rule_path string

File path to store temporary rule files.

alertmanager_url string

Comma-separated list of Alertmanager URLs to send notifications to. Each Alertmanager URL is treated as a separate group in the configuration. Multiple Alertmanagers in HA per group can be supported by using DNS resolution via '-ruler.alertmanager-discovery'.

enable_alertmanager_discovery boolean

Use DNS SRV records to discover Alertmanager hosts.

alertmanager_refresh_interval string

How long to wait between refreshing DNS resolutions of Alertmanager hosts.

enable_alertmanager_v2 boolean

If enabled requests to Alertmanager will utilize the V2 API.

alert_relabel_configs array | null

List of alert relabel configs.

notification_queue_capacity integer

Capacity of the queue for notifications to be sent to the Alertmanager. Default: 10000.

notification_timeout string

HTTP timeout duration when sending notifications to the Alertmanager.

alertmanager_client object
12 nested properties
tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

basic_auth_username string

HTTP Basic authentication username. It overrides the username set in the URL (if any).

basic_auth_password string

HTTP Basic authentication password. It overrides the password set in the URL (if any).

type string

HTTP Header authorization type (default: Bearer).

credentials string

HTTP Header authorization credentials.

credentials_file string

HTTP Header authorization credentials file.

for_outage_tolerance string

Max time to tolerate outage for restoring "for" state of alert.

for_grace_period string

Minimum duration between alert and restored "for" state. This is maintained only for alerts with configured "for" time greater than the grace period.

resend_delay string

Minimum amount of time to wait before resending an alert to Alertmanager.

enable_sharding boolean

Distribute rule evaluation using ring backend.

sharding_strategy string

The sharding strategy to use. Supported values are: default, shuffle-sharding.

sharding_algo string

The sharding algorithm to use for deciding how rules & groups are sharded. Supported values are: by-group, by-rule.

search_pending_for string

Time to spend searching for a pending ruler when shutting down.

ring object

Ring used by Loki ruler. The CLI flags prefix for this block configuration is 'ruler.ring'.

5 nested properties
kvstore object
5 nested properties
store string

Backend storage to use for the ring. Supported values are: consul, etcd, inmemory, memberlist, multi.

prefix string

The prefix for the keys in the store. Should end with a /.

consul object
etcd object
multi object
heartbeat_period string

Interval between heartbeats sent to the ring. 0 = disabled.

heartbeat_timeout string

The heartbeat timeout after which ruler ring members are considered unhealthy within the ring. 0 = never (timeout disabled).

instance_interface_names array | null

Name of network interface to read addresses from.

num_tokens integer

The number of tokens the lifecycler will generate and put into the ring if it joined without transferring tokens from another lifecycler. Default: 128.

flush_period string

Period with which to attempt to flush rule groups.

enable_api boolean

Enable the ruler API.

enabled_tenants string

Comma separated list of tenants whose rules this ruler can evaluate. If specified, only these tenants will be handled by ruler, otherwise this ruler can process rules from all tenants. Subject to sharding.

disabled_tenants string

Comma separated list of tenants whose rules this ruler cannot evaluate. If specified, a ruler that would normally pick the specified tenant(s) for processing will ignore them instead. Subject to sharding.

query_stats_enabled boolean

Report the wall time for ruler queries to complete as a per user metric and as an info level log message.

disable_rule_group_label boolean

Disable the rule_group label on exported metrics.

wal object
4 nested properties
dir string

The directory in which to write tenant WAL files. Each tenant will have its own directory one level below this directory.

truncate_frequency string

Frequency with which to run the WAL truncation process.

min_age string

Minimum age that samples must exist in the WAL before being truncated.

max_age string

Maximum age that samples must exist in the WAL before being truncated.

wal_cleaner object
2 nested properties
min_age string

The minimum age of a WAL to consider for cleaning.

period string

How often to run the WAL cleaner. 0 = disabled.

remote_write object

Remote-write configuration to send rule samples to a Prometheus remote-write endpoint.

5 nested properties
client object

Remote-write configuration to send rule samples to a Prometheus remote-write endpoint.

5 nested properties
client object

Remote-write configuration to send rule samples to a Prometheus remote-write endpoint.

clients Record<string, object>

Configure remote write clients. A map with remote client id as key.

enabled boolean

Enable remote-write functionality.

config_refresh_period string

Minimum period to wait between refreshing remote-write reconfigurations. This should be greater than or equivalent to -limits.per-user-override-period.

add_org_id_header boolean

Add X-Scope-OrgID header in remote write requests.

clients Record<string, object>

Configure remote write clients. A map with remote client id as key.

enabled boolean

Enable remote-write functionality.

config_refresh_period string

Minimum period to wait between refreshing remote-write reconfigurations. This should be greater than or equivalent to -limits.per-user-override-period.

add_org_id_header boolean

Add X-Scope-OrgID header in remote write requests.

evaluation object

Configuration for rule evaluation.

3 nested properties
mode string

The evaluation mode for the ruler. Can be either 'local' or 'remote'. If set to 'local', the ruler will evaluate rules locally. If set to 'remote', the ruler will evaluate rules remotely. If unset, the ruler will evaluate rules locally.

max_jitter string

Upper bound of random duration to wait before rule evaluation to avoid contention during concurrent execution of rules. Jitter is calculated consistently for a given rule. Set 0 to disable (default).

query_frontend object
9 nested properties
address string

GRPC listen address of the query-frontend(s). Must be a DNS address (prefixed with dns:///) to enable client side load balancing.

tls_enabled boolean

Set to true if query-frontend connection requires TLS.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

runtime_config object
period string

How often to check runtime config files.

file string

Comma separated list of yaml files with the configuration that can be updated at runtime. Runtime config files will be merged from left to right.

s3_storage_config object
s3 string

S3 endpoint URL with escaped Key and Secret encoded. If only region is specified as a host, proper endpoint will be deduced. Use inmemory:/// to use a mock in-memory implementation.

s3forcepathstyle boolean

Set this to true to force the request to use path-style addressing.

bucketnames string

Comma separated list of bucket names to evenly distribute chunks over. Overrides any buckets specified in s3.url flag

endpoint string

S3 Endpoint to connect to.

region string

AWS region to use.

access_key_id string

AWS Access Key ID

secret_access_key string

AWS Secret Access Key

session_token string

AWS Session Token

insecure boolean

Disable https on s3 connection.

http_config object
5 nested properties
timeout string

Timeout specifies a time limit for requests made by s3 Client.

idle_conn_timeout string

The maximum amount of time an idle connection will be held open.

response_header_timeout string

If non-zero, specifies the amount of time to wait for a server's response headers after fully writing the request.

insecure_skip_verify boolean

Set to true to skip verifying the certificate chain and hostname.

ca_file string

Path to the trusted CA file that signed the SSL certificate of the S3 endpoint.

signature_version string

The signature version to use for authenticating against S3. Supported values are: v4.

storage_class string

The S3 storage class which objects will use. Supported values are: GLACIER, DEEP_ARCHIVE, GLACIER_IR, INTELLIGENT_TIERING, ONEZONE_IA, OUTPOSTS, REDUCED_REDUNDANCY, STANDARD, STANDARD_IA.

sse object
3 nested properties
type string

Enable AWS Server Side Encryption. Supported values: SSE-KMS, SSE-S3.

kms_key_id string

KMS Key ID used to encrypt objects in S3

kms_encryption_context string

KMS Encryption Context used for object encryption. It expects JSON formatted string.

backoff_config object

Configures back off when S3 get Object.

3 nested properties
min_period string

Minimum backoff time when s3 get Object

max_period string

Maximum backoff time when s3 get Object

max_retries integer

Maximum number of times to retry when s3 get Object. Default: 5.

schema_config object
configs array | null
server object
http_listen_network string

HTTP server listen network, default tcp

http_listen_address string

HTTP server listen address.

http_listen_port integer

HTTP server listen port. Default: 3100.

http_listen_conn_limit integer

Maximum number of simultaneous http connections, <=0 to disable. Default: 0.

grpc_listen_network string

gRPC server listen network

grpc_listen_address string

gRPC server listen address.

grpc_listen_port integer

gRPC server listen port. Default: 9095.

grpc_listen_conn_limit integer

Maximum number of simultaneous grpc connections, <=0 to disable. Default: 0.

tls_cipher_suites string

Comma-separated list of cipher suites to use. If blank, the default Go cipher suites is used.

tls_min_version string

Minimum TLS version to use. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13. If blank, the Go TLS minimum version is used.

http_tls_config object
7 nested properties
cert string

Server TLS certificate. This configuration parameter is YAML only.

key string

Server TLS key. This configuration parameter is YAML only.

client_ca string

Root certificate authority used to verify client certificates. This configuration parameter is YAML only.

cert_file string

HTTP server cert path.

key_file string

HTTP server key path.

client_auth_type string

HTTP TLS Client Auth type.

client_ca_file string

HTTP TLS Client CA path.

grpc_tls_config object
7 nested properties
cert string

Server TLS certificate. This configuration parameter is YAML only.

key string

Server TLS key. This configuration parameter is YAML only.

client_ca string

Root certificate authority used to verify client certificates. This configuration parameter is YAML only.

cert_file string

GRPC TLS server cert path.

key_file string

GRPC TLS server key path.

client_auth_type string

GRPC TLS Client Auth type.

client_ca_file string

GRPC TLS Client CA path.

register_instrumentation boolean

Register the instrumentation handlers (/metrics etc).

report_grpc_codes_in_instrumentation_label_enabled boolean

If set to true, gRPC statuses will be reported in instrumentation labels with their string representations. Otherwise, they will be reported as "error".

graceful_shutdown_timeout string

Timeout for graceful shutdowns

http_server_read_timeout string

Read timeout for entire HTTP request, including headers and body.

http_server_read_header_timeout string

Read timeout for HTTP request headers. If set to 0, value of -server.http-read-timeout is used.

http_server_write_timeout string

Write timeout for HTTP server

http_server_idle_timeout string

Idle timeout for HTTP server

http_log_closed_connections_without_response_enabled boolean

Log closed connections that did not receive any response, most likely because client didn't send any request within timeout.

grpc_server_max_recv_msg_size integer

Limit on the size of a gRPC message this server can receive (bytes). Default: 4194304.

grpc_server_max_send_msg_size integer

Limit on the size of a gRPC message this server can send (bytes). Default: 4194304.

grpc_server_max_concurrent_streams integer

Limit on the number of concurrent streams for gRPC calls per client connection (0 = unlimited). Default: 100.

grpc_server_max_connection_idle string

The duration after which an idle connection should be closed. Default: infinity

grpc_server_max_connection_age string

The duration for the maximum amount of time a connection may exist before it will be closed. Default: infinity

grpc_server_max_connection_age_grace string

An additive period after max-connection-age after which the connection will be forcibly closed. Default: infinity

grpc_server_keepalive_time string

Duration after which a keepalive probe is sent in case of no activity over the connection., Default: 2h

grpc_server_keepalive_timeout string

After having pinged for keepalive check, the duration after which an idle connection should be closed, Default: 20s

grpc_server_min_time_between_pings string

Minimum amount of time a client should wait before sending a keepalive ping. If client sends keepalive ping more often, server will send GOAWAY and close the connection.

grpc_server_ping_without_stream_allowed boolean

If true, server allows keepalive pings even when there are no active streams(RPCs). If false, and client sends ping when there are no active streams, server will send GOAWAY and close the connection.

grpc_server_num_workers integer

If non-zero, configures the amount of GRPC server workers used to serve the requests. Default: 0.

log_format string

Output log messages in the given format. Valid formats: [logfmt, json]

log_level string

Only log messages with the given severity or above. Valid levels: [debug, info, warn, error]

log_source_ips_enabled boolean

Optionally log the source IPs.

log_source_ips_header string

Header field storing the source IPs. Only used if server.log-source-ips-enabled is true. If not set the default Forwarded, X-Real-IP and X-Forwarded-For headers are used

log_source_ips_regex string

Regex for matching the source IPs. Only used if server.log-source-ips-enabled is true. If not set the default Forwarded, X-Real-IP and X-Forwarded-For headers are used

log_request_headers boolean

Optionally log request headers.

log_request_at_info_level_enabled boolean

Optionally log requests at info level instead of debug level. Applies to request headers as well if server.log-request-headers is enabled.

log_request_exclude_headers_list string

Comma separated list of headers to exclude from logging. Only used if server.log-request-headers is true.

http_path_prefix string

Base path to serve all API routes from (e.g. /v1/)

storage_config object
alibabacloud object
4 nested properties
bucket string

Name of OSS bucket.

endpoint string

oss Endpoint to connect to.

access_key_id string

alibabacloud Access Key ID

secret_access_key string

alibabacloud Secret Access Key

aws object
15 nested properties
dynamodb object

Deprecated: Configures storing indexes in DynamoDB.

8 nested properties
dynamodb_url string

DynamoDB endpoint URL with escaped Key and Secret encoded. If only region is specified as a host, proper endpoint will be deduced. Use inmemory:/// to use a mock in-memory implementation.

api_limit number

DynamoDB table management requests per second limit. Default: 2.

throttle_limit number

DynamoDB rate cap to back off when throttled. Default: 10.

metrics object
chunk_gang_size integer

Number of chunks to group together to parallelise fetches (zero to disable). Default: 10.

chunk_get_max_parallelism integer

Max number of chunk-get operations to start in parallel. Default: 32.

backoff_config object
kms_key_id string

KMS key used for encrypting DynamoDB items. DynamoDB will use an Amazon owned KMS key if not provided.

s3 string

S3 endpoint URL with escaped Key and Secret encoded. If only region is specified as a host, proper endpoint will be deduced. Use inmemory:/// to use a mock in-memory implementation.

s3forcepathstyle boolean

Set this to true to force the request to use path-style addressing.

bucketnames string

Comma separated list of bucket names to evenly distribute chunks over. Overrides any buckets specified in s3.url flag

endpoint string

S3 Endpoint to connect to.

region string

AWS region to use.

access_key_id string

AWS Access Key ID

secret_access_key string

AWS Secret Access Key

session_token string

AWS Session Token

insecure boolean

Disable https on s3 connection.

http_config object
5 nested properties
timeout string

Timeout specifies a time limit for requests made by s3 Client.

idle_conn_timeout string

The maximum amount of time an idle connection will be held open.

response_header_timeout string

If non-zero, specifies the amount of time to wait for a server's response headers after fully writing the request.

insecure_skip_verify boolean

Set to true to skip verifying the certificate chain and hostname.

ca_file string

Path to the trusted CA file that signed the SSL certificate of the S3 endpoint.

signature_version string

The signature version to use for authenticating against S3. Supported values are: v4.

storage_class string

The S3 storage class which objects will use. Supported values are: GLACIER, DEEP_ARCHIVE, GLACIER_IR, INTELLIGENT_TIERING, ONEZONE_IA, OUTPOSTS, REDUCED_REDUNDANCY, STANDARD, STANDARD_IA.

sse object
3 nested properties
type string

Enable AWS Server Side Encryption. Supported values: SSE-KMS, SSE-S3.

kms_key_id string

KMS Key ID used to encrypt objects in S3

kms_encryption_context string

KMS Encryption Context used for object encryption. It expects JSON formatted string.

backoff_config object

Configures back off when S3 get Object.

3 nested properties
min_period string

Minimum backoff time when s3 get Object

max_period string

Maximum backoff time when s3 get Object

max_retries integer

Maximum number of times to retry when s3 get Object. Default: 5.

azure object
21 nested properties
environment string

Azure Cloud environment. Supported values are: AzureGlobal, AzureChinaCloud, AzureGermanCloud, AzureUSGovernment.

account_name string

Azure storage account name.

account_key string

Azure storage account key.

connection_string string

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.

container_name string

Name of the storage account blob container used to store chunks. This container must be created before running cortex.

endpoint_suffix string

Azure storage endpoint suffix without schema. The storage account name will be prefixed to this value to create the FQDN.

use_managed_identity boolean

Use Managed Identity to authenticate to the Azure storage account.

use_federated_token boolean

Use Federated Token to authenticate to the Azure storage account.

user_assigned_id string

User assigned identity ID to authenticate to the Azure storage account.

use_service_principal boolean

Use Service Principal to authenticate through Azure OAuth.

client_id string

Azure Service Principal ID(GUID).

client_secret string

Azure Service Principal secret key.

tenant_id string

Azure Tenant ID is used to authenticate through Azure OAuth.

chunk_delimiter string

Chunk delimiter for blob ID to be used

download_buffer_size integer

Preallocated buffer size for downloads. Default: 512000.

upload_buffer_size integer

Preallocated buffer size for uploads. Default: 256000.

upload_buffer_count integer

Number of buffers used to used to upload a chunk. Default: 1.

request_timeout string

Timeout for requests made against azure blob storage.

max_retries integer

Number of retries for a request which times out. Default: 5.

min_retry_delay string

Minimum time to wait before retrying a request.

max_retry_delay string

Maximum time to wait before retrying a request.

bos object
4 nested properties
bucket_name string

Name of BOS bucket.

endpoint string

BOS endpoint to connect to.

access_key_id string

Baidu Cloud Engine (BCE) Access Key ID.

secret_access_key string

Baidu Cloud Engine (BCE) Secret Access Key.

bigtable object

Deprecated: Configures storing indexes in Bigtable. Required fields only required when bigtable is defined in config.

5 nested properties
project string

Bigtable project ID.

instance string

Bigtable instance ID. Please refer to https://cloud.google.com/docs/authentication/production for more information about how to configure authentication.

grpc_client_config object
20 nested properties
max_recv_msg_size integer

gRPC client max receive message size (bytes). Default: 104857600.

max_send_msg_size integer

gRPC client max send message size (bytes). Default: 104857600.

grpc_compression string

Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)

rate_limit number

Rate limit for gRPC client; 0 means disabled. Default: 0.

rate_limit_burst integer

Rate limit burst for gRPC client. Default: 0.

backoff_on_ratelimits boolean

Enable backoff and retry when we hit rate limits.

backoff_config object
initial_stream_window_size string

Initial stream window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

initial_connection_window_size string

Initial connection window size. Values less than the default are not supported and are ignored. Setting this to a value other than the default disables the BDP estimator. Default: 63KiB1023B.

tls_enabled boolean

Enable TLS in the gRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

connect_timeout string

The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.

connect_backoff_base_delay string

Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.

connect_backoff_max_delay string

Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.

table_cache_enabled boolean

If enabled, once a tables info is fetched, it is cached.

table_cache_expiration string

Duration to cache tables before checking again.

gcs object
7 nested properties
bucket_name string

Name of GCS bucket. Please refer to https://cloud.google.com/docs/authentication/production for more information about how to configure authentication.

service_account string

Service account key content in JSON format, refer to https://cloud.google.com/iam/docs/creating-managing-service-account-keys for creation.

chunk_buffer_size integer

The size of the buffer that GCS client for each PUT request. 0 to disable buffering. Default: 0.

request_timeout string

The duration after which the requests to GCS should be timed out.

enable_opencensus boolean

Enable OpenCensus (OC) instrumentation for all requests.

enable_http2 boolean

Enable HTTP2 connections.

enable_retries boolean

Enable automatic retries of failed idempotent requests.

cassandra object

Deprecated: Configures storing chunks and/or the index in Cassandra.

27 nested properties
addresses string

Comma-separated hostnames or IPs of Cassandra instances.

port integer

Port that Cassandra is running on. Default: 9042.

keyspace string

Keyspace to use in Cassandra.

consistency string

Consistency level for Cassandra.

replication_factor integer

Replication factor to use in Cassandra. Default: 3.

disable_initial_host_lookup boolean

Instruct the cassandra driver to not attempt to get host info from the system.peers table.

SSL boolean

Use SSL when connecting to cassandra instances.

host_verification boolean

Require SSL certificate validation.

host_selection_policy string

Policy for selecting Cassandra host. Supported values are: round-robin, token-aware.

CA_path string

Path to certificate file to verify the peer.

tls_cert_path string

Path to certificate file used by TLS.

tls_key_path string

Path to private key file used by TLS.

auth boolean

Enable password authentication when connecting to cassandra.

username string

Username to use when connecting to cassandra.

password string

Password to use when connecting to cassandra.

password_file string

File containing password to use when connecting to cassandra.

custom_authenticators array | null

If set, when authenticating with cassandra a custom authenticator will be expected during the handshake. This flag can be set multiple times.

timeout string

Timeout when connecting to cassandra.

connect_timeout string

Initial connection timeout, used during initial dial to server.

reconnect_interval string

Interval to retry connecting to cassandra nodes marked as DOWN.

max_retries integer

Number of retries to perform on a request. Set to 0 to disable retries. Default: 0.

retry_max_backoff string

Maximum time to wait before retrying a failed request.

retry_min_backoff string

Minimum time to wait before retrying a failed request.

query_concurrency integer

Limit number of concurrent queries to Cassandra. Set to 0 to disable the limit. Default: 0.

num_connections integer

Number of TCP connections per host. Default: 2.

convict_hosts_on_failure boolean

Convict hosts of being down on failure.

table_options string

Table options used to create index or chunk tables. This value is used as plain text in the table WITH like this, "CREATE TABLE <generated_by_cortex> (...) WITH <cassandra.table-options>". For details, see https://cortexmetrics.io/docs/production/cassandra. By default it will use the default table options of your Cassandra cluster.

boltdb object

Deprecated: Configures storing index in BoltDB. Required fields only required when boltdb is present in the configuration.

1 nested properties
directory string

Location of BoltDB index files.

filesystem object
1 nested properties
directory string

Directory to store chunks in.

swift object
19 nested properties
auth_version integer

OpenStack Swift authentication API version. 0 to autodetect. Default: 0.

auth_url string

OpenStack Swift authentication URL

internal boolean

Set this to true to use the internal OpenStack Swift endpoint URL

username string

OpenStack Swift username.

user_domain_name string

OpenStack Swift user's domain name.

user_domain_id string

OpenStack Swift user's domain ID.

user_id string

OpenStack Swift user ID.

password string

OpenStack Swift API key.

domain_id string

OpenStack Swift user's domain ID.

domain_name string

OpenStack Swift user's domain name.

project_id string

OpenStack Swift project ID (v2,v3 auth only).

project_name string

OpenStack Swift project name (v2,v3 auth only).

project_domain_id string

ID of the OpenStack Swift project's domain (v3 auth only), only needed if it differs the from user domain.

project_domain_name string

Name of the OpenStack Swift project's domain (v3 auth only), only needed if it differs from the user domain.

region_name string

OpenStack Swift Region to use (v2,v3 auth only).

container_name string

Name of the OpenStack Swift container to put chunks in.

max_retries integer

Max retries on requests error. Default: 3.

connect_timeout string

Time after which a connection attempt is aborted.

request_timeout string

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.

grpc_store object

Deprecated:

1 nested properties
server_address string

Hostname or IP of the gRPC store instance.

hedging object
3 nested properties
at string

If set to a non-zero value a second request will be issued at the provided duration. Default is 0 (disabled)

up_to integer

The maximum of hedge requests allowed. Default: 2.

max_per_second integer

The maximum of hedge requests allowed per seconds. Default: 5.

named_stores object
8 nested properties
aws Record<string, object>
azure Record<string, object>
bos Record<string, object>
filesystem Record<string, object>
gcs Record<string, object>
alibabacloud Record<string, object>
swift Record<string, object>
cos Record<string, object>
cos object
14 nested properties
forcepathstyle boolean

Set this to true to force the request to use path-style addressing.

bucketnames string

Comma separated list of bucket names to evenly distribute chunks over.

endpoint string

COS Endpoint to connect to.

region string

COS region to use.

access_key_id string

COS HMAC Access Key ID.

secret_access_key string

COS HMAC Secret Access Key.

http_config object
2 nested properties
idle_conn_timeout string

The maximum amount of time an idle connection will be held open.

response_header_timeout string

If non-zero, specifies the amount of time to wait for a server's response headers after fully writing the request.

backoff_config object

Configures back off when cos get Object.

3 nested properties
min_period string

Minimum backoff time when cos get Object.

max_period string

Maximum backoff time when cos get Object.

max_retries integer

Maximum number of times to retry when cos get Object. Default: 5.

api_key string

IAM API key to access COS.

service_instance_id string

COS service instance id to use.

auth_endpoint string

IAM Auth Endpoint for authentication.

cr_token_file_path string

Compute resource token file path.

trusted_profile_name string

Name of the trusted profile.

trusted_profile_id string

ID of the trusted profile.

index_cache_validity string

Cache validity for active index entries. Should be no higher than -ingester.max-chunk-idle.

congestion_control object
4 nested properties
enabled boolean

Use storage congestion control (default: disabled).

controller object
2 nested properties
strategy string

Congestion control strategy to use (default: none, options: 'aimd').

aimd object
retry object
2 nested properties
strategy string

Congestion control retry strategy to use (default: none, options: 'limited').

limit integer

Maximum number of retries allowed. Default: 2.

hedging object
2 nested properties
config object
strategy string

Congestion control hedge strategy to use (default: none, options: 'limited').

object_prefix string

Experimental. Sets a constant prefix for all keys inserted into object storage. Example: loki/

index_queries_cache_config object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
3 nested properties
writeback_goroutines integer

At what concurrency to write back to cache. Default: 1.

writeback_buffer integer

How many key batches to buffer for background write-back. Default is large to prefer size based limiting. Default: 500000.

writeback_size_limit string

Size limit in bytes for background write-back. Default: 500MB.

memcached object
3 nested properties
expiration string

How long keys stay in the memcache.

batch_size integer

How many keys to fetch in each batch. Default: 4.

parallelism integer

Maximum active requests to memcache. Default: 5.

memcached_client object
19 nested properties
host string

Hostname for memcached service to use. If empty and if addresses is unset, no memcached will be used.

service string

SRV service used to discover memcache servers.

addresses string
timeout string

Maximum time to wait before giving up on memcached requests.

max_idle_conns integer

Maximum number of idle connections in pool. Default: 16.

max_item_size integer

The maximum size of an item stored in memcached. Bigger items are not stored. If set to 0, no maximum size is enforced. Default: 0.

update_interval string

Period with which to poll DNS for memcache servers.

consistent_hash boolean

Use consistent hashing to distribute to memcache servers.

circuit_breaker_consecutive_failures integer

Trip circuit-breaker after this number of consecutive dial failures (if zero then circuit-breaker is disabled). Default: 10.

circuit_breaker_timeout string

Duration circuit-breaker remains open after tripping (if zero then 60 seconds is used).

circuit_breaker_interval string

Reset circuit-breaker counts after this long (if zero then never reset).

tls_enabled boolean

Enable connecting to Memcached with TLS.

tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

redis object
13 nested properties
endpoint string

Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. If empty, no redis will be used.

master_name string

Redis Sentinel master name. An empty string for Redis Server or Redis Cluster.

timeout string

Maximum time to wait before giving up on redis requests.

expiration string

How long keys stay in the redis.

db integer

Database index. Default: 0.

pool_size integer

Maximum number of connections in the pool. Default: 0.

username string

Username to use when connecting to redis.

password string

Password to use when connecting to redis.

tls_enabled boolean

Enable connecting to redis with TLS.

tls_insecure_skip_verify boolean

Skip validating server certificate.

idle_timeout string

Close connections after remaining idle for this duration. If the value is zero, then idle connections are not closed.

max_connection_age string

Close connections older than this duration. If the value is zero, then the pool does not close connections based on age.

route_randomly boolean

By default, the Redis client only reads from the master node. Enabling this option can lower pressure on the master node by randomly routing read-only commands to the master and any available replicas.

embedded_cache object
4 nested properties
enabled boolean

Whether embedded cache is enabled.

max_size_mb integer

Maximum memory size of the cache in MB. Default: 100.

max_size_items integer

Maximum number of entries in the cache. Default: 0.

ttl string

The time to live for items in the cache before they get purged.

disable_broad_index_queries boolean

Disable broad index queries which results in reduced cache usage and faster query performance at the expense of somewhat higher QPS on the index store.

max_parallel_get_chunk integer

Maximum number of parallel chunk reads. Default: 150.

max_chunk_batch_size integer

The maximum number of chunks to fetch per batch. Default: 50.

boltdb_shipper object

Configures storing index in an Object Store (GCS/S3/Azure/Swift/COS/Filesystem) in the form of boltdb files. Required fields only required when boltdb-shipper is defined in config.

10 nested properties
active_index_directory string

Directory where ingesters would write index files which would then be uploaded by shipper to configured storage

cache_location string

Cache location for restoring index files from storage for queries

cache_ttl string

TTL for index files restored in cache for queries

resync_interval string

Resync downloaded files with the storage

query_ready_num_days integer

Number of days of common index to be kept downloaded for queries. For per tenant index query readiness, use limits overrides config. Default: 0.

index_gateway_client object
3 nested properties
grpc_client_config object
server_address string

Hostname or IP of the Index Gateway gRPC server running in simple mode. Can also be prefixed with dns+, dnssrv+, or dnssrvnoa+ to resolve a DNS A record with multiple IP's, a DNS SRV record with a followup A record lookup, or a DNS SRV record without a followup A record lookup, respectively.

log_gateway_requests boolean

Whether requests sent to the gateway should be logged or not.

ingestername string
mode string
ingesterdbretainperiod string
build_per_tenant_index boolean

Build per tenant index files

tsdb_shipper object

Configures storing index in an Object Store (GCS/S3/Azure/Swift/COS/Filesystem) in a prometheus TSDB-like format. Required fields only required when TSDB is defined in config.

9 nested properties
active_index_directory string

Directory where ingesters would write index files which would then be uploaded by shipper to configured storage

cache_location string

Cache location for restoring index files from storage for queries

cache_ttl string

TTL for index files restored in cache for queries

resync_interval string

Resync downloaded files with the storage

query_ready_num_days integer

Number of days of common index to be kept downloaded for queries. For per tenant index query readiness, use limits overrides config. Default: 0.

index_gateway_client object
3 nested properties
grpc_client_config object
server_address string

Hostname or IP of the Index Gateway gRPC server running in simple mode. Can also be prefixed with dns+, dnssrv+, or dnssrvnoa+ to resolve a DNS A record with multiple IP's, a DNS SRV record with a followup A record lookup, or a DNS SRV record without a followup A record lookup, respectively.

log_gateway_requests boolean

Whether requests sent to the gateway should be logged or not.

ingestername string
mode string
ingesterdbretainperiod string
bloom_shipper object

Experimental: Configures the bloom shipper component, which contains the store abstraction to fetch bloom filters from and put them to object storage.

5 nested properties
working_directory string

Working directory to store downloaded bloom blocks. Supports multiple directories, separated by comma.

max_query_page_size string

Maximum size of bloom pages that should be queried. Larger pages than this limit are skipped when querying blooms to limit memory usage. Default: 64MiB.

download_parallelism integer

The amount of maximum concurrent bloom blocks downloads. Usually set to 2x number of CPU cores. Default: 8.

blocks_cache object
3 nested properties
soft_limit string

Cache for bloom blocks. Soft limit of the cache in bytes. Exceeding this limit will trigger evictions of least recently used items in the background. Default: 32GiB.

hard_limit string

Cache for bloom blocks. Hard limit of the cache in bytes. Exceeding this limit will block execution until soft limit is deceeded. Default: 64GiB.

ttl string

Cache for bloom blocks. The time to live for items in the cache before they get purged.

metas_cache object
6 nested properties
default_validity string

The default validity of entries for caches unless overridden.

background object
memcached object
memcached_client object
redis object
embedded_cache object
swift_storage_config object
auth_version integer

OpenStack Swift authentication API version. 0 to autodetect. Default: 0.

auth_url string

OpenStack Swift authentication URL

internal boolean

Set this to true to use the internal OpenStack Swift endpoint URL

username string

OpenStack Swift username.

user_domain_name string

OpenStack Swift user's domain name.

user_domain_id string

OpenStack Swift user's domain ID.

user_id string

OpenStack Swift user ID.

password string

OpenStack Swift API key.

domain_id string

OpenStack Swift user's domain ID.

domain_name string

OpenStack Swift user's domain name.

project_id string

OpenStack Swift project ID (v2,v3 auth only).

project_name string

OpenStack Swift project name (v2,v3 auth only).

project_domain_id string

ID of the OpenStack Swift project's domain (v3 auth only), only needed if it differs the from user domain.

project_domain_name string

Name of the OpenStack Swift project's domain (v3 auth only), only needed if it differs from the user domain.

region_name string

OpenStack Swift Region to use (v2,v3 auth only).

container_name string

Name of the OpenStack Swift container to put chunks in.

max_retries integer

Max retries on requests error. Default: 3.

connect_timeout string

Time after which a connection attempt is aborted.

request_timeout string

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.

table_manager object
throughput_updates_disabled boolean

If true, disable all changes to DB capacity

retention_deletes_enabled boolean

If true, enables retention deletes of DB tables

retention_period string

Tables older than this retention period are deleted. Must be either 0 (disabled) or a multiple of 24h. When enabled, be aware this setting is destructive to data!

poll_interval string

How frequently to poll backend to learn our capacity.

creation_grace_period string

Periodic tables grace period (duration which table will be created/deleted before/after it's needed).

index_tables_provisioning object
12 nested properties
enable_ondemand_throughput_mode boolean

Enables on demand throughput provisioning for the storage provider (if supported). Applies only to tables which are not autoscaled. Supported by DynamoDB

provisioned_write_throughput integer

Table default write throughput. Supported by DynamoDB. Default: 1000.

provisioned_read_throughput integer

Table default read throughput. Supported by DynamoDB. Default: 300.

write_scale object
7 nested properties
enabled boolean

Should we enable autoscale for the table.

role_arn string

AWS AutoScaling role ARN

min_capacity integer

DynamoDB minimum provision capacity. Default: 3000.

max_capacity integer

DynamoDB maximum provision capacity. Default: 6000.

out_cooldown integer

DynamoDB minimum seconds between each autoscale up. Default: 1800.

in_cooldown integer

DynamoDB minimum seconds between each autoscale down. Default: 1800.

target number

DynamoDB target ratio of consumed capacity to provisioned capacity. Default: 80.

read_scale object
7 nested properties
enabled boolean

Should we enable autoscale for the table.

role_arn string

AWS AutoScaling role ARN

min_capacity integer

DynamoDB minimum provision capacity. Default: 3000.

max_capacity integer

DynamoDB maximum provision capacity. Default: 6000.

out_cooldown integer

DynamoDB minimum seconds between each autoscale up. Default: 1800.

in_cooldown integer

DynamoDB minimum seconds between each autoscale down. Default: 1800.

target number

DynamoDB target ratio of consumed capacity to provisioned capacity. Default: 80.

enable_inactive_throughput_on_demand_mode boolean

Enables on demand throughput provisioning for the storage provider (if supported). Applies only to tables which are not autoscaled. Supported by DynamoDB

inactive_write_throughput integer

Table write throughput for inactive tables. Supported by DynamoDB. Default: 1.

inactive_read_throughput integer

Table read throughput for inactive tables. Supported by DynamoDB. Default: 300.

inactive_write_scale object
7 nested properties
enabled boolean

Should we enable autoscale for the table.

role_arn string

AWS AutoScaling role ARN

min_capacity integer

DynamoDB minimum provision capacity. Default: 3000.

max_capacity integer

DynamoDB maximum provision capacity. Default: 6000.

out_cooldown integer

DynamoDB minimum seconds between each autoscale up. Default: 1800.

in_cooldown integer

DynamoDB minimum seconds between each autoscale down. Default: 1800.

target number

DynamoDB target ratio of consumed capacity to provisioned capacity. Default: 80.

inactive_read_scale object
7 nested properties
enabled boolean

Should we enable autoscale for the table.

role_arn string

AWS AutoScaling role ARN

min_capacity integer

DynamoDB minimum provision capacity. Default: 3000.

max_capacity integer

DynamoDB maximum provision capacity. Default: 6000.

out_cooldown integer

DynamoDB minimum seconds between each autoscale up. Default: 1800.

in_cooldown integer

DynamoDB minimum seconds between each autoscale down. Default: 1800.

target number

DynamoDB target ratio of consumed capacity to provisioned capacity. Default: 80.

inactive_write_scale_lastn integer

Number of last inactive tables to enable write autoscale. Default: 4.

inactive_read_scale_lastn integer

Number of last inactive tables to enable read autoscale. Default: 4.

chunk_tables_provisioning object
12 nested properties
enable_ondemand_throughput_mode boolean

Enables on demand throughput provisioning for the storage provider (if supported). Applies only to tables which are not autoscaled. Supported by DynamoDB

provisioned_write_throughput integer

Table default write throughput. Supported by DynamoDB. Default: 1000.

provisioned_read_throughput integer

Table default read throughput. Supported by DynamoDB. Default: 300.

write_scale object
7 nested properties
enabled boolean

Should we enable autoscale for the table.

role_arn string

AWS AutoScaling role ARN

min_capacity integer

DynamoDB minimum provision capacity. Default: 3000.

max_capacity integer

DynamoDB maximum provision capacity. Default: 6000.

out_cooldown integer

DynamoDB minimum seconds between each autoscale up. Default: 1800.

in_cooldown integer

DynamoDB minimum seconds between each autoscale down. Default: 1800.

target number

DynamoDB target ratio of consumed capacity to provisioned capacity. Default: 80.

read_scale object
7 nested properties
enabled boolean

Should we enable autoscale for the table.

role_arn string

AWS AutoScaling role ARN

min_capacity integer

DynamoDB minimum provision capacity. Default: 3000.

max_capacity integer

DynamoDB maximum provision capacity. Default: 6000.

out_cooldown integer

DynamoDB minimum seconds between each autoscale up. Default: 1800.

in_cooldown integer

DynamoDB minimum seconds between each autoscale down. Default: 1800.

target number

DynamoDB target ratio of consumed capacity to provisioned capacity. Default: 80.

enable_inactive_throughput_on_demand_mode boolean

Enables on demand throughput provisioning for the storage provider (if supported). Applies only to tables which are not autoscaled. Supported by DynamoDB

inactive_write_throughput integer

Table write throughput for inactive tables. Supported by DynamoDB. Default: 1.

inactive_read_throughput integer

Table read throughput for inactive tables. Supported by DynamoDB. Default: 300.

inactive_write_scale object
7 nested properties
enabled boolean

Should we enable autoscale for the table.

role_arn string

AWS AutoScaling role ARN

min_capacity integer

DynamoDB minimum provision capacity. Default: 3000.

max_capacity integer

DynamoDB maximum provision capacity. Default: 6000.

out_cooldown integer

DynamoDB minimum seconds between each autoscale up. Default: 1800.

in_cooldown integer

DynamoDB minimum seconds between each autoscale down. Default: 1800.

target number

DynamoDB target ratio of consumed capacity to provisioned capacity. Default: 80.

inactive_read_scale object
7 nested properties
enabled boolean

Should we enable autoscale for the table.

role_arn string

AWS AutoScaling role ARN

min_capacity integer

DynamoDB minimum provision capacity. Default: 3000.

max_capacity integer

DynamoDB maximum provision capacity. Default: 6000.

out_cooldown integer

DynamoDB minimum seconds between each autoscale up. Default: 1800.

in_cooldown integer

DynamoDB minimum seconds between each autoscale down. Default: 1800.

target number

DynamoDB target ratio of consumed capacity to provisioned capacity. Default: 80.

inactive_write_scale_lastn integer

Number of last inactive tables to enable write autoscale. Default: 4.

inactive_read_scale_lastn integer

Number of last inactive tables to enable read autoscale. Default: 4.

tls_config object
tls_cert_path string

Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured.

tls_key_path string

Path to the key for the client certificate. Also requires the client certificate to be configured.

tls_ca_path string

Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.

tls_server_name string

Override the expected name on the server certificate.

tls_insecure_skip_verify boolean

Skip validating server certificate.

tls_cipher_suites string

Override the default cipher suite list (separated by commas). Allowed values:

Secure Ciphers:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Insecure Ciphers:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
tls_min_version string

Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

tracing object
enabled boolean

Set to false to disable tracing.