Plugins 〉Groonga
Groonga
Grafana Groonga Data Source Plugin
View report data from Groonga in your Grafana.
Install the Data Source
Use the new grafana-cli tool to install groonga-datasource from the commandline:
grafana-cli plugins install groonga-datasource
The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins if you installed the grafana package.
Configure the Data Source
Accessed from the Grafana main menu, newly installed data sources can be added immediately within the Data Sources
section.
Next, click the Add data source
button in the upper right. The data source will be available for selection in the Type select box.
To see a list of installed data sources, click the Plugins item in the main menu. Both core data sources and installed data sources will appear.
Select Groonga-datasource and enter the Name
, URL
, Default table name
, and Default field name
in the displayed setting screen.
How to try
You can use docker-compose to try groonga-datasource. Here is a command line to try groonga-datasource 1.0.4:
GF_GROONGA_DATASOURCE_DIR=/tmp/groonga-datasource \
GF_INSTALL_PLUGINS="https://github.com/groonga/grafana-datasource-plugin-groonga/releases/download/1.0.4/groonga-datasource-1.0.4.zip;groonga-datasource" \
docker-compose up garafana
You can find Grafana at http://localhost:3000/ .
You can login as the admin
user with admin
for password.
You can find "Groonga" datasource at the bottom of http://localhost:3000/datasources/new . You can use the following parameters to use the test Groonga server that has some test data:
- Name:
Groonga
- HTTP
- URL:
http://groonga:10041/
- URL:
- Groonga Details
- Default table name:
Logs
- Default time field name:
timestamp
- Default table name:
You can use the Groonga datasource in a panel with the following parameters:
- Table Name:
Logs
You can see visualized data in the test Groonga server.
Usage
Table Name
: target table name.Time field
: the key time field for the table.Output columns
: output columns by csv format. (ex:timefield,value1,value2
)limit num
: number of output records. default value is10
.Filter string
: filtering string according to Groonga's script syntax.Sort columns
: sort key columns by csv format. (ex:timefield,value1,-value2
)- If you want to use descending order, add
-
at the beginning.)
- If you want to use descending order, add
If you want to perform aggregation processing, specify the following.
Key columns
: Aggregate key columns by csv format.Type
: data aggregation method(count/sum/max/min/avg).Target
: column to be aggregated.Interval
: Interval when aggregation is performed for each fixed period.
Note:
- If you want to aggregate every certain period in the graph panel,
Interval
is required.- Aggregated time is stored in a column called AGGTIME and can be used in Key columns and Output columns.
- If you want to display aggregated values, specify a special column name in Output columns.
Aggregation method Special column name count _nsubrecs sum _sum max _max min _min avg _avg
Limitations:
- If multiple queries are used, the settings of the first query will be valid except for the aggregated items.
Learn more
- Build a data source plugin tutorial
- Grafana documentation
- Grafana Tutorials - Grafana Tutorials are step-by-step guides that help you make the most of Grafana
- Grafana UI Library - UI components to help you build interfaces using Grafana Design System
License
Apache License 2.0, see LICENSE.
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Installing Groonga on Grafana Cloud:
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
For more information, visit the docs on plugin installation.
Installing on a local Grafana:
For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.
1. Install the Data Source
Use the grafana-cli tool to install Groonga from the commandline:
grafana-cli plugins install
The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.
Alternatively, you can manually download the .zip file for your architecture below and unpack it into your grafana plugins directory.
Alternatively, you can manually download the .zip file and unpack it into your grafana plugins directory.
2. Configure the Data Source
Accessed from the Grafana main menu, newly installed data sources can be added immediately within the Data Sources section.
Next, click the Add data source button in the upper right. The data source will be available for selection in the Type select box.
To see a list of installed data sources, click the Plugins item in the main menu. Both core data sources and installed data sources will appear.