D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
proc
/
self
/
root
/
usr
/
share
/
grafana
/
docs
/
sources
/
datasources
/
influxdb
/
query-editor
/
Filename :
index.md
back
Copy
--- aliases: - ../../data-sources/influxdb/query-editor/ - influxdb-flux/ description: Guide for Flux in Grafana labels: products: - cloud - enterprise - oss title: Flux support in Grafana weight: 200 --- # InfluxDB query editor This topic explains querying specific to the InfluxDB data source. For general documentation on querying data sources in Grafana, see [Query and transform data][query-transform-data]. ## Choose a query editing mode The InfluxDB data source's query editor has two modes depending on your choice of query language in the [data source configuration]({{< relref "../#configure-the-data-source" >}}): - [InfluxQL](#influxql-query-editor) - [Flux](#flux-query-editor) You also use the query editor to retrieve [log data](#query-logs) and [annotate](#apply-annotations) visualizations. ## InfluxQL query editor The InfluxQL query editor helps you select metrics and tags to create InfluxQL queries. **To enter edit mode:** 1. Hover over any part of the panel to display the actions menu on the top right corner. 1. Click the menu and select **Edit**.  ### Filter data (WHERE) To add a tag filter, click the plus icon to the right of the `WHERE` condition. To remove tag filters, click the tag key, then select **--remove tag filter--**. #### Match by regular expressions You can enter regular expressions for metric names or tag filter values. Wrap the regex pattern in forward slashes (`/`). Grafana automatically adjusts the filter tag condition to use the InfluxDB regex match condition operator (`=~`). ### Field and aggregation functions In the `SELECT` row, you can specify which fields and functions to use. If you have a group by time, you must have an aggregation function. Some functions like `derivative` also require an aggregation function. The editor helps you build this part of the query. For example:  This query editor input generates an InfluxDB `SELECT` clause: ```sql SELECT derivative(mean("value"), 10s) /10 AS "REQ/s" FROM .... ``` **To select multiple fields:** 1. Click the plus button. 1. Select **Field > field** to add another `SELECT` clause. You can also `SELECT` an asterisk (`*`) to select all fields. ### Group query results To group results by a tag, define it in a "Group By". **To group by a tag:** 1. Click the plus icon at the end of the GROUP BY row. 1. Select a tag from the dropdown that appears. **To remove the "Group By":** 1. Click the tag. 1. Click the "x" icon. ### Text editor mode (RAW) You can write raw InfluxQL queries by switching the editor mode. However, be careful when writing queries manually. If you use raw query mode, your query _must_ include at least `WHERE $timeFilter`. Also, _always_ provide a group by time and an aggregation function. Otherwise, InfluxDB can easily return hundreds of thousands of data points that can hang your browser. **To switch to raw query mode:** 1. Click the hamburger icon. 1. Toggle **Switch editor mode**. ### Alias patterns | Alias pattern | Replaced with | | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `$m` | Measurement name. | | `$measurement` | Measurement name. | | `$1` - `$9` | Part of measurement name (if you separate your measurement name with dots). | | `$col` | Column name. | | `$tag_exampletag` | The value of the `exampletag` tag. The syntax is `$tag*yourTagName` and must start with `$tag*`. To use your tag as an alias in the ALIAS BY field, you must use the tag to group by in the query. | You can also use `[[tag_hostname]]` pattern replacement syntax. For example, entering the value `Host: [[tag_hostname]]` in the ALIAS BY field replaces it with the `hostname` tag value for each legend value. An example legend value would be `Host: server1`. ## Flux query editor Grafana supports Flux when running InfluxDB v1.8 and higher. If your data source is [configured for Flux]({{< relref "./#configure-the-data-source" >}}), you can use the [Flux query and scripting language](https://www.influxdata.com/products/flux/) in the query editor, which serves as a text editor for raw Flux queries with macro support. For more information and connection details, refer to [1.8 compatibility](https://github.com/influxdata/influxdb-client-go/#influxdb-18-api-compatibility). ### Use macros You can enter macros in the query to replace them with values from Grafana's context. Macros support copying and pasting from [Chronograf](https://www.influxdata.com/time-series-platform/chronograf/). | Macro example | Replaced with | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `v.timeRangeStart` | The start of the currently active time selection, such as `2020-06-11T13:31:00Z`. | | `v.timeRangeStop` | The end of the currently active time selection, such as `2020-06-11T14:31:00Z`. | | `v.windowPeriod` | An interval string compatible with Flux that corresponds to Grafana's calculated interval based on the time range of the active time selection, such as `5s`. | | `v.defaultBucket` | The data source configuration's "Default Bucket" setting. | | `v.organization` | The data source configuration's "Organization" setting. | For example, the query editor interpolates this query: ```flux from(bucket: v.defaultBucket) |> range(start: v.timeRangeStart, stop: v.timeRangeStop) |> filter(fn: (r) => r["_measurement"] == "cpu" or r["_measurement"] == "swap") |> filter(fn: (r) => r["_field"] == "usage_system" or r["_field"] == "free") |> aggregateWindow(every: v.windowPeriod, fn: mean) |> yield(name: "mean") ``` Into this query to send to InfluxDB, with interval and time period values changing according to the active time selection: ```flux from(bucket: "grafana") |> range(start: 2020-06-11T13:59:07Z, stop: 2020-06-11T14:59:07Z) |> filter(fn: (r) => r["_measurement"] == "cpu" or r["_measurement"] == "swap") |> filter(fn: (r) => r["_field"] == "usage_system" or r["_field"] == "free") |> aggregateWindow(every: 2s, fn: mean) |> yield(name: "mean") ``` To view the interpolated version of a query with the query inspector, refer to [Panel Inspector][panel-inspector]. ## Query logs You can query and display log data from InfluxDB in [Explore][explore] and with the [Logs panel][logs] for dashboards. Select the InfluxDB data source, then enter a query to display your logs. ### Create log queries The Logs Explorer next to the query field, accessed by the **Measurements/Fields** button, lists measurements and fields. Choose the desired measurement that contains your log data, then choose which field to use to display the log message. Once InfluxDB returns the result, the log panel lists log rows and displays a bar chart, where the x axis represents the time and the y axis represents the frequency/count. ### Filter search To add a filter, click the plus icon to the right of the **Measurements/Fields** button, or next to a condition. To remove tag filters, click the first select, then choose **--remove filter--**. ## Apply annotations [Annotations][annotate-visualizations] overlay rich event information on top of graphs. You can add annotation queries in the Dashboard menu's Annotations view. For InfluxDB, your query **must** include `WHERE $timeFilter`. If you select only one column, you don't need to enter anything in the column mapping fields. The **Tags** field's value can be a comma-separated string. ### Annotation query example ```sql SELECT title, description from events WHERE $timeFilter ORDER BY time ASC ``` {{% docs/reference %}} [annotate-visualizations]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/dashboards/build-dashboards/annotate-visualizations" [annotate-visualizations]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/dashboards/build-dashboards/annotate-visualizations" [explore]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/explore" [explore]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/explore" [logs]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/panels-visualizations/visualizations/logs" [logs]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/panels-visualizations/visualizations/logs" [panel-inspector]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/panels-visualizations/panel-inspector" [panel-inspector]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/panels-visualizations/panel-inspector" [query-transform-data]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/panels-visualizations/query-transform-data" [query-transform-data]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/panels-visualizations/query-transform-data" {{% /docs/reference %}}