SolGeneos Directories

After SolGeneos Agent is installed on a Solace router, the following directories are created:

Configuration Properties

SolGeneos Agent uses the following types of configuration properties. These are stored in the solgeneos.properties file; they use a standard property name/value pair convention.

  • Global properties—Properties that are shared by all monitors. Some properties can be overwritten in monitor specific property files. To query global properties, call SolGeneosAgent.onlyInstance.getGlobalProperties().
  • Monitor specific properties—Properties that are used by a specific monitor implementation. They can be global properties that must be overwritten or require exclusive monitor properties. For example, properties for AlarmsMonitor are stored in the AlarmsMonitor.properties file. To query monitor specific properties, call SolGeneosAgent.onlyInstance.getMonitorConfig(monitorObject).
  • User properties—Properties that are shared by user developed monitors. The file name for user properties must start with “user”. To query user properties, call SolGeneosAgent.onlyInstance.getUserPropertiesConfig
    (userPropertiesFileName)
    .

After the property files are read, and the property name is understood by the agent, they are loaded into the intended service or monitor's property map when the service or the monitor is initialized. (Otherwise, it stays in the properties object to which it is initially loaded.) For properties whose values are out of range, the default values are used.

Global Properties

The table below lists the global properties SolGeneos Agent supports, and whether they can be overwritten at monitor level or at a data view level inside a monitor:

SolGeneos Agent Properties

Property Name and Description

 

Default Property Value

 

Over-writable in Monitor Properties?

ipaddress

 

Router management IP

127.0.0.1

N

port

 

Router management port used for Solace Element Management Protocol

(SEMP).

80

N

username

 

Username of account the agent uses to log into the SEMP service. The default is ‘admin’, but a best practice is to create and assign a read-only user for the agent to use.

admin

N

password

 

Password for the provisioned username.

admin

N

netprobe.<alias>.<propertyName>

 

Where:

<alias> is an identifier for the NetProbe.

<propertyName> is a customer-defined property for the NetProbe. This can be any valid property name.

 

 

netprobe.<alias>.endpoint

The IP address and port of the NetProbe.

For example:

netprobe.np0.endpoint=127.0.0.1:7036

netprobe.np1.endpoint=127.0.0.1:7037

This is a required property by the agent framework.

netprobe.np0.endpoint=127.0.0.1:7036

N

netprobe.<alias>.heartbeat

 

Heartbeat intervals in seconds used by the agent’s NetProbe services to send keep-alive messages to the NetProbe. For example:

netprobe.np1.heartbeat=50

This is an optional property.

The heartbeat interval is used by the SolGeneos Agent to detect whether the NetProbe is up or down. Although the valid range accepted by Geneos is between 1 and 86400, if this property value is set too big, it will delay the agent from noticing the NetProbe is back up.

60

N

netprobe.<alias>.replyTimeout

The reply timeout in seconds for each XML-RPC request sent to the NetProbe. This is an optional property.

Note:  The replyTimeoutvalue should be smaller than heartbeat. If not, a warning is logged when the agent starts.

30

N

sampler

Geneos sampler name for a data view (it must match the sampler configured on the Gateway).

SolaceSampler

Y (at monitor and view level)

groupHeader

Geneos group header for data view

SolOS

Y (at monitor and view level)

managedEntities

A list of NetProbe to managed entity associations. The NetProbe is represented by its alias name. Managed entities must match the managed entities configured on the Gateway.

Note:  A managed entity must be unique within a Gateway, so if you have multiple NetProbes configured on the same gateway and listen to the same SolGeneos Agent, you should use different managed entity name for each NetProbe, even though they are monitoring the same Solace router.

For example, if there are two NetProbes np0 and np1, then managedEntities might have the following value:

managedEntities=[np0, ManEnt_np0],[np1, ManEnt_np1]

[np0,ManEnt]

Y (at monitor and view level)

 

Monitor Properties

The following table lists the monitor-specific properties that SolGeneos Agent supports.

Monitor-Specific Properties

Property Name and Descriptions

Default Property Value

userMonitorLibPath

The directory that the libraries used by user-
developed monitors are loaded from.

/usr/sw/solgeneos/monitors

monitorClassName

The name of the monitor class to load.

 

autoStart

Whether to start the monitor automatically when the agent is started. (If set to false, the monitor can be started from JMX.)

true

samplingRate

An integer >=30

30

statsIntervals

An integer >=0

0

pageSize

An integer >=1 and <= 500

500

view.<alias>.<propertyName>

Where:

<alias> is an identifier for the data view. <propertyName> is a property defined for the data view.

 

Example:

view.alarms.name=AlarmStats

No default. However, the following view properties are used by the agent framework:

  • view.<alias>.viewName—View name, required for the data view.
  • view.<alias>.sampler—(Optional) Overwrites the global Geneos sampler name.
  • view.<alias>.groupHeader—(Optional) Overwrites the global Geneos header name.
  • view.<alias>.managedEntities— (Optional) Overwrites global managedEntities.
  • view.<alias>.active—(Optional) Set to false to disable the view.