Share this article:

Vertica Integration with Grafana: Connection Guide

About Vertica Connection Guides

Vertica connection guides provide basic instructions for connecting a third-party partner product to Vertica. Connection guides are based on our testing with specific versions of Vertica and the partner product.

Vertica and Grafana: Latest Versions Tested

Software Version
Grafana Server

6.6 Local Instance

Grafana Server Platform

CentOS 7.4

Desktop Client

Windows 10 Edge 41.16299

Vertica-Grafana-datasource plugin

0.1.0

Vertica Server 9.3.0

Grafana Overview

Grafana allows you to query, visualize, alert on, and understand your metrics no matter where they are stored. Create, explore, and share dashboards with your team and foster a data-driven culture.

Installing Grafana

To install Grafana,

  1. Go to https://grafana.com/get

  2. Click Download in the You Run It option. This allows you to download the Grafana distribution for your platform from https://grafana.com/grafana/download

    Alternatively, you can choose the We Host It option which allows setting up a free hosted Grafana instance on their site.

  3. Follow the Grafana documentation for installation and configuration instructions.
  4. Start the Grafana server and make sure it’s accessible via a browser.

Installing the Vertica-Grafana-datasource plugin

For a non-development installation,

  1. Go to https://grafana.com/grafana/plugins/vertica-grafana-datasource/installation
  2. Click the Installation tab and follow the instructions.

    There are options for installing on both a local Grafana instance and a hosted Grafana instance.

  3. After installing, restart the Grafana Server.

Note This plugin defines a new data source that communicates with Vertica using the Vertica native Go driver (http://github.com/vertica/vertica-sql-go). The driver is supplied with the plugin so there is no need to download or install the Vertica driver separately.

Connecting Grafana to Vertica

  1. Log into Grafana with the Admin credentials.
  2. On the left toolbar, hover over the gear icon to open the Configuration menu, and then click Plugins.
  3. Scroll to the bottom of the list of plugins and confirm the Vertica plugin is displayed.
  4. On the left toolbar, hover over the gear icon top open the Configuration menu, and then click Data Sources
  5. Click Add data source, scroll to the SQL section and select the Vertica data source.

  6. Click Save & Test to confirm you get a successful connection to Vertica.
  7. To test the ability to visualize data through the connection
    1. Click Home on the top left corner.
    2. Click the + icon and select Dashboard to create a new dashboard.
    3. Click Add Query.

    The screen refreshes to a New Dashboard with a graph panel and a predefined Vertica SQL query. The graph populates within a second or two confirming it is able to fetch data from Vertica.

  8. From here you can follow the Grafana documentation on how to build and format visualizations.

Troubleshooting

If the Vertica plugin doesn’t show up in the plugins screen, search the /var/log/grafana/grafana.log file for Starting plugin search and review from there down. It should provide hints on the path it’s looking for plugins in, and specifics on finding and loading the Vertica plugin.

Following is a short set of entries showing a successful load:

t=2019-08-19T14:16:42-0400 lvl=info msg="Starting plugin search" logger=plugins
t=2019-08-19T14:16:42-0400 lvl=info msg="Plugin dir created" logger=plugins dir=/var/lib/grafana/plugins
t=2019-08-19T14:18:40-0400 lvl=info msg="Config overridden from command line" logger=settings arg=
"default.paths.plugins=/var/lib/grafana/plugins"
t=2019-08-19T14:18:40-0400 lvl=info msg="Path Plugins" logger=settings path=/var/lib/grafana/plugins
t=2019-08-19T14:18:40-0400 lvl=info msg="Starting plugin search" logger=plugins
t=2019-08-19T14:18:40-0400 lvl=info msg="Registering plugin" logger=plugins name=Vertica
t=2019-08-19T14:19:03-0400 lvl=info msg="Request Completed" logger=context userId=0 orgId=0 uname= method=GET path=/plugins/
vertica-grafana-datasource/public/img/fav32.png status=404 remote_addr=10.100.244.118 time_ms=3 size=23025 referer=

Known Limitations

  • IntervalSecond data type is not supported. The following error appears:
Invalid interval format!
  • LongvarBinary is supported up to 4,194,304 bytes. For values beyond this, the following message is displayed:
ResourceExhausted desc = grpc: received message larger than max (32321854 vs. 4194304)

For More Information

Share this article: