This document describes how to download and install the RTView DataServer for Solace for use with RTView Enterprise, how to configure the data server including defining the connection information for the Solution Package for Solace, how to add alert and historian database connections, how to add connections to RTView Enterprise, and how to verify that your setup is working properly in RTView Enterprise.
You can output and store collected monitoring data to RTView Enterprise, InfluxDB or a Solace Broker. Note that if you are going to Output Data to Solace Broker you don't need to configure RTView Enterprise. These instructions describe how to install and setup each of the three options.
You can also monitor Syslog events from Solace Message Brokers using the Solace Event Module application. For details, see Solace Event Module.
Note: If you are NOT going to Output Data to Solace Broker, you can use the RTView Configuration Application for configuring your connections, or you can use the Property Editor REST API to import initial connections or automate connection updates. See Property Editor REST API for more information.
Before You Get Started
You must have Java installed and you should know the installation directory path.
You should know the correct full path to the directory containing the jar files for each of your solution packages.
You should know the connection settings for your solution packages:
Solace connections: For message routers, know the SEMP Version of the message router(s), URL, and VPN (if defined). For Syslog connections, know the protocol, host, and port.
Solace Cloud Event Brokers: You need to provide the exact SEMP version on each Solace Cloud Broker. Use the Solace Cloud console to get the value for theSolace Broker Versionfield, underStats. The broker version aligns with the SEMP v1 version. You will use the first three digits, including any decimal points, of the value shown in the Solace Cloud Event BrokerSolace Broker Versionfield, concatenated with this string:VMR. For example, if the value for theSolace Broker Versionfield is220.127.116.11.0, you enter:9.1.1VMR
If you are upgrading to a new version of the DataServer, review theGeneral Upgrade Stepsdocument to see if there are any additional steps required. You should also review the upgrade steps for the Solution Package for Solace.
Download the RTView DataServer for Solace
Open a browser and navigate tohttps://sl.flexnetoperations.com/.
Login using your RTView Download Center account login/password.
If you do not have an RTView Download Center account, contact firstname.lastname@example.org about helping you to create an account.
The RTView Download Center page displays.
Click the SL Corporation link in theBrowse My Software and Documentationregion.
The RTView Download Center displays.
Click the RTView DataServer for Solace link.
The Product Information page displays.
Click the RTView DataServer for Solace link.
The Product Download page displays.
Click theRTViewDataServerSolace_<version>.zipfile or, if you want to download multiple files, select the check box next to the different deliverables and click theDownload Selected Filesbutton.
The compressed file(s) is/are saved to your machine.
When you install the DataServer, a temporary license key is included. SL Corporation will send you a permanent key that you will need to add to your RTView license key file so that you can extend the operation of your monitoring system.
This is a universal key that will enable you to run RTView on different machines and platforms. It is your responsibility to ensure you use RTView within the terms of your End User License Agreement (EULA).
To update your RTView system with your new license key, open a command window and:
Navigate to RTViewDataServerSolace/rtvapm/rtview/lib.
Edit the KEYS file using a text editor.
Copy/paste the new replacement key to the file.
Save the KEYS file.
Install the RTView DataServer for Solace
Note: If using UNIX, do not include spaces in your installation directory path. The start_server.sh and stop_server.sh scripts will not function properly if spaces are included in the installation directory path.
Extract All (Windows)/unzip (UNIX/Linux) the file to the directory of your choice. For UNIX/Linux, useunzip -ato unzip the file.
Open a command window and set theJAVA_HOMEenvironment variable to point to your Java Installation. For example:
set JAVA_HOME=C:\Program Files (x86)\Java\jre1.8.0_201(Windows)
Or, in Windows, you can set JAVA_HOME as an environment variable (in Control Panel > System > Advanced system settings), where it will then be used by all command windows and when you double-click on a .bat file.
In the command window, navigate to theRTViewDataServerSolacedirectory and type:
Or, in Windows, you can double-click on the start_server.bat file.
Note: This script starts the Data Server on port 3278 with HTML Server (Eclipse Jetty, by default) on port 3270. If these ports conflict with other processes running on your system, you can change the first two digits of the ports by using-portprefix:and specifying the first two digits you want to use for the ports in the command line. For example:start_server.bat -portprefix:44(which would change the ports to 4478 for the Data Server and 4470 for HTML Server). If you want to save your port prefix, you can change the port prefix in the RTView Configuration Application (see the next section), or you can use -saveportprefix: command line argument (for example: start_server.bat -portprefix:44 -saveportprefix).
Configure the Data Server
Next, you need to create your connections for each of your solution packages using the RTView Configuration Application.
Open a browser and type:
http://localhost:3270/rtvadmin (for a local installation using Eclipse Jetty)
http://<IP address>:3270/rtvadmin (for a remote installation using Eclipse Jetty)
Note: If you specified a different port at startup (due to a port conflict), you must use the port you specified in the command line. For example, if you specified44as your port prefix in the command line at startup, then you would use:
TheAuthentication requireddialog displays.
Log in using rtvadmin/rtvadmin as the username/password.
The RTView Configuration Application displays.
Click RTView DataServer for Solace.
The RTView Configuration Application displays with the Generaltab open.
Note: The navigation tree is in the left panel and the General and Custom Properties tabs are at the top of the page. These instructions use the following format to describe navigation to each tab: Navigation tree>Tab. For example, the figure above illustrates the General>GENERAL Tab.
As previously mentioned, if you modified the port at startup, you should modify the port prefix so that you do not need to specify the port on the command line every time you run the startup script. To do so, navigate toServer Configuration>General>GeneralTab >Ports>Port Prefixand define a new port prefix. If you change thePort Prefixto44then, after saving your changes and restarting your data server, you would access the RTView Configuration Application for the RTView DataServer for Solace using the following URL: http(s)://localhost:4470/rtvadmin(instead of the default http(s)://localhost:3270/rtvadminURL)
Under Solution Package Configuration, select the desired solution package you want to configure and click the link below to view the steps required to set up the configuration for the solution package:
Next, you need to connect your data server to RTView Enterprise. To do so:
ClickServer Configuration>EM Integration.
TheEM INTEGRATIONtab displays.
Click theIntegrate with Enterprise Monitortoggle.
Note: This field can be enabled by default by setting theRTVDS_INTEGRATEENABLEDenvironment variable to 1 (for example: RTVDS_INTEGRATEENABLED=1).
TheCentral Server URLfield and associatedAnnounce this RTView Data Server to the Central Servertoggle display.
Specify theCentral Server URLto be used to connect to your RTView Central Server. By default, a local connection is defined (localhost:10018) and does not need to be modified if your Central Server and Data Server are on the same machine. If they are on different machines, enter the URL containing the IP address and the port like so:
Note: You can specify a different default for the Central Server URLfield by specifying theRTVDS_CENTRALURLenvironment variable (for example: RTVDS_CENTRALURL=http://localhost:10070/rtview-central-rtvdata).
Click the Announce this RTView Data Server to the Central Server toggle to automatically connect the data server to RTView Central.
Note: This field can be enabled by default by setting the RTVDS_ANNUNCIATEENABLEDenvironment variable to 1 (for example: RTVDS_ANNUNCIATEENABLED=1).
The following fields display:
RTView Data Server Name: Define the name of the data server that you want to display in RTView Enterprise. Modifying the default name in this field is optional. However, for our example, enterSolace_Data_Serverso that we can verify our change in our verification section later in this document. This field can be defined by default by defining the RTVDS_NAME environment variable (for example: RTVDS_NAME=SOLMON_LOCAL). Note: You can only enter alphanumeric characters, underbars, and dashes in the data server name.
RTView Data Server URL: The URL that the Central Server should use for connecting to this RTView Data Server. The default depends on theHTML Server Enabledoption on theData Servertab. If theHTML Server Enabledoption is selected, the default ishttp://hostname:3270/rtvdata. If disabled, the default ishostname:3278where 32 is the Port Prefix for this project and hostname is the RTView Server Host. This field can be defined by default by defining the RTVDS_URL environment variable (for example: RTVDS_URL=http://myhost:3270/rtvdata).
RTView Query URL: The URL that HTML clients should use to query this RTView Data Server. The default depends on theHTML Server Enabledoption on theData Servertab. If theHTML Server Enabled option is selected, the default ishttp://hostname:3270/rtvquerywhere 32 is the Port Prefix for this project and hostname is the RTView Server Host. IfHTML Server Enabledis disabled, this field is blank. IfHTML Server Enabledis disabled, this field is blank. This field can be defined by default by defining the RTVDS_QUERYURL environment variable (for example: RTVDS_QUERYURL=http://myhost:3270/rtvquery).
RTView Data Server Host: The Host name or IP address that the Central Server and html clients should use for connecting to this RTView Data Server. If not specified, the IP address for the host is used.This field can be defined by default by defining the RTVDS_HOST environment variable (for example: RTVDS_HOST=localhost).
CITypes to Exclude: The CI Types, if any, that you want to exclude from the Service Model in the Central Server. If not specified, all CI Types for the configured solution packages are included in the Service Model. To select the CI Types you want to exclude, click the associated button to display theCI Types to Excludedialog, select the desired CI Types, and clickOK. This field can be defined by default by defining the RTVDS_CITYPESTOEXCLUDE environment variable (for example: RTVDS_CITYPESTOEXCLUDE=SOLACE-BRIDGE,SOLACE-CLIENT).
Save Your Changes and Restart the Data Server
Once you have created all of your connections, click theSAVE button in the RTView Configuration Application.
For your changes to go into effect, you must stop and restart the data server by either:
clicking thebutton (in the upper right-hand corner of the window)...
or by typing the following in your installation directory in the command window:
Verify Your Setup
To verify your setup:
Open a browser, access the RTView Configuration Application for RTView Central Servers (RTView Enterprise) using http://localhost:10070/rtview-central-rtvadmin, and log in using rtvadmin/rtvadmin as the username/password.
Your data server (Solace_Data_Server, for our example) displays in the list belowRTView Central Servers. You can edit your data server connections/configurations in the RTView Configuration Application for RTView Central (http://localhost:10070/rtview-central-rtvadmin) or in the RTView Configuration Application for the RTView DataServer for Solace deliverable (http://localhost:3270/rtvadmin).
Open a browser, access RTView Enterprise (for example, http://localhost:10070/rtview-central-classic), and log in using admin/admin as the username/password.
Click Admin > Architecture > System Overview and check to make sure that your newly connected data server (Solace_Data_Serverin our example) displays in the Data Servers region and that CI Metrics are being collected.
You can also check the incoming data in your caches by opening a browser and accessing the following URL:
http(s)://localhost:3270/common (for a local installation using Eclipse Jetty)
http(s)://<IP address>:3270/common (for a remote installation using Eclipse Jetty)
The RTView Cache Viewer application displays, which allows you to view the details for the caches that are collecting data.
Otherwise, you have finished setting up the the RTView DataServer for Solace to output and store data to RTView Enterprise.
Create a Database and Account for InfluxDB
Perform these instructions only if you want to output and store monitoring data to InfluxDB.
This section assumes you have already completed all RTView DataServer for Solace Quick Start Guide, Version 5.1.1 (On-Premise) instructions.
To send monitoring data to InfluxDB you edit the stats-receiver.properties file, located in the Data Collector directory, define the metrics to poll and store, and specify the IP address and port number on the InfluxDB platform.
Create a database and a user with read and write privileges in your InfluxDB platform using the following InfluxDB shell commands:
create database <yourSolaceStatsDB> use <yourSolaceStatsDB> create user <SolaceStatsUser> with password <‘yourPwdWithSingleQuotes’> with all privileges grant all on <yourSolaceStatsDB> to <SolaceStatsUser> exit
Edit the stats-receiver.properties file, located in the directory where the data server will be started.
Enable InfluxDB Tap by commenting out the following line: #TAP_PLUGIN_CLASS = com.sl.statsds.RTViewStatsTap
This enables the plugin to send monitoring data to InfluxDB.
Note: Currently there is no option to send monitoring data to both InfluxDB and RTView Enterprise. To revert back to collect all caches and send data to RTView Enterprise, uncomment the RTViewStatsTap line and comment out the InfluxDBStatsTap line. Also revert DB_FIELD_SUBSCRIPTIONS to its initial value (DB_FIELD_SUBSCRIPTIONS =\ which means the filter passes everything, as appropriate for the RTView Enterprise Monitor).
Select the list of topics identifying the fields to write to InfluxDB by copying the list of topics in the DB_FIELD_SUBSCRIPTIONS property. These topics are semicolon separated and multiple lines are appended by "\" at the end of the line. Initially you can choose from the examples that are provided in the stats-receiver.properties file itself. For example:
Add the connection properties to InfluxDB by scrolling down to the Influx DB Properties and defining the following:
INFLUXDB_HOST: the hostname and port used for Influx DB. For example, if you run it locally in the default port: INFLUXDB_HOST = localhost:8086.
INFLUXDB_DB: the database name to which InfluxDB will write. For example: INFLUX_DB=yourSolaceStatsDB
INFLUXDB_USER: the user previously created in Influx DB to execute the inserts in the DB. For example: INFLUXDB_USER = SolaceStatsUser.
INFLUXDB_PASSWORD: the password you set in InfluxDB encrypted with the Solace PSG Password Utility. To use this tool, open a command prompt or terminal and initialize it: Change directory (cd) to <installation_dir>/rtvapm> and execute . ./rtvapm_init.sh (UNIX) or cd <installation_dir>\rtvapm> and execute rtvapm_init.bat (Windows) Change directory to rtvapm\solmon\bin (rtvapm/solmon/bin for UNIX) and execute: pwd-utility[.bat/.sh] <yourPwdString> The following message appears: “The encrypted password is: 'encryptedString' (without the quotes). You should use this value in the password field in configuration property files."
You should now see monitoring data being stored in the InfluxDB database. If you encounter issues, check the log files in the RTViewDataServerSolace/projects/rtview-server/log directory for errors and verify that InfluxDB is available and running.
Congrats! You have finished setting up the the RTView DataServer for Solace to output and store data to InfluxDB.
Output Data to Solace Broker
Perform these instructions only if you want to output and store monitoring data to Solace Broker.
This section assumes you already downloaded, installed and registered the RTView DataServer for Solace and set the Java home var. If not, see the Quick Start Guide, Version 5.1.1 (On-Premise) instructions at the top of this page.
To send monitoring data to a Solace Broker you edit files that are located in the rtvapm/solmon/bin/config directory. Refer to Solace documentation for additional information about the available message formats you can choose for sending the data.
Define Solace Brokers to Monitor
Define the Solace Brokers to monitor by editing the <primary> … </primary> section of the appliance_config_demo.xml file (this adds connection properties to the monitored Solace Brokers). Add as many <primary> … </primary> sections as brokers you want to monitor.
Define the Solace Broker to receive monitoring data by editing the <mgmt.-msg-bus> … </mgmt.-msg-bus> section from the appliance_config_demo.xml file. You should define the message format for the data being transmitted by choosing one of the container factories: SempXmlFragmentFactory, .JsonMapFactory or StdMapFactory for SEMP, and JSON or standard message formats respectively.
If the data to be polled isn't already defined in the preconfigured XML files, or you need additional poller groups for different monitoring options, do the following:
Define the monitoring data to poll by editing the pollers_sl.xml file (this file contains SEMP request details and response parsing specifics which the poller sends to Solace Brokers).
Define the poller groups that you want to use by editing the groups_sl.xml file (this file enables you to separate published statistics into groups of interest, publishes the statistics on the associated topic, and provides the configured poll interval).
Start StatsPump as follows:
In a Windows command prompt or UNIX terminal, go to the RTViewDataServerSolace/rtvapm directory and execute rtvapm_init.bat (Windows) or rtvapm_init.sh (UNIX).
Change directory (cd) to rtvapm/solmon/bin directory and execute the following in the order provided (if you change the order it will not execute properly):
You should now see published monitoring data in the receiving Solace Broker.
Congrats! Your monitoring data is now output and stored to a Solace Broker.
Solace Event Module
You can monitor Syslog events from Solace Message Brokers by using the Solace Event Module application. The Solace Event Module receives and stores Syslog events generated by Solace Message Brokers and generates Syslog event-based alerts when required.
The Syslog event messages generated in the message brokers are forwarded to the SolEventModuleEvents cache from the RTView Solace Data Server. The events that trigger alerts are stored in the SolEventModuleAlerts cache from the RTView Solace Data Server.
The Solace Event Module is not executed by default and requires additional configuration.
To start the Solace Event Module you add a command line argument to the rtvservers.dat file, configure the severity level of the Syslog event-based alerts and the Syslog destination address and port.
To use the Solace Event Module, you configure your Solace Message Brokers to send Syslog events for either thesystem.logor theevent.logand also configure a receiver for those events. It's recommended that the host in which you execute the RTView DataServer for Solace be the host in which you configure the Syslog receiver.
For details about configuring Solace Message Brokers to send monitoring Syslog events, see:
Add the Syslog receiver connection to the RTViewDataServerSolace\rtvapm\solmon\soleventmodule\config\soleventmodule.propertiesfile using theTCP_EVENT_LISTENERS property. The other properties can optionally be configured, but theTCP_EVENT_LISTENERSproperty is required.
Start the RTView DataServer for Solace and login to RTView Enterprise, then look at the soleventmodule.logfile, located in the RTViewDataServerSolace\projects\rtview-server\logs directory, to verify that the Solace Event Module is running.
Solace Event Module Properties
TheRTViewDataServerSolace\rtvapm\solmon\soleventmodule\config\soleventmodule.propertiesfile is used to configure connections and filtering for Syslog events and alerts that are forwarded to RTView.
This section describes how to define the connection to your Syslog event receiver.
TCP_EVENT_LISTENERS- Connection to the Syslog event receiver. The format is name|bindAddress|eventLogFile where name is a unique string used to identify this receiver, bindAddress is the ipaddress:port of the Syslog receiver and logFile is eitherevent.logorsystem.logwhich should match the settings on your Solace Message Broker.
NOTE: Verify the port isn’t blocked by Firewall restrictions, otherwise Syslog events cannot be transmitted properly to the Syslog receiver.
This section describes how to filter out which Syslog events generate alerts that are forwarded to RTView and stored in the SolEventModuleAlerts cache. The filter is not required, but if used, you must specify all three properties. By default, this filter limits alerts to System alerts with a priority of WARNING or higher. Several example filters for different scenarios are included insoleventmodule.properties.
ALERT_FILTER_LIST_PRIORITY- Specify WHITELIST or BLACKLIST to define which takes priority for Syslog messages that match both filters.
ALERT_WHITELIST- Comma separated list of XPath expressions returning a Boolean using the Alert Fields listed at the top of the soleventmodule.properties file.
ALERT_BLACKLIST- Comma separated list of XPath expressions returning a Boolean using the Alert Fields listed at the top of the soleventmodule.properties file.
This section describes how to filter out which Syslog events are forwarded to RTView and stored in the SolEventModuleEvents cache. The filter is not required, but if used, you must specify all three properties. By default, this filter limits events to System events. Several example filters for different scenarios are included insoleventmodule.properties.
EVENTWRITER_FILTER_LIST_PRIORITY- Specify WHITELIST or BLACKLIST to define which takes priority for Syslog messages that match both filters.
EVENTWRITER_WHITELIST - Comma separated list of XPath expressions returning a Boolean using the Alert Fields listed at the top of the soleventmodule.properties file.
EVENTWRITER_BLACKLIST - Comma separated list of XPath expressions returning a Boolean using the Alert Fields listed at the top of the soleventmodule.properties file.
By default, this filter limits events to System events. Several example filters for different scenarios are included in the soleventmodule.properties file.
This section describes how to define the amount of time to wait after a clearable event is received for the corresponding clear event before executing the alert.
This parameter applies to clearable alerts which have corresponding clear events that allow an alarm to resume as soon as the corresponding clear event is received.
ALERT_DURATION= The number of seconds to hold a received clearable event before executing the alert.
ALERT_DURATION = 30 sets the Solace Event Module to wait 30 seconds before generating alerts that are driven by clearable Syslog Events.
Solace Event Module Log Properties File
You can adjust the logging for the Solace Event Module by modifying RTViewDataServerSolace/rtvapm/solmon/soleventmodule/config/log4j2.properties.
The Syslog events from the Solace Event Module are stored in the SolEventModuleEvents cache and displayed in the Syslog Eventsdisplay. See theEvent Filtersection for information about how to filter events that are sent to this cache.
This cache keeps in-memory historical data and can optionally be stored to the history database by the Historian. You can adjust the history settings in the RTView Configuration Application using the following fields in the Solace>DATA-STORAGEtab:
Size>History Rows - sets the maximum number of rows to keep in memory for this cache
Duration>Expire Time For Solace Event Module Events - the time (in seconds) between updates to expire rows in this cache
Duration>Delete Time For Solace Event Module Events - the time (in seconds) between updates to delete rows in this cache
History Storage>Syslog Events - toggle to true to have the Historian store this cache to the History database
The SolEventModuleAlerts Cache
The Solace Event Module generates alerts based on incoming Syslog events. The severity of generated Syslog events is defined by Solace. Events and their severity are scoped to SYSTEM, VPN and CLIENT. Some events of ERROR or WARN severity produce clearable alerts if there is a corresponding clear event for it. In this case, an initial Syslog event generates an alert and another Syslog event clears the alert.
Some Syslog events lack a clear event, which means that there are some alerts that are generated but are not clearable. In this case, a Syslog message generates the alert, but there is no corresponding Syslog message to clear it. In this case, the alert automatically clears in RTView after 24 hours. You can modify this value in the RTView Configuration Application.
The RTViewDataServerSolace\rtvapm\solmon\soleventmodule\config\events\event_details.jsonfile lists all events that can be generated in Solace Message Brokers.
The RTViewDataServerSolace\solmon\soleventmodule\config\events\event_correlation.jsonfile lists the raising and clearing Syslog events that will generate clearable alerts. These files must not be modified, but used for reference only.
Syslog Event Alerts are stored in the SolEventModuleAlerts cache. See theAlert Filtersection for information about how to filter alerts that are sent to this cache.
This cache is not visible in displays, nor does it store history. It is used solely to generate the three alerts described below.
Syslog Event Alerts are deleted from this cache when they are cleared in two ways:
Clearable Event Alerts are deleted within 2 minutes after the clearing event is received by the Solace Event Module.
Non-clearable Event Alerts are cleared after 24 hours. This time can be adjusted in the Configuration Application underSolace>DATA-COLLECTION>Solace Event Module Alerts>Clear Time. The unit of this parameter is in seconds.
There following RTView alerts are generated from the SolEventModuleAlerts cache:
SolEventModuleBrokerAlert - This alert is generated for rows in the SolEventModuleAlerts cache, where Scope=SYSTEM. In RTView Enterprise, this alert is mapped to the SOLACE-MSGROUTER CIType.
SolEventModuleVpnAlert - This alert is generated for rows in the SolEventModuleAlerts cache, where Scope=VPN. In RTView Enterprise, this alert is mapped to the SOLACE-VPN CIType.
SolEventModuleClientAlert - This alert is generated for rows in the SolEventModuleAlerts cache, where Scope=CLIENT. In RTView Enterprise, this alert is mapped to the SOLACE-CLIENT CIType.