Configuring and Running Solace Geneos Agent Service

To configure and run an installed Solace Geneos Agent Service, perform the following steps:

  1. Set the JAVA_HOME environment variable.

    Refer to Setting the JAVA_HOME Environment Variable.

  2. Modify the Solace Geneos Agent properties file.

    Refer to Updating Solace Geneos Agent Configuration Properties.

  3. Start the Solace Geneos Agent Service.

    Refer to Starting Solace Geneos Agent Service.

Setting the JAVA_HOME Environment Variable

The service script assumes that JAVA_HOME is set to /usr/sw/java on the target host.

If Java is installed under a different directory on the target host, you can:

  • Create a /usr/sw/java softlink to the directory where Java is installed. This is the recommended approach.
  • Explicitly set the JAVA_HOME environment variable in /usr/sw/solgeneos/loads/solgeneos_<version>/bin/serviceScript.sh

Updating Solace Geneos Agent Configuration Properties

Before running the Solace Geneos Agent, you must edit solgeneos/config/solgeneosagent.properties to do the following:

Configuring NetProbe Properties

The NetProbe definition in the Solace Geneos Agent properties file uses the form of netprobe.<alias>.<propertyName>.

Where:

<alias> is a unique identifier of the NetProbe.

<propertyName> is a NetProbe property name of the following properties:

  • endpoint—the IP address and port for the NetProbe. This is a required property.

    Typically, if you plan to run one NetProbe instance on the target host where the Solace Geneos Agent service is running, you do not need to modify the default value. However, if the NetProbe is running off the target host where the Solace Geneos Agent service is running, you should change the endpoint property to the corresponding IP address and port.

  • heartbeat—the amount of time (in seconds) to wait between sending heartbeat probes to the NetProbe. The heartbeat interval is used by the Solace Geneos Agent to detect whether the NetProbe is up or down. This property is optional; by default, it is commented out because a default value is used.
  • replyTimeout—the amount of time (in seconds) to wait for a reply from the NetProbe to a XML-RPC request that is made. This property is optional; by default, it is commented out because a default value is used.

Below is an example of configured NetProbe properties.

netprobe.np0.endpoint=127.0.0.1:7036
netprobe.np0.heartbeat=60
netprobe.np0.replyTimeout=30

If you want to run multiple instances of NetProbes on or off the target host, additional NetProbes must be defined. For example, the second NetProbe might be defined as:

netprobe.np1.endpoint=127.0.0.1:7037

If you configure the “Trusted API Hosts” property on the NetProbe, ensure that the hostname where the agent is running is added to the host list. If the hostname is not added, the error code 102 (HOST_NOT_TRUSTED) is returned when the agent tries to communicate with the NetProbe.

Configuring Samplers, Group Headers, Managed Entities

Samplers, group headers, and managed entities are ITRS concepts that are used to group data views. Samplers and managed entities must be configured on the ITRS Geneos Gateway.

For the Solace Geneos Agent, samplers, group headers, and managed entities are represented by the following properties:

sampler=SolaceSampler
groupHeader=SolOS
managedEntities=[np0, <Managed_Entity_Name>]

Where:

sampler is the Geneos sampler name for a data view. The value of the sampler property must match the sampler configured on the Gateway. Samplers must be configured on the ITRS Geneos Gateway.

groupHeader is the Geneos group header for the data view.

managedEntities is a list of comma-separated NetProbe to managed entity associations. Managed entities must be configured on the ITRS Geneos Gateway. <Managed_Entity_Name> is a unique identifier for the event broker’s managed entity.

The managed entity must be unique within a Gateway. Therefore, if you have multiple NetProbes configured on the same Gateway and listen to the same Solace Geneos Agent, you should use different managed entity name for each NetProbe, even though they are monitoring the same event broker. For example, if there are two NetProbes np0 and np1, then managedEntities would have the following value:

managedEntities=[np0, <uid> ManEnt_np0],[np1, <uid> ManEnt_np1]

A NetProbe is represented by its alias name. A managed entity must match the managed entity configured on the Gateway.

Configuring Event Broker Management Properties

These properties include the ipaddress, port, username, and encrypted_password properties.

  • Use port 80 for Solace PubSub+ appliances and port 8080 for Solace PubSub+ software event brokers.

  • If plain-text SEMP service is shutdown, use port 1025 for SolOS versions 8.2 and greater.

Configuring Encrypted Management Password Property

The encrypted_password property value in solgeneos/config/solgeneosagent.properties can be encrypted using the solgeneos/currentload/bin/encryptPassword.sh script. When you run the script, you will be prompted to enter a password and enter it again for verification. If a non-empty password and the correctly repeated password was entered, the script will output an "Encrypted:" password line. You can copy that and use as the value for the encrypted_password property in solgeneos/config/solgeneosagent.properties.

If there are user-developed monitors created for Solace Geneos Agent 7.1 or lower, and the encrypted_password property will be used for Solace Geneos Agent 7.2 or higher, refer to Modifying Custom Monitors Created Before Version 7.2 for details on how to modify these custom monitors to incorporate the encrypted_password property.

Configuring User Monitor Library Path

Solace Geneos Agent can dynamically load user-developed monitors that are used to generate ITRS data views.

The following property tells the Solace Geneos Agent from where to load these monitors packaged in Jar files.

userMonitorLibPath=/usr/sw/solgeneos/monitors

The property is optional, so it is commented out by default.

For more details on how to create custom monitors, refer to Developing and Deploying Monitors.

Refer to the comments in solgeneosagent.properties to further customize the Solace Geneos Agent.

Starting Solace Geneos Agent Service

Solace PubSub+ 8.2 or newer:

  • To start the Solace Geneos Agent service, enter the following from the command line: 
    > systemctl start solgeneos
  • To stop the Solace Geneos Agent service, enter the following from the command line: 
    > systemctl stop solgeneos
  • To check the status of the Solace Geneos Agent service, enter the following from the command line: 
    > systemctl status solgeneos