SSH Platform Service

Hyperic can monitor an SSH service over the network. You configure a platform service of type "SSH" on the operating system platform of your choice. The Hyperic Agent on that platform collects the metrics for the remote service and presents them under the newly created platform service.

Resource Plugin, Functions, and Classes

The SSH service type is managed by Hyperic's netservices plugin and performs the following functions:

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

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

Configure the SSH Service in Hyperic

The "SMTP" service type must be manually configured.

  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 "SSH" from the Service Type pull-down.

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

Configuration Properties Page

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

images/download/attachments/79038211/SshConfigOptions.png

SSH Configuration Options

The tables below define the options in the configuration schema for the "SSH" service type. These are the resource attributes that are displayed, and may be edited, on the Configuration Properties page for an SSH service, shown above.

Note: For the SSH service type, the netservices plugin sets value of port to 22.

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

SSH Metrics

  • Availability - An SSH service is considered available if a ping indicates the service is running and able to accept requests.

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

SSH Monitoring Defaults

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 SSH service type is shown below:

images/download/attachments/79038211/SshMetrics.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 Hyperic log tracking functionality and configuration options, and how to view log events, see Set Up Log Tracking for a Resource.