Configuring a performance monitoring API key for the IBM Spectrum Scale Performance Monitoring Bridge

Starting with IBM Storage Scale version 5.1.1 any client querying the performance data from the IBM Storage Scale cluster needs the API key authentication. To create API key for the grafana-bridge application complete the following steps:

1. Add the 'scale_grafana' API key to your IBM Storage Scale performance monitoring configuration using 'mmperfmon config' command:

# mmperfmon config add --apiKey scale_grafana
API key file _perfmon.keys successfully uploaded to CCR

2. Show the generated key by invoking 'mmperfmon config show --apiKey scale_grafana'.

# mmperfmon config show --apiKey scale_grafana
{
    "key": "ad270b0a-840b-494f-8513-110b6b28b479",
    "comment": "user comment"
}

3. Provide the API key data to your installed IBM Storage Scale Performance Monitoring Bridge. You have three options for doing this:

   • Store the API key name and value in the config.ini file and restart the grafana bridge.

     #################################### GPFS Server ##############################
     [server]
     # The ip address to bind to, empty will bind to all interfaces
     server = localhost
     
     # The https port to use
     serverPort = 9980
     
     # The name of REST HTTPS API key name
     apiKeyName = scale_grafana
     
     # The REST HTTPS API key value
     apiKeyValue = ad270b0a-840b-494f-8513-110b6b28b479
     
     

     Read more about the configurable bridge settings on the WiKi.

   • alternatively you can store a string of 32 hexadecimal digits in a file and specify the file location as the REST HTTPS API key value.

     #################################### GPFS Server ##############################
     [server]
     # The ip address to bind to, empty will bind to all interfaces
     server = localhost
     
     # The https port to use
     serverPort = 9980
     
     # The name of REST HTTPS API key name
     apiKeyName = scale_grafana
     
     # The REST HTTPS API key value
     apiKeyValue = /etc/bridge_ssl/apikey_scale-21
     
     

   • Pass the API key name and value as the input parameters(--apiKeyName, --apiKeyValue) at the grafana-bridge start. If you skip passing the --apiKeyName parameter, the API key name will be automatically set to 'scale_grafana'. To see the full list of supported parameters run 'python3 zimonGrafanaIntf.py --help'.

     # python3 zimonGrafanaIntf.py --apiKeyValue ad270b0a-840b-494f-8513-110b6b28b479
     2021-04-09 08:30 - INFO     -  *** IBM Spectrum Scale bridge for Grafana - Version: 7.0 ***
     2021-04-09 08:30 - INFO     - Successfully retrieved MetaData
     2021-04-09 08:30 - INFO     - Received sensors:CPU, DiskFree, GPFSFilesystem, GPFSFilesystemAPI, GPFSNSDDisk, GPFSNSDFS, GPFSNSDPool,  GPFSNode, GPFSNodeAPI, GPFSRPCS, GPFSVFSX, GPFSWaiters, Load, Memory, Netstat, Network, TopProc, CTDBDBStats, CTDBStats, SMBGlobalStats, SMBStats, GPFSDiskCap, GPFSFileset, GPFSInodeCap, GPFSPool, GPFSPoolCap
     2021-04-09 08:30 - INFO     - Initial cherryPy server engine start have been invoked. Python version: 3.6.8 (default, Dec  5 2019, 15:45:45)
     [GCC 8.3.1 20191121 (Red Hat 8.3.1-5)], cherryPy version: 18.6.0.
     2021-04-09 08:30 - INFO     - server started

     Note: You can suppress displaying of the API value on the command line by invoking the '--apiKeyValue' argument without any value. In this case, the command line interface will prompt you to enter the 'password'.

     # python3 zimonGrafanaIntf.py --apiKeyValue
     no valid apiKeyValue found in the config.ini
     Password:
     2021-04-09 08:21 - INFO     -  *** IBM Spectrum Scale bridge for Grafana - Version: 7.0 ***
     2021-04-09 08:21 - INFO     - Successfully retrieved MetaData
     2021-04-09 08:21 - INFO     - Received sensors:CPU, DiskFree, GPFSFilesystem, GPFSFilesystemAPI, GPFSNSDDisk, GPFSNSDFS, GPFSNSDPool, GPFSNode, GPFSNodeAPI, GPFSRPCS, GPFSVFSX, GPFSWaiters, Load, Memory, Netstat, Network, TopProc, CTDBDBStats, CTDBStats, SMBGlobalStats, SMBStats, GPFSDiskCap, GPFSFileset, GPFSInodeCap, GPFSPool, GPFSPoolCap
     2021-04-09 08:21 - INFO     - Initial cherryPy server engine start have been invoked. Python version: 3.6.8 (default, Dec  5 2019, 15:45:45)
     [GCC 8.3.1 20191121 (Red Hat 8.3.1-5)], cherryPy version: 18.6.0.
     2021-04-09 08:21 - INFO     - server started