mirror of https://github.com/grafana/grafana
[release-11.5.3] Docs: Overhaul of PostgreSQL data source documentation (#101176)
Docs: Overhaul of PostgreSQL data source documenation (#99908)
* created new topic docs
* added info to config doc
* updates to config doc
* updates to config doc
* finished config doc
* updated Query editor doc
* final edits
* rename, ref URI work
* a few more updates prior to PR issue
* fixed the double Macros heading issue
* final edits and cleanup
* edits based on feedback
* ran prettier
* added updates
* updates based on feedback
* vale linter issues
* more vale linting issues addressed
* small addition on main page
* ran prettier again
* changed title
* Update docs/sources/datasources/postgres/query-editor/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/datasources/postgres/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/datasources/postgres/configure/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/datasources/postgres/configure/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/datasources/postgres/query-editor/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/datasources/postgres/configure/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/datasources/postgres/configure/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/datasources/postgres/configure/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* changed Grafana's
* added changes
* Update docs/sources/datasources/postgres/query-editor/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/datasources/postgres/query-editor/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/datasources/postgres/query-editor/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/datasources/postgres/query-editor/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/datasources/postgres/query-editor/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* ran prettier again
* Remove aliases
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix link
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Put code in `code`
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Avoid bold for emphasis
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix link
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Irene Rodríguez <irene.rodriguez@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
(cherry picked from commit 9780a9c49f)
pull/101158/head
Larissa Wandzura
11 months ago
committed by
GitHub
parent
61fbc0310f
commit
3c71bd0a5c
@ -0,0 +1,194 @@ |
||||
--- |
||||
description: This document provides instructions for configuring the PostgreSQL data source. |
||||
keywords: |
||||
- grafana |
||||
- postgresql |
||||
- guide |
||||
labels: |
||||
products: |
||||
- cloud |
||||
- enterprise |
||||
- oss |
||||
menuTitle: Configure the PostgreSQL data source |
||||
title: Configure the PostgreSQL data source |
||||
weight: 10 |
||||
refs: |
||||
provisioning-data-sources: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/administration/provisioning/#datasources |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/administration/provisioning/#datasources |
||||
variables: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/variables/ |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/variables/ |
||||
add-template-variables-interval-ms: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/variables/add-template-variables/#__interval_ms |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/variables/add-template-variables/#__interval_ms |
||||
add-template-variables-interval: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/variables/add-template-variables/#__interval |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/variables/add-template-variables/#__interval |
||||
data-source-management: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/administration/data-source-management/ |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/administration/data-source-management/ |
||||
variable-syntax-advanced-variable-format-options: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/variables/variable-syntax/#advanced-variable-format-options |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/variables/variable-syntax/#advanced-variable-format-options |
||||
--- |
||||
|
||||
# Configure the PostgreSQL data source |
||||
|
||||
This document provides instructions for configuring the PostgreSQL data source and explains available configuration options. For general information on managing data sources refer to [Data source management](ref:data-source-management). |
||||
|
||||
## Before you begin |
||||
|
||||
You must have the `Organization administrator` role to configure the Postgres data source. |
||||
Organization administrators can also [configure the data source via YAML](#provision-the-data-source) with the Grafana provisioning system. |
||||
|
||||
Grafana comes with a built-in PostgreSQL data source plugin, eliminating the need to install a plugin. |
||||
|
||||
{{< admonition type="note" >}} |
||||
When adding a data source, the database user you specify should have only `SELECT` permissions on the relevant database and tables. Grafana does not validate the safety of queries, which means they can include potentially harmful SQL statements, such as `USE otherdb;` or `DROP TABLE user;`, that could be executed. To mitigate this risk, Grafana strongly recommends creating a dedicated PostgreSQL user with restricted permissions. |
||||
{{< /admonition >}} |
||||
|
||||
Example: |
||||
|
||||
```sql |
||||
CREATE USER grafanareader WITH PASSWORD 'password'; |
||||
GRANT USAGE ON SCHEMA schema TO grafanareader; |
||||
GRANT SELECT ON schema.table TO grafanareader; |
||||
``` |
||||
|
||||
## Add the PostgreSQL data source |
||||
|
||||
Complete the following steps to set up a new PostgreSQL data source: |
||||
|
||||
1. Click **Connections** in the left-side menu. |
||||
1. Click **Add new connection** |
||||
1. Type `PostgreSQL` in the search bar. |
||||
1. Select the **PostgreSQL data source**. |
||||
1. Click **Add new data source** in the upper right. |
||||
|
||||
You are taken to the **Settings** tab where you will configure the data source. |
||||
|
||||
## PostgreSQL configuration options |
||||
|
||||
Following is a list of PostgreSQL configuration options: |
||||
|
||||
- **Name** - Sets the name you use to refer to the data source in panels and queries. Examples: `PostgreSQL-DB-1`. |
||||
- **Default** - Toggle to set this specific PostgreSQL data source as the default pre-selected data source in panels and visualizations. |
||||
|
||||
**Connection section:** |
||||
|
||||
- **Host URL** - The IP address/hostname and optional port of your PostgreSQL instance. |
||||
- **Database name** - The name of your PostgreSQL database. |
||||
|
||||
**Authentication section:** |
||||
|
||||
- **Username** - Enter the username used to connect to your PostgreSQL database. |
||||
- **Password** - Enter the password used to connect to the PostgreSQL database. |
||||
- **TLS/SSL Mode** - Determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the server. When **TLS/SSL Mode** is disabled, **TLS/SSL Method** and **TLS/SSL Auth Details** aren't visible options. |
||||
- **TLS/SSL Method** - Determines how TLS/SSL certificates are configured. |
||||
- **File system path** - This option allows you to configure certificates by specifying paths to existing certificates on the local file system where Grafana is running. Ensure this file is readable by the user executing the Grafana process. |
||||
- **Certificate content** - This option allows you to configure certificate by specifying their content. The content is stored and encrypted in the Grafana database. When connecting to the database, the certificates are saved as files, on the local filesystem, in the Grafana data path. |
||||
|
||||
**TLS/SSL Auth Details** |
||||
|
||||
If you select the TLS/SSL Mode options **require**, **verify-ca** or **verify-full** and **file system path** the following are required: |
||||
|
||||
- **TLS/SSL Root Certificate** - Specify the path to the root certificate file. |
||||
- **TLS/SSL Client Certificate** - Specify the path to the client certificate and ensure the file is accessible to the user running the Grafana process. |
||||
- **TLS/SSL Client Key** - Specify the path to the client key file and ensure the file is accessible to the user running the Grafana process. |
||||
|
||||
If you select the TLS/SSL Mode option **require** and TLS/SSL Method certificate content the following are required: |
||||
|
||||
- **TLS/SSL Client Certificate** - Provide the client certificate. |
||||
- **TLS/SSL Client Key** - Provide the client key. |
||||
|
||||
If you select the TLS/SSL Mode options **verify-ca** or **verify-full** with the TLS/SSL Method certificate content the following are required: |
||||
|
||||
- **TLS/SSL Client Certificate** - Provide the client certificate. |
||||
- **TLS/SSL Root Certificate** - Provide the root certificate. |
||||
- **TLS/SSL Client Key** - Provide the client key. |
||||
|
||||
**PostgreSQL Options:** |
||||
|
||||
- **Version** - Determines which functions are available in the query builder. The default is the current version. |
||||
- **Min time interval** - Defines a lower limit for the auto group by by time interval. Grafana recommends aligning this setting with the data write frequency. For example, set it to `1m` if your data is written every minute. Refer to [Min time interval](#min-time-interval) for format examples. |
||||
- **TimescaleDB** - A time-series database built as a PostgreSQL extension. When enabled, Grafana uses `time_bucket` in the `$__timeGroup` macro to display TimescaleDB specific aggregate functions in the query builder. For more information, refer to [TimescaleDB documentation](https://docs.timescale.com/timescaledb/latest/tutorials/grafana/grafana-timescalecloud/#connect-timescaledb-and-grafana). |
||||
|
||||
**Connection limits:** |
||||
|
||||
- **Max open** - The maximum number of open connections to the database. The default `100`. |
||||
- **Auto max idle** - Toggle to set the maximum number of idle connections to the number of maximum open connections. This setting is toggled on by default. |
||||
- **Max idle** - The maximum number of connections in the idle connection pool. The default `100`. |
||||
- **Max lifetime** - The maximum amount of time in seconds a connection may be reused. The default is `14400`, or 4 hours. |
||||
|
||||
**Private data source connect** - _Only for Grafana Cloud users._ Private data source connect, or PDC, allows you to establish a private, secured connection between a Grafana Cloud instance, or stack, and data sources secured within a private network. Click the drop-down to locate the URL for PDC. For more information regarding Grafana PDC refer to [Private data source connect (PDC)](https://grafana.com/docs/grafana-cloud/connect-externally-hosted/private-data-source-connect/). |
||||
|
||||
Click **Manage private data source connect** to be taken to your PDC connection page, where you’ll find your PDC configuration details. |
||||
|
||||
After you have added your PostgreSQL connection settings, click **Save & test** to test and save the data source connection. |
||||
|
||||
### Min time interval |
||||
|
||||
The **Min time interval** setting defines a lower limit for the [`$__interval`](ref:add-template-variables-interval) and [`$__interval_ms`](ref:add-template-variables-interval-ms) variables. |
||||
|
||||
This option can also be configured or overridden in the dashboard panel under the data source settings. |
||||
|
||||
This value must be formatted as a number followed by a valid time identifier: |
||||
|
||||
| Identifier | Description | |
||||
| ---------- | ----------- | |
||||
| `y` | year | |
||||
| `M` | month | |
||||
| `w` | week | |
||||
| `d` | day | |
||||
| `h` | hour | |
||||
| `m` | minute | |
||||
| `s` | second | |
||||
| `ms` | millisecond | |
||||
|
||||
## Provision the data source |
||||
|
||||
You can define and configure the data source in YAML files with [provisioning](/docs/grafana/<GRAFANA_VERSION>/administration/provisioning/#data-sources). |
||||
For more information about provisioning, and available configuration options, refer to [Provision Grafana](ref:provisioning-data-sources). |
||||
|
||||
### PostgreSQL provisioning example |
||||
|
||||
```yaml |
||||
apiVersion: 1 |
||||
|
||||
datasources: |
||||
- name: Postgres |
||||
type: postgres |
||||
url: localhost:5432 |
||||
user: grafana |
||||
secureJsonData: |
||||
password: 'Password!' |
||||
jsonData: |
||||
database: grafana |
||||
sslmode: 'disable' # disable/require/verify-ca/verify-full |
||||
maxOpenConns: 100 |
||||
maxIdleConns: 100 |
||||
maxIdleConnsAuto: true |
||||
connMaxLifetime: 14400 |
||||
postgresVersion: 903 # 903=9.3, 904=9.4, 905=9.5, 906=9.6, 1000=10 |
||||
timescaledb: false |
||||
``` |
||||
|
||||
#### Troubleshoot provisioning issues |
||||
|
||||
If you encounter metric request errors or other issues: |
||||
|
||||
- Ensure that the parameters in your data source YAML file precisely match the example provided, including parameter names and the correct use of quotation marks. |
||||
- Verify that the database name _isn't_ included in the URL. |
||||
@ -0,0 +1,410 @@ |
||||
--- |
||||
description: This document describes the PostgreSQL query editor in Grafana. |
||||
keywords: |
||||
- grafana |
||||
- postgresql |
||||
- guide |
||||
labels: |
||||
products: |
||||
- cloud |
||||
- enterprise |
||||
- oss |
||||
menuTitle: PostgreSQL query editor |
||||
title: PostgreSQL query editor |
||||
weight: 20 |
||||
refs: |
||||
variables: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/variables/ |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/variables/ |
||||
add-template-variables-interval: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/variables/add-template-variables/#__interval |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/variables/add-template-variables/#__interval |
||||
explore: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/explore/ |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/explore/ |
||||
query-transform-data: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/panels-visualizations/query-transform-data/ |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana-cloud/visualizations/panels-visualizations/query-transform-data/ |
||||
query-editor: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/panels-visualizations/query-transform-data/#query-editors |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana-cloud/visualizations/panels-visualizations/query-transform-data/#query-editors |
||||
alert-rules: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/fundamentals/alert-rules/ |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana-cloud/alerting-and-irm/alerting/alerting-rules/ |
||||
template-annotations-and-labels: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/alerting-rules/templates/ |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana-cloud/alerting-and-irm/alerting/alerting-rules/templates/ |
||||
templates: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/variables/#templates |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana-cloud/visualizations/dashboards/variables/#templates |
||||
--- |
||||
|
||||
# PostgreSQL query editor |
||||
|
||||
Grafana query editors are unique for each data source. |
||||
|
||||
For general information on Grafana query editors, refer to [Query editors](ref:query-editor). |
||||
|
||||
For general information on querying data sources in Grafana, refer to [Query and transform data](ref:query-transform-data). |
||||
|
||||
The PostgreSQL query editor is located on the [Explore page](ref:explore). You can also access the PostgreSQL query editor from a dashboard panel. Click the ellipsis in the upper right of the panel and select **Edit**. |
||||
|
||||
{{< figure src="/static/img/docs/screenshot-postgres-query-editor.png" class="docs-image--no-shadow" caption="PostgreSQL query builder" >}} |
||||
|
||||
## PostgreSQL query editor components |
||||
|
||||
The PostgreSQL query editor has two modes: **Builder** and **Code**. |
||||
|
||||
Builder mode helps you build a query using a visual interface. Code mode allows for advanced querying and offers support for complex SQL query writing. |
||||
|
||||
### PostgreSQL Builder mode |
||||
|
||||
The following components will help you build a PostgreSQL query: |
||||
|
||||
- **Format** - Select a format response from the drop-down for the PostgreSQL query. The default is **Table**. If you use the **Time series** format option, one of the columns must be `time`. Refer to [Time series queries](#time-series-queries) for more information. |
||||
- **Table** - Select a table from the drop-down. Tables correspond to the chosen database. |
||||
- **Data operations** - _Optional_ Select an aggregation from the drop-down. You can add multiple data operations by clicking the **+ sign**. Click the **garbage can icon** to remove data operations. |
||||
- **Column** - Select a column on which to run the aggregation. |
||||
- **Alias** - _Optional_ Add an alias from the drop-down. You can also add your own alias by typing it in the box and clicking **Enter**. Remove an alias by clicking the **X**. |
||||
- **Filter** - Toggle to add filters. |
||||
- **Filter by column value** - _Optional_ If you toggle **Filter** you can add a column to filter by from the drop-down. To filter on more columns, click the **+ sign** to the right of the condition drop-down. You can choose a variety of operators from the drop-down next to the condition. When multiple filters are added you can add an `AND` operator to display all true conditions or an `OR` operator to display any true conditions. Use the second drop-down to choose a filter. To remove a filter, click the `X` button next to that filter's drop-down. After selecting a date type column, you can choose **Macros** from the operators list and select `timeFilter` which will add the `$\_\_timeFilter` macro to the query with the selected date column. |
||||
- **Group** - Toggle to add **Group by column**. |
||||
- **Group by column** - Select a column to filter by from the drop-down. Click the **+sign** to filter by multiple columns. Click the **X** to remove a filter. |
||||
- **Order** - Toggle to add an `ORDER BY` statement. |
||||
- **Order by** - Select a column to order by from the drop-down. Select ascending (`ASC`) or descending (`DESC`) order. |
||||
- **Limit** - You can add an optional limit on the number of retrieved results. Default is 50. |
||||
- **Preview** - Toggle for a preview of the SQL query generated by the query builder. Preview is toggled on by default. |
||||
|
||||
## PostgreSQL Code mode |
||||
|
||||
To create advanced queries, switch to **Code mode** by clicking **Code** in the upper right of the editor window. Code mode supports the auto-completion of tables, columns, SQL keywords, standard SQL functions, Grafana template variables, and Grafana macros. Columns cannot be completed before a table has been specified. |
||||
|
||||
{{< figure src="/static/img/docs/v92/sql_code_editor.png" class="docs-image--no-shadow" >}} |
||||
|
||||
Select **Table** or **Time Series** as the format. Click the **{}** in the bottom right to format the query. Click the **downward caret** to expand the Code mode editor. **CTRL/CMD + Return** serves as a keyboard shortcut to execute the query. |
||||
|
||||
{{< admonition type="warning" >}} |
||||
Changes made to a query in Code mode will not transfer to Builder mode and will be discarded. You will be prompted to copy your code to the clipboard to save any changes. |
||||
{{< /admonition >}} |
||||
|
||||
## Macros |
||||
|
||||
You can add macros to your queries to simplify the syntax and enable dynamic elements, such as date range filters. |
||||
|
||||
| Macro example | Description | |
||||
| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
||||
| `$__time(dateColumn)` | Replaces the value with an expression to convert to a UNIX timestamp and renames the column to `time_sec`. Example: `UNIX_TIMESTAMP(dateColumn) AS time_sec`. | |
||||
| `$__timeEpoch(dateColumn)` | Replaces the value with an expression to convert to a UNIX Epoch timestamp and renames the column to `time_sec`. Example: `UNIX_TIMESTAMP(dateColumn) AS time_sec`. | |
||||
| `$__timeFilter(dateColumn)` | Replaces the value a time range filter using the specified column name. Example: `dateColumn BETWEEN FROM_UNIXTIME(1494410783) AND FROM_UNIXTIME(1494410983)` | |
||||
| `$__timeFrom()` | Replaces the value with the start of the currently active time selection. Example: `FROM_UNIXTIME(1494410783)` | |
||||
| `$__timeTo()` | Replaces the value with the end of the currently active time selection. Example: `FROM_UNIXTIME(1494410983)` | |
||||
| `$__timeGroup(dateColumn,'5m')` | Replaces the value with an expression suitable for use in a `GROUP BY` clause. Example: `cast(cast(UNIX_TIMESTAMP(dateColumn)/(300) AS signed)*300 AS signed)` | |
||||
| `$__timeGroup(dateColumn,'5m', 0)` | Same as the `$__timeGroup(dateColumn,'5m')` macro, but includes a fill parameter to ensure missing points in the series are added by Grafana, using 0 as the default value. **This applies only to time series queries.** | |
||||
| `$__timeGroup(dateColumn,'5m', NULL)` | Same as the `$__timeGroup(dateColumn,'5m', 0)` but `NULL` is used as the value for missing points. _This applies only to time series queries._ | |
||||
| `$__timeGroup(dateColumn,'5m', previous)` | Same as the `$__timeGroup(dateColumn,'5m', previous)` macro, but uses the previous value in the series as the fill value. If no previous value exists, it uses `NULL`. _This applies only to time series queries._ | |
||||
| `$__timeGroupAlias(dateColumn,'5m')` | Replaces the value identical to `$__timeGroup` but with an added column alias. | |
||||
| `$__unixEpochFilter(dateColumn)` | Replaces the value by a time range filter using the specified column name with times represented as a UNIX timestamp. Example: `dateColumn > 1494410783 AND dateColumn < 1494497183` | |
||||
| `$__unixEpochFrom()` | Replaces the value with the start of the currently active time selection as a UNIX timestamp. Example: `1494410783` | |
||||
| `$__unixEpochTo()` | Replaces the value with the end of the currently active time selection as a UNIX timestamp. Example: `1494497183` | |
||||
| `$__unixEpochNanoFilter(dateColumn)` | Replaces the value with a time range filter using the specified column name with time represented as a nanosecond timestamp. Example: `dateColumn > 1494410783152415214 AND dateColumn < 1494497183142514872` | |
||||
| `$__unixEpochNanoFrom()` | Replaces the value with the start of the currently active time selection as a nanosecond timestamp. Example: `1494410783152415214` | |
||||
| `$__unixEpochNanoTo()` | Replaces the value with the end of the currently active time selection as nanosecond timestamp. Example: `1494497183142514872` | |
||||
| `$__unixEpochGroup(dateColumn,'5m', [fillmode])` | Same as `$__timeGroup` but for times stored as Unix timestamp. `fillMode` only works with time series queries. | |
||||
| `$__unixEpochGroupAlias(dateColumn,'5m', [fillmode])` | Same as `$__timeGroup` but also adds a column alias. `fillMode` only works with time series queries. | |
||||
|
||||
## Table SQL queries |
||||
|
||||
If the **Format** option is set to **Table**, you can execute virtually any type of SQL query. The Table panel will automatically display the resulting columns and rows from your query. |
||||
|
||||
 |
||||
|
||||
You can change or customize the name of a Table panel column by using the SQL keyword `AS` syntax. |
||||
|
||||
```sql |
||||
SELECT |
||||
title as "Title", |
||||
"user".login as "Created By", |
||||
dashboard.created as "Created On" |
||||
FROM dashboard |
||||
INNER JOIN "user" on "user".id = dashboard.created_by |
||||
WHERE $__timeFilter(dashboard.created) |
||||
``` |
||||
|
||||
## Time series queries |
||||
|
||||
Set the **Format** option to **Time series** to create and run time series queries. |
||||
|
||||
{{< admonition type="note" >}} |
||||
To run a time series query you must include a column named `time` that returns either a SQL `datetime` value or a numeric datatype representing the UNIX epoch time in seconds. Additionally, the query results must be sorted by the `time` column for proper visualization in panels. |
||||
{{< /admonition >}} |
||||
|
||||
The examples in this section refer to the data in the following table: |
||||
|
||||
```text |
||||
+---------------------+--------------+---------------------+----------+ |
||||
| time_date_time | value_double | CreatedAt | hostname | |
||||
+---------------------+--------------+---------------------+----------+ |
||||
| 2020-01-02 03:05:00 | 3.0 | 2020-01-02 03:05:00 | 10.0.1.1 | |
||||
| 2020-01-02 03:06:00 | 4.0 | 2020-01-02 03:06:00 | 10.0.1.2 | |
||||
| 2020-01-02 03:10:00 | 6.0 | 2020-01-02 03:10:00 | 10.0.1.1 | |
||||
| 2020-01-02 03:11:00 | 7.0 | 2020-01-02 03:11:00 | 10.0.1.2 | |
||||
| 2020-01-02 03:20:00 | 5.0 | 2020-01-02 03:20:00 | 10.0.1.2 | |
||||
+---------------------+--------------+---------------------+----------+ |
||||
``` |
||||
|
||||
Time series query results are returned in [wide data frame format](https://grafana.com/developers/plugin-tools/key-concepts/data-frames#wide-format). In the data frame query result, any column, except for time or string-type columns, transforms into value fields. String columns, on the other hand, become field labels. |
||||
|
||||
{{< admonition type="note" >}} |
||||
For backward compatibility, an exception to this rule applies to queries that return three columns, one of which is a string column named `metric`. Instead of converting the metric column into field labels, it is used as the field name, while the series name is set to its value. See the following example for reference. |
||||
{{< /admonition >}} |
||||
|
||||
**Example with `metric` column:** |
||||
|
||||
```sql |
||||
SELECT |
||||
$__timeGroupAlias("time_date_time",'5m'), |
||||
min("value_double"), |
||||
'min' as metric |
||||
FROM test_data |
||||
WHERE $__timeFilter("time_date_time") |
||||
GROUP BY time |
||||
ORDER BY time |
||||
``` |
||||
|
||||
Data frame result: |
||||
|
||||
```text |
||||
+---------------------+-----------------+ |
||||
| Name: time | Name: min | |
||||
| Labels: | Labels: | |
||||
| Type: []time.Time | Type: []float64 | |
||||
+---------------------+-----------------+ |
||||
| 2020-01-02 03:05:00 | 3 | |
||||
| 2020-01-02 03:10:00 | 6 | |
||||
+---------------------+-----------------+ |
||||
``` |
||||
|
||||
To customize default series name formatting, refer to [Standard options definitions](ref:configure-standard-options-display-name). |
||||
|
||||
Following are time series query examples. |
||||
|
||||
**Example using the fill parameter in the $\_\_timeGroupAlias macro to convert null values to be zero instead:** |
||||
|
||||
```sql |
||||
SELECT |
||||
$__timeGroupAlias("createdAt",'5m',0), |
||||
sum(value) as value, |
||||
hostname |
||||
FROM test_data |
||||
WHERE |
||||
$__timeFilter("createdAt") |
||||
GROUP BY time, hostname |
||||
ORDER BY time |
||||
``` |
||||
|
||||
Based on the data frame result in the following example, the time series panel will generate two series named _value 10.0.1.1_ and _value 10.0.1.2_. To display the series names as _10.0.1.1_ and _10.0.1.2_, use the [Standard options definitions](ref:configure-standard-options-display-name) display value `${__field.labels.hostname}`. |
||||
|
||||
Data frame result: |
||||
|
||||
```text |
||||
+---------------------+---------------------------+---------------------------+ |
||||
| Name: time | Name: value | Name: value | |
||||
| Labels: | Labels: hostname=10.0.1.1 | Labels: hostname=10.0.1.2 | |
||||
| Type: []time.Time | Type: []float64 | Type: []float64 | |
||||
+---------------------+---------------------------+---------------------------+ |
||||
| 2020-01-02 03:05:00 | 3 | 4 | |
||||
| 2020-01-02 03:10:00 | 6 | 7 | |
||||
+---------------------+---------------------------+---------------------------+ |
||||
``` |
||||
|
||||
**Example with multiple columns:** |
||||
|
||||
```sql |
||||
SELECT |
||||
$__timeGroupAlias("time_date_time",'5m'), |
||||
min("value_double") as "min_value", |
||||
max("value_double") as "max_value" |
||||
FROM test_data |
||||
WHERE $__timeFilter("time_date_time") |
||||
GROUP BY time |
||||
ORDER BY time |
||||
``` |
||||
|
||||
Data frame result: |
||||
|
||||
```text |
||||
+---------------------+-----------------+-----------------+ |
||||
| Name: time | Name: min_value | Name: max_value | |
||||
| Labels: | Labels: | Labels: | |
||||
| Type: []time.Time | Type: []float64 | Type: []float64 | |
||||
+---------------------+-----------------+-----------------+ |
||||
| 2020-01-02 03:04:00 | 3 | 4 | |
||||
| 2020-01-02 03:05:00 | 6 | 7 | |
||||
+---------------------+-----------------+-----------------+ |
||||
``` |
||||
|
||||
## Templating |
||||
|
||||
Instead of hard coding values like server, application, or sensor names in your metric queries, you can use variables. Variables appear as drop-down select boxes at the top of the dashboard. These drop-downs make it easy to change the data being displayed in your dashboard. |
||||
|
||||
Refer to [Templates](ref:templates) for an introduction to creating template variables as well as the different types. |
||||
|
||||
### Query variable |
||||
|
||||
If you add a `Query` template variable you can write a PostgreSQL query to retrieve items such as measurement names, key names, or key values, which will be displayed in the drop-down menu. |
||||
|
||||
For example, you can use a variable to retrieve all the values from the `hostname` column in a table by creating the following query in the templating variable _Query_ setting. |
||||
|
||||
```sql |
||||
SELECT hostname FROM host |
||||
``` |
||||
|
||||
A query can return multiple columns, and Grafana will automatically generate a list based on the query results. For example, the following query returns a list with values from `hostname` and `hostname2`. |
||||
|
||||
```sql |
||||
SELECT host.hostname, other_host.hostname2 FROM host JOIN other_host ON host.city = other_host.city |
||||
``` |
||||
|
||||
To use time range dependent macros like `$__timeFilter(column)` in your query, you must set the template variable's refresh mode to _On Time Range Change_. |
||||
|
||||
```sql |
||||
SELECT event_name FROM event_log WHERE $__timeFilter(time_column) |
||||
``` |
||||
|
||||
Another option is a query that can create a key/value variable. The query should return two columns that are named `__text` and `__value`. The `__text` column must contain unique values (if not, only the first value is used). This allows the drop-down options to display a text-friendly name as the text while using an ID as the value. For example, a query could use `hostname` as the text and `id` as the value: |
||||
|
||||
```sql |
||||
SELECT hostname AS __text, id AS __value FROM host |
||||
``` |
||||
|
||||
You can also create nested variables. For example, if you have a variable named `region`, you can configure the `hosts` variable to display only the hosts within the currently selected region as shown in the following example. If `region` is a multi-value variable, use the `IN` operator instead of `=` to match multiple values. |
||||
|
||||
```sql |
||||
SELECT hostname FROM host WHERE region IN($region) |
||||
``` |
||||
|
||||
#### Using `__searchFilter` to filter results in Query Variable |
||||
|
||||
Using `__searchFilter` in the query field allows the query results to be filtered based on the user’s input in the drop-down selection box. If you do not enter anything, the default value for `__searchFilter` is `%`. |
||||
|
||||
Note that you must enclose the `__searchFilter` expression in quotes as Grafana does not add them automatically. |
||||
|
||||
The following example demonstrates how to use `__searchFilter` in the query field to enable real-time searching for `hostname` as the user type in the drop-down selection box. |
||||
|
||||
```sql |
||||
SELECT hostname FROM my_host WHERE hostname LIKE '$__searchFilter' |
||||
``` |
||||
|
||||
### Using Variables in Queries |
||||
|
||||
Template variable values are only quoted when the template variable is a `multi-value`. |
||||
|
||||
If the variable is a multi-value variable, use the `IN` comparison operator instead of `=` to match against multiple values. |
||||
|
||||
You can use two different syntaxes: |
||||
|
||||
`$<varname>` Example with a template variable named `hostname`: |
||||
|
||||
```sql |
||||
SELECT |
||||
atimestamp as time, |
||||
aint as value |
||||
FROM table |
||||
WHERE $__timeFilter(atimestamp) and hostname in($hostname) |
||||
ORDER BY atimestamp ASC |
||||
``` |
||||
|
||||
`[[varname]]` Example with a template variable named `hostname`: |
||||
|
||||
```sql |
||||
SELECT |
||||
atimestamp as time, |
||||
aint as value |
||||
FROM table |
||||
WHERE $__timeFilter(atimestamp) and hostname in([[hostname]]) |
||||
ORDER BY atimestamp ASC |
||||
``` |
||||
|
||||
#### Disabling quoting for multi-value variables |
||||
|
||||
Grafana automatically formats multi-value variables as a quoted, comma-separated string. For example, if `server01` and `server02` are selected, they are formatted as `'server01'`, `'server02'`. To remove the quotes, enable the CSV formatting option for the variables: |
||||
|
||||
`${servers:csv}` |
||||
|
||||
Read more about variable formatting options in the [Variables](ref:variable-syntax-advanced-variable-format-options) documentation. |
||||
|
||||
## Annotations |
||||
|
||||
[Annotations](ref:annotate-visualizations) allow you to overlay rich event information on top of graphs. Add annotation queries via the **Dashboard settings > Annotations view**. |
||||
|
||||
**Example query using a `time` column with epoch values:** |
||||
|
||||
```sql |
||||
SELECT |
||||
epoch_time as time, |
||||
metric1 as text, |
||||
concat_ws(', ', metric1::text, metric2::text) as tags |
||||
FROM |
||||
public.test_data |
||||
WHERE |
||||
$__unixEpochFilter(epoch_time) |
||||
``` |
||||
|
||||
**Example region query using `time` and `timeend` columns with epoch values:** |
||||
|
||||
```sql |
||||
SELECT |
||||
epoch_time as time, |
||||
epoch_time_end as timeend, |
||||
metric1 as text, |
||||
concat_ws(', ', metric1::text, metric2::text) as tags |
||||
FROM |
||||
public.test_data |
||||
WHERE |
||||
$__unixEpochFilter(epoch_time) |
||||
``` |
||||
|
||||
**Example query using a `time` column with a native SQL date/time data type:** |
||||
|
||||
```sql |
||||
SELECT |
||||
native_date_time as time, |
||||
metric1 as text, |
||||
concat_ws(', ', metric1::text, metric2::text) as tags |
||||
FROM |
||||
public.test_data |
||||
WHERE |
||||
$__timeFilter(native_date_time) |
||||
``` |
||||
|
||||
| Name | Description | |
||||
| --------- | --------------------------------------------------------------------------------------------------------------------- | |
||||
| `time` | The name of the date/time field, which can be a column with a native SQL date/time data type or epoch value. | |
||||
| `timeend` | Optional name of the end date/time field, which can be a column with a native SQL date/time data type or epoch value. | |
||||
| `text` | Event description field. | |
||||
| `tags` | Optional field name to use for event tags as a comma-separated string. | |
||||
|
||||
## Alerting |
||||
|
||||
Use time series queries to create alerts. Table formatted queries aren't yet supported in alert rule conditions. |
||||
|
||||
For more information regarding alerting refer to the following: |
||||
|
||||
- [Alert rules](ref:alert-rules) |
||||
- [Template annotations and labels](ref:template-annotations-and-labels) |
||||
Loading…
Reference in new issue