Manually installing the Performance Monitoring tool

The Performance Monitoring tool is automatically installed by the spectrumscale installation toolkit. You can also install the Performance Monitoring tool manually for the releases that are not supported by the installation toolkit.

For more information, see Understanding the spectrumscale installation toolkit options. For more information about the Performance Monitoring tool, see Configuring the Performance Monitoring tool in IBM Spectrum Scale: Advanced Administration Guide.

During an upgrade to the tool or in case of any issues, you can manually install the tool by performing the following steps:

Download and install the following packages, which are available in /usr/lpp/mmfs/4.2.0.0/zimon_rpms.
```
gpfs.gss.pmsensors_version-release.os.target_arch.file_format
gpfs.gss.pmcollector_version-release.os.target_arch.file_format
```
Then use your operating system’s native package management mechanism.
For example:

To install 4.2.0-0 sensors on a Red Hat 7, x86_64 node use the following command:
```
rpm -ivh gpfs.gss.pmsensors_4.2.0-0.el7.x86_64.rpm
```
To install 4.2.0-0 sensors on a Ubuntu 14, amd64 node use the following command:
```
dpkg -i gpfs.gss.pmsensors_4.2.0-0.U14.04_amd64.deb
```
To install a 4.2.0-0 collector on a Red Hat 7, ppc64 little endian node use the following command:
```
rpm -ivh gpfs.gss.pmcollector-4.2.0-0.el7.ppc64le.rpm
```
To install a 4.2.0-0 collector on a Red Hat 6, ppc64 node use the following command:
```
rpm -ivh gpfs.gss.pmcollector-4.2.0-0.el6.ppc64.rpm
```
A single collector can easily support up to 400 sensor nodes. The collector can be any node on the system. All sensors will report to this node. Select any node in the system to be the collector node and modify the /opt/IBM/zimon/ZIMonSensors.cfg file on the node as follows:
- If you are running the NFS protocol and want NFS metrics then include the following:
```
{
    # NFS Ganesha statistics
    name = "NFSIO"
    period = 1
    type = "Generic"
},
```
- If you are running the SMB protocol and want SMB metrics then include the following:
```
{ 
        name = "SMBStats"
        period = 1
        type = "Generic"
},
{
        name = "SMBGlobalStats"
        period = 1
        type = "Generic"
},
{
        name = "CTDBStats"
        period = 1
        type = "Generic"
},
{ 
        name = "CTDBDBStats"
        period = 1
        type = "Generic"
},
```
- At the bottom of the file add the following:
```
collectors = 
{
        host = "<ip of collector node>|<fully qualified domain name of collector node>"         
        port = "4739" 
}
```
- To enable performance monitoring for Object, install the pmswift rpm:
  rpm -ivh pmswift-<version>-<release>.noarch.rpm
  
  where <version> is equal to or greater than 4.2 and <release> is equal to or greater than 0.
  
  The installation of the pmswift rpm also copies SWIFT related sensors configuration files, namely, SwiftAccount.cfg, SwiftContainer.cfg, SwiftObject.cfg and SwiftProxy.cfg to the Performance Monitoring tool’s installation directory, /opt/IBM/zimon/. The pmswift rpm converts the operational metrics for Object into a form that is usable by the Performance Monitoring tool.
  After installation of the pmswift rpm, the following steps must be carried out:
  1. Edit the Object configuration files for all Object servers that reside in cluster configuration repository (CCR), using the following command:
```
/usr/local/pmswift/bin/pmswift-config-swift set
```
    CCR will then propagate modified configuration files to /etc/swift/ directory on all the protocol nodes within the cluster. The modified configuration files are:
    - account - *.conf
    - container - *.conf
    - object - *.conf
    - proxy - *.conf
  2. Use the /usr/local/pmswift/bin/pmswift-config-zimon set command to edit the sensors configuration information stored in the CCR. This adds the SWIFT related following sensors entries:
```
{
        # SwiftAccount operational metrics
        name = "SwiftAccount"
        period = 1
        type = "generic"
},
{
        # SwiftContainer operational metrics
        name = "SwiftContainer"
        period = 1
        type = "generic"
},
{
        # SwiftObject operational metrics
        name = "SwiftObject"
        period = 1
        type = "generic"
},
{
        # SwiftProxy operational metrics
        name = "SwiftProxy"
        period = 1
        type = "generic"
},
```
    These entries are then automatically propagated to the ZIMonSensors.cfg file in /opt/IBM/zimon on all the nodes in the cluster.
  3. Start the pmswiftd.service using the following command:
```
systemctl start pmswiftd.service
```
  4. Start/restart the pmsensors.service using the following command:
```
systemctl start|restart pmsensors.service
```
  For more information on how to manually upgrade pmswift, see the Manually upgrading pmswift topic.
If the protocol sensors are enabled on a GPFS-only node, you will see an error regarding them being unavailable, however, the other sensors will continue running.
Start the sensors on each node using the systemctl start pmsensors.service command.
On the collector nodes, start the collector, using the systemctl start pmcollector.service command.
To ensure that sensors and collectors are restarted after the node reboots, you can enable them using the following commands:
Sensors

To disable sensors, use the systemctl disable pmsensors.service command.

To enable sensors, use the systemctl enable pmsensors.service command.

Collector

To disable the collector, use the systemctl disable pmcollector.service command.

To enable the collector, use the systemctl enable pmcollector.service command.

The collector node will start gathering all the requested metrics.

Note: Although you can enable sensors on every node in a system, do note that with the increase in number of nodes, the metric collection work for the collector also increases. It is recommended to ensure that collection of metrics does not increase above 1000000 metrics per second.

By default, the install toolkit enables metrics on each protocol node but not on the GPFS™ nodes.

Metrics can be retrieved from any node in the system using the mmperfmon query command. For more information, see mmperfmon command in IBM Spectrum Scale: Administration and Programming Reference.

For more information about the Performance Monitoring tool, see Configuring the Performance Monitoring tool in IBM Spectrum Scale: Advanced Administration Guide.