Schema registry

Loki

Like Prometheus, but for logs

loki.ymlloki.yaml

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your loki.yml and it validates in your browser — nothing is uploaded.

Validate a loki.yml → View raw schema

Reference

Fields (first 250)

Generated directly from the schema, following local $refs, to two levels of nesting. This schema is large — the table is truncated; use the raw schema for the rest.

Field	Type	Description
`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
`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
`server`	`object`	—
`server.http_listen_network`	`string`	HTTP server listen network, default tcp
`server.http_listen_address`	`string`	HTTP server listen address.
`server.http_listen_port`	`integer`	HTTP server listen port. Default: 3100.
`server.http_listen_conn_limit`	`integer`	Maximum number of simultaneous http connections, <=0 to disable. Default: 0.
`server.grpc_listen_network`	`string`	gRPC server listen network
`server.grpc_listen_address`	`string`	gRPC server listen address.
`server.grpc_listen_port`	`integer`	gRPC server listen port. Default: 9095.
`server.grpc_listen_conn_limit`	`integer`	Maximum number of simultaneous grpc connections, <=0 to disable. Default: 0.
`server.tls_cipher_suites`	`string`	Comma-separated list of cipher suites to use. If blank, the default Go cipher suites is used.
`server.tls_min_version`	`string`	Minimum TLS version to use. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13. If blank, the Go TLS minimum version is used.
`server.http_tls_config`	`object`	—
`server.http_tls_config.cert`	`string`	Server TLS certificate. This configuration parameter is YAML only.
`server.http_tls_config.key`	`string`	Server TLS key. This configuration parameter is YAML only.
`server.http_tls_config.client_ca`	`string`	Root certificate authority used to verify client certificates. This configuration parameter is YAML only.
`server.http_tls_config.cert_file`	`string`	HTTP server cert path.
`server.http_tls_config.key_file`	`string`	HTTP server key path.
`server.http_tls_config.client_auth_type`	`string`	HTTP TLS Client Auth type.
`server.http_tls_config.client_ca_file`	`string`	HTTP TLS Client CA path.
`server.grpc_tls_config`	`object`	—
`server.grpc_tls_config.cert`	`string`	Server TLS certificate. This configuration parameter is YAML only.
`server.grpc_tls_config.key`	`string`	Server TLS key. This configuration parameter is YAML only.
`server.grpc_tls_config.client_ca`	`string`	Root certificate authority used to verify client certificates. This configuration parameter is YAML only.
`server.grpc_tls_config.cert_file`	`string`	GRPC TLS server cert path.
`server.grpc_tls_config.key_file`	`string`	GRPC TLS server key path.
`server.grpc_tls_config.client_auth_type`	`string`	GRPC TLS Client Auth type.
`server.grpc_tls_config.client_ca_file`	`string`	GRPC TLS Client CA path.
`server.register_instrumentation`	`boolean`	Register the instrumentation handlers (/metrics etc).
`server.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".
`server.graceful_shutdown_timeout`	`string`	Timeout for graceful shutdowns
`server.http_server_read_timeout`	`string`	Read timeout for entire HTTP request, including headers and body.
`server.http_server_read_header_timeout`	`string`	Read timeout for HTTP request headers. If set to 0, value of -server.http-read-timeout is used.
`server.http_server_write_timeout`	`string`	Write timeout for HTTP server
`server.http_server_idle_timeout`	`string`	Idle timeout for HTTP server
`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.
`server.grpc_server_max_recv_msg_size`	`integer`	Limit on the size of a gRPC message this server can receive (bytes). Default: 4194304.
`server.grpc_server_max_send_msg_size`	`integer`	Limit on the size of a gRPC message this server can send (bytes). Default: 4194304.
`server.grpc_server_max_concurrent_streams`	`integer`	Limit on the number of concurrent streams for gRPC calls per client connection (0 = unlimited). Default: 100.
`server.grpc_server_max_connection_idle`	`string`	The duration after which an idle connection should be closed. Default: infinity
`server.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
`server.grpc_server_max_connection_age_grace`	`string`	An additive period after max-connection-age after which the connection will be forcibly closed. Default: infinity
`server.grpc_server_keepalive_time`	`string`	Duration after which a keepalive probe is sent in case of no activity over the connection., Default: 2h
`server.grpc_server_keepalive_timeout`	`string`	After having pinged for keepalive check, the duration after which an idle connection should be closed, Default: 20s
`server.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.
`server.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.
`server.grpc_server_num_workers`	`integer`	If non-zero, configures the amount of GRPC server workers used to serve the requests. Default: 0.
`server.log_format`	`string`	Output log messages in the given format. Valid formats: [logfmt, json]
`server.log_level`	`string`	Only log messages with the given severity or above. Valid levels: [debug, info, warn, error]
`server.log_source_ips_enabled`	`boolean`	Optionally log the source IPs.
`server.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
`server.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
`server.log_request_headers`	`boolean`	Optionally log request headers.
`server.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.
`server.log_request_exclude_headers_list`	`string`	Comma separated list of headers to exclude from logging. Only used if server.log-request-headers is true.
`server.http_path_prefix`	`string`	Base path to serve all API routes from (e.g. /v1/)
`distributor`	`object`	—
`distributor.ring`	`object`	—
`distributor.ring.kvstore`	`object`	—
`distributor.ring.heartbeat_period`	`string`	Period at which to heartbeat to the ring. 0 = disabled.
`distributor.ring.heartbeat_timeout`	`string`	The heartbeat timeout after which distributors are considered unhealthy within the ring. 0 = never (timeout disabled).
`distributor.ring.instance_interface_names`	`array \| null`	Name of network interface to read address from.
`distributor.rate_store`	`object`	—
`distributor.rate_store.max_request_parallelism`	`integer`	The max number of concurrent requests to make to ingester stream apis. Default: 200.
`distributor.rate_store.stream_rate_update_interval`	`string`	The interval on which distributors will update current stream rates from ingesters
`distributor.rate_store.ingester_request_timeout`	`string`	Timeout for communication between distributors and any given ingester when updating rates
`distributor.rate_store.debug`	`boolean`	If enabled, detailed logs and spans will be emitted.
`distributor.write_failures_logging`	`object`	Customize the logging of write failures.
`distributor.write_failures_logging.rate`	`string`	Log volume allowed (per second). Default: 1KB. Default: 1KB.
`distributor.write_failures_logging.add_insights_label`	`boolean`	Whether a insight=true key should be logged or not. Default: false.
`distributor.otlp_config`	`object`	—
`distributor.otlp_config.default_resource_attributes_as_index_labels`	`array \| null`	List of default otlp resource attributes to be picked as index labels
`querier`	`object`	—
`querier.tail_max_duration`	`string`	Maximum duration for which the live tailing requests are served.
`querier.extra_query_delay`	`string`	Time to wait before sending more than the minimum successful query requests.
`querier.query_ingesters_within`	`string`	Maximum lookback beyond which queries are not sent to ingester. 0 means all queries are sent to ingester.
`querier.engine`	`object`	—
`querier.engine.max_look_back_period`	`string`	The maximum amount of time to look back for log lines. Used only for instant log queries.
`querier.max_concurrent`	`integer`	The maximum number of queries that can be simultaneously processed by the querier. Default: 4.
`querier.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.
`querier.query_ingester_only`	`boolean`	When true, queriers only query the ingesters, and not stored data. This is useful when the object store is unavailable.
`querier.multi_tenant_queries_enabled`	`boolean`	When true, allow queries to span multiple tenants.
`querier.per_request_limits_enabled`	`boolean`	When true, querier limits sent via a header are enforced.
`query_scheduler`	`object`	—
`query_scheduler.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.
`query_scheduler.max_queue_hierarchy_levels`	`integer`	Maximum number of levels of nesting of hierarchical queues. 0 means that hierarchical queues are disabled. Default: 3.
`query_scheduler.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
`query_scheduler.grpc_client_config`	`object`	—
`query_scheduler.grpc_client_config.max_recv_msg_size`	`integer`	gRPC client max receive message size (bytes). Default: 104857600.
`query_scheduler.grpc_client_config.max_send_msg_size`	`integer`	gRPC client max send message size (bytes). Default: 104857600.
`query_scheduler.grpc_client_config.grpc_compression`	`string`	Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)
`query_scheduler.grpc_client_config.rate_limit`	`number`	Rate limit for gRPC client; 0 means disabled. Default: 0.
`query_scheduler.grpc_client_config.rate_limit_burst`	`integer`	Rate limit burst for gRPC client. Default: 0.
`query_scheduler.grpc_client_config.backoff_on_ratelimits`	`boolean`	Enable backoff and retry when we hit rate limits.
`query_scheduler.grpc_client_config.backoff_config`	`object`	—
`query_scheduler.grpc_client_config.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.
`query_scheduler.grpc_client_config.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.
`query_scheduler.grpc_client_config.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.
`query_scheduler.grpc_client_config.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.
`query_scheduler.grpc_client_config.tls_key_path`	`string`	Path to the key for the client certificate. Also requires the client certificate to be configured.
`query_scheduler.grpc_client_config.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.
`query_scheduler.grpc_client_config.tls_server_name`	`string`	Override the expected name on the server certificate.
`query_scheduler.grpc_client_config.tls_insecure_skip_verify`	`boolean`	Skip validating server certificate.
`query_scheduler.grpc_client_config.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
`query_scheduler.grpc_client_config.tls_min_version`	`string`	Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13
`query_scheduler.grpc_client_config.connect_timeout`	`string`	The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.
`query_scheduler.grpc_client_config.connect_backoff_base_delay`	`string`	Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.
`query_scheduler.grpc_client_config.connect_backoff_max_delay`	`string`	Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.
`query_scheduler.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.
`query_scheduler.scheduler_ring`	`object`	The hash ring configuration. This option is required only if use_scheduler_ring is true.
`query_scheduler.scheduler_ring.kvstore`	`object`	—
`query_scheduler.scheduler_ring.heartbeat_period`	`string`	Period at which to heartbeat to the ring. 0 = disabled.
`query_scheduler.scheduler_ring.heartbeat_timeout`	`string`	The heartbeat timeout after which compactors are considered unhealthy within the ring. 0 = never (timeout disabled).
`query_scheduler.scheduler_ring.tokens_file_path`	`string`	File path where tokens are stored. If empty, tokens are not stored at shutdown and restored at startup.
`query_scheduler.scheduler_ring.zone_awareness_enabled`	`boolean`	True to enable zone-awareness and replicate blocks across different availability zones.
`query_scheduler.scheduler_ring.num_tokens`	`any`	—
`query_scheduler.scheduler_ring.replication_factor`	`any`	—
`query_scheduler.scheduler_ring.instance_id`	`string`	Instance ID to register in the ring.
`query_scheduler.scheduler_ring.instance_interface_names`	`array \| null`	Name of network interface to read address from.
`query_scheduler.scheduler_ring.instance_port`	`integer`	Port to advertise in the ring (defaults to server.grpc-listen-port). Default: 0.
`query_scheduler.scheduler_ring.instance_addr`	`string`	IP address to advertise in the ring.
`query_scheduler.scheduler_ring.instance_availability_zone`	`string`	The availability zone where this instance is running. Required if zone-awareness is enabled.
`query_scheduler.scheduler_ring.instance_enable_ipv6`	`boolean`	Enable using a IPv6 instance address.
`frontend`	`object`	—
`frontend.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.
`frontend.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.
`frontend.max_body_size`	`integer`	Max body size for downstream prometheus. Default: 10485760.
`frontend.query_stats_enabled`	`boolean`	True to enable query statistics tracking. When enabled, a message with some statistics is logged for every query.
`frontend.max_outstanding_per_tenant`	`integer`	Maximum number of outstanding requests per tenant per frontend; requests beyond this error with HTTP 429. Default: 2048.
`frontend.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
`frontend.scheduler_address`	`string`	DNS hostname used for finding query-schedulers.
`frontend.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.
`frontend.scheduler_worker_concurrency`	`integer`	Number of concurrent workers forwarding queries to single query-scheduler. Default: 5.
`frontend.grpc_client_config`	`object`	—
`frontend.grpc_client_config.max_recv_msg_size`	`integer`	gRPC client max receive message size (bytes). Default: 104857600.
`frontend.grpc_client_config.max_send_msg_size`	`integer`	gRPC client max send message size (bytes). Default: 104857600.
`frontend.grpc_client_config.grpc_compression`	`string`	Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)
`frontend.grpc_client_config.rate_limit`	`number`	Rate limit for gRPC client; 0 means disabled. Default: 0.
`frontend.grpc_client_config.rate_limit_burst`	`integer`	Rate limit burst for gRPC client. Default: 0.
`frontend.grpc_client_config.backoff_on_ratelimits`	`boolean`	Enable backoff and retry when we hit rate limits.
`frontend.grpc_client_config.backoff_config`	`object`	—
`frontend.grpc_client_config.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.
`frontend.grpc_client_config.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.
`frontend.grpc_client_config.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.
`frontend.grpc_client_config.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.
`frontend.grpc_client_config.tls_key_path`	`string`	Path to the key for the client certificate. Also requires the client certificate to be configured.
`frontend.grpc_client_config.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.
`frontend.grpc_client_config.tls_server_name`	`string`	Override the expected name on the server certificate.
`frontend.grpc_client_config.tls_insecure_skip_verify`	`boolean`	Skip validating server certificate.
`frontend.grpc_client_config.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
`frontend.grpc_client_config.tls_min_version`	`string`	Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13
`frontend.grpc_client_config.connect_timeout`	`string`	The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.
`frontend.grpc_client_config.connect_backoff_base_delay`	`string`	Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.
`frontend.grpc_client_config.connect_backoff_max_delay`	`string`	Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.
`frontend.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.
`frontend.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.
`frontend.encoding`	`string`	Defines the encoding for requests to and responses from the scheduler and querier. Can be 'json' or 'protobuf' (defaults to 'json').
`frontend.compress_responses`	`boolean`	Compress HTTP responses.
`frontend.downstream_url`	`string`	URL of downstream Loki.
`frontend.tail_proxy_url`	`string`	URL of querier for tail proxy.
`frontend.tail_tls_config`	`object`	—
`frontend.tail_tls_config.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.
`frontend.tail_tls_config.tls_key_path`	`string`	Path to the key for the client certificate. Also requires the client certificate to be configured.
`frontend.tail_tls_config.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.
`frontend.tail_tls_config.tls_server_name`	`string`	Override the expected name on the server certificate.
`frontend.tail_tls_config.tls_insecure_skip_verify`	`boolean`	Skip validating server certificate.
`frontend.tail_tls_config.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
`frontend.tail_tls_config.tls_min_version`	`string`	Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13
`query_range`	`object`	—
`query_range.align_queries_with_step`	`boolean`	Mutate incoming queries to align their start and end with their step.
`query_range.results_cache`	`object`	—
`query_range.results_cache.cache`	`object`	—
`query_range.results_cache.compression`	`string`	Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.
`query_range.cache_results`	`boolean`	Cache query results.
`query_range.max_retries`	`integer`	Maximum number of retries for a single request; beyond this, the downstream error is returned. Default: 5.
`query_range.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.
`query_range.shard_aggregations`	`string`	A comma-separated list of LogQL vector and range aggregations that should be sharded
`query_range.cache_index_stats_results`	`boolean`	Cache index stats query results.
`query_range.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.
`query_range.index_stats_results_cache.cache`	`object`	—
`query_range.index_stats_results_cache.compression`	`string`	Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.
`query_range.cache_volume_results`	`boolean`	Cache volume query results.
`query_range.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.
`query_range.volume_results_cache.cache`	`object`	—
`query_range.volume_results_cache.compression`	`string`	Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.
`query_range.cache_instant_metric_results`	`boolean`	Cache instant metric query results.
`query_range.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.
`query_range.instant_metric_results_cache.cache`	`object`	—
`query_range.instant_metric_results_cache.compression`	`string`	Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.
`query_range.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
`query_range.cache_series_results`	`boolean`	Cache series query results.
`query_range.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.
`query_range.series_results_cache.cache`	`object`	—
`query_range.series_results_cache.compression`	`string`	Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.
`query_range.cache_label_results`	`boolean`	Cache label query results.
`query_range.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.
`query_range.label_results_cache.cache`	`object`	—
`query_range.label_results_cache.compression`	`string`	Use compression in cache. The default is an empty value '', which disables compression. Supported values are: 'snappy' and ''.
`ruler`	`object`	—
`ruler.external_url`	`string`	Base URL of the Grafana instance.
`ruler.datasource_uid`	`string`	Datasource UID for the dashboard.
`ruler.external_labels`	`array \| null`	Labels to add to all alerts.
`ruler.ruler_client`	`object`	—
`ruler.ruler_client.max_recv_msg_size`	`integer`	gRPC client max receive message size (bytes). Default: 104857600.
`ruler.ruler_client.max_send_msg_size`	`integer`	gRPC client max send message size (bytes). Default: 104857600.
`ruler.ruler_client.grpc_compression`	`string`	Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)
`ruler.ruler_client.rate_limit`	`number`	Rate limit for gRPC client; 0 means disabled. Default: 0.
`ruler.ruler_client.rate_limit_burst`	`integer`	Rate limit burst for gRPC client. Default: 0.
`ruler.ruler_client.backoff_on_ratelimits`	`boolean`	Enable backoff and retry when we hit rate limits.
`ruler.ruler_client.backoff_config`	`object`	—
`ruler.ruler_client.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.
`ruler.ruler_client.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.
`ruler.ruler_client.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.
`ruler.ruler_client.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.
`ruler.ruler_client.tls_key_path`	`string`	Path to the key for the client certificate. Also requires the client certificate to be configured.
`ruler.ruler_client.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.
`ruler.ruler_client.tls_server_name`	`string`	Override the expected name on the server certificate.
`ruler.ruler_client.tls_insecure_skip_verify`	`boolean`	Skip validating server certificate.
`ruler.ruler_client.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
`ruler.ruler_client.tls_min_version`	`string`	Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13
`ruler.ruler_client.connect_timeout`	`string`	The maximum amount of time to establish a connection. A value of 0 means default gRPC client connect timeout and backoff.
`ruler.ruler_client.connect_backoff_base_delay`	`string`	Initial backoff delay after first connection failure. Only relevant if ConnectTimeout > 0.
`ruler.ruler_client.connect_backoff_max_delay`	`string`	Maximum backoff delay when establishing a connection. Only relevant if ConnectTimeout > 0.
`ruler.evaluation_interval`	`string`	How frequently to evaluate rules.
`ruler.poll_interval`	`string`	How frequently to poll for rule changes.
`ruler.storage`	`object`	Deprecated: Use -ruler-storage. CLI flags and their respective YAML config options instead.
`ruler.storage.type`	`string`	Method to use for backend rule storage (configdb, azure, gcs, s3, swift, local, bos, cos)
`ruler.storage.azure`	`object`	—
`ruler.storage.alibabacloud`	`object`	—
`ruler.storage.gcs`	`object`	—
`ruler.storage.s3`	`object`	—
`ruler.storage.bos`	`object`	—
`ruler.storage.swift`	`object`	—
`ruler.storage.cos`	`object`	—
`ruler.storage.local`	`object`	Configures backend rule storage for a local file system directory.
`ruler.rule_path`	`string`	File path to store temporary rule files.
`ruler.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.enable_alertmanager_discovery`	`boolean`	Use DNS SRV records to discover Alertmanager hosts.
`ruler.alertmanager_refresh_interval`	`string`	How long to wait between refreshing DNS resolutions of Alertmanager hosts.
`ruler.enable_alertmanager_v2`	`boolean`	If enabled requests to Alertmanager will utilize the V2 API.
`ruler.alert_relabel_configs`	`array \| null`	List of alert relabel configs.
`ruler.notification_queue_capacity`	`integer`	Capacity of the queue for notifications to be sent to the Alertmanager. Default: 10000.
`ruler.notification_timeout`	`string`	HTTP timeout duration when sending notifications to the Alertmanager.
`ruler.alertmanager_client`	`object`	—
`ruler.alertmanager_client.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.
`ruler.alertmanager_client.tls_key_path`	`string`	Path to the key for the client certificate. Also requires the client certificate to be configured.
`ruler.alertmanager_client.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.
`ruler.alertmanager_client.tls_server_name`	`string`	Override the expected name on the server certificate.

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
Has 1 place(s) where keywords sit beside $ref. Under draft-07 those keywords are silently ignored by every conforming validator — first at #/definitions/ruler/properties/remote_write/properties/client.
1219 properties, 90% carrying a description, max nesting depth 13.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$ref`	JSON Schema Core, draft 2020-12	§8.2.3.1 — Direct References with "$ref"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas