How to Visualize Grafana Data in Python with pandas

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData API Driver for Python, the pandas & Matplotlib modules, and the SQLAlchemy toolkit, you can build Grafana-connected Python applications and scripts for visualizing Grafana data. This article shows how to use the pandas, SQLAlchemy, and Matplotlib built-in functions to connect to Grafana data, execute queries, and visualize the results.

With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Grafana data in Python. When you issue complex SQL queries from Grafana, the driver pushes supported SQL operations, like filters and aggregations, directly to Grafana and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Grafana Data

Connecting to Grafana data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

Start by setting the Profile connection property to the location of the Grafana Profile on disk (e.g. C:\profiles\Grafana.apip). Next, set the ProfileSettings connection property to the connection string for Grafana (see below).

Grafana API Profile Settings

In Grafana, navigate to Administration > Users and Access > Service accounts, create a service account, then click Add service account token to generate a token.

Follow the procedure below to install the required modules and start accessing Grafana through Python objects.

Install Required Modules

Use the pip utility to install the pandas & Matplotlib modules and the SQLAlchemy toolkit:

pip install pandas
pip install matplotlib
pip install sqlalchemy

Be sure to import the module with the following:

import pandas
import matplotlib.pyplot as plt
from sqlalchemy import create_engine

Visualize Grafana Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Grafana data.

engine = create_engine("api:///?Profile=C:\profiles\Grafana.apip&ProfileSettings='Token=your_service_account_token&Domain=your_grafana_domain'")

Execute SQL to Grafana

Use the read_sql function from pandas to execute any SQL statement and store the resultset in a DataFrame.

df = pandas.read_sql("SELECT Id, Name FROM Alert WHERE State = 'alerting'", engine)

Visualize Grafana Data

With the query results stored in a DataFrame, use the plot function to build a chart to display the Grafana data. The show method displays the chart in a new window.

df.plot(kind="bar", x="Id", y="Name")
plt.show()

Free Trial & More Information

Download a free, 30-day trial of the CData API Driver for Python to start building Python apps and scripts with connectivity to Grafana data. Reach out to our Support Team if you have any questions.

Full Source Code

import pandas
import matplotlib.pyplot as plt
from sqlalchemy import create_engin

engine = create_engine("api:///?Profile=C:\profiles\Grafana.apip&ProfileSettings='Token=your_service_account_token&Domain=your_grafana_domain'")
df = pandas.read_sql("SELECT Id, Name FROM Alert WHERE State = 'alerting'", engine)

df.plot(kind="bar", x="Id", y="Name")
plt.show()