TCP Socket Platform Service

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

Monitoring a Remote TCP Server

HQ can monitor an remote TCP server over the network. You configure a platform service of type "TCP" on the operating system platform of your choice. The HQ 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 TCP Socket service type is managed by HQ's netservices plugin and performs the following functions:

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

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

Configure the TCP Socket Service in HQ

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

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

TCP Socket Configuration Properties Page

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

images/download/attachments/79038211/TcpConfigOptions.png

TCP Socket Configuration Options

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

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

TCP Socket Metrics

  • Availability - A remote TCP service is considered available if the HQ Agent can open a socket connection to the remote system, write to the stream, and read from the stream.

  • 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.

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

images/download/attachments/79038211/TcpSocketMetrics.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.