2022-05-26 23:06:25 +08:00
---
aliases:
2022-12-10 00:36:04 +08:00
- ../installation/provisioning/
2022-06-18 06:03:26 +08:00
description: Describes provisioning settings for Grafana using configuration files.
2022-05-26 23:06:25 +08:00
keywords:
- grafana
- provisioning
2025-08-21 18:36:25 +08:00
- provision
Explicitly set all front matter labels in the source files (#71548)
* Set every page to have defaults of 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/enterprise-licensing pages to have 'Enterprise' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/recorded-queries pages to have labels cloud,enterprise
* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/stats-and-license pages to have labels cloud,enterprise
* Set alerting pages to have labels cloud,enterprise,oss
* Set breaking-changes pages to have labels cloud,enterprise,oss
* Set dashboards pages to have labels cloud,enterprise,oss
* Set datasources pages to have labels cloud,enterprise,oss
* Set explore pages to have labels cloud,enterprise,oss
* Set fundamentals pages to have labels cloud,enterprise,oss
* Set introduction/grafana-cloud pages to have labels cloud
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix introduction pages products
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set panels-visualizations pages to have labels cloud,enterprise,oss
* Set release-notes pages to have labels cloud,enterprise,oss
* Set search pages to have labels cloud,enterprise,oss
* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss
* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set troubleshooting pages to have labels cloud,enterprise,oss
* Set whatsnew pages to have labels cloud,enterprise,oss
* Apply updated labels from review
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 16:10:12 +08:00
labels:
products:
- enterprise
- oss
2022-06-17 03:09:16 +08:00
title: Provision Grafana
weight: 600
2022-05-26 23:06:25 +08:00
---
2017-10-23 21:21:51 +08:00
2022-06-17 03:09:16 +08:00
# Provision Grafana
2017-10-23 21:21:51 +08:00
2025-08-21 18:36:25 +08:00
Grafana has an active provisioning system that uses configuration files. You can define data sources and dashboards using files that can be version controlled, making GitOps more natural.
2018-03-23 15:55:11 +08:00
2024-08-13 22:39:55 +08:00
## Configuration file
2017-10-30 17:28:56 +08:00
2025-03-06 20:59:08 +08:00
Refer to [Configuration ](../../setup-grafana/configure-grafana/ ) for more information on what you can configure in `grafana.ini` .
2017-10-30 17:28:56 +08:00
2024-08-13 22:39:55 +08:00
### Configuration file locations
2017-10-30 17:28:56 +08:00
2025-03-13 19:35:16 +08:00
Grafana reads its default configuration from `<WORKING DIRECTORY>/conf/defaults.ini` .
2025-08-21 18:36:25 +08:00
Grafana reads custom configuration from `<WORKING DIRECTORY>/conf/custom.ini` . You can override the custom configuration path with the `--config` option.
2017-10-30 17:28:56 +08:00
2024-08-13 22:39:55 +08:00
{{< admonition type = "note" > }}
2025-03-13 19:35:16 +08:00
The Deb and RPM packages install the configuration file at `/etc/grafana/grafana.ini` .
The Grafana init.d script sets the `--config` option to that path.
2024-08-13 22:39:55 +08:00
{{< / admonition > }}
2017-10-30 17:28:56 +08:00
2025-08-21 18:36:25 +08:00
## Use environment variables
You can use environment variable lookups in all provisioning configuration. The syntax for an environment variable is `$ENV_VAR_NAME` or `${ENV_VAR_NAME}` .
2017-10-30 17:28:56 +08:00
2025-08-21 18:36:25 +08:00
The following applies:
2024-08-13 22:39:55 +08:00
2025-08-21 18:36:25 +08:00
- Only use environment variables for configuration values. Do not use it for keys or bigger parts of the configuration file structure.
- Use environment variables in dashboard provisioning configuration, but not in the dashboard definition files themselves.
2025-03-13 19:35:16 +08:00
The following example looks up the data source URL port, user, and password using environment variables:
2019-04-24 21:39:47 +08:00
```yaml
datasources:
2020-05-19 21:01:04 +08:00
- name: Graphite
url: http://localhost:$PORT
user: $USER
secureJsonData:
password: $PASSWORD
2017-10-30 17:28:56 +08:00
```
2025-08-21 18:36:25 +08:00
### Use of the special character `$`
Grafana's provisioning system considers any set of characters after an `$` a variable name.
During the replacement process, Grafana:
1. Replaces the variables that use the syntax `${ENV_VAR_NAME}` .
1. Next, it replaces the variables that use the syntax `$ENV_VAR_NAME` .
If your data contains the character `$` , for example `Pa$sw0rd` , and you're using an environment variable, use the `$ENV_VAR_NAME` syntax to avoid double expansion. If you use the `${ENV_VAR_NAME}` syntax, the value will be first replaced as `Pa$sw0rd` and then again as `Pa` since `$sw0rd` will be considered another variable.
If you want to use the literal value `Pa$sw0rd` , you need to escape the character `$` using a double `$$` : `Pa$$sw0rd` .
The following example shows how variables are replaced, assuming `PASSWORD=Pa$sw0rd` :
```yaml
datasources:
- name: Graphite
secureJsonData:
password1: $PASSWORD # Resolved as Pa$sw0rd
password2: ${PASSWORD} # Resolved as Pa
password3: 'Pa$$sw0rd' # Resolved as Pa$sw0rd
password4: 'Pa$sw0rd' # Resolved as Pa
```
2019-07-11 19:32:07 +08:00
2024-08-13 22:39:55 +08:00
## Configuration management tools
2017-10-30 17:28:56 +08:00
2025-03-13 19:35:16 +08:00
The Grafana community maintains libraries for many popular configuration management tools.
2017-10-30 17:28:56 +08:00
2025-03-13 19:35:16 +08:00
| Tool | Project |
| --------- | --------------------------------------------------------------------------------------------------------------------------------- |
| Puppet | < https: / / forge . puppet . com / puppet / grafana > |
| Ansible | < https: / / github . com / grafana / grafana-ansible-collection > |
| Chef | < https: / / github . com / sous-chefs / chef-grafana > |
| Saltstack | < https: / / github . com / salt-formulas / salt-formula-grafana > |
| Jsonnet | < https: / / github . com / grafana / grafonnet-lib / > ) |
| NixOS | [`services.grafana.provision` module ](https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/monitoring/grafana.nix ) |
2017-10-30 17:28:56 +08:00
2020-06-24 00:56:44 +08:00
## Data sources
2017-10-23 21:21:51 +08:00
2025-03-06 20:59:08 +08:00
You can manage data sources in Grafana by adding YAML configuration files in the [`provisioning/datasources` ](../../setup-grafana/configure-grafana/#provisioning ) directory.
2025-03-13 19:35:16 +08:00
Each configuration file contains a list of data sources, under the `datasources` key, to add or update during startup.
2022-11-01 23:22:06 +08:00
If the data source already exists, Grafana reconfigures it to match the provisioned configuration file.
2017-10-23 21:21:51 +08:00
2025-03-13 19:35:16 +08:00
You can also list data sources to automatically delete, using the key `deleteDatasources` .
2022-11-01 23:22:06 +08:00
Grafana deletes the data sources listed in `deleteDatasources` _before_ adding or updating those in the `datasources` list.
2018-03-23 16:04:50 +08:00
2024-04-08 17:45:39 +08:00
You can configure Grafana to automatically delete provisioned data sources when they're removed from the provisioning file.
2024-10-23 16:31:53 +08:00
To do so, add `prune: true` to the root of your data source provisioning file.
2024-04-08 17:45:39 +08:00
With this configuration, Grafana also removes the provisioned data sources if you remove the provisioning file entirely.
2025-03-13 19:35:16 +08:00
### Run multiple Grafana instances
2017-10-27 22:37:38 +08:00
2022-11-01 23:22:06 +08:00
If you run multiple instances of Grafana, add a version number to each data source in the configuration and increase it when you update the configuration.
2025-03-13 19:35:16 +08:00
Grafana only updates data sources with the same or lower version number than the one set in the configuration file.
2022-11-01 23:22:06 +08:00
This prevents old configurations from overwriting newer ones if you have different versions of the `datasource.yaml` file that don't define version numbers, and then restart instances at the same time.
2024-08-13 22:39:55 +08:00
### Example data source configuration file
2022-11-01 23:22:06 +08:00
2025-03-06 20:59:08 +08:00
This example provisions a [Graphite data source ](../../datasources/graphite/ ):
2018-03-23 16:04:50 +08:00
2017-10-27 22:37:38 +08:00
```yaml
2022-11-01 23:22:06 +08:00
# Configuration file version
2018-02-12 22:17:32 +08:00
apiVersion: 1
2022-11-01 23:22:06 +08:00
# List of data sources to delete from the database.
2018-02-12 22:17:32 +08:00
deleteDatasources:
2017-10-27 22:37:38 +08:00
- name: Graphite
2018-02-12 22:17:32 +08:00
orgId: 1
2017-10-27 22:37:38 +08:00
2024-04-08 17:45:39 +08:00
# Mark provisioned data sources for deletion if they are no longer in a provisioning file.
# It takes no effect if data sources are already listed in the deleteDatasources section.
prune: true
2022-11-01 23:22:06 +08:00
# List of data sources to insert/update depending on what's
# available in the database.
2017-10-27 22:37:38 +08:00
datasources:
2022-11-01 23:22:06 +08:00
# < string , required > Sets the name you use to refer to
# the data source in panels and queries.
2020-05-19 21:01:04 +08:00
- name: Graphite
2022-11-01 23:22:06 +08:00
# < string , required > Sets the data source type.
2020-05-19 21:01:04 +08:00
type: graphite
2022-11-01 23:22:06 +08:00
# < string , required > Sets the access mode, either
# proxy or direct (Server or Browser in the UI).
# Some data sources are incompatible with any setting
# but proxy (Server).
2020-05-19 21:01:04 +08:00
access: proxy
2022-11-01 23:22:06 +08:00
# < int > Sets the organization id. Defaults to orgId 1.
2020-05-19 21:01:04 +08:00
orgId: 1
2022-11-01 23:22:06 +08:00
# < string > Sets a custom UID to reference this
# data source in other parts of the configuration.
# If not specified, Grafana generates one.
2020-05-19 21:01:04 +08:00
uid: my_unique_uid
2022-11-01 23:22:06 +08:00
# < string > Sets the data source's URL, including the
# port.
2020-05-19 21:01:04 +08:00
url: http://localhost:8080
2022-11-01 23:22:06 +08:00
# < string > Sets the database user, if necessary.
2020-05-19 21:01:04 +08:00
user:
2022-11-01 23:22:06 +08:00
# < string > Sets the database name, if necessary.
2020-05-19 21:01:04 +08:00
database:
2022-11-01 23:22:06 +08:00
# < bool > Enables basic authorization.
2020-05-19 21:01:04 +08:00
basicAuth:
2022-11-01 23:22:06 +08:00
# < string > Sets the basic authorization username.
2020-05-19 21:01:04 +08:00
basicAuthUser:
2022-11-01 23:22:06 +08:00
# < bool > Enables credential headers.
2020-05-19 21:01:04 +08:00
withCredentials:
2022-11-01 23:22:06 +08:00
# < bool > Toggles whether the data source is pre-selected
# for new panels. You can set only one default
# data source per organization.
2020-05-19 21:01:04 +08:00
isDefault:
2022-11-01 23:22:06 +08:00
# < map > Fields to convert to JSON and store in jsonData.
2020-05-19 21:01:04 +08:00
jsonData:
2022-11-01 23:22:06 +08:00
# < string > Defines the Graphite service's version.
2020-05-19 21:01:04 +08:00
graphiteVersion: '1.1'
2022-11-01 23:22:06 +08:00
# < bool > Enables TLS authentication using a client
# certificate configured in secureJsonData.
2020-05-19 21:01:04 +08:00
tlsAuth: true
2022-11-01 23:22:06 +08:00
# < bool > Enables TLS authentication using a CA
# certificate.
2020-05-19 21:01:04 +08:00
tlsAuthWithCACert: true
2022-11-01 23:22:06 +08:00
# < map > Fields to encrypt before storing in jsonData.
2020-05-19 21:01:04 +08:00
secureJsonData:
2022-11-01 23:22:06 +08:00
# < string > Defines the CA cert, client cert, and
# client key for encrypted authentication.
2020-05-19 21:01:04 +08:00
tlsCACert: '...'
tlsClientCert: '...'
tlsClientKey: '...'
2022-11-01 23:22:06 +08:00
# < string > Sets the database password, if necessary.
2020-05-19 21:01:04 +08:00
password:
2022-11-01 23:22:06 +08:00
# < string > Sets the basic authorization password.
2020-05-19 21:01:04 +08:00
basicAuthPassword:
2023-11-02 18:27:17 +08:00
# < int > Sets the version. Used to compare versions when
# updating. Ignored when creating a new data source.
2020-05-19 21:01:04 +08:00
version: 1
2022-11-01 23:22:06 +08:00
# < bool > Allows users to edit data sources from the
# Grafana UI.
2020-05-19 21:01:04 +08:00
editable: false
2017-10-27 22:37:38 +08:00
```
2017-11-16 21:22:52 +08:00
2025-03-06 20:59:08 +08:00
For provisioning examples of specific data sources, refer to that [data source's documentation ](../../datasources/ ).
2018-03-21 15:53:47 +08:00
2024-08-13 22:39:55 +08:00
#### JSON data
2017-11-16 21:22:52 +08:00
2025-03-13 19:35:16 +08:00
Not all data sources have the same configuration settings, only the most common ones are fields in the data source provisioning file.
To provision the rest of a data source's settings, include them as JSON in the `jsonData` field.
2022-11-01 23:22:06 +08:00
2025-03-06 20:59:08 +08:00
Common settings in the [built-in core data sources ](../../datasources/#built-in-core-data-sources ) include:
2017-11-16 21:22:52 +08:00
2025-03-13 19:35:16 +08:00
| Name | Type | Data source | Description |
| ------------------------------- | ------- | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tlsAuth` | boolean | _HTTP\*_ , MySQL | Enable TLS authentication using client cert configured in secure JSON data |
| `tlsAuthWithCACert` | boolean | _HTTP\*_ , MySQL, PostgreSQL | Enable TLS authentication using CA cert |
| `tlsSkipVerify` | boolean | _HTTP\*_ , MySQL, PostgreSQL, MSSQL | Controls whether a client verifies the server's certificate chain and host name. |
| `serverName` | string | _HTTP\*_ , MSSQL | Optional. Controls the server name used for certificate common name/subject alternative name verification. Defaults to using the data source URL. |
| `timeout` | string | _HTTP\*_ | Request timeout in seconds. Overrides `dataproxy.timeout` option |
| `graphiteVersion` | string | Graphite | Graphite version |
| `timeInterval` | string | Prometheus, Elasticsearch, InfluxDB, MySQL, PostgreSQL and MSSQL | Lowest interval/step value that should be used for this data source. |
| `httpMode` | string | InfluxDB | HTTP Method. 'GET', 'POST', defaults to GET |
| `maxSeries` | number | InfluxDB | Max number of series/tables that Grafana processes |
| `httpMethod` | string | Prometheus | HTTP Method. 'GET', 'POST', defaults to POST |
| `customQueryParameters` | string | Prometheus | Query parameters to add, as a URL-encoded string. |
| `manageAlerts` | boolean | Prometheus and Loki | Manage alerts via Alerting UI |
| `alertmanagerUid` | string | Prometheus and Loki | UID of Alertmanager that manages Alert for this data source. |
| `timeField` | string | Elasticsearch | Which field that should be used as timestamp |
| `interval` | string | Elasticsearch | Index date time format. nil(No Pattern), 'Hourly', 'Daily', 'Weekly', 'Monthly' or 'Yearly' |
| `logMessageField` | string | Elasticsearch | Which field should be used as the log message |
| `logLevelField` | string | Elasticsearch | Which field should be used to indicate the priority of the log message |
| `maxConcurrentShardRequests` | number | Elasticsearch | Maximum number of concurrent shard requests that each sub-search request executes per node |
| `sigV4Auth` | boolean | Elasticsearch and Prometheus | Enable usage of SigV4 |
| `sigV4AuthType` | string | Elasticsearch and Prometheus | SigV4 auth provider. default/credentials/keys |
| `sigV4ExternalId` | string | Elasticsearch and Prometheus | Optional SigV4 External ID |
| `sigV4AssumeRoleArn` | string | Elasticsearch and Prometheus | Optional SigV4 ARN role to assume |
| `sigV4Region` | string | Elasticsearch and Prometheus | SigV4 AWS region |
| `sigV4Profile` | string | Elasticsearch and Prometheus | Optional SigV4 credentials profile |
| `authType` | string | Amazon CloudWatch | Auth provider. default/credentials/keys |
| `externalId` | string | Amazon CloudWatch | Optional External ID |
| `assumeRoleArn` | string | Amazon CloudWatch | Optional ARN role to assume |
| `defaultRegion` | string | Amazon CloudWatch | Optional default AWS region |
| `customMetricsNamespaces` | string | Amazon CloudWatch | Namespaces of Custom Metrics |
| `profile` | string | Amazon CloudWatch | Optional credentials profile |
| `tsdbVersion` | string | OpenTSDB | Version |
| `tsdbResolution` | string | OpenTSDB | Resolution |
| `sslmode` | string | PostgreSQL | SSL mode. 'disable', 'require', 'verify-ca' or 'verify-full' |
| `tlsConfigurationMethod` | string | PostgreSQL | SSL certificate configuration, either by 'file-path' or 'file-content' |
| `sslRootCertFile` | string | PostgreSQL, MSSQL | SSL server root certificate file, must be readable by the Grafana user |
| `sslCertFile` | string | PostgreSQL | SSL client certificate file, must be readable by the Grafana user |
| `sslKeyFile` | string | PostgreSQL | SSL client key file, must be readable by _only_ the Grafana user |
| `encrypt` | string | MSSQL | Determines SSL encryption handling. Options include: `disable` - data sent between client and server is not encrypted; `false` - data sent between client and server is not encrypted beyond the login packet; `true` - data sent between client and server is encrypted. Default is `false` . |
| `postgresVersion` | number | PostgreSQL | Postgres version as a number (903/904/905/906/1000) meaning v9.3, v9.4, ..., v10 |
| `timescaledb` | boolean | PostgreSQL | Enable usage of TimescaleDB extension |
| `maxOpenConns` | number | MySQL, PostgreSQL and MSSQL | Maximum number of open connections to the database (Grafana v5.4+) |
| `maxIdleConns` | number | MySQL, PostgreSQL and MSSQL | Maximum number of connections in the idle connection pool (Grafana v5.4+) |
| `connMaxLifetime` | number | MySQL, PostgreSQL and MSSQL | Maximum amount of time in seconds a connection may be reused (Grafana v5.4+) |
| `keepCookies` | array | _HTTP\*_ | Cookies that needs to be passed along while communicating with data sources |
| `prometheusVersion` | string | Prometheus | The version of the Prometheus data source, such as `2.37.0` , `2.24.0` |
| `prometheusType` | string | Prometheus | Prometheus database type. Options are `Prometheus` , `Cortex` , `Mimir` or`Thanos`. |
| `cacheLevel` | string | Prometheus | Determines the duration of the browser cache. Valid values include: `Low` , `Medium` , `High` , and `None` . |
| `incrementalQuerying` | string | Prometheus | Experimental: Turn on incremental querying to enhance dashboard reload performance with slow data sources |
| `incrementalQueryOverlapWindow` | string | Prometheus | Experimental: Configure incremental query overlap window. Requires a valid duration string, for example, `180s` or `15m` Default value is `10m` (10 minutes). |
| `disableRecordingRules` | boolean | Prometheus | Experimental: Turn off Prometheus recording rules |
| `implementation` | string | Alertmanager | The implementation of the Alertmanager data source, such as `prometheus` , `cortex` or `mimir` |
| `handleGrafanaManagedAlerts` | boolean | Alertmanager | When enabled, Grafana-managed alerts are sent to this Alertmanager |
2024-08-13 22:39:55 +08:00
{{< admonition type = "note" > }}
2023-05-23 04:45:28 +08:00
Data sources tagged with _HTTP\*_ communicate using the HTTP protocol, which includes all core data source plugins except MySQL, PostgreSQL, and MSSQL.
2024-08-13 22:39:55 +08:00
{{< / admonition > }}
2021-11-09 01:59:21 +08:00
2025-03-06 20:59:08 +08:00
For examples of specific data sources' JSON data, refer to that [data source's documentation ](../../datasources/ ).
2017-11-16 21:22:52 +08:00
2025-03-13 19:35:16 +08:00
#### Secure JSON data
2017-11-16 21:22:52 +08:00
2025-03-13 19:35:16 +08:00
Secure JSON data is a map of settings encrypted with a [secret key ](../../setup-grafana/configure-grafana/#secret_key ).
The encryption hides the JSON data from the users of Grafana.
You should use secure JSON data to store TLS certificates and passwords for data source HTTP requests.
2024-08-13 22:39:55 +08:00
All of these settings are optional.
2017-11-16 21:22:52 +08:00
2025-03-13 19:35:16 +08:00
| Name | Type | Data source | Description |
| ------------------- | ------ | ---------------------------------- | -------------------------------------------------------- |
| `tlsCACert` | string | _HTTP\*_ , MySQL, PostgreSQL | CA cert for out going requests |
| `tlsClientCert` | string | _HTTP\*_ , MySQL, PostgreSQL | TLS Client cert for outgoing requests |
| `tlsClientKey` | string | _HTTP\*_ , MySQL, PostgreSQL | TLS Client key for outgoing requests |
| `password` | string | _HTTP\*_ , MySQL, PostgreSQL, MSSQL | password |
| `basicAuthPassword` | string | _HTTP\*_ | password for basic authentication |
| `accessKey` | string | Amazon CloudWatch | Access key for connecting to Amazon CloudWatch |
| `secretKey` | string | Amazon CloudWatch | Secret key for connecting to Amazon CloudWatch |
| `sigV4AccessKey` | string | Elasticsearch and Prometheus | SigV4 access key. Required when using keys auth provider |
| `sigV4SecretKey` | string | Elasticsearch and Prometheus | SigV4 secret key. Required when using keys auth provider |
2024-08-13 22:39:55 +08:00
{{< admonition type = "note" > }}
2025-03-13 19:35:16 +08:00
The _HTTP\*_ tag denotes data sources that communicate using the HTTP protocol, including all core data source plugins except MySQL, PostgreSQL, and MSSQL.
2024-08-13 22:39:55 +08:00
{{< / admonition > }}
2021-11-09 01:59:21 +08:00
2022-11-01 23:22:06 +08:00
#### Custom HTTP headers for data sources
2020-05-19 21:01:04 +08:00
2025-03-13 19:35:16 +08:00
You can add HTTP headers to all requests sent to data sources managed by Grafana provisioning
2024-08-13 22:39:55 +08:00
Configure the header name in the `jsonData` field and the header value in `secureJsonData` .
2025-03-13 19:35:16 +08:00
The following example sets the `HeaderName` header to have the value `HeaderValue` and the `Authorization` header to have the value `Bearer XXXXXXXXX` :
2019-06-03 21:22:59 +08:00
```yaml
apiVersion: 1
datasources:
2020-05-19 21:01:04 +08:00
- name: Graphite
jsonData:
httpHeaderName1: 'HeaderName'
httpHeaderName2: 'Authorization'
secureJsonData:
httpHeaderValue1: 'HeaderValue'
httpHeaderValue2: 'Bearer XXXXXXXXX'
2019-06-03 21:22:59 +08:00
```
2020-06-22 23:49:13 +08:00
## Plugins
2025-03-06 20:59:08 +08:00
You can manage plugin applications in Grafana by adding one or more YAML configuration files in the [`provisioning/plugins` ](../../setup-grafana/configure-grafana/#provisioning ) directory.
2025-03-13 19:35:16 +08:00
Each configuration file contains a list of `apps` that Grafana configures during start up.
Grafana configures each app to use the configuration in the file.
2022-07-07 02:49:58 +08:00
2024-08-13 22:39:55 +08:00
{{< admonition type = "note" > }}
2023-05-23 04:45:28 +08:00
This feature enables you to provision plugin configurations, not the plugins themselves.
2025-03-13 19:35:16 +08:00
You must have already installed the plugin to use plugin configuration provisioning.
2024-08-13 22:39:55 +08:00
{{< / admonition > }}
2020-06-22 23:49:13 +08:00
### Example plugin configuration file
```yaml
apiVersion: 1
apps:
# < string > the type of app, plugin identifier. Required
- type: raintank-worldping-app
# < int > Org ID. Default to 1, unless org_name is specified
org_id: 1
# < string > Org name. Overrides org_id unless org_id not specified
org_name: Main Org.
# < bool > disable the app. Default to false.
disabled: false
# < map > fields that will be converted to json and stored in jsonData. Custom per app.
jsonData:
# key/value pairs of string to object
key: value
# < map > fields that will be converted to json, encrypted and stored in secureJsonData. Custom per app.
secureJsonData:
# key/value pairs of string to string
key: value
```
2020-04-30 22:17:13 +08:00
## Dashboards
2017-12-07 22:23:14 +08:00
2025-03-06 20:59:08 +08:00
You can manage dashboards in Grafana by adding one or more YAML configuration files in the [`provisioning/dashboards` ](../../setup-grafana/configure-grafana/#dashboards ) directory.
2025-03-13 19:35:16 +08:00
Each configuration file contains a list of `providers` that Grafana uses to load dashboards from the local filesystem.
2017-12-07 22:23:14 +08:00
2025-03-13 19:35:16 +08:00
### Example dashboard configuration file
2017-12-07 22:23:14 +08:00
```yaml
2018-02-13 21:14:10 +08:00
apiVersion: 1
providers:
2020-05-19 21:01:04 +08:00
# < string > an unique provider name. Required
- name: 'a unique provider name'
# < int > Org id. Default to 1
orgId: 1
# < string > name of the dashboard folder.
folder: ''
# < string > folder UID. will be automatically generated if not specified
folderUid: ''
# < string > provider type. Default to 'file'
type: file
# < bool > disable dashboard deletion
disableDeletion: false
# < int > how often Grafana will scan for changed dashboards
updateIntervalSeconds: 10
# < bool > allow updating provisioned dashboards from the UI
allowUiUpdates: false
options:
# < string , required > path to dashboard files on disk. Required when using the 'file' type
path: /var/lib/grafana/dashboards
2020-06-30 21:33:26 +08:00
# < bool > use folder names from filesystem to create folders in Grafana
foldersFromFilesStructure: true
2017-12-07 22:23:14 +08:00
```
2025-03-13 19:35:16 +08:00
When Grafana starts, it updates or creates all dashboards found in the configured path.
It later polls that path every `updateIntervalSeconds` for updates to the dashboard files and updates its database.
2018-02-02 23:14:48 +08:00
2025-03-13 19:35:16 +08:00
{{< admonition type = "note" > }}
Grafana installs dashboards at the root level if you don't set the `folder` field.
{{< / admonition > }}
2020-08-05 00:03:09 +08:00
2025-03-13 19:35:16 +08:00
#### Make changes to a provisioned dashboard
2020-05-19 21:01:04 +08:00
2025-03-13 19:35:16 +08:00
You can make changes to a provisioned dashboard in the Grafana UI but its not possible to automatically save the changes back to the provisioning source.
If `allowUiUpdates` is set to `true` and you make changes to a provisioned dashboard, when you save the dashboard, Grafana persists the changes to its database.
2024-08-13 22:39:55 +08:00
2025-03-13 19:35:16 +08:00
{{< admonition type = "caution" > }}
If you save a provisioned dashboard in the UI and then later update the provisioning source, Grafana always overwrites the database dashboard with the one from the provisioning file.
Grafana ignores the `version` property in the JSON file, even if it's lower than the dashboard in the database.
{{< / admonition > }}
2018-04-17 23:22:25 +08:00
2025-03-13 19:35:16 +08:00
{{< admonition type = "caution" > }}
If you save a provisioned dashboard in the UI and remove the provisioning source, Grafana deletes the dashboard in the database unless you have set the option `disableDeletion` to `true` .
2024-08-13 22:39:55 +08:00
{{< / admonition > }}
2018-04-17 23:22:25 +08:00
2025-03-13 19:35:16 +08:00
If you set `allowUiUpdates` to `false` , you can't save changes to a provisioned dashboard.
When you try to save changes to a provisioned dashboard, Grafana brings up a _Cannot save provisioned dashboard_ dialog box.
2018-04-17 23:22:25 +08:00
2025-03-13 19:35:16 +08:00
Grafana offers options to export the JSON definition of a dashboard.
Use either **Copy JSON to Clipboard** or **Save JSON to file** to sync your dashboard changes back to the provisioning source.
Grafana removes the `id` field from the dashboard JSON to help the provisioning workflow.
2019-10-31 21:27:31 +08:00
2025-03-13 19:35:16 +08:00
The following screenshot illustrates this behavior.
2020-03-21 02:13:18 +08:00
2021-05-28 17:27:40 +08:00
{{< figure src = "/static/img/docs/v51/provisioning_cannot_save_dashboard.png" max-width = "500px" class = "docs-image--no-shadow" > }}
2018-04-17 23:22:25 +08:00
2024-08-13 22:39:55 +08:00
### Reusable dashboard URLs
2018-02-02 23:14:48 +08:00
2025-03-13 19:35:16 +08:00
If the dashboard in the JSON file contains an [UID ](../../dashboards/build-dashboards/view-dashboard-json-model/ ), Grafana updates that the dashboard with that UID in the database.
This lets you migrate dashboards between Grafana instances and keep consistent dashboard URLs.
When Grafana starts, it creates or updates all dashboards available in the configured folders.
2018-02-13 22:47:02 +08:00
2025-03-13 19:35:16 +08:00
{{< admonition type = "caution" > }}
You can overwrite existing dashboards with provisioning.
Be careful not to reuse the same `title` multiple times within a folder or `uid` within the same Grafana instance to avoid inconsistent behavior.
2024-08-13 22:39:55 +08:00
{{< / admonition > }}
2018-11-28 22:35:42 +08:00
2020-06-30 21:33:26 +08:00
### Provision folders structure from filesystem to Grafana
2021-08-06 21:52:36 +08:00
2025-03-13 19:35:16 +08:00
If you already store your dashboards using folders in a Git repository or on a filesystem, and want to have the same folder names in the Grafana menu, use `foldersFromFilesStructure` option.
2020-06-30 21:33:26 +08:00
2025-03-13 19:35:16 +08:00
For example, to replicate the following dashboards structure from the filesystem to Grafana:
2021-08-06 21:52:36 +08:00
2020-06-30 21:33:26 +08:00
```
/etc/dashboards
├── /server
│ ├── /common_dashboard.json
│ └── /network_dashboard.json
└── /application
├── /requests_dashboard.json
└── /resources_dashboard.json
```
2021-08-06 21:52:36 +08:00
2025-03-13 19:35:16 +08:00
use the following provisioning configuration file:
2021-08-06 21:52:36 +08:00
2020-06-30 21:33:26 +08:00
```yaml
apiVersion: 1
2020-07-17 19:54:01 +08:00
2020-06-30 21:33:26 +08:00
providers:
2021-08-06 21:52:36 +08:00
- name: dashboards
type: file
updateIntervalSeconds: 30
options:
path: /etc/dashboards
foldersFromFilesStructure: true
2020-06-30 21:33:26 +08:00
```
2021-08-06 21:52:36 +08:00
2025-03-13 19:35:16 +08:00
Grafana creates the `server` and `application` folders in the UI.
2020-06-30 21:33:26 +08:00
2025-03-13 19:35:16 +08:00
To use `foldersFromFilesStructure` , you must unset the `folder` and `folderUid` options.
2020-06-30 21:33:26 +08:00
2023-09-08 10:57:16 +08:00
To provision dashboards to the root level, store them in the root of your `path` .
2020-08-05 00:03:09 +08:00
2025-03-13 19:35:16 +08:00
{{< admonition type = "note" > }}
This feature doesn't let you create nested folder structures, where you have folders within folders.
2024-01-25 17:20:37 +08:00
{{< / admonition > }}
2022-08-18 00:53:36 +08:00
## Alerting
2025-03-06 20:59:08 +08:00
For information on provisioning Grafana Alerting, refer to [Provision Grafana Alerting resources ](../../alerting/set-up/provision-alerting-resources/ ).
2022-08-18 00:53:36 +08:00
2024-08-13 22:39:55 +08:00
### Supported settings
2018-11-28 22:35:42 +08:00
2025-03-13 19:35:16 +08:00
The following sections detail the supported settings and secure settings for each alert notification type.
In the provisioning YAML use `settings` for settings and `secure_settings` for secure settings.
Grafana encrypts secure settings in the database.
2020-07-18 02:35:36 +08:00
2018-11-28 22:35:42 +08:00
#### Alert notification `pushover`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| ------------ | -------------- |
| `apiToken` | yes |
| `userKey` | yes |
| `device` | |
| `priority` | |
| `okPriority` | |
| `retry` | |
| `expire` | |
| `sound` | |
| `okSound` | |
2018-11-28 22:35:42 +08:00
2021-05-29 05:00:21 +08:00
#### Alert notification `discord`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| ---------------------- | -------------- |
| `url` | yes |
| `avatar_url` | |
| `content` | |
| `use_discord_username` | |
2021-05-29 05:00:21 +08:00
2018-11-28 22:35:42 +08:00
#### Alert notification `slack`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| ---------------- | -------------- |
| `url` | yes |
| `recipient` | |
| `username` | |
| `icon_emoji` | |
| `icon_url` | |
| `uploadImage` | |
| `mentionUsers` | |
| `mentionGroups` | |
| `mentionChannel` | |
| `token` | yes |
| `color` | |
2018-11-28 22:35:42 +08:00
#### Alert notification `victorops`
2025-03-13 19:35:16 +08:00
| Name |
| ------------- |
| `url` |
| `autoResolve` |
2018-11-28 22:35:42 +08:00
#### Alert notification `kafka`
2025-03-13 19:35:16 +08:00
| Name |
| ---------------- |
| `kafkaRestProxy` |
| `kafkaTopic` |
2018-11-28 22:35:42 +08:00
#### Alert notification `LINE`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| ------- | -------------- |
| `token` | yes |
2018-11-28 22:35:42 +08:00
2024-08-22 22:47:48 +08:00
#### Alert notification `MQTT`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| --------------- | -------------- |
| `brokerUrl` | |
| `clientId` | |
| `topic` | |
| `messageFormat` | |
| `username` | |
| `password` | yes |
| `retain` | |
| `qos` | |
| `tlsConfig` | |
2024-09-18 03:11:16 +08:00
2025-03-13 19:35:16 +08:00
##### TLS configuration
| Name | Secure setting |
| -------------------- | -------------- |
| `insecureSkipVerify` | |
| `clientCertificate` | yes |
| `clientKey` | yes |
| `caCertificate` | yes |
2024-08-22 22:47:48 +08:00
2018-11-28 22:35:42 +08:00
#### Alert notification `pagerduty`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| ---------------- | -------------- |
| `integrationKey` | yes |
| `autoResolve` | |
2018-11-28 22:35:42 +08:00
#### Alert notification `sensu`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| ---------- | -------------- |
| `url` | |
| `source` | |
| `handler` | |
| `username` | |
| `password` | yes |
2018-11-28 22:35:42 +08:00
2020-11-28 01:09:24 +08:00
#### Alert notification `sensugo`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| ----------- | -------------- |
| `url` | |
| `apikey` | yes |
| `entity` | |
| `check` | |
| `handler` | |
| `namespace` | |
2020-11-28 01:09:24 +08:00
2018-11-28 22:35:42 +08:00
#### Alert notification `prometheus-alertmanager`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| ------------------- | -------------- |
| `url` | |
| `basicAuthUser` | |
| `basicAuthPassword` | yes |
2018-11-28 22:35:42 +08:00
#### Alert notification `teams`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| ----- | -------------- |
| `url` | |
2018-11-28 22:35:42 +08:00
#### Alert notification `dingding`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| ----- | -------------- |
| `url` | |
2018-11-28 22:35:42 +08:00
#### Alert notification `email`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| ------------- | -------------- |
| `singleEmail` | |
| `addresses` | |
2018-11-28 22:35:42 +08:00
#### Alert notification `hipchat`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| -------- | -------------- |
| `url` | |
| `apikey` | |
| `roomid` | |
2018-11-28 22:35:42 +08:00
#### Alert notification `opsgenie`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| ------------------ | -------------- |
| `apiKey` | yes |
| `apiUrl` | |
| `autoClose` | |
| `overridePriority` | |
| `sendTagsAs` | |
2018-11-28 22:35:42 +08:00
#### Alert notification `telegram`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| ------------- | -------------- |
| `bottoken` | yes |
| `chatid` | |
| `uploadImage` | |
2018-11-28 22:35:42 +08:00
#### Alert notification `threema`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| -------------- | -------------- |
| `gateway_id` | |
| `recipient_id` | |
| `api_secret` | yes |
2018-11-28 22:35:42 +08:00
#### Alert notification `webhook`
2025-03-14 14:22:41 +08:00
| Name | Secure setting |
| ------------- | -------------- |
| `url` | |
| `http_method` | |
| `username` | |
| `password` | yes |
| `tls_config` | |
| `hmac_config` | |
##### TLS configuration
| Name | Secure setting |
| -------------------- | -------------- |
| `insecureSkipVerify` | |
| `clientCertificate` | yes |
| `clientKey` | yes |
| `caCertificate` | yes |
##### HMAC signature configuration
| Name | Secure setting |
| ----------------- | -------------- |
| `secret` | yes |
| `header` | |
| `timestampHeader` | |
2019-04-20 02:50:55 +08:00
#### Alert notification `googlechat`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| ----- | -------------- |
| `url` | |
2021-05-21 00:53:34 +08:00
2022-11-12 01:27:13 +08:00
#### Alert notification `Cisco Webex Teams`
2025-03-13 19:35:16 +08:00
| Name | Secure setting |
| ----------- | -------------- |
| `message` | |
| `room_id` | |
| `api_url` | |
| `bot_token` | yes |
2022-11-12 01:27:13 +08:00
2021-05-21 00:53:34 +08:00
## Grafana Enterprise
2022-12-21 16:44:23 +08:00
Grafana Enterprise supports:
2021-05-21 00:53:34 +08:00
2025-03-06 20:59:08 +08:00
- [Provisioning role-based access control with Grafana ](../roles-and-permissions/access-control/rbac-grafana-provisioning/ )
- [Provisioning role-based access control with Terraform ](../roles-and-permissions/access-control/rbac-terraform-provisioning/ )
