Chronograf Integration

From OSNEXUS Online Documentation Site
Jump to: navigation, search


QuantaStor has numerous real-time stats dashboards built into the main web management user interface that cover what most users and administrators need. In some cases though it can be useful to have visibility into other metrics and to be able to setup advanced custom dashboards for visualizing performance and other historical storage information. QuantaStor internally uses Telegraf and InfluxDB to collect and store real-time stats and these can be easily used by other open source dashboard systems like Chronograf to make custom displays. The following instructions go over how to setup Chronograf with QuantaStor so that these advanced dashboards may be setup.

How to Install Chronograf

Go to the Chronograf downloads page to get the latest version. Next, click the version button under the Chronograf section (for example, "v1.7.12" button) and navigate to the "Unbuntu & Debian" install section and follow the instructions in the "Unbuntu & Debian" section. For example:

sudo wget
sudo dpkg -i chronograf_1.8.9.1_amd64.deb

How to Login to Chronograf

Record the InfluxDB "username" and "password" for the QuantaStor system by logging into your QuantaStor system and executing:

cat /etc/telegraf/telegraf.conf | grep "username\|password"

You will see the InfluxDB credentials in the telegraf.conf file that will looks something like this:

  username = "quantastor"
  password = "b15beec1-a400-fb47-d267-04eedd302c9a"

Next, launch Chronograf in Chrome by navigating to the IP address of the QuantaStor system at port 8888. For example:

Enter the InfluxDB username and password credentials you recorded when prompted. To see a system context diagram of Telegraf+InfluxDB+Chronograf please see: You are now ready to create a custom QuantaStor dashboard using Chronograf!

How to Create a Chronograf Custom Dashboard

After connecting to your QuantaStor system at the above 8888 port number you should be presented with the web management interface for Chronograf. The default http://localhost:8086 is the correct address for Chronograf to communicate with InfluxDB internal to the service. For the Connection Name we recommend calling it the name of your QuantaStor system or just QuantaStor. Similarly the name of the InfluxDB database is quantastor and the username for the database is also quantastor. The password to access InfluxDB is gathered by the above command and is a UUID you'll need to paste into the password field after you've gathered it from the telegraf.conf file.

Connecting Chronograf

Once you've added a InfluxDB Connection it will now ask you to create a dashboard. You might select the InfluxDB option, then choose create but you don't need to create any dashboards at this time and you can skip this and create a new dashboard later once you've selected some graphs you want to select.

Creating InfluxDB Dashboard

Now you should see that connection in the green Connected state. Next, look to the left edge of the screen and select the icon to begin exploring the data.

Dashboard Connection

When you're initially starting to explore the data we recommend looking at the cpu data as that will help verify that everything is working. To do this, choose the quantastor.quantastor database in the DB.RetentionPolicy section, then select the cpu measurement and then select the usage_iowait Field. You should see a graph similar to the one shown below.

Exploring Graphs

Building a Dashboard

Once you have information you want to display, press the green Send to Dashboard button in the upper right corner and add the graph to the dashboard of your choosing or make a new dashboard.

There's lots of information that QuantaStor is setup to collect which we don't display in the main QuantaStor web user interface so there's lots to explore. For further reading on how to customize and configure Chronograf dashboards we recommend the following:

Learning Chronograf Resources

Chronograf API Resources

InfluxData - Get and Post Chronograf Dashboards Examples Chronograf API