Magnum Metrics Collection Module

Metrics collection module for the Magnum RPC-JSON API interface which collects host CPU, Memory, Disk, and Network metrics used by the inSITE Poller program.

The metrics collection module has the below distinct abilities and features:

1. Collect metrics at the system cluster IP address.
2. Discovers all servers in a Magnum system.
3. Normalizes metric values into raw percentages or byte values to support dashboard field formatters.
4. Groups like metrics together to be indexed in a single document.
5. Indexes individual metrics.

Minimum Requirements:

• inSITE Version 10.3 and service pack 6
• Python3.7 (already installed on inSITE machine)

Installation:

Installation of the status monitoring module requires copying two scripts into the poller modules folder:

1. Copy magnum_metrics.py script to the poller python modules folder:

    cp scripts/magnum_metrics.py /opt/evertz/insite/parasite/applications/pll-1/data/python/modules/
   

2. Restart the poller application

Configuration:

To configure a poller to use the module start a new python poller configuration outlined below

1. Click the create a custom poller from the poller application settings page.
2. Enter a Name, Summary and Description information.
3. Enter the cluster ip address of the Magnum system in the Hosts tab.
4. From the Input tab change the Type to Python
5. From the Input tab change the Metric Set Name field to magnum
6. From the Python tab select the Advanced tab and enable the CPython Bindings option
7. Select the Script tab, then paste the contents of scripts/poller_config.py into the script panel.
8. Save changes, then restart the poller program.

Testing:

The magnum_metrics script can be ran manually from the shell using the following command

python magnum_metrics.py

Below is the help output of the

python magnum_metrics.py -h

usage: magnum_metrics.py [-h] (-IP 127.0.0.1 | -z )

Magnum RPC-JSON API Poller program for system health metrics

optional arguments:
  -h, --help            show this help message and exit
  -IP 127.0.0.1, --address 127.0.0.1
                        Magnum Cluster IP Address
  -z , --fakeit         supplement some fake data