2015-04-09 10:18:04 -05:00
##################### Grafana Configuration Example #####################
2015-04-10 03:58:32 -05:00
#
# Everything has defaults so you only need to uncomment things you want to
# change
2015-03-03 03:18:24 -06:00
2015-09-09 10:21:25 -05:00
# possible values : production, development
2018-03-18 04:17:48 -05:00
;app_mode = production
2015-03-03 03:18:24 -06:00
2016-06-02 07:32:17 -05:00
# instance name, defaults to HOSTNAME environment variable value or hostname if HOSTNAME var is empty
2018-03-18 04:17:48 -05:00
;instance_name = ${HOSTNAME}
2016-06-02 07:32:17 -05:00
2015-04-09 10:18:04 -05:00
#################################### Paths ####################################
[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 10:18:04 -05:00
;data = /var/lib/grafana
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
2018-06-14 02:46:29 -05:00
;temp_data_lifetime = 24h
2018-06-14 02:35:22 -05:00
2015-04-09 10:18:04 -05:00
# Directory where grafana can store logs
;logs = /var/log/grafana
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 = /var/lib/grafana/plugins
2015-04-08 07:10:04 -05:00
2017-12-07 08:23:14 -06:00
# folder that contains provisioning config files that grafana will apply on startup and while running.
2018-03-18 04:17:48 -05:00
;provisioning = conf/provisioning
2017-11-23 04:29:06 -06:00
2015-04-10 03:58:32 -05:00
#################################### Server ####################################
2015-03-03 03:18:24 -06:00
[server]
2019-08-16 10:06:54 -05:00
# Protocol (http, https, h2, socket)
2015-04-09 10:18:04 -05:00
;protocol = http
2015-04-10 03:58:32 -05:00
# The ip address to bind to, empty will bind to all interfaces
2015-04-09 10:18:04 -05:00
;http_addr =
2015-04-10 03:58:32 -05:00
# The http port to use
2015-04-09 10:18:04 -05:00
;http_port = 3000
2015-04-10 03:58:32 -05:00
# The public facing domain name used to access grafana from a browser
2015-04-09 10:18:04 -05:00
;domain = localhost
2015-04-10 03:58:32 -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
2016-07-05 07:10:23 -05:00
# The full public facing url you use in browser, used for redirects and emails
# If you use reverse proxy and sub path specify full url (with sub path)
2019-11-11 03:05:32 -06:00
;root_url = %(protocol)s://%(domain)s:%(http_port)s/
2015-04-10 03:58:32 -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-10 03:58:32 -05:00
# Log web requests
2015-04-09 10:18:04 -05:00
;router_logging = false
2015-04-10 03:58:32 -05:00
# the path relative working path
2015-04-09 10:18:04 -05:00
;static_root_path = public
2015-04-10 03:58:32 -05:00
# enable gzip
2015-04-09 10:18:04 -05:00
;enable_gzip = false
2015-04-10 03:58:32 -05:00
# https certs & key file
2015-04-09 10:18:04 -05:00
;cert_file =
;cert_key =
2015-03-12 04:52:29 -05:00
2017-04-27 01:54:21 -05:00
# Unix socket path
;socket =
2021-02-01 03:13:09 -06:00
# CDN Url
;cdn_url =
2021-03-19 05:21:52 -05:00
# Sets the maximum time using a duration format (5s/5m/5ms) before timing out read of an incoming request and closing idle connections.
# `0` means there is no timeout for reading the request.
;read_timeout = 0
2015-04-10 03:58:32 -05:00
#################################### Database ####################################
[database]
2016-09-07 03:34:56 -05:00
# You can configure the database connection by specifying type, host, name, user and password
2018-04-13 12:10:13 -05:00
# as separate properties or as on string using the url properties.
2016-08-19 07:48:40 -05:00
2015-04-10 03:58:32 -05:00
# Either "mysql", "postgres" or "sqlite3", it's your choice
;type = sqlite3
;host = 127.0.0.1:3306
;name = grafana
;user = root
2018-02-15 12:41:26 -06:00
# If the password contains # or ; you have to wrap it with triple quotes. Ex """#password;"""
2015-04-10 03:58:32 -05:00
;password =
2016-08-19 07:48:40 -05:00
# Use either URL or the previous fields to configure the database
# Example: mysql://user:secret@host:port/database
;url =
2015-04-10 03:58:32 -05:00
# For "postgres" only, either "disable", "require" or "verify-full"
;ssl_mode = disable
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 =
2019-11-26 10:14:26 -06:00
;ca_cert_path =
;client_key_path =
;client_cert_path =
;server_cert_name =
2015-04-10 03:58:32 -05:00
# For "sqlite3" only, path relative to data_path setting
;path = grafana.db
2017-08-08 09:17:52 -05:00
# Max idle conn setting default is 2
;max_idle_conn = 2
2017-02-10 08:29:43 -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.
2019-06-06 04:13:27 -05:00
;log_queries =
2017-02-10 08:29:43 -06:00
2018-12-27 03:48:11 -06:00
# For "sqlite3" only. cache mode setting used for connecting to the database. (private, shared)
;cache_mode = private
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
2019-03-08 13:49:16 -06:00
#################################### Cache server #############################
[remote_cache]
# Either "redis", "memcached" or "database" default is "database"
;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-08 13:49:16 -06:00
# memcache: 127.0.0.1:11211
;connstr =
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 probe 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
2019-03-14 10:28:32 -05:00
# If enabled and user is not anonymous, data proxy will add X-Grafana-User header with username into the request, default is false.
2019-03-14 07:04:47 -05:00
;send_user_header = false
2015-04-10 03:58:32 -05:00
#################################### Analytics ####################################
[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
2016-04-11 11:21:48 -05:00
# Set to false to disable all checks to https://grafana.net
2020-06-03 23:51:30 -05:00
# for new versions (grafana itself and plugins), check is used
2016-04-11 11:21:48 -05:00
# in some UI views to notify that grafana or plugin update exists
# This option does not cause any auto updates, nor send any information
2017-03-20 04:20:32 -05:00
# only a GET request to http://grafana.com to get latest versions
2016-09-28 06:02:15 -05:00
;check_for_updates = true
2016-04-11 11:21:48 -05:00
2015-04-10 03:58:32 -05:00
# Google Analytics universal tracking code, only enabled if you specify an id here
;google_analytics_ua_id =
2018-11-29 02:30:03 -06:00
# Google Tag Manager ID, only enabled if you specify an id here
;google_tag_manager_id =
2015-04-10 03:58:32 -05:00
#################################### Security ####################################
[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-10 03:58:32 -05:00
# default admin user, created on startup
;admin_user = admin
# default admin password, can be changed before first start of grafana, or in profile settings
;admin_password = admin
# used for signing
;secret_key = SW2YcwTIb9zpOOhoPsMm
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.
# This is only sent when HTTPS is enabled in this configuration.
# 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';"""
2021-01-12 00:42:32 -06:00
2017-11-15 04:36:36 -06:00
#################################### Snapshots ###########################
2015-10-14 09:39:57 -05:00
[snapshots]
# snapshot sharing options
;external_enabled = true
;external_snapshot_url = https://snapshots-origin.raintank.io
;external_snapshot_name = Publish to snapshot.raintank.io
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
2016-09-23 09:56:12 -05:00
# remove expired snapshot
;snapshot_remove_expired = true
2017-11-15 04:36:36 -06:00
#################################### Dashboards History ##################
[dashboards]
2017-11-17 07:41:44 -06:00
# Number dashboard versions to keep (per dashboard). Default: 20, Minimum: 1
2017-11-15 04:36:36 -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
2017-11-15 04:36:36 -06:00
#################################### Users ###############################
2015-04-10 03:58:32 -05:00
[users]
# disable user signup / registration
;allow_sign_up = true
# Allow non admin users to create organizations
;allow_org_create = true
# Set to true to automatically assign new users to the default organization (id 1)
;auto_assign_org = true
2019-11-26 10:14:26 -06: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
2015-04-10 03:58:32 -05:00
# Default role new users will be automatically assigned (if disabled above is set to true)
;auto_assign_org_role = Viewer
2019-11-26 10:14:26 -06:00
# Require email validation before sign up completes
;verify_email_enabled = false
2015-08-20 13:15:36 -05:00
# Background text for the user field on the login page
;login_hint = email or username
2019-03-11 07:33:57 -05:00
;password_hint = password
2015-08-20 13:15:36 -05:00
2016-05-12 07:11:10 -05:00
# Default UI theme ("dark" or "light")
;default_theme = dark
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 08:04:47 -05:00
# External user management, these options affect the organization users view
;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
2020-11-24 05:10:32 -06:00
# Enter a comma-separated list of users login to hide them in the Grafana UI. These users are shown to Grafana admins and themselves.
2021-01-12 00:42:32 -06:00
; hidden_users =
2020-11-24 05:10:32 -06:00
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
2020-10-13 05:30:09 -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.
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, defaults to false
;disable_login_form = false
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, defaults to false
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.
;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
2019-11-26 10:14:26 -06: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
2019-02-05 14:09:55 -06:00
#################################### Anonymous Auth ######################
2015-04-10 03:58:32 -05:00
[auth.anonymous]
# enable anonymous access
;enabled = false
# specify organization name that should be used for unauthenticated users
;org_name = Main Org.
# specify role for unauthenticated users
;org_role = Viewer
2020-06-17 00:39:50 -05:00
# mask the Grafana version number for unauthenticated users
;hide_version = false
2020-07-22 10:12:50 -05:00
#################################### GitHub Auth ##########################
2015-04-10 03:58:32 -05:00
[auth.github]
;enabled = false
2016-12-12 09:35:42 -06:00
;allow_sign_up = true
2015-04-10 03:58:32 -05:00
;client_id = some_id
;client_secret = some_secret
2015-05-23 09:06:51 -05:00
;scopes = user:email,read:org
2015-04-10 03:58:32 -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
2019-11-27 03:08:08 -06:00
;allowed_domains =
2015-04-29 03:08:01 -05:00
;team_ids =
2015-05-23 09:06:51 -05:00
;allowed_organizations =
2015-04-10 03:58:32 -05:00
2019-11-26 10:14:26 -06:00
#################################### GitLab Auth #########################
[auth.gitlab]
2019-11-27 03:08:08 -06:00
;enabled = false
;allow_sign_up = true
;client_id = some_id
;client_secret = some_secret
;scopes = api
;auth_url = https://gitlab.com/oauth/authorize
;token_url = https://gitlab.com/oauth/token
;api_url = https://gitlab.com/api/v4
;allowed_domains =
;allowed_groups =
2019-11-26 10:14:26 -06:00
2015-04-10 03:58:32 -05:00
#################################### Google Auth ##########################
[auth.google]
;enabled = false
2016-12-12 09:35:42 -06:00
;allow_sign_up = true
2015-04-10 03:58:32 -05:00
;client_id = some_client_id
;client_secret = some_client_secret
;scopes = https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email
;auth_url = https://accounts.google.com/o/oauth2/auth
;token_url = https://accounts.google.com/o/oauth2/token
2015-04-15 01:03:28 -05:00
;api_url = https://www.googleapis.com/oauth2/v1/userinfo
2015-04-29 03:08:01 -05:00
;allowed_domains =
2019-11-26 10:14:26 -06:00
;hosted_domain =
#################################### Grafana.com Auth ####################
[auth.grafana_com]
;enabled = false
;allow_sign_up = true
;client_id = some_id
;client_secret = some_secret
;scopes = user:email
;allowed_organizations =
2015-04-10 03:58:32 -05:00
2020-02-13 03:12:25 -06:00
#################################### Azure AD OAuth #######################
[auth.azuread]
;name = Azure AD
;enabled = false
;allow_sign_up = true
;client_id = some_client_id
;client_secret = some_client_secret
;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
2020-02-14 05:03:00 -06:00
;allowed_domains =
;allowed_groups =
2020-02-13 03:12:25 -06:00
2020-04-02 09:35:48 -05:00
#################################### Okta OAuth #######################
[auth.okta]
;name = Okta
;enabled = false
;allow_sign_up = true
;client_id = some_id
;client_secret = some_secret
;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
;allowed_domains =
;allowed_groups =
;role_attribute_path =
2021-04-14 14:14:27 -05:00
;role_attribute_strict = false
2020-04-02 09:35:48 -05:00
2016-09-07 03:34:56 -05:00
#################################### Generic OAuth ##########################
[auth.generic_oauth]
;enabled = false
2016-12-15 07:08:39 -06:00
;name = OAuth
2016-12-12 09:35:42 -06:00
;allow_sign_up = true
2016-09-07 03:34:56 -05:00
;client_id = some_id
;client_secret = some_secret
;scopes = user:email,read:org
2021-05-10 12:07:30 -05:00
;empty_scopes = false
2019-08-26 11:11:40 -05:00
;email_attribute_name = email:primary
;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 =
2020-08-03 09:33:27 -05:00
;id_token_attribute_name =
2016-09-07 03:34:56 -05:00
;auth_url = https://foo.bar/login/oauth/authorize
;token_url = https://foo.bar/login/oauth/access_token
;api_url = https://foo.bar/user
2019-11-27 03:08:08 -06:00
;allowed_domains =
2016-09-07 03:34:56 -05:00
;team_ids =
2019-11-08 03:51:15 -06:00
;allowed_organizations =
2019-11-05 14:56:42 -06:00
;role_attribute_path =
2021-04-14 14:14:27 -05:00
;role_attribute_strict = false
2021-07-01 15:40:46 -05:00
;groups_attribute_path =
2018-08-14 01:49:56 -05:00
;tls_skip_verify_insecure = false
;tls_client_cert =
;tls_client_key =
;tls_client_ca =
2018-12-19 06:59:33 -06:00
2019-11-26 10:14:26 -06:00
#################################### Basic Auth ##########################
[auth.basic]
;enabled = true
2016-09-28 06:02:15 -05:00
2015-05-02 05:30:53 -05:00
#################################### Auth Proxy ##########################
[auth.proxy]
;enabled = false
;header_name = X-WEBAUTH-USER
;header_property = username
;auto_sign_up = true
2019-11-08 03:51:15 -06:00
;sync_ttl = 60
2016-02-23 07:22:28 -06:00
;whitelist = 192.168.1.1, 192.168.2.1
2018-11-07 17:21:25 -06:00
;headers = Email:X-User-Email, Name:X-User-Name
2019-11-07 10:48:56 -06:00
# Read the auth proxy docs for details on what the setting below enables
;enable_login_token = false
2015-05-02 05:30:53 -05:00
2021-03-31 10:40:44 -05:00
#################################### Auth JWT ##########################
[auth.jwt]
;enabled = true
;header_name = X-JWT-Assertion
;email_claim = sub
;username_claim = sub
;jwk_set_url = https://foo.bar/.well-known/jwks.json
;jwk_set_file = /path/to/jwks.json
;cache_ttl = 60m
;expected_claims = {"aud": ["foo", "bar"]}
;key_file = /path/to/key/file
2015-07-15 03:08:23 -05:00
#################################### Auth LDAP ##########################
[auth.ldap]
2015-07-15 07:48:39 -05:00
;enabled = false
;config_file = /etc/grafana/ldap.toml
2016-10-07 01:49:58 -05:00
;allow_sign_up = true
2015-07-15 03:08:23 -05:00
2020-12-30 04:09:17 -06:00
# LDAP background sync (Enterprise only)
2019-07-04 07:39:11 -05:00
# At 1 am every day
;sync_cron = "0 0 1 * * *"
2019-07-05 09:49:00 -05:00
;active_sync_enabled = true
2019-07-04 07:39:11 -05:00
2021-02-24 11:08:13 -06:00
#################################### AWS ###########################
[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-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
# 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 =
2015-06-08 10:56:56 -05:00
#################################### SMTP / Emailing ##########################
[smtp]
;enabled = false
;host = localhost:25
;user =
2019-10-11 08:57:29 -05: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 in SMTP dialog (defaults to instance_name)
;ehlo_identity = dashboard.example.com
2020-06-29 04:22:49 -05:00
# SMTP startTLS policy (defaults to 'OpportunisticStartTLS')
2020-05-13 09:33:40 -05:00
;startTLS_policy = NoStartTLS
2015-06-08 10:56:56 -05:00
[emails]
;welcome_email_on_sign_up = false
2019-11-26 10:14:26 -06:00
;templates_pattern = emails/*.html
2015-06-08 10:56:56 -05:00
2015-04-10 03:58:32 -05:00
#################################### Logging ##########################
[log]
2016-05-09 02:21:33 -05:00
# Either "console", "file", "syslog". Default is console and file
2016-06-08 01:48:46 -05:00
# Use space to separate multiple modes, e.g. "console file"
2016-12-02 00:48:08 -06:00
;mode = console file
2015-04-10 03:58:32 -05:00
2017-05-18 07:19:39 -05:00
# Either "debug", "info", "warn", "error", "critical", default is "info"
2016-06-08 01:48:46 -05:00
;level = info
2015-04-10 03:58:32 -05:00
2016-10-07 03:39:01 -05:00
# optional settings to set different levels for specific loggers. Ex filters = sqlstore:debug
;filters =
2015-04-10 03:58:32 -05:00
# For "console" mode only
[log.console]
;level =
2016-06-08 01:48:46 -05:00
# log line format, valid options are text, console and json
;format = console
2015-04-10 03:58:32 -05:00
# For "file" mode only
[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
;log_rotate = true
# Max line number of single file, default is 1000000
;max_lines = 1000000
# 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
;daily_rotate = true
# Expired days of log file(delete after max days), default is 7
;max_days = 7
2015-03-03 03:18:24 -06:00
2016-06-08 01:48:46 -05:00
[log.syslog]
;level =
# log line format, valid options are text, console and json
;format = text
# 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]
2020-12-09 09:22:24 -06:00
# Should Sentry javascript agent be initialized
2020-11-12 05:29:43 -06:00
;enabled = false
2020-12-09 09:22:24 -06:00
# Sentry DSN if you want to send events to Sentry.
2020-11-12 05:29:43 -06:00
;sentry_dsn =
2020-12-09 09:22:24 -06:00
# Custom HTTP endpoint to send events captured by the Sentry agent to. Default will log the events to stdout.
2020-11-12 05:29:43 -06:00
;custom_endpoint = /log
# Rate of events to be reported between 0 (none) and 1 (all), float
;sample_rate = 1.0
2020-12-09 09:22:24 -06:00
# Requests per second limit enforced 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
2019-11-26 10:14:26 -06:00
#################################### Usage Quotas ########################
[quota]
; enabled = false
#### 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
2019-11-26 10:14:26 -06: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
2021-05-04 11:16:28 -05:00
# global limit of alerts
;global_alert_rule = -1
2017-01-25 06:34:02 -06:00
#################################### Alerting ############################
2016-08-18 07:13:02 -05:00
[alerting]
2017-01-25 06:34:02 -06:00
# Disable alerting engine & UI features
;enabled = true
# Makes it possible to turn off alert rule execution but alerting UI is visible
2016-10-10 06:09:16 -05:00
;execute_alerts = true
2016-08-18 07:13:02 -05:00
2018-09-06 04:51:24 -05:00
# Default setting for new alert rules. Defaults to categorize error and timeouts as alerting. (alerting, keep_state)
2018-09-06 04:20:38 -05:00
;error_or_timeout = alerting
# Default setting for how Grafana handles nodata or null values in alerting. (alerting, no_data, keep_state, ok)
;nodata_or_nullvalues = no_data
2018-09-25 05:17:04 -05:00
# Alert notifications can include images, but rendering many images at the same time can overload the server
# This limit will protect the server from render overloading and make sure notifications are sent out quickly
;concurrent_render_limit = 5
2019-03-29 00:58:37 -05:00
# Default setting for alert calculation timeout. Default value is 30
;evaluation_timeout_seconds = 30
# Default setting for alert notification timeout. Default value is 30
;notification_timeout_seconds = 30
# Default setting for max attempts to sending alert notifications. Default value is 3
;max_attempts = 3
2020-01-14 03:13:34 -06:00
# Makes it possible to enforce a minimal interval between evaluations, to reduce load on the backend
;min_interval_seconds = 1
2020-09-02 01:07:31 -05:00
# Configures for how long alert 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_annotation_age =
# Configures max number of alert annotations that Grafana stores. Default value is 0, which keeps all alert annotations.
;max_annotations_to_keep =
#################################### 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
[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
2018-04-27 04:39:14 -05:00
2016-06-03 11:38:19 -05:00
#################################### Internal Grafana Metrics ##########################
2017-11-16 02:38:37 -06:00
# Metrics available at HTTP API Url /metrics
2016-06-03 11:38:19 -05:00
[metrics]
# Disable / Enable internal metrics
2016-08-17 02:53:46 -05:00
;enabled = true
2019-11-26 10:14:26 -06:00
# Graphite Publish interval
;interval_seconds = 10
2019-09-17 02:32:24 -05:00
# Disable total stats (stat_totals_*) metrics to be generated
;disable_total_stats = false
2016-06-03 11:38:19 -05:00
2019-11-26 10:14:26 -06:00
#If both are set, basic auth will be required for the metrics endpoint.
; basic_auth_username =
; basic_auth_password =
2016-06-03 11:38:19 -05:00
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-08-10 04:15:27 -05:00
# Send internal metrics to Graphite
2016-08-15 02:37:24 -05:00
[metrics.graphite]
# Enable by setting the address setting (ex localhost:2003)
2016-08-17 02:53:46 -05:00
;address =
;prefix = prod.grafana.%(instance_name)s.
2015-05-13 06:36:13 -05:00
2019-11-26 10:14:26 -06:00
#################################### Grafana.com integration ##########################
# Url used to import dashboards directly from Grafana.com
[grafana_com]
;url = https://grafana.com
2017-09-11 01:42:52 -05:00
#################################### Distributed tracing ############
[tracing.jaeger]
2017-09-11 11:26:20 -05:00
# Enable by setting the address sending traces to jaeger (ex localhost:6831)
;address = localhost:6831
2017-09-14 12:01:22 -05:00
# Tag that will always be included in when creating new spans. ex (tag1:value1,tag2:value2)
;always_included_tag = tag1:value1
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 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
2016-08-10 10:27:39 -05:00
#################################### External image storage ##########################
[external_image_storage]
# Used for uploading images to public servers so they can be included in slack/email messages.
2018-01-22 04:11:30 -06:00
# you can choose between (s3, webdav, gcs, azure_blob, local)
2016-10-05 00:34:48 -05: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-19 03:17:22 -05:00
;bucket =
;region =
2017-10-04 14:04:20 -05:00
;path =
2016-08-17 03:03:33 -05:00
;access_key =
;secret_key =
2016-08-10 10:27:39 -05:00
[external_image_storage.webdav]
2016-08-17 03:03:33 -05:00
;url =
2017-03-23 10:23:46 -05:00
;public_url =
2016-08-17 03:03:33 -05:00
;username =
;password =
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 =
[external_image_storage.azure_blob]
;account_name =
;account_key =
;container_name =
2018-01-22 04:11:30 -06:00
[external_image_storage.local]
# 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 =
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
2018-11-01 06:07:11 -05:00
2019-01-22 04:56:35 -06:00
[panels]
# If set to true Grafana will allow script tags in text panels. Not recommended as it enable XSS vulnerabilities.
;disable_sanitize_html = false
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-05-20 03:42:26 -05:00
# Enable or disable installing plugins directly from within Grafana.
;plugin_admin_enabled = false
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/
2019-11-26 10:14:26 -06: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"
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 =
# 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 =
# When rendering_mode = clustered you can instruct how many browsers or incognito pages can execute concurrently. Default is 'browser'
# and will cluster using browser instances.
# Mode 'context' will cluster using incognito pages.
;rendering_clustering_mode =
# When rendering_mode = clustered you can define maximum number of browser instances/incognito pages that can execute concurrently..
;rendering_clustering_max_concurrency =
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 =
2019-11-26 10:14:26 -06:00
[enterprise]
# Path to a valid Grafana Enterprise license.jwt file
;license_path =
[feature_toggles]
# enable features, separated by spaces
;enable =
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.
2020-10-08 03:03:20 -05:00
;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