GWME-7.2.1-05 Notification Log Retention

Contents
Description

This update is for all GroundWork customers. The notification manager (NoMa) does not natively implement long-term retention control for the logging of outgoing notifications. Over time, that can cause the noma database to grow quite large at a site that makes extensive use of NoMa notifications. It might also slow down the processing of such notifications.

What is in this update?

This Technical Bulletin provides a NoMa retention-control script along with a companion configuration file (/usr/local/groundwork/config/noma_retention.conf), and installs a cron job to run the script on a daily basis. The default setting in the config file will retain NoMa notification-log data for 90 days, which should be sufficient for typical operational usage.

Prerequisites
Installation Steps
Name Size Creator Creation Date Comment  
ZIP Archive TB7.2.1-05-notification-logs.tgz 6 kB Thomas Stocking Sep 24, 2018 16:12 MD5: 393ee28fd83fa67d85c101e0ebb95eea  
  1. As the root user, copy the attached tarball to an empty directory on the server to be patched.
  2. Unpack the tarball using the command:
    tar xf TB7.2.1-05-notification-logs.tgz
    
  3. Change into the directory created by untarring:
    cd TB7.2.1-05-notification-logs
    
  4. Run the installer script:
    ./TB7.2.1-05_install.sh
    

    The install script will test that you are on a 7.2.1 system (which is required), that you have not already installed this patch, and that you want to go ahead.

  5. Respond to the install-confirmation prompt when it appears.
  6. New files will be copied into place. A new cronjob will be added to impose retention control on NoMa log data. Monitoring in general can continue while this patch is installed.
Usage

The retention will be adjusted at 12:50 am daily. If there are a lot of old notification records when you install this patch, the first run will take a minute or two, and there will be some inefficiency in the noma database even after the retention script runs.

You can optionally run the retention script by hand immediately if you want to get the performance benefit right away. You can also do a vacuum operation on the database to regain lost disk space and make things more efficient.
First consider adjusting the default setting in:

/usr/local/groundwork/config/noma_retention.conf 

from 90 days to what you want to have the retention be. Just edit the file and adjust the number as necessary.

To run the script by hand, log in and become the nagios user, then type:

/usr/local/groundwork/tools/noma_retention --logs

To run a vacuum operation afterwards, also as the nagios user, type:

/usr/local/groundwork/postgresql/bin/psql -U noma -d noma -c 'vacuum (full, analyze) notification_logs'

The disk space will then be freed, and the table optimized.

Uninstalling

Reversal of this patch will remove the new files, and remove the new cron job. Monitoring in general can continue while this happens.

  1. As the root user, navigate to the patch-unpack directory you created when installing the patch, (if that directory no longer exists, first unpack the patch again).
    cd TB7.2.1-05-notification-logs
    
  2. Run the uninstall command:
    ./TB7.2.1-05_uninstall.sh