|
| 1 | ++++ |
| 2 | +title = "Using PostgreSQL in Grafana" |
| 3 | +description = "Guide for using PostgreSQL in Grafana" |
| 4 | +keywords = ["grafana", "postgresql", "guide"] |
| 5 | +type = "docs" |
| 6 | +[menu.docs] |
| 7 | +name = "PostgreSQL" |
| 8 | +parent = "datasources" |
| 9 | +weight = 7 |
| 10 | ++++ |
| 11 | + |
| 12 | +# Using PostgreSQL in Grafana |
| 13 | + |
| 14 | +Grafana ships with a built-in PostgreSQL data source plugin that allows you to query and visualize data from a PostgreSQL compatible database. |
| 15 | + |
| 16 | +## Adding the data source |
| 17 | + |
| 18 | +1. Open the side menu by clicking the Grafana icon in the top header. |
| 19 | +2. In the side menu under the `Dashboards` link you should find a link named `Data Sources`. |
| 20 | +3. Click the `+ Add data source` button in the top header. |
| 21 | +4. Select *PostgreSQL* from the *Type* dropdown. |
| 22 | + |
| 23 | +### Database User Permissions (Important!) |
| 24 | + |
| 25 | +The database user you specify when you add the data source should only be granted SELECT permissions on |
| 26 | +the specified database & tables you want to query. Grafana does not validate that the query is safe. The query |
| 27 | +could include any SQL statement. For example, statements like `DELETE FROM user;` and `DROP TABLE user;` would be |
| 28 | +executed. To protect against this we **Highly** recommmend you create a specific postgresql user with restricted permissions. |
| 29 | + |
| 30 | +Example: |
| 31 | + |
| 32 | +```sql |
| 33 | + CREATE USER grafanareader WITH PASSWORD 'password'; |
| 34 | + GRANT USAGE ON SCHEMA schema TO grafanareader; |
| 35 | + GRANT SELECT ON schema.table TO grafanareader; |
| 36 | +``` |
| 37 | + |
| 38 | +Make sure the user does not get any unwanted privileges from the public role. |
| 39 | + |
| 40 | +## Macros |
| 41 | + |
| 42 | +To simplify syntax and to allow for dynamic parts, like date range filters, the query can contain macros. |
| 43 | + |
| 44 | +Macro example | Description |
| 45 | +------------ | ------------- |
| 46 | +*$__time(dateColumn)* | Will be replaced by an expression to rename the column to `time`. For example, *dateColumn as time* |
| 47 | +*$__timeSec(dateColumn)* | Will be replaced by an expression to rename the column to `time` and converting the value to unix timestamp. For example, *extract(epoch from dateColumn) as time* |
| 48 | +*$__timeFilter(dateColumn)* | Will be replaced by a time range filter using the specified column name. For example, *dateColumn > to_timestamp(1494410783) AND dateColumn < to_timestamp(1494497183)* |
| 49 | +*$__timeFrom()* | Will be replaced by the start of the currently active time selection. For example, *to_timestamp(1494410783)* |
| 50 | +*$__timeTo()* | Will be replaced by the end of the currently active time selection. For example, *to_timestamp(1494497183)* |
| 51 | +*$__timeGroup(dateColumn,'5m')* | Will be replaced by an expression usable in GROUP BY clause. For example, *(extract(epoch from "dateColumn")/extract(epoch from '5m'::interval))::int* |
| 52 | +*$__unixEpochFilter(dateColumn)* | Will be replaced by a time range filter using the specified column name with times represented as unix timestamp. For example, *dateColumn > 1494410783 AND dateColumn < 1494497183* |
| 53 | +*$__unixEpochFrom()* | Will be replaced by the start of the currently active time selection as unix timestamp. For example, *1494410783* |
| 54 | +*$__unixEpochTo()* | Will be replaced by the end of the currently active time selection as unix timestamp. For example, *1494497183* |
| 55 | + |
| 56 | +We plan to add many more macros. If you have suggestions for what macros you would like to see, please [open an issue](https://github.com/grafana/grafana) in our GitHub repo. |
| 57 | + |
| 58 | +The query editor has a link named `Generated SQL` that shows up after a query as been executed, while in panel edit mode. Click on it and it will expand and show the raw interpolated SQL string that was executed. |
| 59 | + |
| 60 | +## Table queries |
| 61 | + |
| 62 | +If the `Format as` query option is set to `Table` then you can basically do any type of SQL query. The table panel will automatically show the results of whatever columns & rows your query returns. |
| 63 | + |
| 64 | +Query editor with example query: |
| 65 | + |
| 66 | + |
| 67 | + |
| 68 | + |
| 69 | +The query: |
| 70 | + |
| 71 | +```sql |
| 72 | +SELECT |
| 73 | + title as "Title", |
| 74 | + "user".login as "Created By", |
| 75 | + dashboard.created as "Created On" |
| 76 | +FROM dashboard |
| 77 | +INNER JOIN "user" on "user".id = dashboard.created_by |
| 78 | +WHERE $__timeFilter(dashboard.created) |
| 79 | +``` |
| 80 | + |
| 81 | +You can control the name of the Table panel columns by using regular `as ` SQL column selection syntax. |
| 82 | + |
| 83 | +The resulting table panel: |
| 84 | + |
| 85 | + |
| 86 | + |
| 87 | +### Time series queries |
| 88 | + |
| 89 | +If you set `Format as` to `Time series`, for use in Graph panel for example, then the query must return a column named `time` that returns either a sql datetime or any numeric datatype representing unix epoch in seconds. |
| 90 | +Any column except `time` and `metric` is treated as a value column. |
| 91 | +You may return a column named `metric` that is used as metric name for the value column. |
| 92 | + |
| 93 | +Example with `metric` column |
| 94 | + |
| 95 | +```sql |
| 96 | +SELECT |
| 97 | + min(time_date_time) as time, |
| 98 | + min(value_double), |
| 99 | + 'min' as metric |
| 100 | +FROM test_data |
| 101 | +WHERE $__timeFilter(time_date_time) |
| 102 | +GROUP BY metric1, (extract(epoch from time_date_time)/extract(epoch from $__interval::interval))::int |
| 103 | +ORDER BY time asc |
| 104 | +``` |
| 105 | + |
| 106 | +Example with multiple columns: |
| 107 | + |
| 108 | +```sql |
| 109 | +SELECT |
| 110 | + min(time_date_time) as time, |
| 111 | + min(value_double) as min_value, |
| 112 | + max(value_double) as max_value |
| 113 | +FROM test_data |
| 114 | +WHERE $__timeFilter(time_date_time) |
| 115 | +GROUP BY metric1, (extract(epoch from time_date_time)/extract(epoch from $__interval::interval))::int |
| 116 | +ORDER BY time asc |
| 117 | +``` |
| 118 | + |
| 119 | +## Templating |
| 120 | + |
| 121 | +Instead of hard-coding things like server, application and sensor name in you metric queries you can use variables in their place. Variables are shown as dropdown select boxes at the top of the dashboard. These dropdowns makes it easy to change the data being displayed in your dashboard. |
| 122 | + |
| 123 | +Checkout the [Templating]({{< relref "reference/templating.md" >}}) documentation for an introduction to the templating feature and the different types of template variables. |
| 124 | + |
| 125 | +### Query Variable |
| 126 | + |
| 127 | +If you add a template variable of the type `Query`, you can write a PostgreSQL query that can |
| 128 | +return things like measurement names, key names or key values that are shown as a dropdown select box. |
| 129 | + |
| 130 | +For example, you can have a variable that contains all values for the `hostname` column in a table if you specify a query like this in the templating variable *Query* setting. |
| 131 | + |
| 132 | +```sql |
| 133 | +SELECT hostname FROM host |
| 134 | +``` |
| 135 | + |
| 136 | +A query can return multiple columns and Grafana will automatically create a list from them. For example, the query below will return a list with values from `hostname` and `hostname2`. |
| 137 | + |
| 138 | +```sql |
| 139 | +SELECT host.hostname, other_host.hostname2 FROM host JOIN other_host ON host.city = other_host.city |
| 140 | +``` |
| 141 | + |
| 142 | +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 value should be unique (if it is not unique then the first value is used). The options in the dropdown will have a text and value that allows you to have a friendly name as text and an id as the value. An example query with `hostname` as the text and `id` as the value: |
| 143 | + |
| 144 | +```sql |
| 145 | +SELECT hostname AS __text, id AS __value FROM host |
| 146 | +``` |
| 147 | + |
| 148 | +You can also create nested variables. For example if you had another variable named `region`. Then you could have |
| 149 | +the hosts variable only show hosts from the current selected region with a query like this (if `region` is a multi-value variable then use the `IN` comparison operator rather than `=` to match against multiple values): |
| 150 | + |
| 151 | +```sql |
| 152 | +SELECT hostname FROM host WHERE region IN($region) |
| 153 | +``` |
| 154 | + |
| 155 | +### Using Variables in Queries |
| 156 | + |
| 157 | +Template variables are quoted automatically so if it is a string value do not wrap them in quotes in where clauses. If the variable is a multi-value variable then use the `IN` comparison operator rather than `=` to match against multiple values. |
| 158 | + |
| 159 | +There are two syntaxes: |
| 160 | + |
| 161 | +`$<varname>` Example with a template variable named `hostname`: |
| 162 | + |
| 163 | +```sql |
| 164 | +SELECT |
| 165 | + atimestamp as time, |
| 166 | + aint as value |
| 167 | +FROM table |
| 168 | +WHERE $__timeFilter(atimestamp) and hostname in($hostname) |
| 169 | +ORDER BY atimestamp ASC |
| 170 | +``` |
| 171 | + |
| 172 | +`[[varname]]` Example with a template variable named `hostname`: |
| 173 | + |
| 174 | +```sql |
| 175 | +SELECT |
| 176 | + atimestamp as time, |
| 177 | + aint as value |
| 178 | +FROM table |
| 179 | +WHERE $__timeFilter(atimestamp) and hostname in([[hostname]]) |
| 180 | +ORDER BY atimestamp ASC |
| 181 | +``` |
| 182 | + |
| 183 | +## Alerting |
| 184 | + |
| 185 | +Time series queries should work in alerting conditions. Table formatted queries is not yet supported in alert rule |
| 186 | +conditions. |
0 commit comments