Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paveldanilin/grafana-csv-plugin
CSV datasource for Grafana 6.x.x / 7.x.x
https://github.com/paveldanilin/grafana-csv-plugin
csv csv-datasource datasource golang grafana plugin sftp sql sqlite
Last synced: about 2 months ago
JSON representation
CSV datasource for Grafana 6.x.x / 7.x.x
- Host: GitHub
- URL: https://github.com/paveldanilin/grafana-csv-plugin
- Owner: paveldanilin
- License: mit
- Created: 2020-05-03T09:29:58.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-02-25T00:45:00.000Z (almost 2 years ago)
- Last Synced: 2024-06-18T23:42:39.559Z (6 months ago)
- Topics: csv, csv-datasource, datasource, golang, grafana, plugin, sftp, sql, sqlite
- Language: Go
- Homepage:
- Size: 155 MB
- Stars: 36
- Watchers: 6
- Forks: 12
- Open Issues: 13
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
## CSV datasource for Grafana 6.x.x
Many thanks to JetBrains for providing the OS license for an amazing GoLand IDE.
[](https://www.jetbrains.com/?from=grafana-csv-plugin)
#### Install
- Copy files from the `dist` folder to your [Grafana plugin directory](https://grafana.com/docs/grafana/latest/plugins/installation/#grafana-plugin-directory)
- Ensure that executable file has the execute flag
- Restart Grafana
- Check datasource list as http://you-grafana/datasources/new
##### Grafana 7.x.x
> The plugin is unsigned, hence you may face the error:
>
> `lvl=eror msg=“Failed to load plugin” logger=plugins error=“plugin “grafana-csv-plugin” is unsigned”`
>
> To get it to work you should make configuration as described in [documentation](https://grafana.com/docs/grafana/latest/installation/configuration/#allow-loading-unsigned-plugins)
#### Features
- Read local CSV file
- SQL queries (under the hood CSV will be converted into in-memory SQLite3 DB)
- Auto-detect column types by the first data row
- Reloading CSV file on changing
- Query [variables](https://grafana.com/docs/grafana/latest/variables/templates-and-variables/)
- Macros:
* $__timeFilter(dateColumn)
* $__timeGroup(dateColumn, interval)
* $__unixEpochFrom()
* $__unixEpochTo()
#### CSV format
- Each CSV file must have the first row with column names
#### Query
- [SQLite3](https://www.sqlite.org/index.html)
- Each DS has its own table, the name of the table coincides with the DS name (for example the DS name is `my_data`, hence in a query you should select from `my_data` table)
#### Macros
| Macros | Description |
|------------------------------------|-------------------------------------------|
| $__timeFilter(dateColumn) | Will be replaced by a time range filter using the specified column name. For example, dateColumn BETWEEN ‘2017-04-21T05:01:17Z’ AND ‘2017-04-21T05:06:17Z’ |
| $__timeGroup(dateColumn, interval), Examples: `sec: $__timeGroup(dateColumn, 60); min: $__timeGroup(dateColumn, 60m); hour: $__timeGroup(dateColumn, 1h)` | Will be replaced by an expression usable in a GROUP BY clause. For example, datetime((strftime('%s', dateColumn) / 60) * 60, 'unixepoch') |
| $__unixEpochFrom() | Will be replaced by the start of the currently active time selection as Unix timestamp. For example, 1494410783 |
| $__unixEpochTo() | Will be replaced by the end of the currently active time selection as Unix timestamp. For example, 1494497183 |
#### Build graphs
Example:
- CSV File: data/SacramentocrimeJanuary2006.csv
- DS name `jan_2006`
- group by 1 hour
- filter by current time range
```sql
SELECT $__timeGroup(cdatetime, 1h) as "time", district as "metric", count(*) as "value"
FROM
jan_2006
WHERE
$__timeFilter(cdatetime)
GROUP BY "time", "metric"
ORDER BY "time"
```
Example:
- CSV File: data/SalesJan2009.csv
- DS name `sales`
- group by 24 hours
```sql
SELECT $__timeGroup(Transaction_date, 24h) as "time", Payment_Type as "metric", count(*) as "value"
FROM
sales
GROUP BY "time", "metric"
ORDER BY "time"
```
#### Simple table
#### Config
- Read local file
- Read remote file
#### Build
- npm run build
#### Docker (Grafana 6.7.4)
http://your-server:3000 `(admin/admin)`
- `manage.sh build` (build docker image)
- `manage.sh up` (run container)
- `manage.sh down` (stop container)
After starting container go to the showcase dashboard:
http://your-host:3000/d/DTRcLsVGk/showcase-sales?orgId=1
#### Prev version
- [1.1.0](https://github.com/paveldanilin/grafana-csv-plugin/tree/1.1.0) which doesn't support SQL, but supports the filtering expressions.
###### Example data set: /data
###### Icon: https://freeicons.io/vector-file-types-icons/csv-icon-2272