ZenPack:FTP Monitor

From Zenoss Wiki
This is the approved revision of this page, as well as being the most recent.
Jump to: navigation, search

Note: This is a Core ZenPack which can be found in the Core Zenoss RPM, and is fully documented in the Zenoss Extended Monitoring Guide. If you did not install this pack when you installed Zenoss Core, it can be found in $ZENHOME/packs.

Organization
Zenoss, Inc.
ZenPack name
ZenPacks.Zenoss.FtpMonitor
More Information
GitHub page/HomePage
Link to more docs
View Documentation
Git sources (for cloning)
Link


Applications Monitored: 



FTP Monitor ZenPack

The FTPMonitor ZenPack monitors connection response time to an FTP server.

Warning

The ZenPack Catalog has moved to its new home at https://www.zenoss.com/product/zenpacks as of January 17, 2017. The following information may be out of date, and this page will eventually be removed.

Support

This ZenPack is part of Zenoss Core. Open Source users receive community support for this ZenPack via our online forums. Enterprise support for this ZenPack is provided to Zenoss customers with an active subscription.

Background

The ZenPacks.zenoss.FtpMonitor ZenPack monitors the response times of File Transfer Protocol (FTP) server connection requests.


Prerequisites

Prerequisite Restriction
Product Zenoss platform 4.2.x, 5.x
Required ZenPacks ZenPacks.zenoss.FtpMonitor


Enable Monitoring

To enable monitoring of the device:


  1. Select Infrastructure from the navigation bar.
  2. Click the device name in the device list. The device overview page appears.
  3. Expand Monitoring Templates in the left panel, and then select Device.
  4. Select Bind Templates from the Action menu. The Bind Templates dialog appears.
  5. Select the FTPMonitor template and move it to the list of selected templates.
  6. Click Save. The FTPMonitor template appears under Monitoring Templates.
  7. Select the FTPMonitor template and change options as needed.
    FTPMonitor Basic Data Source Options
    Option Description
    Port The port to connect to FTP server (default 21)
    Send String Command string to send to the server
    Expect String A string to expect in server response
    Mismatch If the expected string does not match the string returned from the remote server, create an event with one of these states: ok, warn, crit (default: warn)
    Quit String Command to send to the remote server to end the session



Enable Secure Site Monitoring

To enable secure site monitoring:


  1. Select Infrastructure from the navigation bar.
  2. Click the device name in the devices list. The device overview page appears.
  3. Expand Monitoring Templates in the left panel.
  4. Select the FTPMonitor template and change options as needed.
    FTPMonitor Secure Data Source Options
    Option Description
    Port The port to connect to FTP server (default 21).
    Certificate Minimum days for which a certificate is valid
    Use SSL Use SSL for the connection



Tuning for Site Responsiveness

  1. Select Infrastructure from the navigation bar.
  2. Click the device name in the devices list. The device overview page appears.
  3. Expand Monitoring Templates in the left panel.
  4. Select the FTPMonitor template and change options as needed.
    FTPMonitor Tunables Data Source Options
    Option Description
    Timeout Seconds before connection times out (default: 60)
    Refuse If a TCP/IP connection to the remote service is refused (ie no program is listening at that port) send an event with one of these severity states: ok, warn, crit (default: crit)
    Max Bytes Close the connection once more than this number of bytes are received.
    Delay Seconds to wait between sending string and polling for response
    Warning response time (seconds) Response time to result in a warning status.
    Critical response time (seconds) Response time to result in critical status



Daemons

Type Name
Performance Collector zencommand

Installation

Normal Installation (packaged egg)

  1. Download the appropriate egg file for the version of Zenoss you are running.
  2. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  3. Install the ZenPack:
    $ zenpack --install ZenPacks.Zenoss.FtpMonitor-*.egg
  4. Restart these services:
    $ zenoss restart

Developer Mode Installation

In order to do a development mode installation you will want to clone the existing git repository, and then use the --link flag with the zenpack command:

  1. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  2. Start by cloning the upstream repository:
    $ git clone https://github.com/zenoss/ZenPacks.zenoss.FtpMonitor.git
  3. Next, perform the installation:
    $ zenpack --link --install ZenPacks.Zenoss.FtpMonitor
  4. Finally, restart these serivices:
    $ zenoss restart

Discuss

Purplemarker.png New: Don't forget to add yourself to the Zenoss User Map!

blog comments powered by Disqus