Spectrum Performance View (Beta)

From 10.4.1, Spectrum Performance View provides a real-time health dashboard for the distributed
DX NetOps Spectrum
environment. The administrator can run this tool to get the performance trends, it is disabled by default. SpectroSERVER tracks the performance statistics like Operating System Metrics (like CPU, memory, threads and so on) and other internal metrics like total models, traps, events, alarms and so on. These metrics are retrieved every minute and stored as an event on the SpectroSERVER Performance model.
These metrics are useful in capacity planning and troubleshooting performance problems like:
  • Spectrum sending too much traffic
  • Frequent disconnection of OneClick Server
  • SpectroSERVER hang
  • Poll/notifications latencies
  • Frequent crashes / getting Out of Memory
Before the current release, PerfCollector was used for the purpose. PerfCollector is a troubleshooting tool which pulls the performance events from every landscape and creates prf files for performance analysis. It lacks in providing real-time UI to observe the trend.
The Health dashboard provides a real-time
DX NetOps Spectrum
performance across DSS. You can review the dashboard at regular intervals and take preventive action if you find any dissimilarity in the trend.
DX NetOps Spectrum
pulls the performance events from every landscape and stores the data into the Influx database. It uses the REST Interface to pull the events from DDMDB.
Understanding the Spectrum Performance View
The following illustration shows the architecture of the Spectrum Performance View:
DSS View
The Spectrum Performance View has the following two dashboards:
  • SpectrumInsideView:
    Application to collect SpectroSERVER performance events and store in influx.
  • Dashboard:
    • OneClick Server -DSS View
      – High-level summary of all SpectroSERVER metrics attached to OneClick.
    • Spectrum Health View
      – Details of SpectroSERVER metrics.
OneClick Server - DSS View
The OneClick Server DSS View (Beta) provides the high-level summary of all SpectroSERVER associated with the OneClick server. The view also provides the following information:
  • SpectroSERVER, Archive manager CPU and memory utilization.
  • The total number of devices discovered in each SpectroSERVER.
DSS View
Spectrum Health View
The Spectrum Health View provides a detailed view of each metric of SpectroSERVER like SpectroSERVER CPU, SpectroSERVER Memory, Archive Manager CPU, Archive Manager Memory, SNMP traps and discovered devices and so on.
Spectrum Health View summary
Spectrum Health View Data
Spectrum Health View Data
Set Up Spectrum Performance View
Set Up Influx Database
The influx database is installed in the
$SPECROOT\influx
folder. It runs on a default port 9445 and uses HTTP communication.
You can change the port by editing the
influxdb_spectrum.conf
file under the HTTP section, port number.
Follow these steps:
  1. Start the Influx DB using the following command:
    influxd.exe -config influxdb_spectrum.conf
  2. Create the
    Spectrum
    user to communicate using the following command.
    influx -port 9445 -database spectrum -execute "CREATE USER spectrum WITH PASSWORD 'spectrum' WITH ALL PRIVILEGES"
    Update the port, if you changed the default value.
Configure the SpectrumInsideView
The configuration file for SpectroSERVER Health View,
SpectrumInsideView.conf
is located in the
$SPECROOT\insideView
directory. The SpectrumInsideView.conf file contains OneClick Server name, Port, HTTP mode and initial sync and increment sync duration. The file also contains the Influx DB details like database name, HTTP port, and mode.
OneClickNodes
  • OneClickServerName
    Specifies the hostname of the OneClick server.
  • httpMode
    Specifies the appropriate protocol.
    Default:
    HTTP
  • CertPath
    Specifies the OneClick certificate path.
  • OcUsername
    Specifies the OneClick user name.
  • OCPassword
    Specifies the OneClick user password.
  • OneClickPort
    Specifies the OneClick port.
  • InitialSyncDays: 45
    Specifies the interval at which the OneClick must sync with Spectruminsideview. The minimum value must be one minute.
  • PollTimerMins
    Specifies the interval between two polls.
    Optimal Interval to avoid Overload:
    Five minutes
  • throttleSize
    Specifies the throttleSize
Service
  • DatabaseType
    Specifies the type of database.
    Default:
    influx.
  • DatabaseName
    Specifies the database name.
  • DBServerName: localhost
    Specifies the DB server name.
  • DBPORT: 9445
    Specifies the DB server port.
  • DBUsername: spectrum
    Specifies the DB user name.
  • DBPassword: spectrum
    Specifies the DB user name.
  • DBhttpMode: http
    Specifies the DB protocol.
  • DBCertPath:
    Specifies the path of the DB certificate.
  • LogLevel: INFO
    Specifies the DEBUG, INFO, ERROR, WARN.
    Default:
    ERROR
  • LogSizeBytes: 10000000
    Specifies the size of the log file in bytes.
  • LogFileCount: 5
    Specifies the maximum number of log back up files.
For more information, see the Sample Configuration file.
Run the SpectrumInsideView
This section describes the steps to run the SpectrumInsideView.
Follow these steps:
  1. Open the terminal.
  2. Navigate to the
    $SPECROOT\insideview\dashboard
    directory.
  3. Run
    SpectrumInsideView.exe
    By default, the
    SpectrumInsideView.log
    file is created in the
    $SPECROOT\insideView\
    directory for troubleshooting.
  4. The <landscape>_sync file is automatically created for each SpectroSERVER that contains the timestamp of last Sync time for corresponding SpectroSERVER.
  5. Press CTRL+C to stop SpectrumInsideView.
Install and Import Dashboard in Grafana
This section describes the procedure to install and import the SpectroSERVER health view dashboard in Grafana.
If Grafana is not available in your pod/machine, install it.
Follow these steps:
  1. Log in to the Grafana portal.
    Default Credentials:
    admin/admin
  2. Add influx DB data source name as "InfluxDB" (URI : http://<oneClickServername>:9445, username: spectrum /password).
    Spectrum Health View Data
  3. Create a dashboard folder with the name
    Spectrum Performance View.
  4. Import the Spectrum_health_View.json and OneClick_Server_View.json files into Grafana and place under the
    Spectrum Performance View
    directory.
    Spectrum Health View Data
Troubleshoot the Spectrum Performance View
This section describes the commonly identified issues and workaround to resolve the issue.
  • If any error occurs while executing SpectrumInsideView, restart the SpectrumInsideView by changing the sync files to 0, then SpectrumInsideView starts from initial sync. This does not lead to data duplication in influx.
  • Ensure that OneClick Rest call throttle size is between 1000 and 2000, to avoid overload on OneClick Server.
  • The optimal value for the PollTimerMins parameter is five minutes, a lower value may overload the OneClick server with RestAPI.