TCPClientStitcherd

The Oracle Communications Unified Assurance Topology TCP Client Stitcher connects to a server and listens for messages, then processes anything received through rules files for inclusion into the Topology and Graph frameworks.

Although generic enough to be able to stitch any type of TCP message from a device for use in the Topology module, the Topology TL1 Stitcher service has been set up to stitch TL1 Gateways and Elements to build a dynamic logical layout.

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

TCP Client Stitcher 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 Topology TL1 Stitcher
Program bin/core/collection/TCPClientStitcherd
Arguments This field is blank. There is no default value.
Description Topology and Inventory rules-based TL1 stitcher via Core 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.

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/topology/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.
Host 127.0.0.1 Text, 255 characters The FQDN/IP Address of the device to be connected to.
IncludeRules collection/topology/tl1g/base.includes Text, 255 characters The relative path to the application Include Rules file.
LoadRules collection/topology/tl1g/base.load Text, 255 characters The relative path to the application Load Rules file.
LogFile logs/ToplogyTL1Stitcher.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.
Port 9000 An integer The port to use when connecting to the device.
Threads 3 An integer The number of process threads created.

Rules

This stitcher 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 stitcher exposes the following tokens for rules processing by the listeners.

Token Description
$Message->{'RxTime'} Time of message
$Message->{'Message'} Processed full TL1 Message (semicolon delimited)
$Message->{'Host'} Hostname
$Message->{'IP'} IP Address
$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: