Grafana Integration - Revision history

Qadmin at 18:13, 11 August 2022

2022-08-11T18:13:52Z

← Older revision		Revision as of 18:13, 11 August 2022
Line 117:		Line 117:

	Grafana is now fully set up to create custom dashboards for QuantaStor that allows you to choose which specific metrics you wish to be displayed.		Grafana is now fully set up to create custom dashboards for QuantaStor that allows you to choose which specific metrics you wish to be displayed.

			=== QuantaStor Performance Counters ===

			QuantaStor uses the InfluxData's InfluxDB as well as TICK Stack (Telegraf, InfluxDB, Chronograf,Kapacitor collectively called the TICK Stack.). Therefore, various InfluxDB Telegraf Input Plugins are enabled for gathering performance metrics within QuantaStor. The list below shows the plugins enabled, links to the fields they support, and a list of currently supported fields within the QuantaStor Web Management application.

			<pre>
			QuantaStor currently does not use Kapacitor. Any InfluxDB Telegraf input plugins not listed must be requested and certified through OSNEXUS.
			</pre>

			====InfluxDB Telegraf Input Plugins Supported and Configured by QuantaStor====
			:[https://github.com/influxdata/telegraf/tree/master/plugins/inputs/system inputs.system]
			:[https://github.com/influxdata/telegraf/tree/master/plugins/inputs/cpu inputs.cpu]
			:[https://github.com/influxdata/telegraf/tree/master/plugins/inputs/mem inputs.mem]
			:[https://github.com/influxdata/telegraf/tree/master/plugins/inputs/net inputs.net]
			:[https://github.com/influxdata/telegraf/tree/master/plugins/inputs/disk inputs.disk]
			:[https://github.com/influxdata/telegraf/tree/master/plugins/inputs/diskio inputs.diskio]
			:[https://github.com/influxdata/telegraf/tree/master/plugins/inputs/swap inputs.swap]
			:[https://github.com/influxdata/telegraf/tree/master/plugins/inputs/zfs inputs.zfs]
			:[https://github.com/influxdata/telegraf/blob/master/plugins/inputs/ceph/README.md inputs.ceph]

			====Measurement Fields Used by QuantaStor Web Management Application====

			<code>
			;"cpu"
			:usage_iowait
			:usage_idle
			:usage_system
			</code>

			<code>
			;"mem"
			:used_percent
			</code>

			<code>
			;"net"
			:bytes_sent
			:bytes_recv
			</code>

			<code>
			;"diskio"
			:write_bytes
			:read_bytes
			:writes
			:reads
			</code>

			<code>
			;"zfs_pool"
			:nread
			:nwritten
			:reads
			:writes
			</code>

			<code>
			;"ceph"
			:op_w_in_bytes
			:op_r_out_bytes
			:op_r_latency.avgcount
			:op_w_latency.avgcount
			:op_r_latency.avgtime
			:op_w_latency.avgtime
			</code>

			<code>
			;"ceph_pool_stats"
			:write_bytes_sec
			:read_bytes_sec
			:write_op_per_sec
			:read_op_per_sec
			</code>

			<code>
			;"zfs"
			:arcstats_hits
			:arcstats_mru_hits
			:arcstats_mfu_hits
			:arcstats_size
			:arcstats_c
			:arcstats_c_max
			:arcstats_c_min
			</code>

	=== Additional Grafana Resources ===		=== Additional Grafana Resources ===

Qadmin: /* Learning Grafana Resources */

2022-07-27T23:28:41Z

Learning Grafana Resources

← Older revision		Revision as of 23:28, 27 July 2022
Line 118:		Line 118:
	Grafana is now fully set up to create custom dashboards for QuantaStor that allows you to choose which specific metrics you wish to be displayed.		Grafana is now fully set up to create custom dashboards for QuantaStor that allows you to choose which specific metrics you wish to be displayed.

	=== ~~Learning~~ Grafana Resources ===		=== Additional Grafana Resources ===

	[https://grafana.com/tutorials/ Grafana Tutorials]		[https://grafana.com/tutorials/ Grafana Tutorials]

Qadmin at 21:27, 27 July 2022

2022-07-27T21:27:01Z

← Older revision		Revision as of 21:27, 27 July 2022
Line 98:		Line 98:
	[[File:GrafanaNewPanel.png\|Add a new panel\|1000px]]		[[File:GrafanaNewPanel.png\|Add a new panel\|1000px]]

	This will bring up the Edit Panel for your new dashboard. In this space, you are able to make custom dashboards to fit your personal needs. For the initial test, in the <span style="color:#6E9FFF">FROM</span> horizontal column click on ''default'' and select ''quantastor''. Next, click on ''select measurement'' and choose ''cpu''. Finally, under the <span style="color:#6E9FFF">SELECT</span> horizontal column change ''field(value)'' to ''field(~~usage_iowait~~)''. After you've changed all of the mentioned fields the graph will now be showing a visualization of the chosen data from your QuantaStor system.		This will bring up the Edit Panel for your new dashboard. In this space, you are able to make custom dashboards to fit your personal needs. For the initial test, in the <span style="color:#6E9FFF">FROM</span> horizontal column click on ''default'' and select ''quantastor''. Next, click on ''select measurement'' and choose ''cpu''. Finally, under the <span style="color:#6E9FFF">SELECT</span> horizontal column change ''field(value)'' to ''field(usage_idle)''. After you've changed all of the mentioned fields the graph will now be showing a visualization of the chosen data from your QuantaStor system.

	'''Before image of Edit Panel'''		'''Before image of Edit Panel'''

Qadmin at 21:13, 27 July 2022

2022-07-27T21:13:58Z

← Older revision		Revision as of 21:13, 27 July 2022
Line 81:		Line 81:
	[[File:GrafanaURL.png\|Grafana URl Connection\|500px]]		[[File:GrafanaURL.png\|Grafana URl Connection\|500px]]

	For the next step, under the ''InfluxDB Details'' header enter 'quantastor' into the Database and User fields. The password is the same as the password previously found in the [https://wiki.osnexus.com/index.php?title=Grafana_Integration~~&action=submit~~#Acquiring_Username.2FPassword_for_InfluxDB ''Acquiring Username/Password for InfluxDB''] section of this guide.		For the next step, under the ''InfluxDB Details'' header enter 'quantastor' into the Database and User fields. The password is the same as the password previously found in the [https://wiki.osnexus.com/index.php?title=Grafana_Integration#Acquiring_Username.2FPassword_for_InfluxDB ''Acquiring Username/Password for InfluxDB''] section of this guide.

	[[File:GrafanaInfluxDBDetails.png\|Grafana InfluxDB Details\|1000px]]		[[File:GrafanaInfluxDBDetails.png\|Grafana InfluxDB Details\|1000px]]

Qadmin at 21:12, 27 July 2022

2022-07-27T21:12:25Z

← Older revision		Revision as of 21:12, 27 July 2022
Line 31:		Line 31:

	[[File:GrafanaServer.png\|Grafana Server Active\|650px]]		[[File:GrafanaServer.png\|Grafana Server Active\|650px]]

			If you want your Grafana server to automatically launch on boot you can enter the following command:
			<pre>
			sudo systemctl enable grafana-server.service
			</pre>

	=== Acquiring Username/Password for InfluxDB ===		=== Acquiring Username/Password for InfluxDB ===

Qadmin: Created page with "Category:integration_guide == Overview == QuantaStor internally gathers it's metrics through Telegraf and InfluxDB. A user who wishes to set up their own custom dashboard..."

2022-07-27T21:09:11Z

Created page with "Category:integration_guide == Overview == QuantaStor internally gathers it's metrics through Telegraf and InfluxDB. A user who wishes to set up their own custom dashboard..."

New page

[[Category:integration_guide]]
== Overview ==
QuantaStor internally gathers it's metrics through Telegraf and InfluxDB. A user who wishes to set up their own custom dashboard separate from QuantaStor's own tools to view real time stats can also do so through other third party tools like Grafana which can also detect and visualize the data from InfluxDB. The following guide is to be used to help setup a custom Grafana dashboard alongside QuantaStor.

=== How to Install Grafana ===

On the [https://grafana.com/docs/grafana/latest/installation/debian/ Grafana downloads] page underneath the header ''To install the latest Enterprise edition'' you can find instructions for the installation of Grafana on Debian or Ubuntu that goes as follows:
<pre>sudo apt-get install -y apt-transport-https
sudo apt-get install -y software-properties-common wget
sudo wget -q -O /usr/share/keyrings/grafana.key https://packages.grafana.com/gpg.key
</pre>
Adding the following repository will keep your Grafana up-to-date on stable releases:
<pre>
echo "deb [signed-by=/usr/share/keyrings/grafana.key] https://packages.grafana.com/enterprise/deb stable main" | sudo tee -a /etc/apt/sources.list.d/grafana.list
</pre>
After these steps you can finish installation of Grafana with the commands:
<pre>
sudo apt-get update
sudo apt-get install grafana-enterprise
</pre>

=== Running the Grafana Server ===

To turn on and verify Grafana is working you should enter the following command lines:
<pre>
sudo systemctl daemon-reload
sudo systemctl start grafana-server
sudo systemctl status grafana-server
</pre>
The system should display '''Active:''' active(running) if everything is working properly.

[[File:GrafanaServer.png|Grafana Server Active|650px]]

=== Acquiring Username/Password for InfluxDB ===

Run the following command on your QuantaStor system and record the given ''username'' and ''password''.
<pre>
cat /etc/telegraf/telegraf.conf | grep "username\|password"
</pre>
The credentials will be given in a format similar to this:
<pre>
username = "quantastor"
password = "b15beec1-a400-fb47-d267-04eedd302c9a"
</pre>
This is the username and password used to access your QuantaStor systems metrics via InfluxDB. Keep a record of the username and password to enter in at a later step.

=== How to log in to Grafana ===

Open up a browser and navigate to the IP address of the QuantaStor system followed by the port 3000, the default used to access Grafana. For example:
<pre>
http://10.0.16.60:3000
</pre>
This will bring you to the login page of Grafana. The default username and password for this login screen is "admin". Once you successfully are logged in you'll be taken to the main page of Grafana.

[[File:GrafanaLogin.png|Grafana Login Screen|500px]]

'''*If prompted to set up a password for Grafana you can either select skip or set up a personal password'''

=== Set up InfluxDB as a Data Source ===

By default, the user has to select InfluxDB as a data source in order for Grafana to be able to detect and visualize the data from your QuantaStor system. This can be done by clicking on the Configuration wheel toward the bottom left of the screen (see image).

[[File:GrafanaConfig.png|Grafana Configuration Wheel|1000px]]

[[File:GrafanaAddDataSource.png|Grafana Add Data Source|1000px]]

From this screen, you can click on the large ''Add data source'' button in the middle of the screen. This will bring you to a menu with numerous options to select from, choose ''InfluxDB''.

[[File:GrafanaInfluxDB.png|Grafana InfluxDB Selection|1000px]]

In this new menu for setting up the InfluxDB data source under the ''HTTP'' header set the url to the IP address of the QuantaStor system followed by the default port used by Grafana, 8086. For example:
<pre>
http://10.0.16.60:8086
</pre>

[[File:GrafanaURL.png|Grafana URl Connection|500px]]

For the next step, under the ''InfluxDB Details'' header enter 'quantastor' into the Database and User fields. The password is the same as the password previously found in the [https://wiki.osnexus.com/index.php?title=Grafana_Integration&action=submit#Acquiring_Username.2FPassword_for_InfluxDB ''Acquiring Username/Password for InfluxDB''] section of this guide.

[[File:GrafanaInfluxDBDetails.png|Grafana InfluxDB Details|1000px]]

Once all mentioned fields are filled click on ''Save & Test'' toward the bottom of the screen. This will result in an alert that the '''data source is working''' if everything is functional. Now Grafana is ready to create custom advanced dashboards for your QuantaStor system.

[[File:GrafanaWorking.png|Data Source is working|450px]]

=== Setting up a Test Dashboard in Grafana ===
It can be a good idea to set up an initial simple test dashboard in order to make sure that everything is working properly. To do so in Grafana, hover over the four-cube icon on the left bar and select ''+ New Dashboard''.

[[File:GrafanaNewDashboard.png|+ New Dashboard|1000px]]

On this new screen, select ''Add a new panel'' inside of the Add panel box.

[[File:GrafanaNewPanel.png|Add a new panel|1000px]]

This will bring up the Edit Panel for your new dashboard. In this space, you are able to make custom dashboards to fit your personal needs. For the initial test, in the FROM horizontal column click on ''default'' and select ''quantastor''. Next, click on ''select measurement'' and choose ''cpu''. Finally, under the SELECT horizontal column change ''field(value)'' to ''field(usage_iowait)''. After you've changed all of the mentioned fields the graph will now be showing a visualization of the chosen data from your QuantaStor system.

'''Before image of Edit Panel'''

[[File:GrafanaEmptyEditPanel.png|Grafana before edit panel|1000px]]

'''After image of Edit Panel'''

[[File:GrafanaAfterEditPanel.png|Grafana after edit panel|1000px]]

To save this panel to your new dashboard click on Apply in the top right of the screen.

[[File:GrafanaApply.png|Apply changes to panel|1000px]]

After that you'll be brought back to your dashboard, which now has a panel displaying the chosen metrics. If you want to create additional panels for this dashboard you can press the ''Add panel'' icon near the top right of the screen. You can also edit the name and additional settings of the dashboard by clicking on the Dashboard settings wheel towards the top right of the page near the Add Panel icon.

[[File:GrafanaAddPanel.png|Create a new panel for the dashboard|1000px]]

Grafana is now fully set up to create custom dashboards for QuantaStor that allows you to choose which specific metrics you wish to be displayed.

=== Learning Grafana Resources ===

[https://grafana.com/tutorials/ Grafana Tutorials]

[https://university.grafana.com/learn Grafana University]

[https://grafana.com/docs/ Grafana Documentation]