sample.ini 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617
  1. ##################### Grafana Configuration Example #####################
  2. #
  3. # Everything has defaults so you only need to uncomment things you want to
  4. # change
  5. # possible values : production, development
  6. ;app_mode = production
  7. # instance name, defaults to HOSTNAME environment variable value or hostname if HOSTNAME var is empty
  8. ;instance_name = ${HOSTNAME}
  9. #################################### Paths ####################################
  10. [paths]
  11. # Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used)
  12. ;data = /var/lib/grafana
  13. # Temporary files in `data` directory older than given duration will be removed
  14. ;temp_data_lifetime = 24h
  15. # Directory where grafana can store logs
  16. ;logs = /var/log/grafana
  17. # Directory where grafana will automatically scan and look for plugins
  18. ;plugins = /var/lib/grafana/plugins
  19. # folder that contains provisioning config files that grafana will apply on startup and while running.
  20. ;provisioning = conf/provisioning
  21. #################################### Server ####################################
  22. [server]
  23. # Protocol (http, https, h2, socket)
  24. ;protocol = http
  25. # The ip address to bind to, empty will bind to all interfaces
  26. ;http_addr =
  27. # The http port to use
  28. ;http_port = 3000
  29. # The public facing domain name used to access grafana from a browser
  30. ;domain = localhost
  31. # Redirect to correct domain if host header does not match domain
  32. # Prevents DNS rebinding attacks
  33. ;enforce_domain = false
  34. # The full public facing url you use in browser, used for redirects and emails
  35. # If you use reverse proxy and sub path specify full url (with sub path)
  36. ;root_url = http://localhost:3000
  37. # Serve Grafana from subpath specified in `root_url` setting. By default it is set to `false` for compatibility reasons.
  38. ;serve_from_sub_path = false
  39. # Log web requests
  40. ;router_logging = false
  41. # the path relative working path
  42. ;static_root_path = public
  43. # enable gzip
  44. ;enable_gzip = false
  45. # https certs & key file
  46. ;cert_file =
  47. ;cert_key =
  48. # Unix socket path
  49. ;socket =
  50. #################################### Database ####################################
  51. [database]
  52. # You can configure the database connection by specifying type, host, name, user and password
  53. # as separate properties or as on string using the url properties.
  54. # Either "mysql", "postgres" or "sqlite3", it's your choice
  55. ;type = sqlite3
  56. ;host = 127.0.0.1:3306
  57. ;name = grafana
  58. ;user = root
  59. # If the password contains # or ; you have to wrap it with triple quotes. Ex """#password;"""
  60. ;password =
  61. # Use either URL or the previous fields to configure the database
  62. # Example: mysql://user:secret@host:port/database
  63. ;url =
  64. # For "postgres" only, either "disable", "require" or "verify-full"
  65. ;ssl_mode = disable
  66. # For "sqlite3" only, path relative to data_path setting
  67. ;path = grafana.db
  68. # Max idle conn setting default is 2
  69. ;max_idle_conn = 2
  70. # Max conn setting default is 0 (mean not set)
  71. ;max_open_conn =
  72. # Connection Max Lifetime default is 14400 (means 14400 seconds or 4 hours)
  73. ;conn_max_lifetime = 14400
  74. # Set to true to log the sql calls and execution times.
  75. ;log_queries =
  76. # For "sqlite3" only. cache mode setting used for connecting to the database. (private, shared)
  77. ;cache_mode = private
  78. #################################### Cache server #############################
  79. [remote_cache]
  80. # Either "redis", "memcached" or "database" default is "database"
  81. ;type = database
  82. # cache connectionstring options
  83. # database: will use Grafana primary database.
  84. # 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'.
  85. # memcache: 127.0.0.1:11211
  86. ;connstr =
  87. #################################### Data proxy ###########################
  88. [dataproxy]
  89. # This enables data proxy logging, default is false
  90. ;logging = false
  91. # How long the data proxy should wait before timing out default is 30 (seconds)
  92. ;timeout = 30
  93. # If enabled and user is not anonymous, data proxy will add X-Grafana-User header with username into the request, default is false.
  94. ;send_user_header = false
  95. #################################### Analytics ####################################
  96. [analytics]
  97. # Server reporting, sends usage counters to stats.grafana.org every 24 hours.
  98. # No ip addresses are being tracked, only simple counters to track
  99. # running instances, dashboard and error counts. It is very helpful to us.
  100. # Change this option to false to disable reporting.
  101. ;reporting_enabled = true
  102. # Set to false to disable all checks to https://grafana.net
  103. # for new vesions (grafana itself and plugins), check is used
  104. # in some UI views to notify that grafana or plugin update exists
  105. # This option does not cause any auto updates, nor send any information
  106. # only a GET request to http://grafana.com to get latest versions
  107. ;check_for_updates = true
  108. # Google Analytics universal tracking code, only enabled if you specify an id here
  109. ;google_analytics_ua_id =
  110. # Google Tag Manager ID, only enabled if you specify an id here
  111. ;google_tag_manager_id =
  112. #################################### Security ####################################
  113. [security]
  114. # default admin user, created on startup
  115. ;admin_user = admin
  116. # default admin password, can be changed before first start of grafana, or in profile settings
  117. ;admin_password = admin
  118. # used for signing
  119. ;secret_key = SW2YcwTIb9zpOOhoPsMm
  120. # disable gravatar profile images
  121. ;disable_gravatar = false
  122. # data source proxy whitelist (ip_or_domain:port separated by spaces)
  123. ;data_source_proxy_whitelist =
  124. # disable protection against brute force login attempts
  125. ;disable_brute_force_login_protection = false
  126. # set to true if you host Grafana behind HTTPS. default is false.
  127. ;cookie_secure = false
  128. # set cookie SameSite attribute. defaults to `lax`. can be set to "lax", "strict" and "none"
  129. ;cookie_samesite = lax
  130. # set to true if you want to allow browsers to render Grafana in a <frame>, <iframe>, <embed> or <object>. default is false.
  131. ;allow_embedding = false
  132. # Set to true if you want to enable http strict transport security (HSTS) response header.
  133. # This is only sent when HTTPS is enabled in this configuration.
  134. # HSTS tells browsers that the site should only be accessed using HTTPS.
  135. # The default version will change to true in the next minor release, 6.3.
  136. ;strict_transport_security = false
  137. # Sets how long a browser should cache HSTS. Only applied if strict_transport_security is enabled.
  138. ;strict_transport_security_max_age_seconds = 86400
  139. # Set to true if to enable HSTS preloading option. Only applied if strict_transport_security is enabled.
  140. ;strict_transport_security_preload = false
  141. # Set to true if to enable the HSTS includeSubDomains option. Only applied if strict_transport_security is enabled.
  142. ;strict_transport_security_subdomains = false
  143. # Set to true to enable the X-Content-Type-Options response header.
  144. # The X-Content-Type-Options response HTTP header is a marker used by the server to indicate that the MIME types advertised
  145. # in the Content-Type headers should not be changed and be followed. The default will change to true in the next minor release, 6.3.
  146. ;x_content_type_options = false
  147. # Set to true to enable the X-XSS-Protection header, which tells browsers to stop pages from loading
  148. # when they detect reflected cross-site scripting (XSS) attacks. The default will change to true in the next minor release, 6.3.
  149. ;x_xss_protection = false
  150. #################################### Snapshots ###########################
  151. [snapshots]
  152. # snapshot sharing options
  153. ;external_enabled = true
  154. ;external_snapshot_url = https://snapshots-origin.raintank.io
  155. ;external_snapshot_name = Publish to snapshot.raintank.io
  156. # Set to true to enable this Grafana instance act as an external snapshot server and allow unauthenticated requests for
  157. # creating and deleting snapshots.
  158. ;public_mode = false
  159. # remove expired snapshot
  160. ;snapshot_remove_expired = true
  161. #################################### Dashboards History ##################
  162. [dashboards]
  163. # Number dashboard versions to keep (per dashboard). Default: 20, Minimum: 1
  164. ;versions_to_keep = 20
  165. #################################### Users ###############################
  166. [users]
  167. # disable user signup / registration
  168. ;allow_sign_up = true
  169. # Allow non admin users to create organizations
  170. ;allow_org_create = true
  171. # Set to true to automatically assign new users to the default organization (id 1)
  172. ;auto_assign_org = true
  173. # Default role new users will be automatically assigned (if disabled above is set to true)
  174. ;auto_assign_org_role = Viewer
  175. # Background text for the user field on the login page
  176. ;login_hint = email or username
  177. ;password_hint = password
  178. # Default UI theme ("dark" or "light")
  179. ;default_theme = dark
  180. # External user management, these options affect the organization users view
  181. ;external_manage_link_url =
  182. ;external_manage_link_name =
  183. ;external_manage_info =
  184. # Viewers can edit/inspect dashboard settings in the browser. But not save the dashboard.
  185. ;viewers_can_edit = false
  186. # Editors can administrate dashboard, folders and teams they create
  187. ;editors_can_admin = false
  188. [auth]
  189. # Login cookie name
  190. ;login_cookie_name = grafana_session
  191. # The lifetime (days) an authenticated user can be inactive before being required to login at next visit. Default is 7 days,
  192. ;login_maximum_inactive_lifetime_days = 7
  193. # The maximum lifetime (days) an authenticated user can be logged in since login time before being required to login. Default is 30 days.
  194. ;login_maximum_lifetime_days = 30
  195. # How often should auth tokens be rotated for authenticated users when being active. The default is each 10 minutes.
  196. ;token_rotation_interval_minutes = 10
  197. # Set to true to disable (hide) the login form, useful if you use OAuth, defaults to false
  198. ;disable_login_form = false
  199. # Set to true to disable the signout link in the side menu. useful if you use auth.proxy, defaults to false
  200. ;disable_signout_menu = false
  201. # URL to redirect the user to after sign out
  202. ;signout_redirect_url =
  203. # Set to true to attempt login with OAuth automatically, skipping the login screen.
  204. # This setting is ignored if multiple OAuth providers are configured.
  205. ;oauth_auto_login = false
  206. #################################### Anonymous Auth ######################
  207. [auth.anonymous]
  208. # enable anonymous access
  209. ;enabled = false
  210. # specify organization name that should be used for unauthenticated users
  211. ;org_name = Main Org.
  212. # specify role for unauthenticated users
  213. ;org_role = Viewer
  214. #################################### Github Auth ##########################
  215. [auth.github]
  216. ;enabled = false
  217. ;allow_sign_up = true
  218. ;client_id = some_id
  219. ;client_secret = some_secret
  220. ;scopes = user:email,read:org
  221. ;auth_url = https://github.com/login/oauth/authorize
  222. ;token_url = https://github.com/login/oauth/access_token
  223. ;api_url = https://api.github.com/user
  224. ;team_ids =
  225. ;allowed_organizations =
  226. #################################### Google Auth ##########################
  227. [auth.google]
  228. ;enabled = false
  229. ;allow_sign_up = true
  230. ;client_id = some_client_id
  231. ;client_secret = some_client_secret
  232. ;scopes = https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email
  233. ;auth_url = https://accounts.google.com/o/oauth2/auth
  234. ;token_url = https://accounts.google.com/o/oauth2/token
  235. ;api_url = https://www.googleapis.com/oauth2/v1/userinfo
  236. ;allowed_domains =
  237. #################################### Generic OAuth ##########################
  238. [auth.generic_oauth]
  239. ;enabled = false
  240. ;name = OAuth
  241. ;allow_sign_up = true
  242. ;client_id = some_id
  243. ;client_secret = some_secret
  244. ;scopes = user:email,read:org
  245. ;email_attribute_name = email:primary
  246. ;email_attribute_path =
  247. ;auth_url = https://foo.bar/login/oauth/authorize
  248. ;token_url = https://foo.bar/login/oauth/access_token
  249. ;api_url = https://foo.bar/user
  250. ;team_ids =
  251. ;allowed_organizations =
  252. ;tls_skip_verify_insecure = false
  253. ;tls_client_cert =
  254. ;tls_client_key =
  255. ;tls_client_ca =
  256. ; Set to true to enable sending client_id and client_secret via POST body instead of Basic authentication HTTP header
  257. ; This might be required if the OAuth provider is not RFC6749 compliant, only supporting credentials passed via POST payload
  258. ;send_client_credentials_via_post = false
  259. #################################### SAML Auth ###########################
  260. [auth.saml] # Enterprise only
  261. # Defaults to false. If true, the feature is enabled.
  262. ;enabled = false
  263. # Base64-encoded public X.509 certificate. Used to sign requests to the IdP
  264. ;certificate =
  265. # Path to the public X.509 certificate. Used to sign requests to the IdP
  266. ;certificate_path =
  267. # Base64-encoded private key. Used to decrypt assertions from the IdP
  268. ;private_key =
  269. ;# Path to the private key. Used to decrypt assertions from the IdP
  270. ;private_key_path =
  271. # Base64-encoded IdP SAML metadata XML. Used to verify and obtain binding locations from the IdP
  272. ;idp_metadata =
  273. # Path to the SAML metadata XML. Used to verify and obtain binding locations from the IdP
  274. ;idp_metadata_path =
  275. # URL to fetch SAML IdP metadata. Used to verify and obtain binding locations from the IdP
  276. ;idp_metadata_url =
  277. # Duration, since the IdP issued a response and the SP is allowed to process it. Defaults to 90 seconds.
  278. ;max_issue_delay = 90s
  279. # Duration, for how long the SP's metadata should be valid. Defaults to 48 hours.
  280. ;metadata_valid_duration = 48h
  281. # Friendly name or name of the attribute within the SAML assertion to use as the user's name
  282. ;assertion_attribute_name = displayName
  283. # Friendly name or name of the attribute within the SAML assertion to use as the user's login handle
  284. ;assertion_attribute_login = mail
  285. # Friendly name or name of the attribute within the SAML assertion to use as the user's email
  286. ;assertion_attribute_email = mail
  287. #################################### Grafana.com Auth ####################
  288. [auth.grafana_com]
  289. ;enabled = false
  290. ;allow_sign_up = true
  291. ;client_id = some_id
  292. ;client_secret = some_secret
  293. ;scopes = user:email
  294. ;allowed_organizations =
  295. #################################### Auth Proxy ##########################
  296. [auth.proxy]
  297. ;enabled = false
  298. ;header_name = X-WEBAUTH-USER
  299. ;header_property = username
  300. ;auto_sign_up = true
  301. ;ldap_sync_ttl = 60
  302. ;whitelist = 192.168.1.1, 192.168.2.1
  303. ;headers = Email:X-User-Email, Name:X-User-Name
  304. #################################### Basic Auth ##########################
  305. [auth.basic]
  306. ;enabled = true
  307. #################################### Auth LDAP ##########################
  308. [auth.ldap]
  309. ;enabled = false
  310. ;config_file = /etc/grafana/ldap.toml
  311. ;allow_sign_up = true
  312. # LDAP backround sync (Enterprise only)
  313. # At 1 am every day
  314. ;sync_cron = "0 0 1 * * *"
  315. ;active_sync_enabled = true
  316. #################################### SMTP / Emailing ##########################
  317. [smtp]
  318. ;enabled = false
  319. ;host = localhost:25
  320. ;user =
  321. # If the password contains # or ; you have to wrap it with trippel quotes. Ex """#password;"""
  322. ;password =
  323. ;cert_file =
  324. ;key_file =
  325. ;skip_verify = false
  326. ;from_address = admin@grafana.localhost
  327. ;from_name = Grafana
  328. # EHLO identity in SMTP dialog (defaults to instance_name)
  329. ;ehlo_identity = dashboard.example.com
  330. [emails]
  331. ;welcome_email_on_sign_up = false
  332. #################################### Logging ##########################
  333. [log]
  334. # Either "console", "file", "syslog". Default is console and file
  335. # Use space to separate multiple modes, e.g. "console file"
  336. ;mode = console file
  337. # Either "debug", "info", "warn", "error", "critical", default is "info"
  338. ;level = info
  339. # optional settings to set different levels for specific loggers. Ex filters = sqlstore:debug
  340. ;filters =
  341. # For "console" mode only
  342. [log.console]
  343. ;level =
  344. # log line format, valid options are text, console and json
  345. ;format = console
  346. # For "file" mode only
  347. [log.file]
  348. ;level =
  349. # log line format, valid options are text, console and json
  350. ;format = text
  351. # This enables automated log rotate(switch of following options), default is true
  352. ;log_rotate = true
  353. # Max line number of single file, default is 1000000
  354. ;max_lines = 1000000
  355. # Max size shift of single file, default is 28 means 1 << 28, 256MB
  356. ;max_size_shift = 28
  357. # Segment log daily, default is true
  358. ;daily_rotate = true
  359. # Expired days of log file(delete after max days), default is 7
  360. ;max_days = 7
  361. [log.syslog]
  362. ;level =
  363. # log line format, valid options are text, console and json
  364. ;format = text
  365. # Syslog network type and address. This can be udp, tcp, or unix. If left blank, the default unix endpoints will be used.
  366. ;network =
  367. ;address =
  368. # Syslog facility. user, daemon and local0 through local7 are valid.
  369. ;facility =
  370. # Syslog tag. By default, the process' argv[0] is used.
  371. ;tag =
  372. #################################### Alerting ############################
  373. [alerting]
  374. # Disable alerting engine & UI features
  375. ;enabled = true
  376. # Makes it possible to turn off alert rule execution but alerting UI is visible
  377. ;execute_alerts = true
  378. # Default setting for new alert rules. Defaults to categorize error and timeouts as alerting. (alerting, keep_state)
  379. ;error_or_timeout = alerting
  380. # Default setting for how Grafana handles nodata or null values in alerting. (alerting, no_data, keep_state, ok)
  381. ;nodata_or_nullvalues = no_data
  382. # Alert notifications can include images, but rendering many images at the same time can overload the server
  383. # This limit will protect the server from render overloading and make sure notifications are sent out quickly
  384. ;concurrent_render_limit = 5
  385. # Default setting for alert calculation timeout. Default value is 30
  386. ;evaluation_timeout_seconds = 30
  387. # Default setting for alert notification timeout. Default value is 30
  388. ;notification_timeout_seconds = 30
  389. # Default setting for max attempts to sending alert notifications. Default value is 3
  390. ;max_attempts = 3
  391. #################################### Explore #############################
  392. [explore]
  393. # Enable the Explore section
  394. ;enabled = true
  395. #################################### Internal Grafana Metrics ##########################
  396. # Metrics available at HTTP API Url /metrics
  397. [metrics]
  398. # Disable / Enable internal metrics
  399. ;enabled = true
  400. # Disable total stats (stat_totals_*) metrics to be generated
  401. ;disable_total_stats = false
  402. # Publish interval
  403. ;interval_seconds = 10
  404. # Send internal metrics to Graphite
  405. [metrics.graphite]
  406. # Enable by setting the address setting (ex localhost:2003)
  407. ;address =
  408. ;prefix = prod.grafana.%(instance_name)s.
  409. #################################### Distributed tracing ############
  410. [tracing.jaeger]
  411. # Enable by setting the address sending traces to jaeger (ex localhost:6831)
  412. ;address = localhost:6831
  413. # Tag that will always be included in when creating new spans. ex (tag1:value1,tag2:value2)
  414. ;always_included_tag = tag1:value1
  415. # Type specifies the type of the sampler: const, probabilistic, rateLimiting, or remote
  416. ;sampler_type = const
  417. # jaeger samplerconfig param
  418. # for "const" sampler, 0 or 1 for always false/true respectively
  419. # for "probabilistic" sampler, a probability between 0 and 1
  420. # for "rateLimiting" sampler, the number of spans per second
  421. # for "remote" sampler, param is the same as for "probabilistic"
  422. # and indicates the initial sampling rate before the actual one
  423. # is received from the mothership
  424. ;sampler_param = 1
  425. # Whether or not to use Zipkin propagation (x-b3- HTTP headers).
  426. ;zipkin_propagation = false
  427. # Setting this to true disables shared RPC spans.
  428. # Not disabling is the most common setting when using Zipkin elsewhere in your infrastructure.
  429. ;disable_shared_zipkin_spans = false
  430. #################################### Grafana.com integration ##########################
  431. # Url used to import dashboards directly from Grafana.com
  432. [grafana_com]
  433. ;url = https://grafana.com
  434. #################################### External image storage ##########################
  435. [external_image_storage]
  436. # Used for uploading images to public servers so they can be included in slack/email messages.
  437. # you can choose between (s3, webdav, gcs, azure_blob, local)
  438. ;provider =
  439. [external_image_storage.s3]
  440. ;bucket =
  441. ;region =
  442. ;path =
  443. ;access_key =
  444. ;secret_key =
  445. [external_image_storage.webdav]
  446. ;url =
  447. ;public_url =
  448. ;username =
  449. ;password =
  450. [external_image_storage.gcs]
  451. ;key_file =
  452. ;bucket =
  453. ;path =
  454. [external_image_storage.azure_blob]
  455. ;account_name =
  456. ;account_key =
  457. ;container_name =
  458. [external_image_storage.local]
  459. # does not require any configuration
  460. [rendering]
  461. # Options to configure a remote HTTP image rendering service, e.g. using https://github.com/grafana/grafana-image-renderer.
  462. # 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.
  463. ;server_url =
  464. # 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/.
  465. ;callback_url =
  466. [enterprise]
  467. # Path to a valid Grafana Enterprise license.jwt file
  468. ;license_path =
  469. [panels]
  470. # If set to true Grafana will allow script tags in text panels. Not recommended as it enable XSS vulnerabilities.
  471. ;disable_sanitize_html = false
  472. [plugins]
  473. ;enable_alpha = false
  474. ;app_tls_skip_verify_insecure = false