For a basic setup of System Insight, you require the following:
- An InfluxDB instance to store metrics with a minimum of 10 GB of disk space
- A Grafana dashboard to visualize the metrics that you want to display
- An SC to run the system insight service
Note!
The minimum requirement of 10 GB is based on a basic setup for system statistics with the default retention policy of one week for short-term storage, and one year for downsampled long-term storage.
To get System Insight up and running for test purposes, there are a number of scripts and configuration files available:
- A script for a default setup of InfluxDB
- A script for a default setup of Grafana
A sample script to set up System Insight on SCs
Note!
The scripts to set up InfluxDB and Grafana are supported on Ubuntu/Debian and Centos/Redhat only.
If you require to configure a System Insight setup using InfluxDB and Grafana offline, copy the grafana<version>.deb
and influxdb.conf
files and the scripts from $MZ_HOME/scripts/str-templates/system-insight
and save them in the same directory, then follow the instructions provided below starting from step 2:
If you are working online, proceed to the instructions below.
Note!
Due to the service manager used in Ubuntu 14.04, if you are using this version of Ubuntu, before you run the script to set up InfluxDB as instructed in step 2, you must rename the systemctl
command as follows:
mv systemctl systemctl-bak
Before you proceed to step 3, rename systemctl-bak to systemctl again:
mv systemctl-bak systemctl
The steps are as follows:
Navigate to the directory
$MZ_HOME/scripts/str-templates/system-insight
.
Run the following script to set up InfluxDB:
$ sudo ./si_influxdb_setup.sh
If required, you can modify the default username and password, and you can also change the database name before running the script. The variables to change in the script are INFLUX_ADMIN_USR, INFLUX_ADMIN_PWD and INFLUX_SCHEMA.
To ensure that the InfluxDB instance works as it should, use the following influx command:
$ sudo influx -username <username> -password <password> $ show databases
The output should be the following:
name: databases name ---- mz _internal
Alternatively, you can use the following cURL command:$ curl -XPOST -u <username>:<password> http://<host name>:8086/query --data-urlencode "q=SHOW DATABASES"
The output should be the following:
{"results":[{"statement_id":0,"series":[{"name":"databases","columns":["name"],"values":[["mz"],["_internal"]]}]}]}
Run the following script to set up Grafana:
$ sudo ./si_grafana_setup.sh
If required, you can modify the default username and password before running the script. The variables to change in the script are
GRAFANA_USR
andGRAFANA_PWD
.If you want to add sample dashboards, run the script again with the flag
add-dashboards
:$ sudo ./si_grafana_setup.sh add-dashboards
Once successfully installed browse to http://<host name>:3000.
Note!
By default, Grafana is installed using http. If you want to use Grafana over https, see the section, Grafana Over https, in 2.1.3 Access Grafana via Desktop or Web UI.
Run the following script on the Platform instance, with the
si-topo
flag to run the topo commands required to set up with System Insight:$ ./si_basic_setup.sh si-topo
If you want to access Grafana from the Desktop via Tools, or via theWeb UI,
http://<platform host>:<web interface port>/mz/
, modify the property GRAFANA_URL as follows before running the script:GRAFANA_URL='http://<host name>:3000'
For further information an this method of accessing Grafana from, see 2.1.3 Access Grafana via Desktop or Web UI.
You are then prompted to restart the Platform and picos, and startup the services:
$ mzsh restart platform $ mzsh system restart $ mzsh service start
To set up the filters, run the script with the
si-basic-filters
flag and your credentials. This step is not obligatory but provides a setup in which system metrics are produced for InfluxDB:$ ./si_basic_setup.sh si-basic-filters <username> <password>
Steps 6 - 8 are required as system insight service must be up and running to be able to create profiles and filters.