Create a Platform Service

This page has general instructions for creating a service in Hyperic.

For information about creating a service using the HQApi see HQApi resource command.

When to Manually Create a Platform Service

There are two types of platform services in Hyperic:

  • System services local to an operating system platform, such as CPUs, network interfaces, filesystems, and so on. Most local service are auto-discovered by the system plugin.

  • Remote services that the Hyperic Agent monitors over the network, such as HTTP, FTP, DNS, and other services using a supported protocol. Because such services are monitored by a remote agent, they cannot be auto-discovered. For network services, you manually configure platform service on the platform running the Hyperic Agent that will monitor the service.

Need to Know What a "Platform Service" Is?

See Resources, Resource Types and Inventory Types for more information.

Create a Platform Service

  1. Use Browse > Resources > Platforms to navigate to the platform to which you wish to add a service.

  2. Select New Platform Service from the Tools menu.

  3. On the New Platform Service page enter:

    • Name - A meaningful name for the service.

    • Description - (optional) A description of the service

    • Service Type - Select the desired service type from the pull-down list.

  4. Click OK to create the new service.

    • The Inventory tab for the new service appears and prompts: "This resource has not been configured". Please set its Configuration Properties.

  5. Click Configuration Properties in the prompt.

  6. On the Configuration Properties page, enter values for the required configuration properties, which are prefixed with a red asterisk, and optional properties as appropriate. For information about the configuration properties for a service type, click the link in the Configuration Notes column for it in the Configuration Instructions for Platform Services table below.

Configuration Instructions for Platform Services

The table below lists all supported platform service types in Hyperic. The Configuration Notes column for a network service or an other platform service type that require configuration has a link to a configuration properties reference for the service type. No configuration instructions are provided for auto-discovered platform services.

Service

Description

Configuration Notes

CPU

The Hyperic Agent on a platform automatically discovers CPUs on the platform.

It is not necessary to manually configure CPU monitoring. For information about metrics available for a CPU, see CPU Service in vFabric Hyperic Resource Configuration and Metrics.

DHCP

Use to monitor a remote Dynamic Host Configuration Protocol server.

See DHCP Platform Service in vFabric Hyperic Resource Configuration and Metrics.

DNS

Use to monitor a remote Domain Name System server.

See DNS Platform Service in vFabric Hyperic Resource Configuration and Metrics.

FileServer Directory

Use to monitor a directory.

See FileServer Directory Service in vFabric Hyperic Resource Configuration and Metrics.

FileServer File

Use to monitor a file.

See FileServer File Service in vFabric Hyperic Resource Configuration and Metrics.

FileServer Mount

Use to monitor a filesystem mount point and associated disks and raid arrays.

Note: The Hyperic Agent auto-discovers local mount points. You only need to explicitly configure a FileServer Mount service to monitor a remote network file system (NFS). Alternatively, you can install an Hyperic Agent on the system that hosts the NFS, in which case the NFS will be auto-discovered.

See FileServer Mount Service in vFabric Hyperic Resource Configuration and Metrics.

FileServer Directory Tree

Use to monitor a directory and the entire tree under that directory.

See FileServer Directory Tree Service in vFabric Hyperic Resource Configuration and Metrics.

HTTP

Use to monitor a particular URL.

See HTTP Platform Service in vFabric Hyperic Resource Configuration and Metrics.

FTP

Use to monitor a remote File Transfer Protocol server.

See FTP Platform Service in vFabric Hyperic Resource Configuration and Metrics.

IMAP

Use to monitor a remote Internet Message Access Protocol server.

See IMAP Platform Service in vFabric Hyperic Resource Configuration and Metrics.

InetAddress Ping

Use to ping a remote host for availability.

See InetAddress Ping Platform Service in vFabric Hyperic Resource Configuration and Metrics.

LDAP

Use to monitor a remote Lightweight Directory Access Server.

See LDAP Platform Service in vFabric Hyperic Resource Configuration and Metrics.

Multiprocess

Use to monitor multiple related processes. For example, to monitor the number of httpd processes running on Apache and the system resource they consume in aggregate.

See Multiprocess Service in vFabric Hyperic Resource Configuration and Metrics.

NetworkServer Interface

Use to monitor a network interface.

Note: Because the Hyperic Agent auto-discovers network interfaces, manual configuration of a NetworkServer Interface is rare.

See NetworkServer Interface Service in vFabric Hyperic Resource Configuration and Metrics.

NTP

Use to monitor a remote Network Time Protocol server.

See NTP Platform Service in vFabric Hyperic Resource Configuration and Metrics.

POP3

Use to monitor a remote Post Office Protocol 3 server.  Configure along with an SMTP service  to monitor incoming and outgoing email services.

See POP3 Platform Service in vFabric Hyperic Resource Configuration and Metrics.

Process

Use to monitor a process using a Hyperic SIGAR Process Table Query Language (PTQL) query. To configure, you supply the PTQL query in the form:

Class.Attribute.
operator=value

For example,

Pid.PidFile.eq=
/var/run/sshd.pid

See Process Service in vFabric Hyperic Resource Configuration and Metrics.

RPC

Use to monitor a Remote Procedure Call service.
Note: Not available on Windows platforms. 

See RPC Platform Service in vFabric Hyperic Resource Configuration and Metrics.

Script

Used to configure Hyperic to periodically run a script that collects a  system or application metric.

Script Service

SMTP

Use to monitor a remote Simple Mail Transfer Protocol server.  Configure along with a POP3 service to monitor incoming and outgoing email services.

See SMTP Platform Service in vFabric Hyperic Resource Configuration and Metrics.

SNMP

Use to monitor a remote Simple Network Management Protocol agent.

See SNMP Platform Service in vFabric Hyperic Resource Configuration and Metrics.

SSH

Use to monitor a remote SSH service.

See SSH Platform Service in vFabric Hyperic Resource Configuration and Metrics.

TCP Socket

Use to monitor the availability of a remote TCP socket

See TCP Socket Platform Service in vFabric Hyperic Resource Configuration and Metrics.

Windows Service

Use to monitor an application that runs as a service under Windows.

To configure it, you supply its Service Name in Windows. To determine the Service Name:

  1. Select Run from the Windows Start menu.

  2. Type services.msc in the run dialog and click OK.

  3. In the list of services displayed, right-click the service you wish to monitor and choose Properties.

  4. Locate the Service Name on the General tab.
    See Windows Service Service.