diff --git a/docs/sources/administration/data-source-management/_index.md b/docs/sources/administration/data-source-management/_index.md index f4a9be6f23b..b57424f245e 100644 --- a/docs/sources/administration/data-source-management/_index.md +++ b/docs/sources/administration/data-source-management/_index.md @@ -10,7 +10,7 @@ description: Data source management information for Grafana administrators labels: products: - enterprise - - oss + - cloud title: Data source management weight: 100 --- @@ -21,27 +21,15 @@ Grafana supports many different storage backends for your time series data (data Refer to [data sources]({{< relref "../../datasources" >}}) for more information about using data sources in Grafana. Only users with the organization admin role can add data sources. -## Add a data source - -Before you can create your first dashboard, you need to add your data source. - -{{% admonition type="note" %}} -Only users with the organization admin role can add data sources. -{{% /admonition %}} - -**To add a data source:** - -1. Click **Connections** in the left-side menu. -1. Enter the name of a specific data source in the search dialog. You can filter by **Data source** to only see data sources. -1. Click the data source you want to add. -1. Configure the data source following instructions specific to that data source. - For links to data source-specific documentation, see [Data sources]({{< relref "../../datasources" >}}). ## Data source permissions You can configure data source permissions to allow or deny certain users the ability to query, edit, or administrate a data source. Each data source’s configuration includes a Permissions tab where you can restrict data source permissions to specific users, service accounts, teams, or roles. -Query permission allows users to query the data source. Edit permission allows users to query the data source, edit the data source’s configuration and delete the data source. Admin permission allows users to query and edit the data source, change permissions on the data source and enable or disable query caching for the data source. + +- The `query` permission allows users to query the data source. +- The `edit` permission allows users to query the data source, edit the data source’s configuration and delete the data source. +- The `admin` permission allows users to query and edit the data source, change permissions on the data source and enable or disable query caching for the data source. {{% admonition type="note" %}} Available in [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise/" >}}) and [Grafana Cloud](/docs/grafana-cloud). @@ -71,7 +59,7 @@ You can assign data source permissions to users, service accounts, teams, and ro 1. Click **Connections** in the left-side menu. 1. Under Your connections, click **Data sources**. 1. Select the data source for which you want to edit permissions. -1. On the Permissions tab, find the user, service account, team, or role permission you want to update. +1. On the Permissions tab, find the **User**, **Service Account**, **Team**, or **Role** permission you want to update. 1. Select a different option in the **Permission** dropdown.
@@ -81,7 +69,7 @@ You can assign data source permissions to users, service accounts, teams, and ro 1. Click **Connections** in the left-side menu. 1. Under Your connections, click **Data sources**. 1. Select the data source from which you want to remove permissions. -1. On the Permissions tab, find the user, service account, team, or role permission you want to remove. +1. On the Permissions tab, find the **User**, **Service Account**, **Team**, or **Role** permission you want to remove. 1. Click the **X** next to the permission.
@@ -178,22 +166,3 @@ This action impacts all cache-enabled data sources. If you are using Memcached, ### Sending a request without cache If a data source query request contains an `X-Cache-Skip` header, then Grafana skips the caching middleware, and does not search the cache for a response. This can be particularly useful when debugging data source queries using cURL. - -## Add data source plugins - -Grafana ships with several [built-in data sources]({{< relref "../../datasources#built-in-core-data-sources" >}}). -You can add additional data sources as plugins, which you can install or create yourself. - -### Find data source plugins in the plugin catalog - -To view available data source plugins, go to the [plugin catalog](/grafana/plugins/?type=datasource) and select the "Data sources" filter. -For details about the plugin catalog, refer to [Plugin management]({{< relref "../../administration/plugin-management/" >}}). - -You can further filter the plugin catalog's results for data sources provided by the Grafana community, Grafana Labs, and partners. -If you use [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise/" >}}), you can also filter by Enterprise-supported plugins. - -For more documentation on a specific data source plugin's features, including its query language and editor, refer to its plugin catalog page. - -### Create a data source plugin - -To build your own data source plugin, refer to the ["Build a data source plugin"](/developers/plugin-tools/tutorials/build-a-data-source-plugin) tutorial and our documentation about [building a plugin](/developers/plugin-tools). diff --git a/docs/sources/datasources/_index.md b/docs/sources/datasources/_index.md index d264340a5e8..b738aa80a0c 100644 --- a/docs/sources/datasources/_index.md +++ b/docs/sources/datasources/_index.md @@ -32,14 +32,29 @@ This documentation describes how to manage data sources in general, and how to configure or query the built-in data sources. For other data sources, refer to the list of [datasource plugins](/grafana/plugins/). -To develop a custom plugin, refer to [Build a plugin](/developers/plugin-tools). +To develop a custom plugin, refer to [Create a data source plugin](#create-a-data-source-plugin). ## Manage data sources Only users with the [organization administrator role][organization-roles] can add or remove data sources. To access data source management tools in Grafana as an administrator, navigate to **Configuration > Data Sources** in the Grafana sidebar. -For details on data source management, including instructions on how to add data sources and configure user permissions for queries, refer to the [administration documentation][data-source-management]. +For details on data source management, including instructions on how configure user permissions for queries, refer to the [administration documentation][data-source-management]. + +## Add a data source + +Before you can create your first dashboard, you need to add your data source. + +{{% admonition type="note" %}} +Only users with the organization admin role can add data sources. +{{% /admonition %}} + +**To add a data source:** + +1. Click **Connections** in the left-side menu. +1. Enter the name of a specific data source in the search dialog. You can filter by **Data source** to only see data sources. +1. Click the data source you want to add. +1. Configure the data source following instructions specific to that data source. ## Use query editors @@ -55,7 +70,7 @@ For example, this video demonstrates the visual Prometheus query builder: {{< vimeo 720004179 >}} -For general information about querying in Grafana, and common options and user interface elements across all query editors, refer to [Query and transform data][query-transform-data] . +For general information about querying in Grafana, and common options and user interface elements across all query editors, refer to [Query and transform data][query-transform-data]. ## Special data sources @@ -68,6 +83,7 @@ Grafana includes three special data sources: - You can't change an existing query to use the **Mixed** data source. - Grafana Play example: [Mixed data sources](https://play.grafana.org/d/000000100/mixed-datasources?orgId=1) - **Dashboard:** A data source that uses the result set from another panel in the same dashboard. The dashboard data source can use data either directly from the selected panel or from annotations attached to the selected panel. + - Grafana Play example: [Panel as Data source](https://play.grafana.org/d/ede8zps8ndb0gc/panel-as-data-source?orgId=1) ## Built-in core data sources @@ -91,6 +107,24 @@ These built-in core data sources are also included in the Grafana documentation: - [Testdata]({{< relref "./testdata" >}}) - [Zipkin]({{< relref "./zipkin" >}}) +## Add additional data source plugins + +You can add additional data sources as plugins (that are not available in core Grafana), which you can install or create yourself. + +### Find data source plugins in the plugin catalog + +To view available data source plugins, go to the [plugin catalog](/grafana/plugins/?type=datasource) and select the "Data sources" filter. +For details about the plugin catalog, refer to [Plugin management][Plugin-management]. + +You can further filter the plugin catalog's results for data sources provided by the Grafana community, Grafana Labs, and partners. +If you use [Grafana Enterprise][Grafana-Enterprise], you can also filter by Enterprise-supported plugins. + +For more documentation on a specific data source plugin's features, including its query language and editor, refer to its plugin catalog page. + +### Create a data source plugin + +To build your own data source plugin, refer to the [Build a data source plugin](/developers/plugin-tools/tutorials/build-a-data-source-plugin) tutorial and [Plugin tools](/developers/plugin-tools). + {{% docs/reference %}} [alerts]: "/docs/grafana/ -> /docs/grafana//alerting" [alerts]: "/docs/grafana-cloud/ -> /docs/grafana//alerting" @@ -109,4 +143,10 @@ These built-in core data sources are also included in the Grafana documentation: [query-transform-data]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/query-transform-data" [query-transform-data]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/query-transform-data" + +[Plugin-management]: "/docs/grafana/ -> /docs/grafana//administration/plugin-management" +[Plugin-management]: "/docs/grafana-cloud -> /docs/grafana//administration/plugin-management" + +[Grafana-Enterprise]: "/docs/grafana/ -> /docs/grafana//introduction/grafana-enterprise" + {{% /docs/reference %}} diff --git a/docs/sources/getting-started/build-first-dashboard.md b/docs/sources/getting-started/build-first-dashboard.md index 49dda7915a3..fd76142ab5f 100644 --- a/docs/sources/getting-started/build-first-dashboard.md +++ b/docs/sources/getting-started/build-first-dashboard.md @@ -77,7 +77,7 @@ Congratulations, you have created your first dashboard and it's displaying resul #### Next steps -Continue to experiment with what you have built, try the [explore workflow]({{< relref "../explore" >}}) or another visualization feature. Refer to [Data sources]({{< relref "../datasources" >}}) for a list of supported data sources and instructions on how to [add a data source]({{< relref "../administration/data-source-management#add-a-data-source" >}}). The following topics will be of interest to you: +Continue to experiment with what you have built, try the [explore workflow]({{< relref "../explore" >}}) or another visualization feature. Refer to [Data sources]({{< relref "../datasources" >}}) for a list of supported data sources and instructions on how to [add a data source]({{< relref "../datasources#add-a-data-source" >}}). The following topics will be of interest to you: - [Panels and visualizations]({{< relref "../panels-visualizations" >}}) - [Dashboards]({{< relref "../dashboards" >}}) diff --git a/docs/sources/getting-started/get-started-grafana-influxdb.md b/docs/sources/getting-started/get-started-grafana-influxdb.md index c257014ae35..d6a163a1219 100644 --- a/docs/sources/getting-started/get-started-grafana-influxdb.md +++ b/docs/sources/getting-started/get-started-grafana-influxdb.md @@ -38,7 +38,7 @@ Windows users might need to make additional adjustments. Look for special instru You can have more than one InfluxDB data source defined in Grafana. -1. Follow the general instructions to [add a data source]({{< relref "../administration/data-source-management#add-a-data-source" >}}). +1. Follow the general instructions to [add a data source]({{< relref "../datasources#add-a-data-source" >}}). 1. Decide if you will use InfluxQL or Flux as your query language. - [Configure the data source]({{< relref "../datasources/influxdb#configure-the-data-source" >}}) for your chosen query language. Each query language has its own unique data source settings.