2015-04-10 04:05:56 -05:00
##################### Grafana Configuration Defaults #####################
#
# Do not modify this file in grafana installs
2015-04-09 10:18:04 -05:00
#
2014-10-04 06:33:20 -05:00
2015-09-04 02:01:06 -05:00
# possible values : production, development
2015-04-10 04:05:56 -05:00
app_mode = production
2015-04-09 10:18:04 -05:00
2016-06-02 07:32:17 -05:00
# instance name, defaults to HOSTNAME environment variable value or hostname if HOSTNAME var is empty
instance_name = ${HOSTNAME}
2016-09-20 09:09:20 -05:00
#################################### Paths ###############################
2015-04-09 05:16:59 -05:00
[paths]
2015-04-23 03:42:04 -05:00
# Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used)
2015-04-09 05:16:59 -05:00
data = data
2017-10-26 10:13:07 -05:00
2018-06-14 02:35:22 -05:00
# Temporary files in `data` directory older than given duration will be removed
temp_data_lifetime = 24h
2015-04-09 10:18:04 -05:00
# Directory where grafana can store logs
2015-04-09 05:16:59 -05:00
logs = data/log
2017-10-26 10:13:07 -05:00
2015-12-15 04:21:00 -06:00
# Directory where grafana will automatically scan and look for plugins
plugins = data/plugins
2015-04-08 07:10:04 -05:00
2017-12-07 08:14:57 -06:00
# folder that contains provisioning config files that grafana will apply on startup and while running.
provisioning = conf/provisioning
2017-11-23 04:29:06 -06:00
2016-09-20 09:09:20 -05:00
#################################### Server ##############################
2014-10-04 06:33:20 -05:00
[server]
2019-08-16 10:06:54 -05:00
# Protocol (http, https, h2, socket)
2014-10-04 06:33:20 -05:00
protocol = http
2015-04-09 10:18:04 -05:00
2023-05-08 10:11:36 -05:00
# Minimum TLS version allowed. By default, this value is empty. Accepted values are: TLS1.2, TLS1.3. If nothing is set TLS1.2 would be taken
min_tls_version = ""
2015-04-09 10:18:04 -05:00
# The ip address to bind to, empty will bind to all interfaces
2014-10-04 06:33:20 -05:00
http_addr =
2015-04-09 10:18:04 -05:00
2018-11-29 02:21:06 -06:00
# The http port to use
2014-10-04 06:33:20 -05:00
http_port = 3000
2015-04-09 10:18:04 -05:00
# The public facing domain name used to access grafana from a browser
2015-02-16 01:12:07 -06:00
domain = localhost
2015-04-09 10:18:04 -05:00
2015-05-05 04:21:06 -05:00
# Redirect to correct domain if host header does not match domain
# Prevents DNS rebinding attacks
enforce_domain = false
2015-04-09 10:18:04 -05:00
# The full public facing url
2015-02-16 01:12:07 -06:00
root_url = %(protocol)s://%(domain)s:%(http_port)s/
2015-04-09 10:18:04 -05:00
2019-05-27 10:47:29 -05:00
# Serve Grafana from subpath specified in `root_url` setting. By default it is set to `false` for compatibility reasons.
serve_from_sub_path = false
2015-04-09 10:18:04 -05:00
# Log web requests
2014-10-05 09:50:04 -05:00
router_logging = false
2015-04-09 10:18:04 -05:00
# the path relative working path
2015-01-01 08:29:10 -06:00
static_root_path = public
2015-04-09 10:18:04 -05:00
# enable gzip
2015-03-31 10:42:51 -05:00
enable_gzip = false
2015-04-09 10:18:04 -05:00
# https certs & key file
2015-03-11 13:44:31 -05:00
cert_file =
cert_key =
2024-08-06 17:18:32 -05:00
cert_pass =
2014-10-05 09:50:04 -05:00
2024-03-22 10:13:22 -05:00
# Certificates file watch interval
certs_watch_interval =
2022-11-01 09:04:01 -05:00
# Unix socket gid
# Changing the gid of a file without privileges requires that the target group is in the group of the process and that the process is the file owner
# It is recommended to set the gid as http server user gid
# Not set when the value is -1
socket_gid = -1
# Unix socket mode
socket_mode = 0660
2017-04-27 01:54:21 -05:00
# Unix socket path
socket = /tmp/grafana.sock
2021-02-01 03:13:09 -06:00
# CDN Url
cdn_url =
2021-04-26 04:38:24 -05:00
# Sets the maximum time in minutes before timing out read of an incoming request and closing idle connections.
2021-03-19 05:21:52 -05:00
# `0` means there is no timeout for reading the request.
read_timeout = 0
2022-11-30 11:12:34 -06:00
# This setting enables you to specify additional headers that the server adds to HTTP(S) responses.
[server.custom_response_headers]
#exampleHeader1 = exampleValue1
#exampleHeader2 = exampleValue2
2024-03-01 03:39:50 -06:00
[environment]
# Sets whether the local file system is available for Grafana to use. Default is true for backward compatibility.
local_file_system_available = true
2023-04-15 06:01:34 -05:00
#################################### GRPC Server #########################
[grpc_server]
network = "tcp"
address = "127.0.0.1:10000"
use_tls = false
cert_file =
key_file =
2024-04-16 09:30:51 -05:00
# this will log the request and response for each unary gRPC call
enable_logging = false
2023-04-15 06:01:34 -05:00
2024-04-30 09:18:03 -05:00
# Maximum size of a message that can be received in bytes. If not set, uses the gRPC default (4MiB).
max_recv_msg_size =
# Maximum size of a message that can be sent in bytes. If not set, uses the gRPC default (unlimited).
max_send_msg_size =
2016-09-20 09:09:20 -05:00
#################################### Database ############################
2015-01-29 07:33:50 -06:00
[database]
2016-09-07 03:34:56 -05:00
# You can configure the database connection by specifying type, host, name, user and password
2017-03-30 10:12:00 -05:00
# as separate properties or as on string using the url property.
2016-08-19 07:48:40 -05:00
2015-04-09 10:18:04 -05:00
# Either "mysql", "postgres" or "sqlite3", it's your choice
2015-01-29 07:33:50 -06:00
type = sqlite3
host = 127.0.0.1:3306
name = grafana
user = root
2017-03-30 10:12:00 -05:00
# If the password contains # or ; you have to wrap it with triple quotes. Ex """#password;"""
2015-01-29 07:33:50 -06:00
password =
2016-06-28 10:45:44 -05:00
# Use either URL or the previous fields to configure the database
# Example: mysql://user:secret@host:port/database
url =
2015-04-09 10:18:04 -05:00
2017-08-08 09:17:52 -05:00
# Max idle conn setting default is 2
max_idle_conn = 2
2017-02-09 21:31:55 -06:00
# Max conn setting default is 0 (mean not set)
max_open_conn =
2018-03-15 18:25:15 -05:00
# Connection Max Lifetime default is 14400 (means 14400 seconds or 4 hours)
conn_max_lifetime = 14400
2017-11-03 14:05:32 -05:00
# Set to true to log the sql calls and execution times.
2017-11-06 08:01:31 -06:00
log_queries =
2017-11-03 14:05:32 -05:00
2015-11-24 10:17:21 -06:00
# For "postgres", use either "disable", "require" or "verify-full"
# For "mysql", use either "true", "false", or "skip-verify".
2015-01-29 07:33:50 -06:00
ssl_mode = disable
2015-04-09 10:18:04 -05:00
2024-04-08 03:08:43 -05:00
# For "postgres", use either "1" to enable or "0" to disable SNI
2024-03-12 05:03:24 -05:00
ssl_sni =
2021-05-10 10:54:13 -05:00
# Database drivers may support different transaction isolation levels.
# Currently, only "mysql" driver supports isolation levels.
# If the value is empty - driver's default isolation level is applied.
# For "mysql" use "READ-UNCOMMITTED", "READ-COMMITTED", "REPEATABLE-READ" or "SERIALIZABLE".
isolation_level =
2015-11-24 10:17:21 -06:00
ca_cert_path =
client_key_path =
client_cert_path =
server_cert_name =
2015-04-09 10:18:04 -05:00
# For "sqlite3" only, path relative to data_path setting
2015-04-08 07:10:04 -05:00
path = grafana.db
2015-01-29 07:33:50 -06:00
2018-12-27 03:48:11 -06:00
# For "sqlite3" only. cache mode setting used for connecting to the database
cache_mode = private
2022-11-16 12:29:33 -06:00
# For "sqlite3" only. Enable/disable Write-Ahead Logging, https://sqlite.org/wal.html. Default is false.
wal = false
2024-03-22 14:22:29 -05:00
# For "mysql" and "postgres". Lock the database for the migrations, default is true.
migration_locking = true
# For "mysql" and "postgres" only if migrationLocking is set. How many seconds to wait before failing to lock the database for the migrations, default is 0.
2022-02-15 10:54:27 -06:00
locking_attempt_timeout_sec = 0
2022-10-17 13:23:44 -05:00
# For "sqlite" only. How many times to retry query in case of database is locked failures. Default is 0 (disabled).
query_retries = 0
# For "sqlite" only. How many times to retry transaction in case of database is locked failures. Default is 5.
transaction_retries = 5
2023-05-12 02:37:29 -05:00
# Set to true to add metrics and tracing for database queries.
2023-04-28 08:19:06 -05:00
instrument_queries = false
2019-03-03 14:48:00 -06:00
#################################### Cache server #############################
2019-03-08 13:49:16 -06:00
[remote_cache]
2019-03-05 08:34:51 -06:00
# Either "redis", "memcached" or "database" default is "database"
2019-03-03 14:48:00 -06:00
type = database
# cache connectionstring options
# database: will use Grafana primary database.
2019-08-13 05:51:13 -05:00
# redis: config like redis server e.g. `addr=127.0.0.1:6379,pool_size=100,db=0,ssl=false`. Only addr is required. ssl may be 'true', 'false', or 'insecure'.
2019-03-03 14:48:00 -06:00
# memcache: 127.0.0.1:11211
2019-06-20 09:15:21 -05:00
connstr =
2019-03-03 14:48:00 -06:00
2022-12-06 06:20:49 -06:00
# prefix prepended to all the keys in the remote cache
prefix =
2022-12-06 08:12:27 -06:00
# This enables encryption of values stored in the remote cache
encryption =
2017-01-16 05:43:59 -06:00
#################################### Data proxy ###########################
[dataproxy]
# This enables data proxy logging, default is false
logging = false
2021-05-25 03:32:41 -05:00
# How long the data proxy waits to read the headers of the response before timing out, default is 30 seconds.
2020-06-29 04:22:49 -05:00
# This setting also applies to core backend HTTP data sources where query requests use an HTTP client with timeout set.
2019-01-24 13:04:21 -06:00
timeout = 30
2021-05-25 03:32:41 -05:00
# How long the data proxy waits to establish a TCP connection before timing out, default is 10 seconds.
dialTimeout = 10
2020-10-12 03:36:47 -05:00
# How many seconds the data proxy waits before sending a keepalive request.
keep_alive_seconds = 30
# How many seconds the data proxy waits for a successful TLS Handshake before timing out.
tls_handshake_timeout_seconds = 10
# How many seconds the data proxy will wait for a server's first response headers after
# fully writing the request headers if the request has an "Expect: 100-continue"
# header. A value of 0 will result in the body being sent immediately, without
# waiting for the server to approve.
expect_continue_timeout_seconds = 1
2021-06-11 07:18:08 -05:00
# Optionally limits the total number of connections per host, including connections in the dialing,
# active, and idle states. On limit violation, dials will block.
# A value of zero (0) means no limit.
max_conns_per_host = 0
2020-10-12 03:36:47 -05:00
# The maximum number of idle connections that Grafana will keep alive.
max_idle_connections = 100
# How many seconds the data proxy keeps an idle connection open before timing out.
idle_conn_timeout_seconds = 90
# If enabled and user is not anonymous, data proxy will add X-Grafana-User header with username into the request.
2019-03-14 07:04:47 -05:00
send_user_header = false
2021-09-10 08:51:06 -05:00
# Limit the amount of bytes that will be read/accepted from responses of outgoing HTTP requests.
response_limit = 0
2021-09-13 08:27:51 -05:00
# Limits the number of rows that Grafana will process from SQL data sources.
row_limit = 1000000
2023-02-28 07:10:05 -06:00
# Sets a custom value for the `User-Agent` header for outgoing data proxy requests. If empty, the default value is `Grafana/<BuildVersion>` (for example `Grafana/9.0.0`).
user_agent =
2016-09-20 09:09:20 -05:00
#################################### Analytics ###########################
2015-04-09 10:18:04 -05:00
[analytics]
# Server reporting, sends usage counters to stats.grafana.org every 24 hours.
# No ip addresses are being tracked, only simple counters to track
# running instances, dashboard and error counts. It is very helpful to us.
# Change this option to false to disable reporting.
reporting_enabled = true
2021-02-10 03:07:32 -06:00
# The name of the distributor of the Grafana instance. Ex hosted-grafana, grafana-labs
reporting_distributor = grafana-labs
2017-03-20 04:20:32 -05:00
# Set to false to disable all checks to https://grafana.com
2022-04-06 03:50:21 -05:00
# for new versions of grafana. The check is used
# in some UI views to notify that a grafana update exists.
2016-04-11 11:21:48 -05:00
# This option does not cause any auto updates, nor send any information
2024-01-16 05:19:32 -06:00
# only a GET request to https://grafana.com/api/grafana/versions/stable to get the latest version.
2016-04-11 11:21:48 -05:00
check_for_updates = true
2022-04-06 03:50:21 -05:00
# Set to false to disable all checks to https://grafana.com
# for new versions of plugins. The check is used
# in some UI views to notify that a plugin update exists.
# This option does not cause any auto updates, nor send any information
# only a GET request to https://grafana.com to get the latest versions.
check_for_plugin_updates = true
2015-04-09 10:18:04 -05:00
# Google Analytics universal tracking code, only enabled if you specify an id here
2022-10-27 08:57:01 -05:00
google_analytics_ua_id =
2022-09-20 05:13:14 -05:00
# Google Analytics 4 tracking code, only enabled if you specify an id here
2022-10-27 08:57:01 -05:00
google_analytics_4_id =
2015-04-09 10:18:04 -05:00
2022-11-09 08:09:19 -06:00
# When Google Analytics 4 Enhanced event measurement is enabled, we will try to avoid sending duplicate events and let Google Analytics 4 detect navigation changes, etc.
google_analytics_4_send_manual_page_views = false
2015-08-21 02:30:39 -05:00
# Google Tag Manager ID, only enabled if you specify an id here
google_tag_manager_id =
2021-07-09 04:45:25 -05:00
# Rudderstack write key, enabled only if rudderstack_data_plane_url is also set
rudderstack_write_key =
# Rudderstack data plane url, enabled only if rudderstack_write_key is also set
rudderstack_data_plane_url =
2021-12-06 08:42:29 -06:00
# Rudderstack SDK url, optional, only valid if rudderstack_write_key and rudderstack_data_plane_url is also set
rudderstack_sdk_url =
# Rudderstack Config url, optional, used by Rudderstack SDK to fetch source config
rudderstack_config_url =
2023-03-03 08:39:53 -06:00
2023-10-23 07:43:33 -05:00
# Rudderstack Integrations URL, optional. Only valid if you pass the SDK version 1.1 or higher
rudderstack_integrations_url =
2023-03-03 08:39:53 -06:00
# Intercom secret, optional, used to hash user_id before passing to Intercom via Rudderstack
intercom_secret =
2021-12-06 08:42:29 -06:00
2021-09-15 06:00:38 -05:00
# Application Insights connection string. Specify an URL string to enable this feature.
application_insights_connection_string =
2021-09-16 09:33:51 -05:00
# Optional. Specifies an Application Insights endpoint URL where the endpoint string is wrapped in backticks ``.
2021-09-15 06:00:38 -05:00
application_insights_endpoint_url =
2022-04-14 08:18:03 -05:00
# Controls if the UI contains any links to user feedback forms
feedback_links_enabled = true
2024-07-08 09:37:45 -05:00
# Static context that is being added to analytics events
2024-07-17 08:48:23 -05:00
reporting_static_context =
2024-07-08 09:37:45 -05:00
2016-09-20 09:09:20 -05:00
#################################### Security ############################
2015-01-27 03:09:54 -06:00
[security]
2019-11-08 04:11:03 -06:00
# disable creation of admin user on first start of grafana
disable_initial_admin_creation = false
2015-04-09 10:18:04 -05:00
# default admin user, created on startup
2015-01-27 03:09:54 -06:00
admin_user = admin
2015-04-10 03:58:32 -05:00
2018-11-29 02:21:06 -06:00
# default admin password, can be changed before first start of grafana, or in profile settings
2015-01-27 03:09:54 -06:00
admin_password = admin
2015-04-10 03:58:32 -05:00
2022-09-07 07:38:40 -05:00
# default admin email, created on startup
admin_email = admin@localhost
2015-04-09 10:18:04 -05:00
# used for signing
2015-01-27 08:14:53 -06:00
secret_key = SW2YcwTIb9zpOOhoPsMm
2015-04-10 03:58:32 -05:00
2021-11-23 12:29:35 -06:00
# current key provider used for envelope encryption, default to static value specified by secret_key
2022-01-07 06:52:28 -06:00
encryption_provider = secretKey.v1
2021-11-04 12:25:01 -05:00
2021-11-23 12:29:35 -06:00
# list of configured key providers, space separated (Enterprise only): e.g., awskms.v1 azurekv.v1
available_encryption_providers =
2015-05-01 01:40:13 -05:00
# disable gravatar profile images
disable_gravatar = false
2016-05-22 19:32:18 -05:00
# data source proxy whitelist (ip_or_domain:port separated by spaces)
2015-09-09 10:21:25 -05:00
data_source_proxy_whitelist =
2018-01-26 03:41:41 -06:00
# disable protection against brute force login attempts
disable_brute_force_login_protection = false
2019-02-05 14:09:55 -06:00
# set to true if you host Grafana behind HTTPS. default is false.
cookie_secure = false
2020-01-14 10:41:54 -06:00
# set cookie SameSite attribute. defaults to `lax`. can be set to "lax", "strict", "none" and "disabled"
2019-02-05 14:09:55 -06:00
cookie_samesite = lax
2019-01-24 12:04:58 -06:00
2019-05-06 02:56:23 -05:00
# set to true if you want to allow browsers to render Grafana in a <frame>, <iframe>, <embed> or <object>. default is false.
allow_embedding = false
2019-06-12 06:15:50 -05:00
# Set to true if you want to enable http strict transport security (HSTS) response header.
# HSTS tells browsers that the site should only be accessed using HTTPS.
strict_transport_security = false
# Sets how long a browser should cache HSTS. Only applied if strict_transport_security is enabled.
strict_transport_security_max_age_seconds = 86400
# Set to true if to enable HSTS preloading option. Only applied if strict_transport_security is enabled.
strict_transport_security_preload = false
# Set to true if to enable the HSTS includeSubDomains option. Only applied if strict_transport_security is enabled.
strict_transport_security_subdomains = false
# Set to true to enable the X-Content-Type-Options response header.
# The X-Content-Type-Options response HTTP header is a marker used by the server to indicate that the MIME types advertised
2020-05-28 03:38:22 -05:00
# in the Content-Type headers should not be changed and be followed.
x_content_type_options = true
2019-06-12 06:15:50 -05:00
# Set to true to enable the X-XSS-Protection header, which tells browsers to stop pages from loading
2020-05-28 03:38:22 -05:00
# when they detect reflected cross-site scripting (XSS) attacks.
x_xss_protection = true
2019-06-12 06:15:50 -05:00
2021-01-12 00:42:32 -06:00
# Enable adding the Content-Security-Policy header to your requests.
# CSP allows to control resources the user agent is allowed to load and helps prevent XSS attacks.
content_security_policy = false
# Set Content Security Policy template used when adding the Content-Security-Policy header to your requests.
# $NONCE in the template includes a random nonce.
2021-05-28 10:01:10 -05:00
# $ROOT_PATH is server.root_url without the protocol.
content_security_policy_template = """script-src 'self' 'unsafe-eval' 'unsafe-inline' 'strict-dynamic' $NONCE;object-src 'none';font-src 'self';style-src 'self' 'unsafe-inline' blob:;img-src * data:;base-uri 'self';connect-src 'self' grafana.com ws://$ROOT_PATH wss://$ROOT_PATH;manifest-src 'self';media-src 'none';form-action 'self';"""
2019-06-12 06:15:50 -05:00
2022-11-16 11:11:26 -06:00
# Enable adding the Content-Security-Policy-Report-Only header to your requests.
# Allows you to monitor the effects of a policy without enforcing it.
content_security_policy_report_only = false
# Set Content Security Policy Report Only template used when adding the Content-Security-Policy-Report-Only header to your requests.
# $NONCE in the template includes a random nonce.
# $ROOT_PATH is server.root_url without the protocol.
content_security_policy_report_only_template = """script-src 'self' 'unsafe-eval' 'unsafe-inline' 'strict-dynamic' $NONCE;object-src 'none';font-src 'self';style-src 'self' 'unsafe-inline' blob:;img-src * data:;base-uri 'self';connect-src 'self' grafana.com ws://$ROOT_PATH wss://$ROOT_PATH;manifest-src 'self';media-src 'none';form-action 'self';"""
2024-03-22 11:09:53 -05:00
# Controls if old angular plugins are supported or not.
angular_support_enabled = false
2022-02-16 10:14:33 -06:00
2023-04-24 08:11:08 -05:00
# The CSRF check will be executed even if the request has no login cookie.
csrf_always_check = false
2024-10-17 09:56:50 -05:00
# Comma-separated list of plugins ids that will be loaded inside the frontend sandbox
# Currently behind the feature flag pluginsFrontendSandbox
enable_frontend_sandbox_for_plugins =
2023-07-05 04:16:56 -05:00
2024-09-10 09:45:27 -05:00
# Comma-separated list of paths for POST/PUT URL in actions. Empty will allow anything that is not on the same origin
actions_allow_post_url =
2022-03-16 14:05:13 -05:00
[security.encryption]
# Defines the time-to-live (TTL) for decrypted data encryption keys stored in memory (cache).
# Please note that small values may cause performance issues due to a high frequency decryption operations.
data_keys_cache_ttl = 15m
# Defines the frequency of data encryption keys cache cleanup interval.
# On every interval, decrypted data encryption keys that reached the TTL are removed from the cache.
data_keys_cache_cleanup_interval = 1m
2017-11-14 04:34:27 -06:00
#################################### Snapshots ###########################
2015-10-14 09:39:57 -05:00
[snapshots]
2023-01-26 07:28:11 -06:00
# set to false to remove snapshot functionality
enabled = true
2015-10-14 09:39:57 -05:00
# snapshot sharing options
external_enabled = true
2022-01-27 15:11:20 -06:00
external_snapshot_url = https://snapshots.raintank.io
external_snapshot_name = Publish to snapshots.raintank.io
2015-10-14 09:39:57 -05:00
2019-09-02 08:15:46 -05:00
# Set to true to enable this Grafana instance act as an external snapshot server and allow unauthenticated requests for
# creating and deleting snapshots.
public_mode = false
2017-11-17 07:41:44 -06:00
#################################### Dashboards ##################
2017-11-15 04:36:36 -06:00
[dashboards]
2017-11-17 07:41:44 -06:00
# Number dashboard versions to keep (per dashboard). Default: 20, Minimum: 1
2017-11-14 04:34:27 -06:00
versions_to_keep = 20
2020-04-27 09:51:54 -05:00
# Minimum dashboard refresh interval. When set, this will restrict users to set the refresh interval of a dashboard lower than given interval. Per default this is 5 seconds.
2020-02-28 07:32:01 -06:00
# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
2020-04-27 09:51:54 -05:00
min_refresh_interval = 5s
2020-02-28 07:32:01 -06:00
2020-06-22 11:00:39 -05:00
# Path to the default home dashboard. If this value is empty, then Grafana uses StaticRootPath + "dashboards/home.json"
2020-06-29 04:22:49 -05:00
default_home_dashboard_path =
2020-06-22 11:00:39 -05:00
2020-12-28 05:24:42 -06:00
################################### Data sources #########################
[datasources]
# Upper limit of data sources that Grafana will return. This limit is a temporary configuration and it will be deprecated when pagination will be introduced on the list data sources API.
datasource_limit = 5000
2024-01-29 04:47:28 -06:00
# Number of queries to be executed concurrently. Only for the datasource supports concurrency.
# For now only Loki and InfluxDB (with influxql) are supporting concurrency behind the feature flags.
# Check datasource documentations for enabling concurrency.
concurrent_query_count = 10
2023-04-17 03:44:05 -05:00
################################### SQL Data Sources #####################
[sql_datasources]
2023-05-04 03:36:51 -05:00
# Default maximum number of open connections maintained in the connection pool
2023-04-17 03:44:05 -05:00
# when connecting to SQL based data sources
max_open_conns_default = 100
# Default maximum number of idle connections maintained in the connection pool
# when connecting to SQL based data sources
max_idle_conns_default = 100
# Default maximum connection lifetime used when connecting
2023-05-04 03:36:51 -05:00
# to SQL based data sources.
2023-04-17 03:44:05 -05:00
max_conn_lifetime_default = 14400
2017-11-14 04:34:27 -06:00
#################################### Users ###############################
2015-03-11 10:19:29 -05:00
[users]
2015-04-09 10:18:04 -05:00
# disable user signup / registration
2017-07-24 05:36:42 -05:00
allow_sign_up = false
2015-04-10 03:58:32 -05:00
2015-04-09 10:18:04 -05:00
# Allow non admin users to create organizations
2017-07-24 05:36:42 -05:00
allow_org_create = false
2015-04-10 03:58:32 -05:00
2015-03-11 10:19:29 -05:00
# Set to true to automatically assign new users to the default organization (id 1)
auto_assign_org = true
2015-04-10 03:58:32 -05:00
2018-08-02 11:29:47 -05:00
# Set this value to automatically add new users to the provided organization (if auto_assign_org above is set to true)
auto_assign_org_id = 1
2023-07-17 08:58:16 -05:00
# Default role new users will be automatically assigned
2015-03-11 10:19:29 -05:00
auto_assign_org_role = Viewer
2015-01-27 08:14:53 -06:00
2015-08-31 04:35:07 -05:00
# Require email validation before sign up completes
verify_email_enabled = false
2024-03-12 03:35:13 -05:00
# Redirect to default OrgId after login
login_default_org_id =
2015-08-20 13:20:40 -05:00
# Background text for the user field on the login page
2024-05-01 06:17:53 -05:00
login_hint =
password_hint =
2015-08-20 13:20:40 -05:00
2023-01-30 03:51:51 -06:00
# Default UI theme ("dark" or "light" or "system")
2016-05-12 07:11:10 -05:00
default_theme = dark
2022-11-22 06:18:34 -06:00
# Default UI language (supported IETF language tag, such as en-US)
default_language = en-US
2022-06-21 05:12:49 -05:00
2021-04-13 08:27:51 -05:00
# Path to a custom home page. Users are only redirected to this if the default home dashboard is used. It should match a frontend route and contain a leading slash.
home_page =
2017-07-31 06:03:42 -05:00
# External user management
external_manage_link_url =
external_manage_link_name =
external_manage_info =
2017-12-13 11:53:42 -06:00
# Viewers can edit/inspect dashboard settings in the browser. But not save the dashboard.
viewers_can_edit = false
2019-02-22 06:54:15 -06:00
# Editors can administrate dashboard, folders and teams they create
2019-03-12 01:32:47 -05:00
editors_can_admin = false
2019-02-22 06:54:15 -06:00
2020-10-13 05:30:09 -05:00
# The duration in time a user invitation remains valid before expiring. This setting should be expressed as a duration. Examples: 6h (hours), 2d (days), 1w (week). Default is 24h (24 hours). The minimum supported duration is 15m (15 minutes).
user_invite_max_lifetime_duration = 24h
2024-03-07 06:51:27 -06:00
# The duration in time a verification email, used to update the email address of a user, remains valid before expiring. This setting should be expressed as a duration. Examples: 6h (hours), 2d (days), 1w (week). Default is 1h (1 hour).
verification_email_max_lifetime_duration = 1h
2024-06-24 09:54:56 -05:00
# Frequency of updating a user's last seen time. The minimum supported duration is 5m (5 minutes). The maximum supported duration is 1h (1 hour)
last_seen_update_interval = 15m
2020-11-24 05:10:32 -06:00
# Enter a comma-separated list of usernames to hide them in the Grafana UI. These users are shown to Grafana admins and to themselves.
2021-01-12 00:42:32 -06:00
hidden_users =
2020-11-24 05:10:32 -06:00
2023-05-04 03:36:51 -05:00
[secretscan]
# Enable secretscan feature
enabled = false
# Interval to check for token leaks
interval = 5m
# base URL of the grafana token leak check service
base_url = https://secret-scanning.grafana.net
# URL to send outgoing webhooks to in case of detection
oncall_url =
# Whether to revoke the token if a leak is detected or just send a notification
revoke = true
2022-11-22 03:08:40 -06:00
[service_accounts]
# When set, Grafana will not allow the creation of tokens with expiry greater than this setting.
token_expiration_day_limit =
2016-09-28 08:27:08 -05:00
[auth]
2019-02-05 14:09:55 -06:00
# Login cookie name
login_cookie_name = grafana_session
2024-10-15 07:00:40 -05:00
# Disable usage of Grafana's built-in login solution.
2022-10-12 10:34:59 -05:00
disable_login = false
2020-09-14 08:57:38 -05:00
# The maximum lifetime (duration) an authenticated user can be inactive before being required to login at next visit. Default is 7 days (7d). This setting should be expressed as a duration, e.g. 5m (minutes), 6h (hours), 10d (days), 2w (weeks), 1M (month). The lifetime resets at each successful token rotation (token_rotation_interval_minutes).
2020-10-08 03:03:20 -05:00
login_maximum_inactive_lifetime_duration =
2019-02-05 14:09:55 -06:00
2020-09-14 08:57:38 -05:00
# The maximum lifetime (duration) an authenticated user can be logged in since login time before being required to login. Default is 30 days (30d). This setting should be expressed as a duration, e.g. 5m (minutes), 6h (hours), 10d (days), 2w (weeks), 1M (month).
2020-10-08 03:03:20 -05:00
login_maximum_lifetime_duration =
2019-02-05 14:09:55 -06:00
# How often should auth tokens be rotated for authenticated users when being active. The default is each 10 minutes.
token_rotation_interval_minutes = 10
2016-09-28 08:27:08 -05:00
# Set to true to disable (hide) the login form, useful if you use OAuth
disable_login_form = false
2016-06-25 09:30:41 -05:00
2021-03-31 10:40:44 -05:00
# Set to true to disable the sign out link in the side menu. Useful if you use auth.proxy or auth.jwt.
2017-03-29 04:33:28 -05:00
disable_signout_menu = false
2018-05-27 07:52:50 -05:00
# URL to redirect the user to after sign out
signout_redirect_url =
2018-12-12 03:42:37 -06:00
# Set to true to attempt login with OAuth automatically, skipping the login screen.
# This setting is ignored if multiple OAuth providers are configured.
2023-01-19 08:53:02 -06:00
# Deprecated, use auto_login option for specific provider instead.
2018-12-12 03:42:37 -06:00
oauth_auto_login = false
2020-09-01 03:57:43 -05:00
# OAuth state max age cookie duration in seconds. Defaults to 600 seconds.
oauth_state_cookie_max_age = 600
2020-03-30 09:44:58 -05:00
2024-09-27 05:11:27 -05:00
# Sets a custom oAuth error message. This is useful if you need to point the users to a specific location for support.
oauth_login_error_message = oauth.login.error
2024-08-19 11:57:37 -05:00
# Minimum wait time in milliseconds for the server lock retry mechanism.
# The server lock retry mechanism is used to prevent multiple Grafana instances from
# simultaneously refreshing OAuth tokens. This mechanism waits at least this amount
# of time before retrying to acquire the server lock. There are 5 retries in total.
# The wait time between retries is calculated as random(n, n + 500)
oauth_refresh_token_server_lock_min_wait_ms = 1000
2019-06-26 01:47:03 -05:00
# limit of api_key seconds to live before expiration
api_key_max_seconds_to_live = -1
2020-10-08 03:03:20 -05:00
# Set to true to enable SigV4 authentication option for HTTP-based datasources
sigv4_auth_enabled = false
2022-02-08 07:48:17 -06:00
# Set to true to enable verbose logging of SigV4 request signing
sigv4_verbose_logging = false
2022-08-11 09:12:57 -05:00
# Set to true to enable Azure authentication option for HTTP-based datasources
azure_auth_enabled = false
2023-06-16 04:22:05 -05:00
# Use email lookup in addition to the unique ID provided by the IdP
oauth_allow_insecure_email_lookup = false
2023-11-29 08:51:13 -06:00
# Set to true to include id of identity as a response header
id_response_header_enabled = false
# Prefix used for the id response header, X-Grafana-Identity-Id
id_response_header_prefix = X-Grafana
# List of identity namespaces to add id response headers for, separated by space.
# Available namespaces are user, api-key and service-account.
# The header value will encode the namespace ("user:<id>", "api-key:<id>", "service-account:<id>")
id_response_header_namespaces = user api-key service-account
2024-09-27 02:11:59 -05:00
# Enables the use of managed service accounts for plugin authentication
2024-09-27 04:07:02 -05:00
# This feature currently **only supports single-organization deployments**
2024-09-27 02:11:59 -05:00
managed_service_accounts_enabled = false
2024-01-12 02:24:16 -06:00
#################################### SSO Settings ###########################
[sso_settings]
# interval for reloading the SSO Settings from the database
# useful in high availability setups running multiple Grafana instances
# set to 0 to disable this feature
reload_interval = 1m
2024-01-23 08:48:06 -06:00
# List of providers that can be configured through the SSO Settings API and UI.
configurable_providers = github gitlab google generic_oauth azuread okta
2016-09-20 09:09:20 -05:00
#################################### Anonymous Auth ######################
2015-01-27 08:14:53 -06:00
[auth.anonymous]
2015-04-09 10:18:04 -05:00
# enable anonymous access
2015-01-29 05:10:34 -06:00
enabled = false
2015-04-10 03:58:32 -05:00
2015-04-09 10:18:04 -05:00
# specify organization name that should be used for unauthenticated users
2015-03-12 13:43:52 -05:00
org_name = Main Org.
2015-04-10 03:58:32 -05:00
2015-04-09 10:18:04 -05:00
# specify role for unauthenticated users
2015-03-11 10:19:29 -05:00
org_role = Viewer
2014-10-07 16:56:37 -05:00
2020-06-17 00:39:50 -05:00
# mask the Grafana version number for unauthenticated users
hide_version = false
2023-12-18 02:32:57 -06:00
# number of devices in total
2024-01-12 02:24:16 -06:00
device_limit =
2023-12-18 02:32:57 -06:00
2020-07-22 10:12:50 -05:00
#################################### GitHub Auth #########################
2015-01-07 09:37:24 -06:00
[auth.github]
2023-03-03 02:17:43 -06:00
name = GitHub
icon = github
2015-01-07 09:37:24 -06:00
enabled = false
2016-12-12 09:35:42 -06:00
allow_sign_up = true
2023-01-19 08:53:02 -06:00
auto_login = false
2015-01-07 09:37:24 -06:00
client_id = some_id
2020-08-03 09:33:27 -05:00
client_secret =
2018-02-28 06:08:15 -06:00
scopes = user:email,read:org
2014-10-07 16:56:37 -05:00
auth_url = https://github.com/login/oauth/authorize
token_url = https://github.com/login/oauth/access_token
2015-04-15 01:03:28 -05:00
api_url = https://api.github.com/user
2023-11-29 07:50:21 -06:00
signout_redirect_url =
2019-11-27 03:08:08 -06:00
allowed_domains =
2015-04-29 03:33:37 -05:00
team_ids =
2015-05-23 09:06:51 -05:00
allowed_organizations =
2022-07-20 09:32:04 -05:00
role_attribute_path =
role_attribute_strict = false
2024-06-05 09:15:53 -05:00
org_mapping =
2022-09-08 05:11:00 -05:00
allow_assign_grafana_admin = false
2023-07-12 08:25:46 -05:00
skip_org_role_sync = false
2023-03-13 10:26:05 -05:00
tls_skip_verify_insecure = false
2023-05-26 07:15:19 -05:00
tls_client_cert =
tls_client_key =
tls_client_ca =
2023-07-14 07:03:01 -05:00
# GitHub OAuth apps does not provide refresh tokens and the access tokens never expires.
use_refresh_token = false
2014-10-07 16:56:37 -05:00
2018-02-15 12:13:47 -06:00
#################################### GitLab Auth #########################
[auth.gitlab]
2023-03-03 02:17:43 -06:00
name = GitLab
icon = gitlab
2018-02-15 12:13:47 -06:00
enabled = false
allow_sign_up = true
2023-01-19 08:53:02 -06:00
auto_login = false
2018-02-15 12:13:47 -06:00
client_id = some_id
2020-08-03 09:33:27 -05:00
client_secret =
2023-07-25 11:46:46 -05:00
scopes = openid email profile
2018-02-15 12:13:47 -06:00
auth_url = https://gitlab.com/oauth/authorize
token_url = https://gitlab.com/oauth/token
api_url = https://gitlab.com/api/v4
2023-11-29 07:50:21 -06:00
signout_redirect_url =
2019-11-27 03:08:08 -06:00
allowed_domains =
2018-02-15 12:13:47 -06:00
allowed_groups =
2022-06-03 06:07:39 -05:00
role_attribute_path =
role_attribute_strict = false
2024-06-05 09:15:53 -05:00
org_mapping =
2022-09-08 05:11:00 -05:00
allow_assign_grafana_admin = false
2023-01-25 06:39:54 -06:00
skip_org_role_sync = false
2023-03-13 10:26:05 -05:00
tls_skip_verify_insecure = false
2023-05-26 07:15:19 -05:00
tls_client_cert =
tls_client_key =
tls_client_ca =
2023-05-12 02:37:29 -05:00
use_pkce = true
2023-07-14 07:03:01 -05:00
use_refresh_token = true
2018-02-15 12:13:47 -06:00
2016-09-20 09:09:20 -05:00
#################################### Google Auth #########################
2015-01-07 09:37:24 -06:00
[auth.google]
2023-03-03 02:17:43 -06:00
name = Google
icon = google
2015-01-07 09:37:24 -06:00
enabled = false
2016-12-12 09:35:42 -06:00
allow_sign_up = true
2023-01-19 08:53:02 -06:00
auto_login = false
2015-01-07 09:37:24 -06:00
client_id = some_client_id
2020-08-03 09:33:27 -05:00
client_secret =
2023-06-26 02:44:57 -05:00
scopes = openid email profile
auth_url = https://accounts.google.com/o/oauth2/v2/auth
token_url = https://oauth2.googleapis.com/token
api_url = https://openidconnect.googleapis.com/v1/userinfo
2023-11-29 07:50:21 -06:00
signout_redirect_url =
2015-04-13 07:04:52 -05:00
allowed_domains =
2024-02-29 09:48:32 -06:00
validate_hd = true
2016-11-10 09:15:48 -06:00
hosted_domain =
2023-10-10 11:07:23 -05:00
allowed_groups =
role_attribute_path =
role_attribute_strict = false
2024-06-07 07:07:35 -05:00
org_mapping =
2023-10-10 11:07:23 -05:00
allow_assign_grafana_admin = false
skip_org_role_sync = true
2023-03-13 10:26:05 -05:00
tls_skip_verify_insecure = false
2023-05-26 07:15:19 -05:00
tls_client_cert =
tls_client_key =
tls_client_ca =
2023-05-12 02:37:29 -05:00
use_pkce = true
2023-07-14 07:03:01 -05:00
use_refresh_token = true
2014-10-07 16:56:37 -05:00
2017-03-20 04:20:32 -05:00
#################################### Grafana.com Auth ####################
2017-05-22 07:56:50 -05:00
# legacy key names (so they work in env variables)
2016-09-20 09:09:20 -05:00
[auth.grafananet]
enabled = false
2016-12-12 09:35:42 -06:00
allow_sign_up = true
2016-09-20 09:09:20 -05:00
client_id = some_id
2020-08-03 09:33:27 -05:00
client_secret =
2016-09-20 09:09:20 -05:00
scopes = user:email
allowed_organizations =
2023-07-14 07:03:01 -05:00
use_refresh_token = false
2016-09-20 09:09:20 -05:00
2017-05-22 07:56:50 -05:00
[auth.grafana_com]
2023-03-03 02:17:43 -06:00
name = Grafana.com
icon = grafana
2017-05-22 07:56:50 -05:00
enabled = false
allow_sign_up = true
2023-01-19 08:53:02 -06:00
auto_login = false
2017-05-22 07:56:50 -05:00
client_id = some_id
2020-08-03 09:33:27 -05:00
client_secret =
2017-05-22 07:56:50 -05:00
scopes = user:email
allowed_organizations =
2023-01-12 09:44:08 -06:00
skip_org_role_sync = false
2023-07-14 07:03:01 -05:00
use_refresh_token = false
2017-05-22 07:56:50 -05:00
2020-02-13 03:12:25 -06:00
#################################### Azure AD OAuth #######################
[auth.azuread]
2023-03-03 02:17:43 -06:00
name = Microsoft
icon = microsoft
2020-02-13 03:12:25 -06:00
enabled = false
allow_sign_up = true
2023-01-19 08:53:02 -06:00
auto_login = false
2020-02-13 03:12:25 -06:00
client_id = some_client_id
2020-08-03 09:33:27 -05:00
client_secret =
2020-02-13 03:12:25 -06:00
scopes = openid email profile
auth_url = https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/authorize
token_url = https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/token
2023-11-29 07:50:21 -06:00
signout_redirect_url =
2020-02-14 05:03:00 -06:00
allowed_domains =
allowed_groups =
2023-06-16 11:29:09 -05:00
allowed_organizations =
2022-03-18 05:34:16 -05:00
role_attribute_strict = false
2024-06-10 05:08:30 -05:00
org_mapping =
2022-09-08 05:11:00 -05:00
allow_assign_grafana_admin = false
2022-10-14 05:55:00 -05:00
force_use_graph_api = false
2023-03-13 10:26:05 -05:00
tls_skip_verify_insecure = false
2023-05-26 07:15:19 -05:00
tls_client_cert =
tls_client_key =
tls_client_ca =
2023-05-12 02:37:29 -05:00
use_pkce = true
2023-06-26 09:54:32 -05:00
skip_org_role_sync = false
2023-07-14 07:03:01 -05:00
use_refresh_token = true
2020-02-13 03:12:25 -06:00
2020-04-02 09:35:48 -05:00
#################################### Okta OAuth #######################
[auth.okta]
name = Okta
2022-02-16 10:35:00 -06:00
icon = okta
2020-04-02 09:35:48 -05:00
enabled = false
allow_sign_up = true
2023-01-19 08:53:02 -06:00
auto_login = false
2020-04-02 09:35:48 -05:00
client_id = some_id
2020-08-03 09:33:27 -05:00
client_secret =
2020-04-02 09:35:48 -05:00
scopes = openid profile email groups
auth_url = https://<tenant-id>.okta.com/oauth2/v1/authorize
token_url = https://<tenant-id>.okta.com/oauth2/v1/token
api_url = https://<tenant-id>.okta.com/oauth2/v1/userinfo
2023-11-29 07:50:21 -06:00
signout_redirect_url =
2020-04-02 09:35:48 -05:00
allowed_domains =
allowed_groups =
role_attribute_path =
2021-04-14 14:14:27 -05:00
role_attribute_strict = false
2024-06-06 03:35:06 -05:00
org_attribute_path =
org_mapping =
2022-09-08 05:11:00 -05:00
allow_assign_grafana_admin = false
2023-01-30 04:54:14 -06:00
skip_org_role_sync = false
2023-03-13 10:26:05 -05:00
tls_skip_verify_insecure = false
2023-05-26 07:15:19 -05:00
tls_client_cert =
tls_client_key =
tls_client_ca =
2023-05-12 02:37:29 -05:00
use_pkce = true
2023-07-14 07:03:01 -05:00
use_refresh_token = false
2020-04-02 09:35:48 -05:00
2016-09-20 09:09:20 -05:00
#################################### Generic OAuth #######################
2016-09-07 03:34:56 -05:00
[auth.generic_oauth]
2016-12-15 07:08:39 -06:00
name = OAuth
2022-02-16 10:35:00 -06:00
icon = signin
2016-09-07 03:34:56 -05:00
enabled = false
2016-12-12 09:35:42 -06:00
allow_sign_up = true
2023-01-19 08:53:02 -06:00
auto_login = false
2016-09-07 03:34:56 -05:00
client_id = some_id
2020-08-03 09:33:27 -05:00
client_secret =
2016-09-07 03:34:56 -05:00
scopes = user:email
2021-05-10 12:07:30 -05:00
empty_scopes = false
2018-09-10 02:45:07 -05:00
email_attribute_name = email:primary
2019-08-26 11:11:40 -05:00
email_attribute_path =
2020-08-03 09:33:27 -05:00
login_attribute_path =
2020-10-20 01:56:48 -05:00
name_attribute_path =
2019-11-26 10:14:26 -06:00
role_attribute_path =
2021-04-14 14:14:27 -05:00
role_attribute_strict = false
2024-05-23 02:55:45 -05:00
org_attribute_path =
org_mapping =
2021-07-01 15:40:46 -05:00
groups_attribute_path =
2020-08-03 09:33:27 -05:00
id_token_attribute_name =
2021-09-07 19:57:20 -05:00
team_ids_attribute_path =
2016-09-07 03:34:56 -05:00
auth_url =
token_url =
api_url =
2023-11-29 07:50:21 -06:00
signout_redirect_url =
2021-09-07 19:57:20 -05:00
teams_url =
2019-11-27 03:08:08 -06:00
allowed_domains =
2023-05-30 04:07:04 -05:00
allowed_groups =
2016-09-07 03:34:56 -05:00
team_ids =
allowed_organizations =
2018-07-30 02:02:16 -05:00
tls_skip_verify_insecure = false
2018-08-14 01:49:56 -05:00
tls_client_cert =
tls_client_key =
tls_client_ca =
2021-10-13 09:45:15 -05:00
use_pkce = false
2022-07-07 09:28:04 -05:00
auth_style =
2022-09-08 05:11:00 -05:00
allow_assign_grafana_admin = false
2023-02-01 10:27:53 -06:00
skip_org_role_sync = false
2023-07-14 07:03:01 -05:00
use_refresh_token = false
2016-09-07 03:34:56 -05:00
2015-06-30 02:37:52 -05:00
#################################### Basic Auth ##########################
[auth.basic]
enabled = true
2024-02-16 04:58:05 -06:00
# This setting will enable a stronger password policy for user's password under basic auth.
# The password will need to comply with the following password policy
# 1. Have a minimum of 12 characters
# 2. Composed by at least 1 uppercase character
# 3. Composed by at least 1 lowercase character
# 4. Composed by at least 1 digit character
# 5. Composed by at least 1 symbol character
password_policy = false
2015-06-30 02:37:52 -05:00
2015-05-01 04:55:59 -05:00
#################################### Auth Proxy ##########################
[auth.proxy]
2015-05-02 05:30:53 -05:00
enabled = false
2015-05-01 04:55:59 -05:00
header_name = X-WEBAUTH-USER
header_property = username
auto_sign_up = true
2024-03-01 04:31:06 -06:00
sync_ttl = 15
2016-02-23 07:22:28 -06:00
whitelist =
2018-11-07 16:36:44 -06:00
headers =
2022-03-04 03:58:27 -06:00
headers_encoded = false
2019-11-07 10:48:56 -06:00
enable_login_token = false
2015-05-01 04:55:59 -05:00
2021-03-31 10:40:44 -05:00
#################################### Auth JWT ##########################
[auth.jwt]
enabled = false
2022-07-07 09:28:04 -05:00
enable_login_token = false
2021-03-31 10:40:44 -05:00
header_name =
2021-04-26 04:38:24 -05:00
email_claim =
username_claim =
2024-03-28 11:25:26 -05:00
email_attribute_path =
username_attribute_path =
2021-04-26 04:38:24 -05:00
jwk_set_url =
jwk_set_file =
2021-03-31 10:40:44 -05:00
cache_ttl = 60m
2022-11-07 06:29:27 -06:00
expect_claims = {}
2021-04-26 04:38:24 -05:00
key_file =
2023-08-03 02:13:23 -05:00
key_id =
2022-09-07 07:00:33 -05:00
role_attribute_path =
role_attribute_strict = false
2024-02-09 09:35:58 -06:00
groups_attribute_path =
2022-01-13 10:15:22 -06:00
auto_sign_up = false
2022-10-27 08:57:01 -05:00
url_login = false
2022-09-07 07:00:33 -05:00
allow_assign_grafana_admin = false
2023-01-18 06:59:50 -06:00
skip_org_role_sync = false
2021-03-31 10:40:44 -05:00
2016-09-20 09:09:20 -05:00
#################################### Auth LDAP ###########################
2015-06-04 02:34:42 -05:00
[auth.ldap]
2015-07-15 03:08:23 -05:00
enabled = false
config_file = /etc/grafana/ldap.toml
2016-10-07 01:49:58 -05:00
allow_sign_up = true
2022-10-12 06:33:33 -05:00
skip_org_role_sync = false
2015-06-04 02:34:42 -05:00
2020-12-30 04:09:17 -06:00
# LDAP background sync (Enterprise only)
2019-06-25 05:54:13 -05:00
# At 1 am every day
2022-04-26 07:14:48 -05:00
sync_cron = "0 1 * * *"
2019-07-05 09:49:00 -05:00
active_sync_enabled = true
2019-04-25 09:12:56 -05:00
2024-01-12 02:24:16 -06:00
#################################### AWS #####################################
2021-02-24 11:08:13 -06:00
[aws]
2021-04-26 04:38:24 -05:00
# Enter a comma-separated list of allowed AWS authentication providers.
2021-03-09 14:20:59 -06:00
# Options are: default (AWS SDK Default), keys (Access && secret key), credentials (Credentials field), ec2_iam_role (EC2 IAM Role)
2021-02-24 11:08:13 -06:00
allowed_auth_providers = default,keys,credentials
2021-04-26 04:38:24 -05:00
# Allow AWS users to assume a role using temporary security credentials.
2021-02-24 11:08:13 -06:00
# If true, assume role will be enabled for all AWS authentication providers that are specified in aws_auth_providers
assume_role_enabled = true
2021-03-10 00:41:22 -06:00
# Specify max no of pages to be returned by the ListMetricPages API
list_metrics_page_limit = 500
2023-07-20 09:37:41 -05:00
# Experimental, for use in Grafana Cloud only. Please do not set.
2023-10-10 11:07:23 -05:00
external_id =
2023-07-20 09:37:41 -05:00
2024-02-05 12:59:32 -06:00
# Sets the expiry duration of an assumed role.
# This setting should be expressed as a duration. Examples: 6h (hours), 10d (days), 2w (weeks), 1M (month).
session_duration = "15m"
# Set the plugins that will receive AWS settings for each request (via plugin context)
# By default this will include all Grafana Labs owned AWS plugins, or those that make use of AWS settings (ElasticSearch, Prometheus).
forward_settings_to_plugins = cloudwatch, grafana-athena-datasource, grafana-redshift-datasource, grafana-x-ray-datasource, grafana-timestream-datasource, grafana-iot-sitewise-datasource, grafana-iot-twinmaker-app, grafana-opensearch-datasource, aws-datasource-provisioner, elasticsearch, prometheus
2021-05-12 09:23:37 -05:00
#################################### Azure ###############################
[azure]
# Azure cloud environment where Grafana is hosted
# Possible values are AzureCloud, AzureChinaCloud, AzureUSGovernment and AzureGermanCloud
# Default value is AzureCloud (i.e. public cloud)
cloud = AzureCloud
2024-05-24 11:40:04 -05:00
# A customized list of Azure cloud settings and properties, used by data sources which need this information when run in non-standard azure environments
# When specified, this list will replace the default cloud list of AzureCloud, AzureChinaCloud, AzureUSGovernment and AzureGermanCloud
2024-05-31 07:23:45 -05:00
clouds_config =
2024-05-24 11:40:04 -05:00
2021-05-12 09:23:37 -05:00
# Specifies whether Grafana hosted in Azure service with Managed Identity configured (e.g. Azure Virtual Machines instance)
# If enabled, the managed identity can be used for authentication of Grafana in Azure services
# Disabled by default, needs to be explicitly enabled
managed_identity_enabled = false
# Client ID to use for user-assigned managed identity
# Should be set for user-assigned identity and should be empty for system-assigned identity
managed_identity_client_id =
2023-09-28 06:05:16 -05:00
# Specifies whether Azure AD Workload Identity authentication should be enabled in datasources that support it
# For more documentation on Azure AD Workload Identity, review this documentation:
# https://azure.github.io/azure-workload-identity/docs/
# Disabled by default, needs to be explicitly enabled
workload_identity_enabled = false
# Tenant ID of the Azure AD Workload Identity
# Allows to override default tenant ID of the Azure AD identity associated with the Kubernetes service account
workload_identity_tenant_id =
# Client ID of the Azure AD Workload Identity
# Allows to override default client ID of the Azure AD identity associated with the Kubernetes service account
workload_identity_client_id =
# Custom path to token file for the Azure AD Workload Identity
# Allows to set a custom path to the projected service account token file
workload_identity_token_file =
2023-05-15 12:00:54 -05:00
# Specifies whether user identity authentication (on behalf of currently signed-in user) should be enabled in datasources
# that support it (requires AAD authentication)
# Disabled by default, needs to be explicitly enabled
user_identity_enabled = false
2024-03-19 11:32:24 -05:00
# Specifies whether user identity authentication fallback credentials should be enabled in data sources
# Enabling this allows data source creators to provide fallback credentials for backend initiated requests
# e.g. alerting, recorded queries etc.
# Enabled by default, needs to be explicitly disabled
# Will not have any effect if user identity is disabled above
user_identity_fallback_credentials_enabled = true
2023-05-15 12:00:54 -05:00
# Override token URL for Azure Active Directory
# By default is the same as token URL configured for AAD authentication settings
user_identity_token_url =
# Override ADD application ID which would be used to exchange users token to an access token for the datasource
# By default is the same as used in AAD authentication or can be set to another application (for OBO flow)
user_identity_client_id =
# Override the AAD application client secret
# By default is the same as used in AAD authentication or can be set to another application (for OBO flow)
user_identity_client_secret =
2024-05-16 11:50:02 -05:00
# Allows the usage of a custom token request assertion when Grafana is behind an authentication proxy
# In most cases this will not need to be used. To enable this set the value to "username"
# The default is empty and any other value will not enable this functionality
username_assertion =
2023-12-14 05:48:22 -06:00
# Set the plugins that will receive Azure settings for each request (via plugin context)
# By default this will include all Grafana Labs owned Azure plugins, or those that make use of Azure settings (Azure Monitor, Azure Data Explorer, Prometheus, MSSQL).
forward_settings_to_plugins = grafana-azure-monitor-datasource, prometheus, grafana-azure-data-explorer-datasource, mssql
2024-07-16 14:08:51 -05:00
# Specifies whether Entra password auth can be used for the MSSQL data source
# Disabled by default, needs to be explicitly enabled
azure_entra_password_credentials_enabled = false
2022-05-16 05:45:41 -05:00
#################################### Role-based Access Control ###########
[rbac]
2022-09-14 02:13:10 -05:00
# If enabled, cache permissions in a in memory cache
2022-05-16 10:52:10 -05:00
permission_cache = true
2022-05-16 05:45:41 -05:00
2022-12-01 02:41:40 -06:00
# Reset basic roles permissions on boot
# Warning left to true, basic roles permissions will be reset on every boot
reset_basic_roles = false
2023-08-25 07:07:40 -05:00
# Validate permissions' action and scope on role creation and update
permission_validation_enabled = true
2016-09-20 09:09:20 -05:00
#################################### SMTP / Emailing #####################
2015-06-08 10:56:56 -05:00
[smtp]
enabled = false
host = localhost:25
user =
2018-02-15 12:37:23 -06:00
# If the password contains # or ; you have to wrap it with triple quotes. Ex """#password;"""
2015-06-08 10:56:56 -05:00
password =
cert_file =
key_file =
skip_verify = false
from_address = admin@grafana.localhost
2017-02-15 03:45:04 -06:00
from_name = Grafana
2017-09-22 16:29:56 -05:00
ehlo_identity =
2020-05-13 09:33:40 -05:00
startTLS_policy =
2024-01-22 09:50:05 -06:00
enable_tracing = false
2015-06-08 10:56:56 -05:00
2023-12-14 12:59:43 -06:00
[smtp.static_headers]
# Include custom static headers in all outgoing emails
2015-06-08 10:56:56 -05:00
[emails]
welcome_email_on_sign_up = false
2021-07-19 05:31:51 -05:00
templates_pattern = emails/*.html, emails/*.txt
content_types = text/html
2015-06-08 10:56:56 -05:00
2015-04-09 10:18:04 -05:00
#################################### Logging ##########################
2014-10-04 06:33:20 -05:00
[log]
2018-11-29 02:21:06 -06:00
# Either "console", "file", "syslog". Default is console and file
2016-06-07 05:11:41 -05:00
# Use space to separate multiple modes, e.g. "console file"
2016-12-02 00:46:41 -06:00
mode = console file
2015-04-10 03:58:32 -05:00
2016-06-21 09:29:17 -05:00
# Either "debug", "info", "warn", "error", "critical", default is "info"
2016-06-08 01:48:46 -05:00
level = info
2014-10-04 06:33:20 -05:00
2016-10-07 03:39:01 -05:00
# optional settings to set different levels for specific loggers. Ex filters = sqlstore:debug
filters =
2023-06-16 10:46:47 -05:00
# Set the default error message shown to users. This message is displayed instead of sensitive backend errors which should be obfuscated.
user_facing_default_error = "please inspect Grafana server log for details"
2015-04-09 10:18:04 -05:00
# For "console" mode only
2014-10-04 06:33:20 -05:00
[log.console]
level =
2016-06-08 01:48:46 -05:00
# log line format, valid options are text, console and json
format = console
2014-10-04 06:33:20 -05:00
2015-04-09 10:18:04 -05:00
# For "file" mode only
2014-10-04 06:33:20 -05:00
[log.file]
level =
2016-06-08 01:48:46 -05:00
# log line format, valid options are text, console and json
format = text
2015-04-10 03:58:32 -05:00
# This enables automated log rotate(switch of following options), default is true
2014-10-04 06:33:20 -05:00
log_rotate = true
2015-04-10 03:58:32 -05:00
# Max line number of single file, default is 1000000
2014-10-04 06:33:20 -05:00
max_lines = 1000000
2015-04-10 03:58:32 -05:00
# Max size shift of single file, default is 28 means 1 << 28, 256MB
2016-06-06 16:06:44 -05:00
max_size_shift = 28
2015-04-10 03:58:32 -05:00
# Segment log daily, default is true
2014-10-04 06:33:20 -05:00
daily_rotate = true
2015-04-10 03:58:32 -05:00
# Expired days of log file(delete after max days), default is 7
2014-10-04 06:33:20 -05:00
max_days = 7
2015-11-07 20:06:31 -06:00
[log.syslog]
level =
2016-06-08 01:48:46 -05:00
# log line format, valid options are text, console and json
format = text
2015-11-07 20:06:31 -06:00
# Syslog network type and address. This can be udp, tcp, or unix. If left blank, the default unix endpoints will be used.
network =
address =
# Syslog facility. user, daemon and local0 through local7 are valid.
facility =
# Syslog tag. By default, the process' argv[0] is used.
tag =
2020-11-12 05:29:43 -06:00
[log.frontend]
2023-05-02 04:10:56 -05:00
# Should Faro javascript agent be initialized
2020-11-12 05:29:43 -06:00
enabled = false
2022-06-28 02:25:30 -05:00
# Custom HTTP endpoint to send events to. Default will log the events to stdout.
custom_endpoint =
2020-11-12 05:29:43 -06:00
2020-12-09 09:22:24 -06:00
# Requests per second limit enforced per an extended period, for Grafana backend log ingestion endpoint (/log).
log_endpoint_requests_per_second_limit = 3
# Max requests accepted per short interval of time for Grafana backend log ingestion endpoint (/log)
log_endpoint_burst_limit = 15
2022-06-28 02:25:30 -05:00
# Should error instrumentation be enabled, only affects Grafana Javascript Agent
instrumentations_errors_enabled = true
# Should console instrumentation be enabled, only affects Grafana Javascript Agent
instrumentations_console_enabled = false
# Should webvitals instrumentation be enabled, only affects Grafana Javascript Agent
instrumentations_webvitals_enabled = false
2024-08-01 05:54:39 -05:00
# Should tracing instrumentation be enabled, only affects Grafana Javascript Agent
instrumentations_tracing_enabled = false
2024-02-01 08:08:40 -06:00
# level of internal logging for debugging Grafana Javascript Agent.
# possible values are: 0 = OFF, 1 = ERROR, 2 = WARN, 3 = INFO, 4 = VERBOSE
# more details: https://github.com/grafana/faro-web-sdk/blob/v1.3.7/docs/sources/tutorials/quick-start-browser.md#how-to-activate-debugging
internal_logger_level = 0
2022-06-28 02:25:30 -05:00
# Api Key, only applies to Grafana Javascript Agent provider
2022-07-07 09:28:04 -05:00
api_key =
2022-06-28 02:25:30 -05:00
2016-09-20 09:09:20 -05:00
#################################### Usage Quotas ########################
2015-07-20 07:51:27 -05:00
[quota]
2015-09-10 12:47:33 -05:00
enabled = false
2015-09-11 10:17:10 -05:00
#### set quotas to -1 to make unlimited. ####
# limit number of users per Org.
org_user = 10
# limit number of dashboards per Org.
org_dashboard = 100
# limit number of data_sources per Org.
org_data_source = 10
# limit number of api_keys per Org.
org_api_key = 10
2021-05-04 11:16:28 -05:00
# limit number of alerts per Org.
org_alert_rule = 100
2015-09-11 10:17:10 -05:00
# limit number of orgs a user can create.
user_org = 10
# Global limit of users.
global_user = -1
# global limit of orgs.
global_org = -1
# global limit of dashboards
global_dashboard = -1
# global limit of api_keys
global_api_key = -1
# global limit on number of logged in users.
global_session = -1
2016-04-29 07:35:58 -05:00
2021-05-04 11:16:28 -05:00
# global limit of alerts
global_alert_rule = -1
2022-07-18 06:24:39 -05:00
# global limit of files uploaded to the SQL DB
global_file = 1000
2023-03-21 15:27:25 -05:00
# global limit of correlations
global_correlations = -1
2024-02-13 08:29:03 -06:00
# Limit of the number of alert rules per rule group.
# This is not strictly enforced yet, but will be enforced over time.
alerting_rule_group_rules = 100
2024-06-27 02:45:15 -05:00
# Limit the number of query evaluation results per alert rule.
# If the condition query of an alert rule produces more results than this limit,
# the evaluation results in an error.
alerting_rule_evaluation_results = -1
2021-08-13 07:14:36 -05:00
#################################### Unified Alerting ####################
[unified_alerting]
2024-03-14 09:36:35 -05:00
# Enable the Alerting sub-system and interface.
2021-11-24 13:56:07 -06:00
enabled =
2021-09-29 09:16:40 -05:00
# Comma-separated list of organization IDs for which to disable unified alerting. Only supported if unified alerting is enabled.
2021-10-13 09:45:15 -05:00
disabled_orgs =
2021-09-29 09:16:40 -05:00
2021-08-13 07:14:36 -05:00
# Specify the frequency of polling for admin config changes.
2021-09-16 09:33:51 -05:00
# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
admin_config_poll_interval = 60s
# Specify the frequency of polling for Alertmanager config changes.
# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
alertmanager_config_poll_interval = 60s
2024-07-24 07:22:29 -05:00
# Maximum number of active and pending silences that a tenant can have at once. Default: 0 (no limit).
alertmanager_max_silences_count =
# Maximum silence size in bytes. Default: 0 (no limit).
alertmanager_max_silence_size_bytes =
2024-06-05 11:02:25 -05:00
# Set to true when using redis in cluster mode.
ha_redis_cluster_mode_enabled = false
# The redis server address(es) that should be connected to.
# Can either be a single address, or if using redis in cluster mode,
# the cluster configuration address or a comma-separated list of addresses.
2023-04-19 10:05:26 -05:00
ha_redis_address =
# The username that should be used to authenticate with the redis server.
ha_redis_username =
# The password that should be used to authenticate with the redis server.
ha_redis_password =
# The redis database, by default it's 0.
ha_redis_db =
# A prefix that is used for every key or channel that is created on the redis server
# as part of HA for alerting.
ha_redis_prefix =
# The name of the cluster peer that will be used as identifier. If none is
# provided, a random one will be generated.
ha_redis_peer_name =
2023-08-29 14:59:12 -05:00
# The maximum number of simultaneous redis connections.
ha_redis_max_conns = 5
2024-05-14 08:21:42 -05:00
# Enable TLS on the client used to communicate with the redis server. This should be set to true
# if using any of the other ha_redis_tls_* fields.
ha_redis_tls_enabled = false
# Path to the PEM-encoded TLS client certificate file used to authenticate with the redis server.
2024-05-31 07:23:45 -05:00
# Required if using Mutual TLS.
2024-05-14 08:21:42 -05:00
ha_redis_tls_cert_path =
# Path to the PEM-encoded TLS private key file. Also requires the client certificate to be configured.
2024-05-31 07:23:45 -05:00
# Required if using Mutual TLS.
2024-05-14 08:21:42 -05:00
ha_redis_tls_key_path =
2024-05-31 07:23:45 -05:00
# Path to the PEM-encoded CA certificates file. If not set, the host's root CA certificates are used.
2024-05-14 08:21:42 -05:00
ha_redis_tls_ca_path =
# Overrides the expected name of the redis server certificate.
ha_redis_tls_server_name =
# Skips validating the redis server certificate.
ha_redis_tls_insecure_skip_verify =
# Overrides the default TLS cipher suite list.
ha_redis_tls_cipher_suites =
# Overrides the default minimum TLS version.
# Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13
ha_redis_tls_min_version =
2021-09-16 09:33:51 -05:00
# Listen address/hostname and port to receive unified alerting messages for other Grafana instances. The port is used for both TCP and UDP. It is assumed other Grafana instances are also running on the same port.
ha_listen_address = "0.0.0.0:9094"
# Explicit address/hostname and port to advertise other Grafana instances. The port is used for both TCP and UDP.
ha_advertise_address = ""
# Comma-separated list of initial instances (in a format of host:port) that will form the HA cluster. Configuring this setting will enable High Availability mode for alerting.
ha_peers = ""
# Time to wait for an instance to send a notification via the Alertmanager. In HA, each Grafana instance will
# be assigned a position (e.g. 0, 1). We then multiply this position with the timeout to indicate how long should
# each instance wait before sending the notification to take into account replication lag.
# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
ha_peer_timeout = 15s
2023-05-12 02:37:29 -05:00
# The label is an optional string to include on each packet and stream.
# It uniquely identifies the cluster and prevents cross-communication
2023-05-09 03:32:23 -05:00
# issues when sending gossip messages in an enviromenet with multiple clusters.
ha_label =
2021-09-16 09:33:51 -05:00
# The interval between sending gossip messages. By lowering this value (more frequent) gossip messages are propagated
# across cluster more quickly at the expense of increased bandwidth usage.
# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
ha_gossip_interval = 200ms
2024-06-11 12:25:48 -05:00
# Length of time to attempt to reconnect to a lost peer. Recommended to be short (<15m) when Grafana is running in a Kubernetes cluster.
# The string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
ha_reconnect_timeout = 6h
2021-09-16 09:33:51 -05:00
# The interval between gossip full state syncs. Setting this interval lower (more frequent) will increase convergence speeds
# across larger clusters at the expense of increased bandwidth usage.
# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
ha_push_pull_interval = 60s
2021-08-13 07:14:36 -05:00
2024-03-07 15:01:11 -06:00
# Enable or disable alerting rule execution. The alerting UI remains visible.
2021-09-28 05:00:16 -05:00
execute_alerts = true
2024-03-07 15:01:11 -06:00
# Alert evaluation timeout when fetching data from the datasource.
2021-09-28 05:00:16 -05:00
# The timeout string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
evaluation_timeout = 30s
2023-12-05 11:42:34 -06:00
# Number of times we'll attempt to evaluate an alert rule before giving up on that evaluation. The default value is 1.
max_attempts = 1
2021-09-28 05:00:16 -05:00
2024-03-07 15:01:11 -06:00
# Minimum interval to enforce between rule evaluations. Rules will be adjusted if they are less than this value or if they are not multiple of the scheduler interval (10s). Higher values can help with resource management as we'll schedule fewer evaluations over time.
2021-09-28 05:00:16 -05:00
# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
min_interval = 10s
2023-06-23 05:36:07 -05:00
# This is an experimental option to add parallelization to saving alert states in the database.
# It configures the maximum number of concurrent queries per rule evaluated. The default value is 1
# (concurrent queries per rule disabled).
max_state_save_concurrency = 1
2024-01-23 10:03:30 -06:00
# If the feature flag 'alertingSaveStatePeriodic' is enabled, this is the interval that is used to persist the alerting instances to the database.
# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
state_periodic_save_interval = 5m
2024-02-09 15:53:58 -06:00
# Disables the smoothing of alert evaluations across their evaluation window.
# Rules will evaluate in sync.
disable_jitter = false
2024-04-05 05:25:43 -05:00
# Retention period for Alertmanager notification log entries.
notification_log_retention = 5d
2024-06-20 15:33:03 -05:00
# Duration for which a resolved alert state transition will continue to be sent to the Alertmanager.
resolved_alert_retention = 15m
2024-10-04 16:31:21 -05:00
# Defines the limit of how many alert rule versions
# should be stored in the database for each alert rule in an organization including the current one.
# 0 value means no limit
rule_version_record_limit = 0
2022-05-22 09:33:49 -05:00
[unified_alerting.screenshots]
2023-02-20 03:59:45 -06:00
# Enable screenshots in notifications. You must have either installed the Grafana image rendering
# plugin, or set up Grafana to use a remote rendering service.
2022-07-26 04:09:48 -05:00
# For more information on configuration options, refer to [rendering].
2022-06-07 22:04:51 -05:00
capture = false
2022-05-22 09:33:49 -05:00
2023-01-05 10:07:46 -06:00
# The timeout for capturing screenshots. If a screenshot cannot be captured within the timeout then
# the notification is sent without a screenshot. The maximum duration is 30 seconds. This timeout
# should be less than the minimum Interval of all Evaluation Groups to avoid back pressure on alert
# rule evaluation.
capture_timeout = 10s
2022-05-22 09:33:49 -05:00
# The maximum number of screenshots that can be taken at the same time. This option is different from
# concurrent_render_request_limit as max_concurrent_screenshots sets the number of concurrent screenshots
# that can be taken at the same time for all firing alerts where as concurrent_render_request_limit sets
# the total number of concurrent screenshots across all Grafana services.
max_concurrent_screenshots = 5
# Uploads screenshots to the local Grafana server or remote storage such as Azure, S3 and GCS. Please
# see [external_image_storage] for further configuration options. If this option is false then
# screenshots will be persisted to disk for up to temp_data_lifetime.
upload_external_image_storage = false
2022-07-11 11:41:40 -05:00
[unified_alerting.reserved_labels]
# Comma-separated list of reserved labels added by the Grafana Alerting engine that should be disabled.
# For example: `disabled_labels=grafana_folder`
disabled_labels =
2023-01-05 12:21:07 -06:00
[unified_alerting.state_history]
# Enable the state history functionality in Unified Alerting. The previous states of alert rules will be visible in panels and in the UI.
enabled = true
2023-04-11 14:38:06 -05:00
# Select which pluggable state history backend to use. Either "annotations", "loki", or "multiple"
# "loki" writes state history to an external Loki instance. "multiple" allows history to be written to multiple backends at once.
# Defaults to "annotations".
backend =
# For "multiple" only.
# Indicates the main backend used to serve state history queries.
# Either "annotations" or "loki"
primary =
# For "multiple" only.
# Comma-separated list of additional backends to write state history data to.
secondaries =
# For "loki" only.
# URL of the external Loki instance.
# Either "loki_remote_url", or both of "loki_remote_read_url" and "loki_remote_write_url" is required for the "loki" backend.
loki_remote_url =
# For "loki" only.
# URL of the external Loki's read path. To be used in configurations where Loki has separated read and write URLs.
# Either "loki_remote_url", or both of "loki_remote_read_url" and "loki_remote_write_url" is required for the "loki" backend.
loki_remote_read_url =
# For "loki" only.
# URL of the external Loki's write path. To be used in configurations where Loki has separated read and write URLs.
# Either "loki_remote_url", or both of "loki_remote_read_url" and "loki_remote_write_url" is required for the "loki" backend.
loki_remote_write_url =
# For "loki" only.
# Optional tenant ID to attach to requests sent to Loki.
loki_tenant_id =
# For "loki" only.
# Optional username for basic authentication on requests sent to Loki. Can be left blank to disable basic auth.
loki_basic_auth_username =
# For "loki" only.
# Optional password for basic authentication on requests sent to Loki. Can be left blank.
loki_basic_auth_password =
2024-03-15 11:59:45 -05:00
# For "loki" only.
# Optional max query length for queries sent to Loki. Default is 721h which matches the default Loki value.
loki_max_query_length = 721h
2024-06-25 08:20:38 -05:00
# For "loki" only.
# Maximum size in bytes for queries sent to Loki. This limit is applied to user provided filters as well as system defined ones, e.g. applied by access control.
# If filter exceeds the limit, API returns error with code "alerting.state-history.loki.requestTooLong".
# Default is 64kb
loki_max_query_size = 65536
2023-04-11 14:38:06 -05:00
[unified_alerting.state_history.external_labels]
# Optional extra labels to attach to outbound state history records or log streams.
# Any number of label key-value-pairs can be provided.
#
# ex.
# mylabelkey = mylabelvalue
2024-02-26 16:04:27 -06:00
[unified_alerting.state_history.annotations]
2024-03-01 04:31:06 -06:00
# Controls retention of annotations automatically created while evaluating alert rules.
2024-02-26 16:04:27 -06:00
# Alert state history backend must be configured to be annotations (see setting [unified_alerting.state_history].backend).
# Configures how long alert annotations are stored for. Default is 0, which keeps them forever.
# This setting should be expressed as a duration. Ex 6h (hours), 10d (days), 2w (weeks), 1M (month).
max_age =
# Configures max number of alert annotations that Grafana stores. Default value is 0, which keeps all alert annotations.
max_annotations_to_keep =
2024-06-12 15:04:46 -05:00
[recording_rules]
2024-08-19 12:01:00 -05:00
# Enable recording rules. You must provide write credentials below.
enabled = false
2024-06-12 15:04:46 -05:00
# Target URL (including write path) for recording rules.
url =
# Optional username for basic authentication on recording rule write requests. Can be left blank to disable basic auth
basic_auth_username =
# Optional assword for basic authentication on recording rule write requests. Can be left blank.
basic_auth_password =
# Request timeout for recording rule writes.
timeout = 10s
# Optional custom headers to include in recording rule write requests.
[recording_rules.custom_headers]
# exampleHeader = exampleValue
2023-09-05 09:24:35 -05:00
# NOTE: this configuration options are not used yet.
[remote.alertmanager]
# Enable the use of the configured remote Alertmanager and disable the internal one.
# The default value is `false`.
enabled = false
# URL of the remote Alertmanager that will replace the internal one.
2023-12-21 05:20:13 -06:00
# This URL should be the root path, Grafana will automatically append an "/alertmanager" suffix for certain HTTP calls.
2023-09-05 09:24:35 -05:00
# Required if `enabled` is set to `true`.
url =
# Tenant ID to use in requests to the Alertmanager.
2023-12-21 05:20:13 -06:00
# It will also be used for the basic auth username if a password is configured.
2023-10-10 11:07:23 -05:00
tenant =
2023-09-05 09:24:35 -05:00
# Optional password for basic authentication.
# If not present, the tenant ID will be set in the X-Scope-OrgID header.
password =
2023-12-21 08:26:31 -06:00
sync_interval = 5m
2020-09-02 01:07:31 -05:00
#################################### Annotations #########################
2021-03-08 07:16:07 -06:00
[annotations]
# Configures the batch size for the annotation clean-up job. This setting is used for dashboard, API, and alert annotations.
cleanupjob_batchsize = 100
2020-09-02 01:07:31 -05:00
2022-09-23 05:04:41 -05:00
# Enforces the maximum allowed length of the tags for any newly introduced annotations. It can be between 500 and 4096 inclusive (which is the respective's column length). Default value is 500.
# Setting it to a higher value would impact performance therefore is not recommended.
tags_length = 500
2020-09-02 01:07:31 -05:00
[annotations.dashboard]
# Dashboard annotations means that annotations are associated with the dashboard they are created on.
# Configures how long dashboard annotations are stored. Default is 0, which keeps them forever.
# This setting should be expressed as a duration. Examples: 6h (hours), 10d (days), 2w (weeks), 1M (month).
max_age =
# Configures max number of dashboard annotations that Grafana stores. Default value is 0, which keeps all dashboard annotations.
max_annotations_to_keep =
[annotations.api]
# API annotations means that the annotations have been created using the API without any
# association with a dashboard.
# Configures how long Grafana stores API annotations. Default is 0, which keeps them forever.
# This setting should be expressed as a duration. Examples: 6h (hours), 10d (days), 2w (weeks), 1M (month).
max_age =
# Configures max number of API annotations that Grafana keeps. Default value is 0, which keeps all API annotations.
max_annotations_to_keep =
2018-04-27 04:39:14 -05:00
#################################### Explore #############################
[explore]
# Enable the Explore section
2019-01-28 06:02:54 -06:00
enabled = true
2022-03-29 10:27:53 -05:00
2024-07-17 11:47:49 -05:00
# set the default offset for the time picker
defaultTimeOffset = 1h
2022-03-29 10:27:53 -05:00
#################################### Help #############################
[help]
# Enable the Help section
enabled = true
#################################### Profile #############################
[profile]
# Enable the Profile section
enabled = true
2018-04-27 04:39:14 -05:00
2023-06-01 07:35:05 -05:00
#################################### News #############################
[news]
# Enable the news feed section
news_feed_enabled = true
2023-07-06 09:15:43 -05:00
#################################### Query #############################
[query]
# Set the number of data source queries that can be executed concurrently in mixed queries. Default is the number of CPUs.
2023-07-25 11:46:46 -05:00
concurrent_query_limit =
2023-07-06 09:15:43 -05:00
2022-01-28 10:55:09 -06:00
#################################### Query History #############################
[query_history]
# Enable the Query history
2022-05-23 09:53:36 -05:00
enabled = true
2022-01-28 10:55:09 -06:00
2024-04-22 07:39:24 -05:00
#################################### Short Links #############################
[short_links]
2024-10-16 03:36:54 -05:00
# Short links that are never accessed will be deleted as cleanup. Time is set up in days. The default is 7 days. Maximum value is 365.
# 0 means they will be deleted approximately every 10 minutes. A negative value (such as -1) will disable expiration.
2024-04-22 07:39:24 -05:00
expire_time = 7
2016-09-20 09:09:20 -05:00
#################################### Internal Grafana Metrics ############
2022-03-29 04:18:26 -05:00
# Metrics available at HTTP URL /metrics and /metrics/plugins/:pluginId
2016-06-02 14:06:49 -05:00
[metrics]
2024-10-04 16:31:21 -05:00
enabled = true
interval_seconds = 10
2019-09-17 02:32:24 -05:00
# Disable total stats (stat_totals_*) metrics to be generated
disable_total_stats = false
2023-08-03 03:01:44 -05:00
# The interval at which the total stats collector will update the stats. Default is 1800 seconds.
total_stats_collector_interval_seconds = 1800
2016-06-02 14:06:49 -05:00
2022-03-29 04:18:26 -05:00
#If both are set, basic auth will be required for the metrics endpoints.
2018-11-20 04:07:39 -06:00
basic_auth_username =
basic_auth_password =
2020-11-05 04:55:40 -06:00
# Metrics environment info adds dimensions to the `grafana_environment_info` metric, which
2020-10-19 09:58:16 -05:00
# can expose more information about the Grafana instance.
[metrics.environment_info]
#exampleLabel1 = exampleValue1
#exampleLabel2 = exampleValue2
2016-06-16 01:06:43 -05:00
# Send internal Grafana metrics to graphite
2016-08-15 02:37:24 -05:00
[metrics.graphite]
# Enable by setting the address setting (ex localhost:2003)
address =
2016-08-17 02:53:46 -05:00
prefix = prod.grafana.%(instance_name)s.
2016-06-02 14:06:49 -05:00
2019-11-26 10:14:26 -06:00
#################################### Grafana.com integration ##########################
2016-05-27 06:52:19 -05:00
[grafana_net]
2017-03-20 04:20:32 -05:00
url = https://grafana.com
2016-07-29 07:55:02 -05:00
2017-05-22 07:56:50 -05:00
[grafana_com]
url = https://grafana.com
Add a separate grafana.com API URL setting (#59506)
The GrafanaComURL setting is currently used in two places:
- the /api/gnet endpoint, which proxies all requests to the URL
configured in GrafanaComURL
- OAuth logins using grafana.com, where the auth URL, token URL and
redirect URL are all configured to use the GrafanaComURL.
This has worked fine until now because almost all Grafana instances have
just used the default value, https://grafana.com. However, we now have a
few different grafana.com's, some of which are behind IAP. The IAP
causes the /api/gnet proxy to fail because the required cookies are not
present in the request (how could they be?). Setting the
[grafana_net.url] setting to an internal-only URL improves the situation
slightly - the proxy works again just fine - but breaks any OAuth logins
using grafana.com, because the user must be redirected to a publicly
accessible URL.
This commit adds an additional setting, `[grafana_com.api_url]`,
which can be used to tell Grafana to use the new API URL when proxying
requests to the grafana.com API, while still using the existing
`GrafanaComURL` setting for other things.
The setting will fall back to the GrafanaComURL setting + "/api" if unset.
2022-12-01 11:06:12 -06:00
api_url = https://grafana.com/api
2024-05-30 08:52:16 -05:00
sso_api_token = ""
2017-05-22 07:56:50 -05:00
2017-09-11 01:42:52 -05:00
#################################### Distributed tracing ############
2022-06-02 07:13:00 -05:00
# Opentracing is deprecated use opentelemetry instead
2017-09-11 01:42:52 -05:00
[tracing.jaeger]
2017-09-11 11:26:20 -05:00
# jaeger destination (ex localhost:6831)
2017-09-11 01:42:52 -05:00
address =
2017-09-14 12:01:22 -05:00
# tag that will always be included in when creating new spans. ex (tag1:value1,tag2:value2)
2017-09-15 02:27:47 -05:00
always_included_tag =
2017-09-18 04:03:17 -05:00
# Type specifies the type of the sampler: const, probabilistic, rateLimiting, or remote
sampler_type = const
2017-09-15 02:27:47 -05:00
# jaeger samplerconfig param
# for "const" sampler, 0 or 1 for always false/true respectively
# for "probabilistic" sampler, a probability between 0 and 1
# for "rateLimiting" sampler, the number of spans per second
# for "remote" sampler, param is the same as for "probabilistic"
# and indicates the initial sampling rate before the actual one
# is received from the mothership
sampler_param = 1
2020-11-11 03:21:52 -06:00
# sampling_server_url is the URL of a sampling manager providing a sampling strategy.
sampling_server_url =
2019-06-05 06:12:05 -05:00
# Whether or not to use Zipkin span propagation (x-b3- HTTP headers).
zipkin_propagation = false
# Setting this to true disables shared RPC spans.
# Not disabling is the most common setting when using Zipkin elsewhere in your infrastructure.
disable_shared_zipkin_spans = false
2017-09-11 01:42:52 -05:00
2022-09-16 08:54:25 -05:00
[tracing.opentelemetry]
# attributes that will always be included in when creating new spans. ex (key1:value1,key2:value2)
custom_attributes =
2023-09-11 11:13:29 -05:00
# Type specifies the type of the sampler: const, probabilistic, rateLimiting, or remote
sampler_type =
# Sampler configuration parameter
# for "const" sampler, 0 or 1 for always false/true respectively
# for "probabilistic" sampler, a probability between 0.0 and 1.0
# for "rateLimiting" sampler, the number of spans per second
# for "remote" sampler, param is the same as for "probabilistic"
# and indicates the initial sampling rate before the actual one
# is received from the sampling server (set at sampling_server_url)
sampler_param =
# specifies the URL of the sampling server when sampler_type is remote
sampling_server_url =
2022-09-16 08:54:25 -05:00
2021-12-01 10:05:08 -06:00
[tracing.opentelemetry.jaeger]
# jaeger destination (ex http://localhost:14268/api/traces)
2022-05-22 09:33:49 -05:00
address =
2022-05-05 03:37:26 -05:00
# Propagation specifies the text map propagation format: w3c, jaeger
2022-05-22 09:33:49 -05:00
propagation =
2022-05-05 03:37:26 -05:00
# This is a configuration for OTLP exporter with GRPC protocol
[tracing.opentelemetry.otlp]
2022-05-22 09:33:49 -05:00
# otlp destination (ex localhost:4317)
address =
2022-05-05 03:37:26 -05:00
# Propagation specifies the text map propagation format: w3c, jaeger
2022-05-22 09:33:49 -05:00
propagation =
2021-12-01 10:05:08 -06:00
2016-09-20 09:09:20 -05:00
#################################### External Image Storage ##############
2016-08-10 10:27:39 -05:00
[external_image_storage]
2019-11-26 10:14:26 -06:00
# Used for uploading images to public servers so they can be included in slack/email messages.
2017-12-30 16:01:51 -06:00
# You can choose between (s3, webdav, gcs, azure_blob, local)
2018-01-24 14:30:48 -06:00
provider =
2016-08-10 10:27:39 -05:00
[external_image_storage.s3]
2020-01-02 08:10:20 -06:00
endpoint =
path_style_access =
2017-09-27 02:43:32 -05:00
bucket_url =
2017-09-19 03:17:22 -05:00
bucket =
region =
2017-10-04 14:04:20 -05:00
path =
2016-07-29 07:55:02 -05:00
access_key =
secret_key =
2016-08-10 10:27:39 -05:00
[external_image_storage.webdav]
url =
username =
password =
2017-03-23 10:23:46 -05:00
public_url =
2017-08-04 16:46:26 -05:00
2017-08-06 10:04:38 -05:00
[external_image_storage.gcs]
2017-08-04 16:46:26 -05:00
key_file =
bucket =
2017-07-29 21:31:28 -05:00
path =
2020-09-07 12:10:14 -05:00
enable_signed_urls = false
signed_url_expiration =
2017-07-29 21:31:28 -05:00
[external_image_storage.azure_blob]
account_name =
account_key =
container_name =
2022-11-01 07:02:17 -05:00
sas_token_expiration_days =
2017-12-30 16:01:51 -06:00
[external_image_storage.local]
2018-01-24 14:30:48 -06:00
# does not require any configuration
2018-09-04 06:42:55 -05:00
[rendering]
2019-09-17 12:24:03 -05:00
# Options to configure a remote HTTP image rendering service, e.g. using https://github.com/grafana/grafana-image-renderer.
# URL to a remote HTTP image renderer service, e.g. http://localhost:8081/render, will enable Grafana to render panels and dashboards to PNG-images using HTTP requests to an external service.
2018-09-04 06:42:55 -05:00
server_url =
2019-09-17 12:24:03 -05:00
# If the remote HTTP image renderer service runs on a different server than the Grafana server you may have to configure this to a URL where Grafana is reachable, e.g. http://grafana.domain/.
2018-09-04 06:42:55 -05:00
callback_url =
2022-08-30 05:09:38 -05:00
# An auth token that will be sent to and verified by the renderer. The renderer will deny any request without an auth token matching the one configured on the renderer side.
renderer_token = -
2020-04-27 10:25:08 -05:00
# Concurrent render request limit affects when the /render HTTP endpoint is used. Rendering many images at the same time can overload the server,
# which this setting can help protect against by only allowing a certain amount of concurrent requests.
concurrent_render_request_limit = 30
2022-11-03 06:06:55 -05:00
# Determines the lifetime of the render key used by the image renderer to access and render Grafana.
2022-11-16 12:29:33 -06:00
# This setting should be expressed as a duration. Examples: 10s (seconds), 5m (minutes), 2h (hours).
2022-11-03 06:06:55 -05:00
# Default is 5m. This should be more than enough for most deployments.
# Change the value only if image rendering is failing and you see `Failed to get the render key from cache` in Grafana logs.
render_key_lifetime = 5m
2024-02-26 06:27:34 -06:00
# Default width for panel screenshot
default_image_width = 1000
# Default height for panel screenshot
default_image_height = 500
# Default scale for panel screenshot
default_image_scale = 1
2018-10-09 10:47:43 -05:00
[panels]
2019-04-12 06:46:42 -05:00
# here for to support old env variables, can remove after a few months
2018-10-09 10:47:43 -05:00
enable_alpha = false
2019-01-22 04:56:35 -06:00
disable_sanitize_html = false
2018-11-01 06:07:11 -05:00
2019-04-12 06:46:42 -05:00
[plugins]
enable_alpha = false
app_tls_skip_verify_insecure = false
2021-06-15 11:53:11 -05:00
# Enter a comma-separated list of plugin identifiers to identify plugins to load even if they are unsigned. Plugins with modified signatures are never loaded.
2020-05-04 03:57:55 -05:00
allow_loading_unsigned_plugins =
2021-11-19 06:42:26 -06:00
# Enable or disable installing / uninstalling / updating plugins directly from within Grafana.
2021-09-30 01:34:03 -05:00
plugin_admin_enabled = true
2021-05-27 05:45:06 -05:00
plugin_admin_external_manage_enabled = false
2021-05-20 03:42:26 -05:00
plugin_catalog_url = https://grafana.com/grafana/plugins/
2021-11-15 03:53:35 -06:00
# Enter a comma-separated list of plugin identifiers to hide in the plugin catalog.
plugin_catalog_hidden_plugins =
2023-02-07 05:49:16 -06:00
# Log all backend requests for core and external plugins.
log_backend_requests = false
2023-06-16 04:20:30 -05:00
# Disable download of the public key for verifying plugin signature.
public_key_retrieval_disabled = false
# Force download of the public key for verifying plugin signature on startup. If disabled, the public key will be retrieved every 10 days.
# Requires public_key_retrieval_disabled to be false to have any effect.
public_key_retrieval_on_startup = false
2023-09-14 05:58:12 -05:00
# Enter a comma-separated list of plugin identifiers to avoid loading (including core plugins). These plugins will be hidden in the catalog.
disable_plugins =
2023-10-24 09:21:37 -05:00
# Auth token for plugin installations and removal in managed instances
install_token =
2023-12-12 03:20:21 -06:00
# Comma separated list of plugin ids for which angular deprecation UI should be disabled
hide_angular_deprecation =
2023-12-13 03:25:17 -06:00
# Comma separated list of plugin ids for which environment variables should be forwarded. Used only when feature flag pluginsSkipHostEnvVars is enabled.
forward_host_env_vars =
2024-09-23 08:49:18 -05:00
# Comma separated list of plugin ids to install as part of the startup process.
2024-10-04 04:15:29 -05:00
preinstall = grafana-lokiexplore-app
2024-08-23 03:32:23 -05:00
# Controls whether preinstall plugins asynchronously (in the background) or synchronously (blocking). Useful when preinstalled plugins are used with provisioning.
preinstall_async = true
# Disables preinstall feature. It has the same effect as setting preinstall to an empty list.
preinstall_disabled = false
2019-04-12 06:46:42 -05:00
2021-05-27 14:03:18 -05:00
#################################### Grafana Live ##########################################
[live]
# max_connections to Grafana Live WebSocket endpoint per Grafana server instance. See Grafana Live docs
# if you are planning to make it higher than default 100 since this can require some OS and infrastructure
# tuning. 0 disables Live, -1 means unlimited connections.
max_connections = 100
2021-07-01 01:30:09 -05:00
# allowed_origins is a comma-separated list of origins that can establish connection with Grafana Live.
2021-07-02 16:46:48 -05:00
# If not set then origin will be matched over root_url. Supports wildcard symbol "*".
2021-07-01 01:30:09 -05:00
allowed_origins =
2021-06-24 03:07:09 -05:00
# engine defines an HA (high availability) engine to use for Grafana Live. By default no engine used - in
# this case Live features work only on a single Grafana server.
# Available options: "redis".
# Setting ha_engine is an EXPERIMENTAL feature.
ha_engine =
# ha_engine_address sets a connection address for Live HA engine. Depending on engine type address format can differ.
# For now we only support Redis connection address in "host:port" format.
# This option is EXPERIMENTAL.
ha_engine_address = "127.0.0.1:6379"
2023-10-11 03:45:24 -05:00
# ha_engine_password allows setting an optional password to authenticate with the engine
ha_engine_password = ""
2024-09-25 15:20:35 -05:00
# ha_prefix is a prefix for keys in the HA engine. It's used to separate keys for different Grafana instances.
ha_prefix =
2020-04-21 09:16:41 -05:00
#################################### Grafana Image Renderer Plugin ##########################
[plugin.grafana-image-renderer]
# Instruct headless browser instance to use a default timezone when not provided by Grafana, e.g. when rendering panel image of alert.
# See ICU’ s metaZones.txt (https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt) for a list of supported
# timezone IDs. Fallbacks to TZ environment variable if not set.
rendering_timezone =
# Instruct headless browser instance to use a default language when not provided by Grafana, e.g. when rendering panel image of alert.
# Please refer to the HTTP header Accept-Language to understand how to format this value, e.g. 'fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5'.
rendering_language =
# Instruct headless browser instance to use a default device scale factor when not provided by Grafana, e.g. when rendering panel image of alert.
# Default is 1. Using a higher value will produce more detailed images (higher DPI), but will require more disk space to store an image.
rendering_viewport_device_scale_factor =
# Instruct headless browser instance whether to ignore HTTPS errors during navigation. Per default HTTPS errors are not ignored. Due to
# the security risk it's not recommended to ignore HTTPS errors.
rendering_ignore_https_errors =
# Instruct headless browser instance whether to capture and log verbose information when rendering an image. Default is false and will
# only capture and log error messages. When enabled, debug messages are captured and logged as well.
# For the verbose information to be included in the Grafana server log you have to adjust the rendering log level to debug, configure
# [log].filter = rendering:debug.
rendering_verbose_logging =
# Instruct headless browser instance whether to output its debug and error messages into running process of remote rendering service.
# Default is false. This can be useful to enable (true) when troubleshooting.
rendering_dumpio =
2023-11-23 08:03:13 -06:00
# Instruct headless browser instance whether to register metrics for the duration of every rendering step. Default is false.
# This can be useful to enable (true) when optimizing the rendering mode settings to improve the plugin performance or when troubleshooting.
rendering_timing_metrics =
2020-04-21 09:16:41 -05:00
# Additional arguments to pass to the headless browser instance. Default is --no-sandbox. The list of Chromium flags can be found
# here (https://peter.sh/experiments/chromium-command-line-switches/). Multiple arguments is separated with comma-character.
rendering_args =
# You can configure the plugin to use a different browser binary instead of the pre-packaged version of Chromium.
# Please note that this is not recommended, since you may encounter problems if the installed version of Chrome/Chromium is not
# compatible with the plugin.
rendering_chrome_bin =
# Instruct how headless browser instances are created. Default is 'default' and will create a new browser instance on each request.
# Mode 'clustered' will make sure that only a maximum of browsers/incognito pages can execute concurrently.
# Mode 'reusable' will have one browser instance and will create a new incognito page on each request.
rendering_mode =
2021-11-18 11:09:08 -06:00
# When rendering_mode = clustered, you can instruct how many browsers or incognito pages can execute concurrently. Default is 'browser'
2020-04-21 09:16:41 -05:00
# and will cluster using browser instances.
# Mode 'context' will cluster using incognito pages.
rendering_clustering_mode =
2021-11-18 11:09:08 -06:00
# When rendering_mode = clustered, you can define the maximum number of browser instances/incognito pages that can execute concurrently. Default is '5'.
2020-04-21 09:16:41 -05:00
rendering_clustering_max_concurrency =
2021-11-18 11:09:08 -06:00
# When rendering_mode = clustered, you can specify the duration a rendering request can take before it will time out. Default is `30` seconds.
rendering_clustering_timeout =
2020-04-21 09:16:41 -05:00
2020-06-03 23:51:30 -05:00
# Limit the maximum viewport width, height and device scale factor that can be requested.
2020-04-21 09:16:41 -05:00
rendering_viewport_max_width =
rendering_viewport_max_height =
rendering_viewport_max_device_scale_factor =
# Change the listening host and port of the gRPC server. Default host is 127.0.0.1 and default port is 0 and will automatically assign
# a port not in use.
grpc_host =
grpc_port =
2018-11-01 06:07:11 -05:00
[enterprise]
license_path =
2019-09-09 01:58:57 -05:00
[feature_toggles]
2021-12-24 02:49:52 -06:00
# there are currently two ways to enable feature toggles in the `grafana.ini`.
# you can either pass an array of feature you want to enable to the `enable` field or
2021-12-20 08:33:11 -06:00
# configure each toggle by setting the name of the toggle to true/false. Toggles set to true/false
2021-12-24 02:49:52 -06:00
# will take precedence over toggles in the `enable` list.
2021-12-20 08:33:11 -06:00
# enable = feature1,feature2
2019-09-09 01:58:57 -05:00
enable =
2020-09-07 09:19:33 -05:00
2022-12-01 10:27:52 -06:00
# Some features are enabled by default, see:
# https://grafana.com/docs/grafana/next/setup-grafana/configure-grafana/feature-toggles/
# To enable features by default, set `Expression: "true"` in:
# https://github.com/grafana/grafana/blob/main/pkg/services/featuremgmt/registry.go
2022-11-23 08:23:26 -06:00
2021-12-20 08:33:11 -06:00
# feature1 = true
# feature2 = false
2020-09-07 09:19:33 -05:00
[date_formats]
# For information on what formatting patterns that are supported https://momentjs.com/docs/#/displaying/
# Default system date format used in time range picker and other places where full time is displayed
full_date = YYYY-MM-DD HH:mm:ss
# Used by graph and other places where we only show small intervals
interval_second = HH:mm:ss
interval_minute = HH:mm
interval_hour = MM/DD HH:mm
interval_day = MM/DD
interval_month = YYYY-MM
interval_year = YYYY
# Experimental feature
use_browser_locale = false
2020-09-15 08:20:53 -05:00
# Default timezone for user preferences. Options are 'browser' for the browser local timezone or a timezone name from IANA Time Zone database, e.g. 'UTC' or 'Europe/Amsterdam' etc.
default_timezone = browser
2021-01-22 11:27:33 -06:00
[expressions]
2021-01-26 10:49:58 -06:00
# Enable or disable the expressions functionality.
2021-01-22 11:27:33 -06:00
enabled = true
2021-07-21 10:54:05 -05:00
[geomap]
2021-07-21 15:48:20 -05:00
# Set the JSON configuration for the default basemap
default_baselayer_config =
2021-07-21 10:54:05 -05:00
# Enable or disable loading other base map layers
2021-07-21 15:48:20 -05:00
enable_custom_baselayers = true
2022-04-24 16:55:10 -05:00
2023-02-24 09:24:44 -06:00
#################################### Support Bundles #####################################
[support_bundles]
# Enable support bundle creation (default: true)
enabled = true
# Only server admins can generate and view support bundles (default: true)
server_admin_only = true
# If set, bundles will be encrypted with the provided public keys separated by whitespace
public_keys = ""
2022-07-25 12:11:17 -05:00
#################################### Storage ################################################
[storage]
# Allow uploading SVG files without sanitization.
allow_unsanitized_svg_upload = false
2022-09-20 18:09:55 -05:00
#################################### Search ################################################
[search]
# Defines the number of dashboards loaded at once in a batch during a full reindex.
# This is a temporary settings that might be removed in the future.
dashboard_loading_batch_size = 200
# Defines the frequency of a full search reindex.
# This is a temporary settings that might be removed in the future.
full_reindex_interval = 5m
# Defines the frequency of partial index updates based on recent changes such as dashboard updates.
# This is a temporary settings that might be removed in the future.
index_update_interval = 10s
2022-10-06 05:57:03 -05:00
2022-10-27 08:57:01 -05:00
# Move an app plugin referenced by its id (including all its pages) to a specific navigation section
# Format: <Plugin ID> = <Section ID> <Sort Weight>
2022-10-06 05:57:03 -05:00
[navigation.app_sections]
2022-10-27 08:57:01 -05:00
# Move a specific app plugin page (referenced by its `path` field) to a specific navigation section
# Format: <Page URL> = <Section ID> <Sort Weight>
2022-10-06 05:57:03 -05:00
[navigation.app_standalone_pages]
2022-11-29 23:50:59 -06:00
#################################### Secure Socks5 Datasource Proxy #####################################
[secure_socks_datasource_proxy]
enabled = false
root_ca_cert =
client_key =
client_cert =
server_name =
# The address of the socks5 proxy datasources should connect to
2023-01-05 10:07:46 -06:00
proxy_address =
2023-06-01 13:58:51 -05:00
# Determines if the secure socks proxy should be shown on the datasources page, defaults to true if the feature is enabled
2023-06-02 08:23:05 -05:00
show_ui = true
2023-12-14 09:16:32 -06:00
# Disables TLS in the secure socks proxy
allow_insecure = false
2023-07-24 15:12:59 -05:00
################################## Feature Management ##############################################
2023-08-09 10:32:28 -05:00
# Options to configure the experimental Feature Toggle Admin Page feature, which is behind the `featureToggleAdminPage` feature toggle. Use at your own risk.
2023-07-24 15:12:59 -05:00
[feature_management]
2023-08-09 10:32:28 -05:00
# Allows editing of feature toggles in the feature management page
allow_editing = false
# Allow customization of URL for the controller that manages feature toggles
2023-09-25 13:11:24 -05:00
update_webhook =
# Allow configuring an auth token for feature management update requests
update_webhook_token =
2023-08-09 10:32:28 -05:00
2023-07-24 15:12:59 -05:00
# Hides specific feature toggles from the feature management page
hidden_toggles =
# Disables updating specific feature toggles in the feature management page
2023-09-11 11:13:29 -05:00
read_only_toggles =
2023-12-19 04:43:54 -06:00
#################################### Public Dashboards #####################################
[public_dashboards]
# Set to false to disable public dashboards
enabled = true
2024-03-11 07:29:44 -05:00
###################################### Cloud Migration ######################################
[cloud_migration]
# Set to true to enable target-side migration UI
is_target = false
2024-03-25 10:43:28 -05:00
# Token used to send requests to grafana com
gcom_api_token = ""
2024-07-03 08:38:26 -05:00
# How long to wait for a request sent to gms to start a snapshot to complete
start_snapshot_timeout = 5s
2024-07-15 08:22:57 -05:00
# How long to wait for a request sent to gms to validate a key to complete
validate_key_timeout = 5s
# How long to wait for a request sent to gms to get a snapshot status to complete
get_snapshot_status_timeout = 5s
2024-07-17 10:53:21 -05:00
# How long to wait for a request sent to gms to create a presigned upload url
create_upload_url_timeout = 5s
2024-07-19 23:02:31 -05:00
# How long to wait for a request sent to gms to report an event
report_event_timeout = 5s
2024-03-25 10:43:28 -05:00
# How long to wait for a request to fetch an instance to complete
fetch_instance_timeout = 5s
# How long to wait for a request to create an access policy to complete
create_access_policy_timeout = 5s
# How long to wait for a request to create to fetch an access policy to complete
fetch_access_policy_timeout = 5s
# How long to wait for a request to create to delete an access policy to complete
2024-04-03 06:36:13 -05:00
delete_access_policy_timeout = 5s
# The domain name used to access cms
2024-07-17 08:48:23 -05:00
domain = grafana.net
2024-07-03 08:38:26 -05:00
# Folder used to store snapshot files. Defaults to the home dir
2024-07-10 13:48:02 -05:00
snapshot_folder = ""
2024-07-26 05:26:18 -05:00
# Link to form to give feedback on the feature
feedback_url = https://docs.google.com/forms/d/e/1FAIpQLSeEE33vhbSpR8A8S1A1ocZ1ByVRRwiRl1GZr2FSrEer_tSa8w/viewform?usp=sf_link
2024-08-02 04:46:41 -05:00
# How frequently should the frontend UI poll for changes while resources are migrating
frontend_poll_interval = 2s
2024-07-26 05:26:18 -05:00
2024-08-13 07:07:42 -05:00
################################## Frontend development configuration ###################################
# Warning! Any settings placed in this section will be available on `process.env.frontend_dev_{foo}` within frontend code
# Any values placed here may be accessible to the UI. Do not place sensitive information here.
[frontend_dev]
# Should UI tests fail when console log/warn/erroring?
# Does not affect the result when running on CI - only for allowing devs to choose this behaviour locally
fail_tests_on_console = true
2024-09-04 04:22:03 -05:00
# Whether or not to enable the MSW mock API, which intercepts requests and returns mock data
# Should only be used for local development or demo purposes
mock_api = false