FTP Platform Service

Topics marked with * relate to features available only in vFabric Hyperic.

Monitor a Remote FTP Service

You can configure a platform service of type "FTP" to report the availability of a remote FTP service.

Resource Plugin, Functions, and Classes

The "FTP" service type is managed by HQ's netservices  plugin and performs the following functions:

  • Metric collection using the org.hyperic.hq.plugin.netservices.FTPCollector class.

  • Event tracking using the reportEvent method in the Collector class.

Configure the FTP Service in HQ

You manually configure an FTP service, on supported Unix-like platforms.

  1. Navigate to the platform whose Agent will monitor the service.

  2. Select New Platform Service from the Tools menu.

  3. On New Service page, enter a name for the service and select "FTP" from the Service Type pull-down.

  4. Supply all required values on the Configuration Properties page. Configuration options are defined below in FTP Configuration Options.

Configuration Properties Page

The Configuration Properties page for the "FTP" service type is shown below.

images/download/attachments/79038211/FtpConfigOptions.png

FTP Configuration Options

The tables below document the options in the configuration schema for the FTP service type in the netservices plugin descriptor.
Notes:

  • If user and pass are not configured, the anonymous credentials defined in the org.hyperic.hq.plugin.netservices.FTPCollector class "anonymous" and "hyperic-monitor@" are used to connect to the FTP server.

  • The default value of port is set to 21 by a property in the netservices plugin descriptor.

name

description

default

optional

type

Notes

Parent Schema

hostname

Hostname

localhost

false

Hostname of system that hosts the service to monitor. For example: mysite.com

sockaddr

port

Port

A default value for port is usually set for each type of network service by properties in the netservices plugin descriptor.

false

Port where service listens.

sockaddr

sotimeout

Socket Timeout (in seconds)

10

true

int

The maximum amount of time the agent will wait for a response to a request to the remote service.

sockaddr

user

Username

true

Supply if target site is password-protected.

credentials

pass

Password

true

secret

Supply if target site is password-protected.

credentials

FTP Metrics

  • Availability - An FTP service is considered available if the 3 digit response code it returns begins with 1, 3, or 3. The agent reports the service to be unavailable if there is no response, or a response code that begins with 4 or 5. For information about FTP response codes, see http://en.wikipedia.org/wiki/List_of_FTP_server_return_codes.

  • Connection Metrics

    • All Inbound Connections - Number of inbound connections of all types to the service.

    • All Outbound Connections - Number of outbound connections of all types from the service.

    • Inbound Connections - Number of inbound TCP connections to the service.

    • Outbound Connections - Number of outbound TCP connections from the service.

  • Response Time - The time (in ms) it took to determine service availability.

  • TCP connection state metrics - The number of connections in each connection state is reported:

    • CLOSE_WAIT

    • CLOSED

    • ESTABLISHED

    • FIN_WAIT_1

    • FIN_WAIT_2

    • LAST_ACK

    • LISTEN

    • SYN_RECEIVED

    • SYN_SEND

    • TIME_WAIT

For definitions of TCP connection states, see RFC 793.

FTP Monitoring Defaults Page

You can enable and disable metrics, select indicator metrics, and change the collection interval for a resource type on its Monitoring Defaults page. To navigate to a resource type's Monitoring Defaults page:

  1. Click the Administration tab.

  2. Click Monitoring Defaults.

  3. Scroll down to the resource type and click Edit Metric Template.

The Monitoring Defaults page for the FTP service type is shown below:

images/download/attachments/79038211/FtpMetrics.png

Event Tracking

You can enable log tracking for a network service. If you do, the agent will log an event for responses that match the criteria you specify.

To enable log tracking, click the Enable Log Tracking box in the Monitoring section of the Configuration Properties page.

For information about HQ log tracking functionality and configuration options, and how to view log events, see Set Up Log Tracking for a Resource.