544bff2539
* changed tags from oss to enterprise and cloud * added Dashboard Panel example * swapped the all-grafana-umbrella information to the correct page * added minor visibility improvements in steps * made some minor adjustments * added minor improvements * fixed a link * updates links * Apply suggestions from code review thanks for the improved suggestions. looks more better Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * fixed links * fixed Grafana Enterprise link * run prettier * fixed add a data source links --------- Co-authored-by: Chris Moyer <chris.moyer@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
6.8 KiB
| aliases | description | labels | title | weight | |||||
|---|---|---|---|---|---|---|---|---|---|
|
Learn how to build your first InfluxDB dashboard in Grafana. |
|
Get started with Grafana and InfluxDB | 400 |
Get started with Grafana and InfluxDB
{{< docs/shared lookup="influxdb/intro.md" source="grafana" version="" >}}
Get InfluxDB
You can download InfluxDB and install it locally or you can sign up for InfluxDB Cloud. Windows installers are not available for some versions of InfluxDB.
Install other InfluxDB software
Install Telegraf. This tool is an agent that helps you get metrics into InfluxDB. For more information, refer to Telegraf documentation.
If you chose to use InfluxDB Cloud, then you should download and install the InfluxDB Cloud CLI. This tool allows you to send command line instructions to your cloud account. For more information, refer to Influx CLI documentation.
Get data into InfluxDB
If you downloaded and installed InfluxDB on your local machine, then use the Quick Start feature to visualize InfluxDB metrics.
If you are using the cloud account, then the wizards will guide you through the initial process. For more information, refer to Configure Telegraf.
Note for Windows users:
Windows users might need to make additional adjustments. Look for special instructions in the InfluxData documentation and Using Telegraf on Windows blog post. The regular system monitoring template in InfluxDB Cloud is not compatible with Windows. Windows users who use InfluxDB Cloud to monitor their system will need to use the Windows System Monitoring Template.
Add your InfluxDB data source to Grafana
You can have more than one InfluxDB data source defined in Grafana.
- Follow the general instructions to [add a data source]({{< relref "../datasources#add-a-data-source" >}}).
- 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.
- For querying features specific to each language, see the data source's [query editor documentation]({{< relref "../datasources/influxdb/query-editor" >}}).
InfluxDB guides
InfluxDB publishes guidance for connecting different versions of their product to Grafana.
- InfluxDB OSS or Enterprise 1.8+. To turn on Flux, refer to Configure InfluxDB. Select your InfluxDB version in the upper right corner.
- InfluxDB OSS or Enterprise 2.x. Refer to Use Grafana with InfluxDB. Select your InfluxDB version in the upper right corner.
- InfluxDB Cloud. Refer to Use Grafana with InfluxDB Cloud.
Important tips
- Make sure your Grafana token has read access. If it doesn't, then you'll get an authentication error and be unable to connect Grafana to InfluxDB.
- Avoid apostrophes and other non-standard characters in bucket and token names.
- If the text name of the organization or bucket doesn't work, then try the ID number.
- If you change your bucket name in InfluxDB, then you must also change it in Grafana and your Telegraf .conf file as well.
Add a query
This step varies depending on the query language that you selected when you set up your data source in Grafana.
InfluxQL query language
In the query editor, click select measurement.
Grafana displays a list of possible series. Click one to select it, and Grafana graphs any available data. If there is no data to display, then try another selection or check your data source.
Flux query language
Create a simple Flux query.
- [Add a panel]({{< relref "../dashboards/build-dashboards/create-dashboard" >}}).
- In the query editor, select your InfluxDB-Flux data source. For more information, refer to [Queries]({{< relref "../panels-visualizations/query-transform-data" >}}).
- Select the Table visualization.
- In the query editor text field, enter
buckets()and then click outside of the query editor.
This generic query returns a list of buckets.
You can also create Flux queries in the InfluxDB Explore view.
-
In your browser, log in to the InfluxDB native UI (OSS is typically something like http://localhost:8086 or for InfluxDB Cloud use: https://cloud2.influxdata.com).
-
Click Explore to open the Data Explorer.
-
The InfluxDB Data Explorer provides two mechanisms for creating Flux queries: a graphical query editor and a script editor. Using the graphical query editor, create a query. It will look something like this:
-
Click Script Editor to view the text of the query, and then copy all the lines of your Flux code, which will look something like this:
-
In Grafana, [add a panel]({{< relref "../dashboards/build-dashboards/create-dashboard" >}}) and then paste your Flux code into the query editor.
-
Click Apply. Your new panel should be visible with data from your Flux query.
Check InfluxDB metrics in Grafana Explore
In your Grafana instance, go to the [Explore]({{< relref "../explore" >}}) view and build queries to experiment with the metrics you want to monitor. Here you can also debug issues related to collecting metrics.
Start building dashboards
There you go! Use Explore and Data Explorer to experiment with your data, and add the queries that you like to your dashboard as panels. Have fun!
Here are some resources to learn more:
- Grafana documentation: [InfluxDB data source]({{< relref "../datasources/influxdb" >}})
- InfluxDB documentation: Comparison of Flux vs InfluxQL