TCPClientCollectord

The Oracle Communications Unified Assurance Metric TCP Client Collector is a generic TCP socket collection application that will connect to a device using a configurable port, get the streams of ASCII delimited messages and process the messages into metrics and compare them for thresholding. This collector is device and instance oriented.

By default, Unified Assurance has the Metric TCP Client Collector and Metric TL1 Collector metric services that utilizes the TCP Client Collector to collect metrics.

You can run this application as a service using the Services UI.

TCP Client Collector Setup

  1. Determine the host and port settings needed to establish a client connection.

  2. Review the logic in the rules files referenced in the configuration to see the processing that will be done when messages are retrieved:

    • LoadRules will be run during application startup to load data that might be needed during processing.

    • IncludeRules will be read during application startup to load additional files that might be called during processing.

    • BaseRules will be run for each device that is selected based on the configuration.

    Update the logic as needed.

  3. Create a clone of the default service, making changes to the configuration as needed.

  4. Enable the Service.

    Configuration -> Broker Control -> Services

Default Service

The following table shows the settings for the default service. Actual values are in bold, descriptions of values are in plaintext.

Field Value
Package coreCollection-app
Name Metric TCP Client Collector
Program bin/core/collection/TCPClientCollectord
Arguments This field is blank. There is no default value.
Description Metric rules-based TCP client collector
Failover Type Standalone (Supported: Standalone, Primary, Redundant/Backup)
Status Disabled
Privileged This option is selected.

See Services in Unified Assurance User's Guide for general information about the settings for services.

See Using Application Primary/Backup Failover for more information about the different failover types.

Default Configuration

The following table shows the default configurations for the application. Actual values are in bold, descriptions of values are in plaintext.

Name Default Value Possible Values Notes
BaseRules collection/metric/tcpclient/base.rules Text, 255 characters The relative path to the application Base Rules file.
BranchDir core/default Text, 255 characters The relative path to the rules directory.
CheckTime 900 An integer How often (in seconds) where the application checks to see if there are any relevant changes.
Host localhost Text, 255 characters The FQDN/IP Address of the device to be connected to.
IncludeRules collection/metric/tcpclient/base.includes Text, 255 characters The relative path to the application Include Rules file.
LoadRules collection/metric/tcpclient/base.load Text, 255 characters The relative path to the application Load Rules file.
LogFile logs/MetricTCPClientCollector.log Text, 255 characters The relative path to the log file.
LogLevel ERROR OFF, FATAL, ERROR, WARN, INFO, DEBUG The logging level for the application.
PollTime 300 An integer How often the poller will start a poll cycle, in seconds.
Port 9001 An integer The port to use when connecting to the device.
Threads 3 An integer Number of process threads created. The aggregator takes a third of this value (rounded up) for database threads unless overridden by the DBThreads application configuration.
DBThreads This field is blank. There is no default value. An integer (Optional) Number of database threads to be created. If not specified, defaults to a third (rounded up) of Threads application configuration.
ThresholdThreads This field is blank. There is no default value. An integer (Optional) Number of threshold threads to be created. Enables the checking of thresholds in the application instead of the Default Threshold Engine. If not specified, application threshold checking is disabled.
SendAllViolations Disabled Enabled or Disabled (Optional) If enabled, thresholds will send violation notifications every poll cycle rather than only on state change. Requires 'ThresholdThreads'

Metric TL1 Collector Service

Field Value
Package coreCollection-app
Name Metric TL1 Collector
Program bin/core/collection/TCPClientCollectord
Arguments This field is blank. There is no default value.
Description Metric rules-based TL1 Performance collector via the TL1 Gateway
Failover Type Standalone (Supported: Standalone, Primary, Redundant/Backup)
Status Disabled
Privileged This option is selected.

See Services in Unified Assurance User's Guide for general information about the settings for services.

See Using Application Primary/Backup Failover for more information about the different failover types.

Metric TL1 Collector Configuration

Name Default Value Possible Values Notes
BaseRules collection/metric/tl1g/base.rules Text, 255 characters The relative path to the application Base Rules file.
BranchDir core/default Text, 255 characters The relative path to the rules directory.
CheckTime 900 An integer How often (in seconds) where the application checks to see if there are any relevant changes.
Host localhost Text, 255 characters The FQDN/IP Address of the device to be connected to.
IncludeRules collection/metric/tl1g/base.includes Text, 255 characters The relative path to the application Include Rules file.
LoadRules collection/metric/tl1g/base.load Text, 255 characters The relative path to the application Load Rules file.
LogFile logs/MetricTL1Collector.log Text, 255 characters The relative path to the log file.
LogLevel ERROR OFF, FATAL, ERROR, WARN, INFO, DEBUG The logging level for the application.
PollTime 300 An integer How often the poller will start a poll cycle, in seconds.
Port 9001 An integer The port to use when connecting to the device.
Threads 3 An integer Number of process threads created. The aggregator takes a third of this value (rounded up) for database threads unless overridden by the DBThreads application configuration.
DBThreads This field is blank. There is no default value. An integer (Optional) Number of database threads to be created. If not specified, defaults to a third (rounded up) of Threads application configuration.
ThresholdThreads This field is blank. There is no default value. An integer (Optional) Number of threshold threads to be created. Enables the checking of thresholds in the application instead of the Default Threshold Engine. If not specified, application threshold checking is disabled.
SendAllViolations Disabled Enabled or Disabled (Optional) If enabled, thresholds will send violation notifications every poll cycle rather than only on state change. Requires 'ThresholdThreads'

Rules

This collector uses the Unified Assurance standard rules architecture in Perl syntax. For information about creating rules, see the following in Unified Assurance Developer's Guide:

Tokens

The collector exposes the following tokens for rules processing.

Token Description
$Message->{'RxTime'} Received Time
$Message->{'Message'} Message received
$Message->{'Host'} Host connected to
$AppConfig Hash reference to the application configuration name-value pairs that were configured. (i.e. use $AppConfig->{'Host'} to retrieve the set value for 'Host'.)
$CustomHash Custom key, value cache available across all rules. Contents commonly defined in Load Rules then used in Base or other rules. NOTE: This variable is a shared object and any additional sub hashes or arrays must be shared before use or it will cause the error: Invalid value for shared scalar. Instantiate the sub hash/array using '&share({})' e.g. 
$CustomHash->{SubObject} = &share({});
$StorageHash Internal cache used as the StorageHash option when calling rules functions such as FindDeviceID(). NOTE: The structure of this cache is subject to change! Not recommended for custom global storage or manual manipulation; use $CustomHash.

Administration Details

The following list shows the technical details you will need for advanced administration of the application: