From 6a90067fb8a11c136039d1c68c1fbca7e9b0fdee Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 6 Oct 2025 16:19:43 -0500 Subject: [PATCH] docs(grafana): add Grafana Cloud private data source guidance Add note to all Grafana integration pages about using Grafana Cloud with local InfluxDB instances. The note recommends running Grafana locally to avoid exposing databases to the internet, and provides information about configuring Grafana Cloud private data sources as an alternative. Updated files: - content/shared/v3-process-data/visualize/grafana.md - content/shared/influxdb-v2/tools/grafana.md - content/influxdb/v1/tools/grafana.md - content/enterprise_influxdb/v1/tools/grafana.md --- .../enterprise_influxdb/v1/tools/grafana.md | 11 +++++++ content/influxdb/v1/tools/grafana.md | 11 +++++++ content/shared/influxdb-v2/tools/grafana.md | 13 ++++++++ .../v3-process-data/visualize/grafana.md | 30 +++++++++++++++++-- 4 files changed, 63 insertions(+), 2 deletions(-) diff --git a/content/enterprise_influxdb/v1/tools/grafana.md b/content/enterprise_influxdb/v1/tools/grafana.md index e65ca04b6..67df7b97e 100644 --- a/content/enterprise_influxdb/v1/tools/grafana.md +++ b/content/enterprise_influxdb/v1/tools/grafana.md @@ -44,6 +44,17 @@ to visualize data from your **InfluxDB Enterprise** cluster. [start Grafana](https://grafana.com/docs/grafana/latest/installation/) and visit in your browser. +> [!Note] +> #### Using Grafana Cloud with a local InfluxDB instance +> +> If you need to keep your database local, consider running Grafana locally instead of using Grafana Cloud, +> as this avoids the need to expose your database to the internet. +> +> To use InfluxDB running on your private network with Grafana Cloud, you must +> [configure a private data source](https://grafana.com/docs/grafana-cloud/data-sources/private-data-sources/). +> See the Grafana documentation for instructions on configuring a Grafana Cloud private data source +> with {{% product-name %}} running on `http://localhost:8086`. + > [!Note] > #### Query language support > - InfluxQL is supported in InfluxDB Enterprise v1.8.x and later. diff --git a/content/influxdb/v1/tools/grafana.md b/content/influxdb/v1/tools/grafana.md index e952452ea..e97db18f1 100644 --- a/content/influxdb/v1/tools/grafana.md +++ b/content/influxdb/v1/tools/grafana.md @@ -45,6 +45,17 @@ to visualize data from your **InfluxDB v1.11** instance. [start Grafana](https://grafana.com/docs/grafana/latest/installation/) and visit in your browser. +> [!Note] +> #### Using Grafana Cloud with a local InfluxDB instance +> +> If you need to keep your database local, consider running Grafana locally instead of using Grafana Cloud, +> as this avoids the need to expose your database to the internet. +> +> To use InfluxDB running on your private network with Grafana Cloud, you must +> [configure a private data source](https://grafana.com/docs/grafana-cloud/data-sources/private-data-sources/). +> See the Grafana documentation for instructions on configuring a Grafana Cloud private data source +> with {{% product-name %}} running on `http://localhost:8086`. + > [!Note] > SQL is only supported in InfluxDB 3. > For more information, see how to [get started with InfluxDB 3 Core](/influxdb3/core/get-started/). diff --git a/content/shared/influxdb-v2/tools/grafana.md b/content/shared/influxdb-v2/tools/grafana.md index d119d6ed4..75ee6d511 100644 --- a/content/shared/influxdb-v2/tools/grafana.md +++ b/content/shared/influxdb-v2/tools/grafana.md @@ -20,6 +20,19 @@ to visualize data from your **InfluxDB {{< current-version >}}** instance. [start Grafana](https://grafana.com/docs/grafana/latest/installation/) and visit in your browser. +{{% show-in "v2" %}} +> [!Note] +> #### Using Grafana Cloud with a local InfluxDB instance +> +> If you need to keep your database local, consider running Grafana locally instead of using Grafana Cloud, +> as this avoids the need to expose your database to the internet. +> +> To use InfluxDB running on your private network with Grafana Cloud, you must +> [configure a private data source](https://grafana.com/docs/grafana-cloud/data-sources/private-data-sources/). +> See the Grafana documentation for instructions on configuring a Grafana Cloud private data source +> with {{% product-name %}} running on `http://localhost:8086`. +{{% /show-in %}} + > [!Note] > SQL is only supported in InfluxDB 3. > {{% show-in "v2" %}}For more information, see how to [get-started with InfluxDB 3 Core](/influxdb3/core/get-started/).{{% /show-in %}}{{% show-in "cloud" %}}For more information, see how to upgrade to [InfluxDB Cloud Serverless](/influxdb/cloud/upgrade/v2-to-cloud/).{{% /show-in %}} diff --git a/content/shared/v3-process-data/visualize/grafana.md b/content/shared/v3-process-data/visualize/grafana.md index 53884a62f..360423669 100644 --- a/content/shared/v3-process-data/visualize/grafana.md +++ b/content/shared/v3-process-data/visualize/grafana.md @@ -25,6 +25,32 @@ If using the open source version of **Grafana**, follow the to install Grafana for your operating system. If using **Grafana Cloud**, log in to your Grafana Cloud instance. +{{% show-in "core,enterprise" %}} +> [!Note] +> #### Using Grafana Cloud with a local InfluxDB instance +> +> If you need to keep your database local, consider running Grafana locally instead of using Grafana Cloud, +> as this avoids the need to expose your database to the internet. +> +> To use InfluxDB running on your private network with Grafana Cloud, you must +> [configure a private data source](https://grafana.com/docs/grafana-cloud/data-sources/private-data-sources/). +> See the Grafana documentation for instructions on configuring a Grafana Cloud private data source +> with {{% product-name %}} running on `http://localhost:8181`. +{{% /show-in %}} + +{{% show-in "clustered" %}} +> [!Note] +> #### Using Grafana Cloud with a local InfluxDB instance +> +> If you need to keep your database local, consider running Grafana locally instead of using Grafana Cloud, +> as this avoids the need to expose your database to the internet. +> +> To use InfluxDB running on your private network with Grafana Cloud, you must +> [configure a private data source](https://grafana.com/docs/grafana-cloud/data-sources/private-data-sources/). +> See the Grafana documentation for instructions on configuring a Grafana Cloud private data source +> with {{% product-name %}} running on `http://localhost`. +{{% /show-in %}} + ## InfluxDB data source The InfluxDB data source plugin is included in the Grafana core distribution. @@ -50,7 +76,7 @@ both SQL and InfluxQL. | Configuration | Value | |:------------- |:----- | -| **Product selection** | {{% hide-in "core,enterprise" %}}**{{% product-name %}}**{{% /hide-in %}}{{% show-in "core" %}}**InfluxDB Core 3.x**{{% /show-in %}}{{% show-in "enterprise" %}}**InfluxDB Enterprise 3.x**{{% /show-in %}} | +| **Product selection** | {{% hide-in "core,enterprise" %}}**{{% product-name %}}**{{% /hide-in %}}{{% show-in "core" %}}**InfluxDB Enterprise 3.x** _(currently, no **Core** menu option)_{{% /show-in %}}{{% show-in "enterprise" %}}**InfluxDB Enterprise 3.x**{{% /show-in %}} | | **URL** | {{% show-in "cloud-dedicated,clustered" %}} Cluster URL{{% /show-in %}}{{% show-in "cloud-serverless" %}} [Region URL](/influxdb3/cloud-serverless/reference/regions/)--for example, `https://us-west-2-1.aws.cloud2.influxdata.com`{{% /show-in %}}{{% show-in "core,enterprise" %}}Server URL{{% /show-in %}}{{% hide-in "cloud-serverless" %}}--for example, `https://{{< influxdb/host >}}`{{% /hide-in %}} | | **Query languages** | SQL (requires HTTP/2), InfluxQL | | **Authentication** | {{% show-in "cloud-serverless" %}}Required (API token){{% /show-in %}}{{% show-in "core" %}}Admin token (if authentication is enabled){{% /show-in %}}{{% show-in "enterprise" %}}Admin or database token (if authentication is enabled){{% /show-in %}}{{% show-in "cloud-dedicated, clustered" %}}Required (database token){{% /show-in %}} | @@ -66,7 +92,7 @@ both SQL and InfluxQL. - **Name**: A descriptive name for your data source - **URL**: Your {{% product-name %}}{{% show-in "cloud-dedicated,clustered" %}} cluster URL{{% /show-in %}}{{% show-in "cloud-serverless" %}} [region URL](/influxdb3/cloud-serverless/reference/regions/)--for example, `https://us-west-2-1.aws.cloud2.influxdata.com`{{% /show-in %}}{{% show-in "core,enterprise" %}} server URL{{% /show-in %}}{{% hide-in "cloud-serverless" %}}--for example, `https://{{< influxdb/host >}}`{{% /hide-in %}} - - **Product**: From the dropdown, select {{% hide-in "core,enterprise" %}}**{{% product-name %}}**{{% /hide-in %}}{{% show-in "core" %}}**InfluxDB Core 3.x**{{% /show-in %}}{{% show-in "enterprise" %}}**InfluxDB Enterprise 3.x**{{% /show-in %}} + - **Product**: From the dropdown, select {{% hide-in "core,enterprise" %}}**{{% product-name %}}**{{% /hide-in %}}{{% show-in "core" %}}**InfluxDB Enterprise 3.x** _(currently, no **Core** menu option)_{{% /show-in %}}{{% show-in "core,enterprise" %}}**InfluxDB Enterprise 3.x**{{% /show-in %}} - **Query Language**: Select **SQL** or **InfluxQL** ### Configure database settings