2.7 Configuring the check_uptrack Nagios Plugin

2.7.1 Using the Nagios Plugins
Note

The Nagios software is not included with the python-ksplice-uptrack package. For information about obtaining and using Nagios, got to the official Nagios website: http://www.nagios.org.

To configure the check_uptrack Nagios plugin:

  1. Set the username and api_key variables in the configuration file /etc/uptrack-api.conf under an [uptrack] section heading, for example:

    [uptrack]
    username = jo.admin@mydom.com
    api_key  = 3af3c2c1ec407feb0fdc9fc1d8c4460c
  2. If you access the Internet via a proxy, specify the connection information in the [uptrack] section of /etc/uptrack-api.conf:

    https_proxy = [protocol://][username:password@]proxy[:port] 

    where protocol is http or https, username and password authenticate you with the proxy (if required), and proxy and port are the host name or IP address and port number used to connect to the proxy.

    For example:

    https_proxy = http://proxy.example.com:3128/

    The proxy must support HTTPS connections.

  3. Configure the check_uptrack plugin in the Nagios configuration file, usually /usr/local/nagios/etc/nagios.cfg. The following minimal configuration alows you to run the plugin:

    # Dummy host with which to associate the Uptrack service
    define host {
           host_name                       uptrack-service
           notifications_enabled           0
           max_check_attempts              1
           notification_interval           0
           check_period                    never
           contacts                        server-admins
    }
    
    define service {
           host_name                       uptrack-service
           service_description             Ksplice Uptrack Update Status
           check_command                   check_uptrack
           notifications_enabled           1
           normal_check_interval           60
           retry_check_interval            15
           max_check_attempts              4
           notification_options            w,c,r
           contacts                        server-admins
    }
    
    define command {
           command_name     check_uptrack
           command_line     /usr/lib/nagios/plugins/check_uptrack
    }
    
    define command {
           command_name     check_uptrack_opts
           command_line     /usr/lib/nagios/plugins/check_uptrack -w $ARG1$ -c $ARG2$
    } 

2.7.1 Using the Nagios Plugins

To monitor all of your machines, run:

# /usr/lib/nagios/plugins/check_uptrack

This command produces a summary about your machines in the standard Nagios plugin format, for example:

2 machines are OUTOFDATE!|uptodate=1280;outofdate=1;unsupported=0;inactive=3
  prod1.mydom.com (192.168.1.1) is OUTOFDATE
  prod2.mydom.com (192.168.1.2) is OUTOFDATE

If you specify the -c or -w options with a comma-separated list of the arguments i, o, or u for inactive out of date, or unsupported machines, check_uptrack displays critical or warning notices for machines that match those criteria. For example, the following command returns warning notices for any machines that are inactive or unsupported, and critical notices for any machines that are out of date:

/usr/lib/nagios/plugins/check_uptrack -w u,i -c o

To monitor the local machine, you can use the check_uptrack_local plugin:

# /usr/lib/nagios/plugins/check_uptrack_local

The output from check_uptrack_local is similar to that from check_uptrack. However, for out-of-date machines, it also lists the updates that are required to bring the machine up to date.

Note

check_uptrack_local reads the local Uptrack update cache. It does not use the settings in /etc/uptrack-api.conf.