Reload for GroupWise Monitoring Methods

  • 7019072
  • 07-Dec-2016
  • 29-Aug-2017

Environment


Reload 5.1

Situation

What methods can be used to monitor Reload for GroupWise profiles.

Resolution

1. The Reload Web Interface visually shows the status of each post office and domain profile created on a Reload server.  The Reload Daemon monitors the following two values to reflect the health of a profile. They are:

Time: How old the most recent backup is.

Space: How much disk space remains for getting more Reload backups.

Both of these values can be modified in Reload Web Administration under the profile on the Configure tab, and the Preferences panel.

2. Reload supports the ability to send a consolidated Daily Status Report to one or multiple users. Reload also supports Error Notification, Warning Notification and Job Completion email messages. These notifications are configured in Reload Web Administration on the Configure tab, and the Reports & Notifications panel. 

3. Reload supports integration with both PRTG and Nagios.

PRTG: The PRTG scripts that Reload ships with are kept on the Reload Server in the following location:

/var/prtg/scripts

Each Reload profile has 3 scripts that PRTG can execute in order to derive the health state of a Reload profile. They are: 

reload_disk_space_check_profile_<profile_name>.sh

reload_most_recent_backup_age_profile_<profile_name.sh

reload_number_of_backups_to_keep_profile_<profile_name>.sh

These scripts in no way need to be modified. The scripts can be executed by PRTG and will send to standard output their status. They also support exit codes. See the screenshot below to see how the scripts work.

Nagios: Nagios integration is accomplished with two scripts. They are located on the Reload Server at the following location:

/opt/beginfinite/reload/setup/nagios

The two scripts are:

check_nagios_reload_profile_disk_space.sh

check_nagios_reload_profile_most_recent_backup_age.sh

The syntax for using these scripts are:

<script> -p <reload profile name>

Example:

check_nagios_reload_profile_most_recent_backup_age.sh -p po1

4. Reload API

The Reload API works as is. You are welcome to use the Reload API in the following manner:

a. Go to the directory /opt/beginfinite/reload/lib/code

b. Execute the Reload API in the following manner:

./gre_api -o -p $ -c reportProfileDiskSpaceWarningSetting

./gre_api -o -p $ -c reportProfileDiskSpaceErrorSetting

./gre_api -o -p $ -c reportProfileDiskLocationSetting

./gre_api -o -p $ -c reportProfileDiskType

./gre_api -o -p $ -c reportProfileLastBackupAgeWarningSetting

./gre_api -o -p $ -c reportProfileLastBackupAgeErrorSetting

./gre_api -o -p $ -c checkProfileLastBackupAge

The output of the Reload API is meant to be parsed and used by a script that would then report or act upon the output given by the Reload API.

If you look at the PRTG and Nagios scripts, you can see programatic examples of how to parse the output of the Reload API.

Additional Information

This article was originally published in the GWAVA knowledgebase as article ID 2883.