Visualize data for InfluxDB 3 Core and Enterprise (#5785)

* add grafana for influxdb3 core and enterprise

* add superset docs for monolith

* added tableau to monolith

* mark tableau and superset as draft
pull/5789/head
Scott Anderson 2025-01-17 13:22:23 -07:00 committed by GitHub
parent 895e104ad6
commit c0e3f4941f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
30 changed files with 772 additions and 10 deletions

View File

@ -18,6 +18,8 @@ aliases:
alt_links: alt_links:
v2: /influxdb/v2/tools/grafana/ v2: /influxdb/v2/tools/grafana/
cloud: /influxdb/cloud/tools/grafana/ cloud: /influxdb/cloud/tools/grafana/
core: /influxdb3/core/visualize-data/grafana/
enterprise: /influxdb3/enterprise/visualize-data/grafana/
--- ---
Use [Grafana](https://grafana.com/) to query and visualize data stored in Use [Grafana](https://grafana.com/) to query and visualize data stored in

View File

@ -18,6 +18,9 @@ aliases:
- /influxdb3/cloud-dedicated/process-data/tools/superset/ - /influxdb3/cloud-dedicated/process-data/tools/superset/
related: related:
- /influxdb3/cloud-dedicated/visualize-data/superset/ - /influxdb3/cloud-dedicated/visualize-data/superset/
alt_links:
core: /influxdb3/core/visualize-data/superset/
enterprise: /influxdb3/enterprise/visualize-data/superset/
metadata: [SQL only] metadata: [SQL only]
--- ---
@ -210,7 +213,7 @@ With Superset running, you're ready to [log in](#log-in-to-superset) and set up
3. In the **Connect a Database** window, click on the **Supported Databases** 3. In the **Connect a Database** window, click on the **Supported Databases**
drop-down menu and select **Other**. drop-down menu and select **Other**.
{{< img-hd src="/img/influxdb/cloud-serverless-superset-connect.png" alt="Configure InfluxDB connection in Superset" />}} {{< img-hd src="/img/influxdb3/cloud-serverless-superset-connect.png" alt="Configure InfluxDB connection in Superset" />}}
4. Enter a **Display Name** (for example, _InfluxDB Cloud Dedicated_) for the database connection. 4. Enter a **Display Name** (for example, _InfluxDB Cloud Dedicated_) for the database connection.
5. Enter your **SQL Alchemy URI** comprised of the following: 5. Enter your **SQL Alchemy URI** comprised of the following:
@ -253,7 +256,7 @@ to query and visualize data from InfluxDB.
The measurement schema appears in the left pane: The measurement schema appears in the left pane:
{{< img-hd src="/img/influxdb/cloud-serverless-superset-schema.png" alt="Select your InfluxDB schema in Superset" />}} {{< img-hd src="/img/influxdb3/cloud-serverless-superset-schema.png" alt="Select your InfluxDB schema in Superset" />}}
3. Use the **query editor** to write an SQL query that queries data in your 3. Use the **query editor** to write an SQL query that queries data in your
InfluxDB database. InfluxDB database.
@ -267,4 +270,4 @@ Use Superset to create visualizations and dashboards for InfluxDB queries.
For a comprehensive walk-through of creating visualizations with For a comprehensive walk-through of creating visualizations with
Superset, see the [Creating Charts and Dashboards in Superset documentation](https://superset.apache.org/docs/creating-charts-dashboards/creating-your-first-dashboard). Superset, see the [Creating Charts and Dashboards in Superset documentation](https://superset.apache.org/docs/creating-charts-dashboards/creating-your-first-dashboard).
{{< img-hd src="/img/influxdb/cloud-serverless-superset-dashboard.png" alt="Build InfluxDB dashboards in Apache Superset" />}} {{< img-hd src="/img/influxdb3/cloud-serverless-superset-dashboard.png" alt="Build InfluxDB dashboards in Apache Superset" />}}

View File

@ -16,8 +16,9 @@ aliases:
- /influxdb3/cloud-dedicated/query-data/tools/tableau/ - /influxdb3/cloud-dedicated/query-data/tools/tableau/
- /influxdb3/cloud-dedicated/query-data/sql/execute-queries/tableau/ - /influxdb3/cloud-dedicated/query-data/sql/execute-queries/tableau/
- /influxdb3/cloud-dedicated/process-data/tools/tableau/ - /influxdb3/cloud-dedicated/process-data/tools/tableau/
related: alt_links:
- /influxdb3/cloud-dedicated/visualize-data/tableau/ core: /influxdb3/core/visualize-data/tableau/
enterprise: /influxdb3/enterprise/visualize-data/tableau/
metadata: [SQL only] metadata: [SQL only]
--- ---

View File

@ -19,6 +19,8 @@ aliases:
alt_links: alt_links:
v2: /influxdb/v2/tools/grafana/ v2: /influxdb/v2/tools/grafana/
cloud: /influxdb/cloud/tools/grafana/ cloud: /influxdb/cloud/tools/grafana/
core: /influxdb3/core/visualize-data/grafana/
enterprise: /influxdb3/enterprise/visualize-data/grafana/
--- ---
Use [Grafana](https://grafana.com/) to query and visualize data stored in Use [Grafana](https://grafana.com/) to query and visualize data stored in

View File

@ -14,6 +14,9 @@ aliases:
- /influxdb3/cloud-serverless/query-data/tools/superset/ - /influxdb3/cloud-serverless/query-data/tools/superset/
- /influxdb3/cloud-serverless/query-data/sql/execute-queries/superset/ - /influxdb3/cloud-serverless/query-data/sql/execute-queries/superset/
- /influxdb3/cloud-serverless/process-data/tools/superset/ - /influxdb3/cloud-serverless/process-data/tools/superset/
alt_links:
core: /influxdb3/core/visualize-data/superset/
enterprise: /influxdb3/enterprise/visualize-data/superset/
metadata: [SQL only] metadata: [SQL only]
--- ---

View File

@ -11,6 +11,9 @@ menu:
influxdb3/cloud-serverless/tags: [Flight client, query, flightsql, tableau, sql] influxdb3/cloud-serverless/tags: [Flight client, query, flightsql, tableau, sql]
aliases: aliases:
- /influxdb3/cloud-serverless/query-data/sql/execute-queries/tableau/ - /influxdb3/cloud-serverless/query-data/sql/execute-queries/tableau/
alt_links:
core: /influxdb3/core/visualize-data/tableau/
enterprise: /influxdb3/enterprise/visualize-data/tableau/
metadata: [SQL only] metadata: [SQL only]
--- ---

View File

@ -18,6 +18,8 @@ aliases:
alt_links: alt_links:
v2: /influxdb/v2/tools/grafana/ v2: /influxdb/v2/tools/grafana/
cloud: /influxdb/cloud/tools/grafana/ cloud: /influxdb/cloud/tools/grafana/
core: /influxdb3/core/visualize-data/grafana/
enterprise: /influxdb3/enterprise/visualize-data/grafana/
--- ---
Use [Grafana](https://grafana.com/) to query and visualize data stored in Use [Grafana](https://grafana.com/) to query and visualize data stored in

View File

@ -18,6 +18,9 @@ aliases:
- /influxdb3/clustered/process-data/tools/superset/ - /influxdb3/clustered/process-data/tools/superset/
related: related:
- /influxdb3/clustered/visualize-data/superset/ - /influxdb3/clustered/visualize-data/superset/
alt_links:
core: /influxdb3/core/visualize-data/superset/
enterprise: /influxdb3/enterprise/visualize-data/superset/
metadata: [SQL only] metadata: [SQL only]
--- ---
@ -210,7 +213,7 @@ With Superset running, you're ready to [log in](#log-in-to-superset) and set up
3. In the **Connect a Database** window, click on the **Supported Databases** 3. In the **Connect a Database** window, click on the **Supported Databases**
drop-down menu and select **Other**. drop-down menu and select **Other**.
{{< img-hd src="/img/influxdb/cloud-serverless-superset-connect.png" alt="Configure InfluxDB connection in Superset" />}} {{< img-hd src="/img/influxdb3/cloud-serverless-superset-connect.png" alt="Configure InfluxDB connection in Superset" />}}
4. Enter a **Display Name** (for example, _InfluxDB Clustered_) for the database connection. 4. Enter a **Display Name** (for example, _InfluxDB Clustered_) for the database connection.
5. Enter your **SQL Alchemy URI** comprised of the following: 5. Enter your **SQL Alchemy URI** comprised of the following:
@ -253,7 +256,7 @@ to query and visualize data from InfluxDB.
The measurement schema appears in the left pane: The measurement schema appears in the left pane:
{{< img-hd src="/img/influxdb/cloud-serverless-superset-schema.png" alt="Select your InfluxDB schema in Superset" />}} {{< img-hd src="/img/influxdb3/cloud-serverless-superset-schema.png" alt="Select your InfluxDB schema in Superset" />}}
3. Use the **query editor** to write an SQL query that queries data in your 3. Use the **query editor** to write an SQL query that queries data in your
InfluxDB database. InfluxDB database.
@ -267,4 +270,4 @@ Use Superset to create visualizations and dashboards for InfluxDB queries.
For a comprehensive walk-through of creating visualizations with For a comprehensive walk-through of creating visualizations with
Superset, see the [Creating Charts and Dashboards in Superset documentation](https://superset.apache.org/docs/creating-charts-dashboards/creating-your-first-dashboard). Superset, see the [Creating Charts and Dashboards in Superset documentation](https://superset.apache.org/docs/creating-charts-dashboards/creating-your-first-dashboard).
{{< img-hd src="/img/influxdb/cloud-serverless-superset-dashboard.png" alt="Build InfluxDB dashboards in Apache Superset" />}} {{< img-hd src="/img/influxdb3/cloud-serverless-superset-dashboard.png" alt="Build InfluxDB dashboards in Apache Superset" />}}

View File

@ -16,8 +16,9 @@ aliases:
- /influxdb3/clustered/query-data/tools/tableau/ - /influxdb3/clustered/query-data/tools/tableau/
- /influxdb3/clustered/query-data/sql/execute-queries/tableau/ - /influxdb3/clustered/query-data/sql/execute-queries/tableau/
- /influxdb3/clustered/process-data/tools/tableau/ - /influxdb3/clustered/process-data/tools/tableau/
related: alt_links:
- /influxdb3/clustered/visualize-data/tableau/ core: /influxdb3/core/visualize-data/tableau/
enterprise: /influxdb3/enterprise/visualize-data/tableau/
metadata: [SQL only] metadata: [SQL only]
--- ---

View File

@ -0,0 +1,15 @@
---
title: Visualize data
description: >
Use visualization tools like Grafana, Superset, and others to visualize time
series data stored in InfluxDB 3 Core.
menu: influxdb3_core
weight: 19
related:
- /influxdb3/clustered/query-data/
---
Use visualization tools like Grafana, Superset, and others to visualize time
series data stored in {{< product-name >}}.
{{< children >}}

View File

@ -0,0 +1,25 @@
---
title: Use Grafana to visualize data
list_title: Grafana
description: >
Install and run [Grafana](https://grafana.com/) to query and visualize data
stored in InfluxDB 3 Core.
weight: 101
menu:
influxdb3_core:
name: Grafana
parent: Visualize data
influxdb3/core/tags: [query, visualization]
alt_links:
v1: /influxdb/v1/tools/grafana/
v2: /influxdb/v2/tools/grafana/
cloud: /influxdb/cloud/tools/grafana/
cloud-serverless: /influxdb3/cloud-serverless/process-data/visualize/grafana/
cloud-dedicated: /influxdb3/cloud-dedicated/process-data/visualize/grafana/
clustered: /influxdb3/cloud-clustered/process-data/visualize/grafana/
source: /shared/influxdb3-visualize/grafana.md
---
<!--
The content of this page is at content/shared/influxdb3-visualize/grafana.md
-->

View File

@ -0,0 +1,25 @@
---
title: Use Superset to visualize data
list_title: Superset
description: >
Install and run [Apache Superset](https://superset.apache.org/)
to query and visualize data stored in InfluxDB 3 Core.
weight: 101
menu:
influxdb3_core:
parent: Visualize data
name: Superset
identifier: query-with-superset
influxdb3/core/tags: [Flight client, query, flightsql, superset]
metadata: [SQL only]
alt_links:
cloud-serverless: /influxdb3/cloud-serverless/process-data/visualize/superset/
cloud-dedicated: /influxdb3/cloud-dedicated/process-data/visualize/superset/
clustered: /influxdb3/clustered/process-data/visualize/superset/
draft: true
source: /shared/influxdb3-visualize/superset.md
---
<!--
The content for this page is at content/shared/influxdb3-visualize/superset.md
-->

View File

@ -0,0 +1,27 @@
---
title: Use Tableau to visualize data
list_title: Tableau
description: >
Install and use [Tableau](https://www.tableau.com/) to query and visualize
data stored in InfluxDB 3 Core.
weight: 101
menu:
influxdb3_core:
parent: Visualize data
name: Tableau
influxdb3/core/tags: [Flight client, query, flightsql, tableau, sql]
alt_links:
v1: /influxdb/v1/tools/tableau/
v2: /influxdb/v2/tools/tableau/
cloud: /influxdb/cloud/tools/tableau/
cloud-serverless: /influxdb3/cloud-serverless/process-data/visualize/tableau/
cloud-dedicated: /influxdb3/cloud-dedicated/process-data/visualize/tableau/
clustered: /influxdb3/cloud-clustered/process-data/visualize/tableau/
metadata: [SQL only]
draft: true
source: /shared/influxdb3-visualize/tableau.md
---
<!--
The content of this file is at content/shared/influxdb3-visualize/tableau.md
-->

View File

@ -0,0 +1,15 @@
---
title: Visualize data
description: >
Use visualization tools like Grafana, Superset, and others to visualize time
series data stored in InfluxDB 3 Core.
menu: influxdb3_enterprise
weight: 19
related:
- /influxdb3/enterprise/query-data/
---
Use visualization tools like Grafana, Superset, and others to visualize time
series data stored in {{< product-name >}}.
{{< children >}}

View File

@ -0,0 +1,25 @@
---
title: Use Grafana to visualize data
list_title: Grafana
description: >
Install and run [Grafana](https://grafana.com/) to query and visualize data
stored in InfluxDB 3 Enterprise.
weight: 101
menu:
influxdb3_enterprise:
name: Grafana
parent: Visualize data
influxdb3/enterprise/tags: [query, visualization]
alt_links:
v1: /influxdb/v1/tools/grafana/
v2: /influxdb/v2/tools/grafana/
cloud: /influxdb/cloud/tools/grafana/
cloud-serverless: /influxdb3/cloud-serverless/process-data/visualize/grafana/
cloud-dedicated: /influxdb3/cloud-dedicated/process-data/visualize/grafana/
clustered: /influxdb3/cloud-clustered/process-data/visualize/grafana/
source: /shared/influxdb3-visualize/grafana.md
---
<!--
The content of this page is at content/shared/influxdb3-visualize/grafana.md
-->

View File

@ -0,0 +1,25 @@
---
title: Use Superset to visualize data
list_title: Superset
description: >
Install and run [Apache Superset](https://superset.apache.org/)
to query and visualize data stored in InfluxDB 3 Enterprise.
weight: 101
menu:
influxdb3_enterprise:
parent: Visualize data
name: Superset
identifier: query-with-superset
influxdb3/enterprise/tags: [Flight client, query, flightsql, superset]
metadata: [SQL only]
alt_links:
cloud-serverless: /influxdb3/cloud-serverless/process-data/visualize/superset/
cloud-dedicated: /influxdb3/cloud-dedicated/process-data/visualize/superset/
clustered: /influxdb3/clustered/process-data/visualize/superset/
draft: true
source: /shared/influxdb3-visualize/superset.md
---
<!--
The content for this page is at content/shared/influxdb3-visualize/superset.md
-->

View File

@ -0,0 +1,27 @@
---
title: Use Tableau to visualize data
list_title: Tableau
description: >
Install and use [Tableau](https://www.tableau.com/) to query and visualize
data stored in InfluxDB 3 Enterprise.
weight: 101
menu:
influxdb3_enterprise:
parent: Visualize data
name: Tableau
influxdb3/enterprise/tags: [Flight client, query, flightsql, tableau, sql]
alt_links:
v1: /influxdb/v1/tools/tableau/
v2: /influxdb/v2/tools/tableau/
cloud: /influxdb/cloud/tools/tableau/
cloud-serverless: /influxdb3/cloud-serverless/process-data/visualize/tableau/
cloud-dedicated: /influxdb3/cloud-dedicated/process-data/visualize/tableau/
clustered: /influxdb3/cloud-clustered/process-data/visualize/tableau/
metadata: [SQL only]
draft: true
source: /shared/influxdb3-visualize/tableau.md
---
<!--
The content of this file is at content/shared/influxdb3-visualize/tableau.md
-->

View File

@ -0,0 +1,201 @@
Use [Grafana](https://grafana.com/) to query and visualize data stored in
{{% product-name %}}.
> [Grafana] enables you to query, visualize, alert on, and explore your metrics,
> logs, and traces wherever they are stored.
> [Grafana] provides you with tools to turn your time-series database (TSDB)
> data into insightful graphs and visualizations.
>
> {{% cite %}}-- [Grafana documentation](https://grafana.com/docs/grafana/latest/introduction/){{% /cite %}}
- [Install Grafana or login to Grafana Cloud](#install-grafana-or-login-to-grafana-cloud)
- [InfluxDB data source](#influxdb-data-source)
- [Create an InfluxDB data source](#create-an-influxdb-data-source)
- [Query InfluxDB with Grafana](#query-influxdb-with-grafana)
- [Build visualizations with Grafana](#build-visualizations-with-grafana)
## Install Grafana or login to Grafana Cloud
If using the open source version of **Grafana**, follow the
[Grafana installation instructions](https://grafana.com/docs/grafana/latest/setup-grafana/installation/)
to install Grafana for your operating system.
If using **Grafana Cloud**, login to your Grafana Cloud instance.
## InfluxDB data source
The InfluxDB data source plugin is included in the Grafana core distribution.
Use the plugin to query and visualize data stored in {{< product-name >}} with
both SQL and InfluxQL.
> [!Note]
> #### Grafana 10.3+
>
> The instructions below are for **Grafana 10.3+** which introduced the newest
> version of the InfluxDB core plugin.
> The updated plugin includes **SQL support** for InfluxDB 3-based products such
> as {{< product-name >}}.
## Create an InfluxDB data source
1. In your Grafana user interface (UI), navigate to **Data Sources**.
2. Click **Add new data source**.
3. Search for and select the **InfluxDB** plugin.
4. Provide a name for your data source.
5. Under **Query Language**, select either **SQL** or **InfluxQL**:
{{< tabs-wrapper >}}
{{% tabs %}}
[SQL](#)
[InfluxQL](#)
{{% /tabs %}}
{{% tab-content %}}
<!--------------------------------- BEGIN SQL --------------------------------->
When creating an InfluxDB data source that uses SQL to query data:
1. Under **HTTP**:
- **URL**: Provide your {{% product-name %}} URL:
```
http://{{< influxdb/host >}}
```
> [!Note]
> If you are _not_ using HTTPS, enable the **Insecure Connection** option
> under **InfluxDB Details**.
2. Under **InfluxDB Details**:
- **Database**: Provide a default database name to query.
- **Token**: Provide an arbitrary string.
> [!Note]
> While in alpha, {{< product-name >}} does not require an authorization token.
- **Insecure Connection**: If _not_ using HTTPS, enable this option.
3. Click **Save & test**.
{{< img-hd src="/img/influxdb3/influxdb3-grafana-sql.png" alt="Grafana InfluxDB data source for InfluxDB 3 that uses SQL" />}}
<!---------------------------------- END SQL ---------------------------------->
{{% /tab-content %}}
{{% tab-content %}}
<!------------------------------- BEGIN INFLUXQL ------------------------------>
When creating an InfluxDB data source that uses InfluxQL to query data:
1. Under **HTTP**:
- **URL**: Provide your {{% product-name %}} URL:
```
https://{{< influxdb/host >}}
```
2. Under **InfluxDB Details**:
- **Database**: Provide a default database name to query.
- **User**: Provide an arbitrary string.
_This credential is ignored when querying {{% product-name %}}, but it cannot be empty._
- **Password**: Provide an arbitrary string.
> [!Note]
> While in alpha, {{< product-name >}} does not require an authorization
> token, but the **Password** field does require a value.
- **HTTP Method**: Choose one of the available HTTP request methods to use when querying data:
- **POST** ({{< req text="Recommended" >}})
- **GET**
3. Click **Save & test**.
{{< img-hd src="/img/influxdb3/influxdb3-grafana-influxql.png" alt="Grafana InfluxDB data source for InfluxDB 3 that uses InfluxQL" />}}
<!-------------------------------- END INFLUXQL ------------------------------->
{{% /tab-content %}}
{{< /tabs-wrapper >}}
## Query InfluxDB with Grafana
After you [configure and save an InfluxDB datasource](#create-an-influxdb-data-source),
use Grafana to build, run, and inspect queries against {{< product-name >}}.
{{< tabs-wrapper >}}
{{% tabs %}}
[SQL](#)
[InfluxQL](#)
{{% /tabs %}}
{{% tab-content %}}
<!--------------------------------- BEGIN SQL --------------------------------->
{{% note %}}
{{% sql/sql-schema-intro %}}
To learn more, see [Query Data](/influxdb3/version/query-data/sql/).
{{% /note %}}
1. Click **Explore**.
2. In the dropdown, select the saved InfluxDB data source to query.
3. Use the SQL query form to build your query:
- **Table**: Select the measurement to query.
- **Column**: Select one or more fields and tags to return as columns in query results.
With SQL, select the `time` column to include timestamps with the data.
Grafana relies on the `time` column to correctly graph time series data.
- _**Optional:**_ Toggle **filter** to generate **WHERE** clause statements.
- **WHERE**: Configure condition expressions to include in the `WHERE` clause.
- _**Optional:**_ Toggle **group** to generate **GROUP BY** clause statements.
- **GROUP BY**: Select columns to group by.
If you include an aggregation function in the **SELECT** list,
you must group by one or more of the queried columns.
SQL returns the aggregation for each group.
- {{< req text="Recommended" color="green" >}}:
Toggle **order** to generate **ORDER BY** clause statements.
- **ORDER BY**: Select columns to sort by.
You can sort by time and multiple fields or tags.
To sort in descending order, select **DESC**.
4. {{< req text="Recommended" color="green" >}}: Change format to **Time series**.
- Use the **Format** dropdown to change the format of the query results.
For example, to visualize the query results as a time series, select **Time series**.
5. Click **Run query** to execute the query.
<!---------------------------------- END SQL ---------------------------------->
{{% /tab-content %}}
{{% tab-content %}}
<!------------------------------- BEGIN INFLUXQL ------------------------------>
1. Click **Explore**.
2. In the dropdown, select the **InfluxDB** data source that you want to query.
3. Use the InfluxQL query form to build your query:
- **FROM**: Select the measurement that you want to query.
- **WHERE**: To filter the query results, enter a conditional expression.
- **SELECT**: Select fields to query and an aggregate function to apply to each.
The aggregate function is applied to each time interval defined in the
`GROUP BY` clause.
- **GROUP BY**: By default, Grafana groups data by time to downsample results
and improve query performance.
You can also add other tags to group by.
4. Click **Run query** to execute the query.
<!-------------------------------- END INFLUXQL ------------------------------->
{{% /tab-content %}}
{{< /tabs-wrapper >}}
{{< youtube "rSsouoNsNDs" >}}
To learn about query management and inspection in Grafana, see the
[Grafana Explore documentation](https://grafana.com/docs/grafana/latest/explore/).
## Build visualizations with Grafana
For a comprehensive walk-through of creating visualizations with
Grafana, see the [Grafana documentation](https://grafana.com/docs/grafana/latest/).

View File

@ -0,0 +1,263 @@
Use [Apache Superset](https://superset.apache.org/) to query and visualize data
in {{< product-name >}}.
> Apache Superset is a modern, enterprise-ready business intelligence web application.
> It is fast, lightweight, intuitive, and loaded with options that make it easy for
> users of all skill sets to explore and visualize their data, from simple pie
> charts to highly detailed deck.gl geospatial charts.
>
> {{% cite %}}-- [Apache Superset documentation](https://superset.apache.org/docs/intro){{% /cite %}}
> [!Important]
> **Apache Superset only supports SQL**. You can not use Superset to query
> {{< product-name >}} with InfluxQL.
<!-- TOC -->
- [Set up Docker for Superset and Flight SQL](#set-up-docker-for-superset-and-flight-sql)
- [Install prerequisites](#install-prerequisites)
- [Set up Docker for Superset](#set-up-docker-for-superset)
- [Start the Superset Docker containers](#start-the-superset-docker-containers)
- [Log in to Superset](#log-in-to-superset)
- [Create a database connection for InfluxDB](#create-a-database-connection-for-influxdb)
- [Query InfluxDB with Superset](#query-influxdb-with-superset)
- [Build visualizations with Superset](#build-visualizations-with-superset)
<!-- /TOC -->
## Set up Docker for Superset and Flight SQL
### Install prerequisites
We recommend using **Docker and docker-compose** to run Superset.
To set up Superset to run in Docker containers with Flight SQL, follow these steps:
> [!Warning]
> **Superset** is not officially supported on Windows. For more information about
> running Superset with Windows and Docker, see the
> [Superset documentation](https://superset.apache.org/docs/installation/installing-superset-using-docker-compose#1-install-a-docker-engine-and-docker-compose).
1. Follow the instructions to download and install Docker and docker-compose for your system:
- **macOS**: [Install Docker for macOS](https://docs.docker.com/desktop/install/mac-install/)
- **Linux**: [Install Docker for Linux](https://docs.docker.com/desktop/install/linux-install/)
2. Follow the [Python.org Downloading Python](https://wiki.python.org/moin/BeginnersGuide/Download)
instructions for your system.
3. Once you've installed Python, check that you can run Python and Pip.
Depending on your system, you may need to use the Python version 3 (`python3` and `pip3`) commands.
Enter the following commands into your terminal:
{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[python](#)
[python3](#)
{{% /code-tabs %}}
{{% code-tab-content %}}
```sh
python --version
```
```sh
pip --version
```
{{% /code-tab-content %}}
{{% code-tab-content %}}
```sh
python3 --version
```
```sh
pip3 --version
```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
If neither `pip` nor `pip3` works, follow one of the
[Pypa.io Pip Installation](https://pip.pypa.io/en/stable/installation/)
methods for your system.
3. Use Pip to install the `flightsql-dbapi` library.
{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[pip](#)
[pip3](#)
{{% /code-tabs %}}
{{% code-tab-content %}}
```sh
pip install flightsql-dbapi
```
{{% /code-tab-content %}}
{{% code-tab-content %}}
```sh
pip3 install flightsql-dbapi
```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
The `flightsql-dbapi` library for Python provides a
[DB API 2](https://peps.python.org/pep-0249/) interface and
[SQLAlchemy](https://www.sqlalchemy.org/) dialect for
[Flight SQL](https://arrow.apache.org/docs/format/FlightSql.html).
Later, you'll add `flightsql-dbapi` to Superset's Docker configuration.
> [!Warning]
> The `flightsql-dbapi` library is experimental and under active development.
> The APIs it provides could change at any time.
4. Use Git to clone the Apache Superset repository:
```sh
git clone https://github.com/apache/superset.git
```
The repository contains Superset code and configuration files for running
Superset in Docker containers.
### Set up Docker for Superset
1. Change to your **superset** repository directory:
```sh
cd ./superset
```
2. In your text editor or terminal, create the file `./docker/requirements-local.txt`
and append the line `flightsql-dbapi`--for example:
```sh
cat <<EOF >./docker/requirements-local.txt
flightsql-dbapi
EOF
```
The `./docker/requirements-local.txt` file is used to specify additional
Python packages that Docker should include for Superset.
For more information about Superset's Docker configuration, see
[Getting Started with Superset using Docker](https://github.com/apache/superset/tree/master/docker#readme).
3. Use the `docker-compose pull` command to fetch dependencies for the Docker
containers.
```sh
docker-compose -f docker-compose-non-dev.yml pull
```
The process might take several seconds to complete.
After it completes, you're ready to [Start the Superset Docker containers](#start-the-superset-docker-containers).
## Start the Superset Docker containers
To start the containers and run Superset, enter the `docker-compose up` command
and pass the `-f` flag with the setup file name:
```sh
docker-compose -f docker-compose-non-dev.yml up
```
This might take several seconds to complete.
If successful, the terminal contains output similar to the following:
```sh
superset_init | Init Step 4/4 [Complete] -- Loading examples
superset_init |
superset_init |
superset_init | ######################################################################
superset_init |
superset_init exited with code 0
superset_app | 127.0.0.1 - - [15/Jan/2025:15:14:11 +0000] "GET /health HTTP/1.1" 200 2 "-" "curl/7.74.0"
```
With Superset running, you're ready to [log in](#log-in-to-superset) and set up
a database connection.
## Log in to Superset
1. In a browser, visit [localhost:8088](http://localhost:8088) to log in to the
Superset user interface (UI). If you configured Superset to use a custom
domain, navigate to your custom domain.
2. If this is your first time logging into Superset, use the following username
and password:
- **Username**: admin
- **Password**: admin
3. Optional: Create a new admin user with a unique password.
1. In the Superset UI, click **Settings** and select **List Users**.
2. Click **{{< icon "plus" >}}**.
3. Select the **Admin** role and provide the remaining credentials for the
new user.
4. Click **Save**.
5. Delete the default **admin** users.
## Create a database connection for InfluxDB
1. In the Superset UI, click **Settings** and select **Database Connections**.
2. Click **+ Database** .
3. In the **Connect a Database** window, click on the **Supported Databases**
drop-down menu and select **Other**.
{{< img-hd src="/img/influxdb3/cloud-serverless-superset-connect.png" alt="Configure InfluxDB connection in Superset" />}}
4. Enter a **Display Name** (for example, _{{< product-name >}}_) for the database connection.
5. Enter your **SQL Alchemy URI** comprised of the following:
- **Protocol**: `datafusion+flightsql`
- **Domain**: {{< product-name >}} host (default is `localhost`)
- **Port**: {{< product-name >}} port (default is `8181`)
**Query parameters**
- **`?database`**: URL-encoded InfluxDB database name
- **`?token`**: InfluxDB authorization token
> [!Note]
> While in alpha, {{< product-name >}} does not require an authorization token.
{{< code-callout "&lt;(domain|port|database-name|token)&gt;" >}}
{{< code-callout "localhost|8181|example-database|example-token" >}}
```sh
# Syntax
datafusion+flightsql://<domain>:<port>?database=<database-name>&token=<token>
# Example
datafusion+flightsql://{{< influxdb/host >}}?database=example-database&token=example-token
```
{{< /code-callout >}}
{{< /code-callout >}}
6. Click **Test Connection** to ensure the connection works.
7. Click **Connect** to save the database connection.
## Query InfluxDB with Superset
With a connection to {{< product-name >}} established, you can begin to query
and visualize data.
1. In the Superset UI, click **SQL ▾** in the top navigation bar and select **SQL Lab**.
2. In the left pane:
1. Under **Database**, select your {{< product-name >}} connection.
2. Under **Schema**, select **iox**.
3. Under **See table schema**, select the table to query.
The table schema appears in the left pane:
{{< img-hd src="/img/influxdb3/cloud-serverless-superset-schema.png" alt="Select your InfluxDB schema in Superset" />}}
3. Use the **query editor** to write an SQL query that queries data in your
InfluxDB database.
4. Click **Run** to execute the query.
Query results appear below the query editor.
## Build visualizations with Superset
Use Superset to create visualizations and dashboards for InfluxDB queries.
For a comprehensive walk-through of creating visualizations with
Superset, see the [Creating Charts and Dashboards in Superset documentation](https://superset.apache.org/docs/creating-charts-dashboards/creating-your-first-dashboard).
{{< img-hd src="/img/influxdb3/cloud-serverless-superset-dashboard.png" alt="Build InfluxDB dashboards in Apache Superset" />}}

View File

@ -0,0 +1,94 @@
Use [Tableau](https://www.tableau.com/) to query and visualize time series data
stored in {{< product-name >}}. Tableau supports multiple SQL dialects.
> Tableau is a visual analytics platform transforming the way we use data to
> solve problems—empowering people and organizations to make the most of their data.
>
> {{% cite %}}[tableau.com](https://www.tableau.com/why-tableau/what-is-tableau){{% /cite %}}
> [!Note]
> #### Tableau Desktop
>
> These instructions are for **[Tableau Desktop](https://www.tableau.com/trial/tableau-software)**.
> Tableau Cloud and other Tableau products have not been tested, but may support
> connecting to {{< product-name >}} through the **Flight SQL JDBC driver**.
## Install Tableau Desktop
If you have not already, [download and install Tableau Desktop](https://www.tableau.com/products/desktop/download).
## Download and install the Flight SQL JDBC driver
To query {{< product-name >}} from Tableau, use the **Flight SQL protocol** and
the **Flight SQL JDBC driver**.
1. **Download the Flight SQL JDBC driver.**
1. Visit the [Flight SQL JDBC driver](https://central.sonatype.com/artifact/org.apache.arrow/flight-sql-jdbc-driver/) page.
2. Select the **Versions** tab.
3. Click **Browse {{< icon "export" >}}** next to the version you want to
download.
4. Click the `flight-sql-jdbc-driver-XX.XX.XX.jar` file
(with only the `.jar` file extension) from the list of files
to download the driver jar file.
The version number in the file name is specific to the version you selected.
2. **Copy the downloaded jar file into the following directory based on your operating system.**
- **Windows**: `C:\Program Files\Tableau\Drivers`
- **Mac**: `~/Library/Tableau/Drivers`
- **Linux**: `/opt/tableau/tableau_driver/jdbc`
3. **Start or restart Tableau.**
## Configure a JDBC server connection
1. Open Tableau
2. In the **Connect** column, under **To a Server**, select **Other Databases (JDBC)**.
If that option isn't in the initial list, select **More...** to find it in
the full list of connection options.
3. Provide the required credentials:
- **URL**: Your **InfluxDB cluster URL** with the following:
- **Protocol**: `jdbc:arrow-flight-sql`
- **Port**: `443`
- **Query parameters**:
- **useSystemTrustStore**: `false`
{{% note %}}
Setting `useSystemTrustStore=false` is only necessary on macOS and doesn't actually affect the security of the connection to Tableau.
{{% /note %}}
- **database**: InfluxDB database name to query
_See an [example connection URL](#example-connection-url)._
- **Dialect**: PostgreSQL
- **Username**: _Leave empty_
- **Password**: _Leave empty_
> [!Note]
> While in alpha, {{< product-name >}} does not require authorization tokens.
- **Properties File**: _Leave empty_
4. Click **Sign In**.
#### Example connection URL
{{< code-placeholders "DATABASE_NAME" >}}
```
jdbc:arrow-flight-sql://{{< influxdb/host >}}?useSystemTrustStore=false&database=DATABASE_NAME
```
{{< /code-placeholders >}}
## Query InfluxDB
With the connection successfully established, query your time series data stored
in {{< product-name >}}. In the left pane:
1. Under **Database**, select **public** from the drop-down menu.
2. Under **Schema**, select **iox** from the drop-down menu.
3. Under **Table**, click and drag the table you want to query into the query pane.
4. Use Tableau to build and execute SQL queries.
For more information, see the
[Tableau Desktop documentation](https://help.tableau.com/current/pro/desktop/en-us/default.htm).

View File

Before

Width:  |  Height:  |  Size: 846 KiB

After

Width:  |  Height:  |  Size: 846 KiB

View File

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 48 KiB

View File

Before

Width:  |  Height:  |  Size: 113 KiB

After

Width:  |  Height:  |  Size: 113 KiB

View File

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB

View File

Before

Width:  |  Height:  |  Size: 67 KiB

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 107 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB