Options in the sgagent.conf statement section

When you want to configure a particular setting, the syntax starts with the command config.

The available options are listed in the following table:

Table 1. Options in the sgagent.conf statement section
Option Description
port port_number

Specifies the port that the Server Pool uses for communication with the engines.

All Server Pool members must use the same port number; the port setting cannot start with the begin host command. The port number can be from 0–65535.

By default, the port is set to 7777. If you use another port instead of the default port, you must edit the IPv4 and IPv6 Access rules to allow connections to the new port.

boot-delay time

Defines how long the tester waits before starting the tests after the system has been booted up or restarted to ensure that all necessary processes have completed their startup.

Time is entered in the format [(hh:)mm:]ss. The default is 30 seconds.

alert-interval time

Defines how long the system waits before sending a new alert in response to a test failure to prevent excessive alerts from being sent.

Time is entered in the format [(hh:)mm:]ss. The default is 1 hour.

alert-script path

Specifies the path to a custom alert script.

You must use quotation marks if the path contains spaces. This is only needed when you want to use a custom alert script. There is no default value.

startup-script path

Specifies the path to the custom script to be run when the Monitoring Agent starts.

You must use quotation marks if the path contains spaces.

overload-script path

Specifies the path to the custom script to be run if the load index exceeds the threshold value defined with the load-index statement.

You must use quotation marks if the path contains spaces.

listen IP_address [:port]

Specifies the IP address the Monitoring Agent listens on.

If no IP address is specified, the first IP address of the interface is used by default. If no port is defined, the default port (7777) is used.

load-index threshold index_name [index-parameter]

Defines the method that is used to measure the load.

We recommend using the same method of measurement for all members of the Server Pool. If the load measurement exceeds the defined threshold, a log message and an alert are generated. The index_name can be a complex expression combining multiple methods with basic arithmetic operations (+ - * /), such as "index-name + index-name".

load-index-action exclude [time]

Excludes the server from handling traffic for the specified time (in seconds) when the threshold value of the load-index is reached.

When the server has switched to the Excluded state, the server does not return to the normal state until the specified length of time has elapsed, even if the load of the server has dropped to a normal level.

Table 2. Index_name options
Option Description
processor-load time

Measures the average processor load level over the specified time period.

The time is entered in the format [(hh:)mm:]ss. The returned value is a percentage value from 0–100.

processor-kernel-load time

Measures the average processor time spent in the kernel mode over the specified time period.

The time is entered in the format [(hh:)mm:]ss. The returned value is a percentage value from 0–100.

load-average- minutes

Measures the average number of processes waiting in the execution queue due to reserved resources over the specified number of minutes.

The options for the value of minutes are 1, 5, or 15. The returned value is the load average for the specified time period multiplied by 100.