Configuring Solution Package for Solace for DataCollector, Version 5.1.1

This section describes the required configurations as well as the optional configurations available for the Solution Package for Solace in the RTView Configuration Application. You must define data source connections for each message router and Syslog connection that you want to monitor on the CONNECTIONS tab. You can also optionally modify the default data update rates on the DATA COLLECTION tab.

Obtain SEMP Version

In order to properly request monitored data, the Monitor requires the exact SEMP version on your message routers. These instructions describe how to use SolAdmin to determine the SEMP version for each of your Solace Message Routers or VMRs. You will need this information when you connect your message routers and edit connection properties.

Note: These instructions are for SolAdmin on Windows. For Linux, only the path to the log file changes.

To obtain the SEMP Version:

  • Navigate to the SolAdmin installation folder. For example, C:\Program Files (x86)\SolAdmin\.
  • Change directory (cd) to the bin directory and open the log4j.properties file in a text editor.
  • Change the logging level to DEBUG and provide the full path to the logging file (for example, C:\Logs) while retaining all other settings. The edited properties are as follows:

# full path to the location where you want the log file to be stored. In this example C:\Logs
log4j.appender.A1.File=C:\Logs\soladmin.log
# Set the logging category to DEBUG
log4j.category.com.solacesystems=DEBUG, A1

  • Save the log4j.properties file.
  • Start SolAdmin and add your message routers or VMRs as managed instances.
  • Open the soladmin.log file and locate the semp-version tag in SEMP requests. The SEMP version that will be used by the Monitor replaces underscores (_) with dots (.). For example, if the SEMP request in the SolAdmin log file is 7_2VMR, you use 7.2VMR for the $solSempVersion substitution of the Monitor connection property.

Configuring Data Collection

To configure data collection:

  • Navigate to the Solution Package Configuration > Solace > CONNECTIONS tab and click the icon.

The Add Connection dialog displays.

  • Select the HA Pair button to create connections to your primary and backup servers.

  • Specify the connection information and click SAVE where:

Connection Name: Enter a unique string to identify the connection.

Primary URL: Enter the URL to be used for the primary connection, which contains an IP address or the host name that can be resolved by your network name resolution method.

Primary Username: Enter the username to be used when connecting to the primary server. This field is only required when the connection has been secured.

Primary Password: This password is used when connecting to the primary server. This field is only required when the connection has been secured. By default, the password entered is hidden. Click the  icon to view the password text.

Backup URL: Enter the URL to be used for the backup connection, which contains an IP address or the host name that can be resolved by your network name resolution method.

Backup Username: Enter the username to be used when connecting to the backup server. This field is only required when the connection has been secured.

Backup Password: This password is used when connecting to the backup server. This field is only required when the connection has been secured. By default, the password entered is hidden. Click the  icon to view the password text.

  • Select the Standalone Broker button to create a connection to your standalone broker.

  • Specify the connection information and click SAVE where:

Edition: Enable the Is this a Solace PubSub+ Cloud service instance? toggle if the connection is a Solace PubSub+ Cloud service instance.

Connection Name: Enter a unique string to identify the connection of the monitored broker.

Host:Port: Enter the host:port combination to be used for the broker. Only available when the Is this a Solace PubSub+ Cloud service instance? toggle is disabled.

URL: Enter the URL to be used for the connection, which contains an IP address or the host name that can be resolved by your network name resolution method and the SEMP port number configured for your broker. Only available when the Is this a Solace PubSub+ Cloud service instance? toggle is enabled.

Username: The username is used when creating the connection to the broker. This field is only required when the connection has been secured.

Password: This password is used when creating the connection to the broker. This field is only required when the connection has been secured. By default, the password entered is hidden. Click the  icon to view the password text.

SEMP Version: Specify the SEMP Version used by the connection. Only available when the Is this a Solace PubSub+ Cloud service instance? toggle is enabled.

VPN Name: Optionally enter the names of the VPN that you want to monitor. Only available when the Is this a Solace PubSub+ Cloud service instance? toggle is enabled.

Once saved, your newly saved connection displays in the Message Broker Connections region on the CONNECTIONS tab.

Once saved, your newly saved message router connection displays in the Message Broker Connections region on the CONNECTIONS tab.

  • If you want to modify the default values for the update rates for all caches, you can update the default polling rates in Solution Package Configuration > Solace > DATA COLLECTION > Poll Rates.

Note: When modifying your update rates, you should take your system architecture and number of elements per cache into account and ensure that you are not changing your update rates to values that might negatively impact system performance.

The following options are available:

Poll Rate: Enter the query interval, in seconds, to collect data updates. Caches impacted by this field are SolEndpointStats, SolEndpoints, SolClients, SolClientStats, SolBridges, SolAppliances, SolBridgeStats, SolApplianceInterfaces and SolApplianceMessageSpool.

Poll Rate Large: Enter the time interval, in seconds, to check for data updates. Caches impacted by this field are SolCspfNeighbors, SolApplicances and SolEnvironmentSensors.

  • If you want to modify the default value for the time in which alerts in the SolaceEventAlertCache are cleared, you can update the default value in the Clear Time field in Solution Package Configuration > Solace > DATA COLLECTION > Solace Event Module Alerts.