Load Balancer Connector Scripts for SOAP-to-REST Ingest

Overview

This document describes the load balancer (LB) connector scripts and configuration snippets designed to integrate various load balancer and reverse proxy products with the SOAP-to-REST generic ingest pipeline. These scripts are provided as part of the platform deployment bundle, located in the lb-connectors/ directory relative to the deploy package root, and serve as the canonical location for all vendor connector scripts (source: deploy/lb-connectors/README.md).

Capabilities

The connector scripts capture SOAP traffic metadata, including request/response bodies, client IP addresses, HTTP methods, HTTP status codes, and latency. This metadata is then POSTed as a canonical JSON envelope to the SOAP-to-REST generic ingest endpoint (source: deploy/lb-connectors/README.md).

How it Works

Each connector script functions by extracting specific SOAP traffic metadata from the load balancer's traffic flow. This collected data is then formatted into a standardized JSON envelope. The JSON envelope is subsequently sent via an HTTP POST request to the platform's /ingest/v1/generic/traffic endpoint. Upon receipt, the ingest service writes this event to the platform's traffic log table. This log data then feeds into the Observability dashboard, the Live Traffic Log, and the automatic service-discovery pipeline, enabling monitoring and analysis of SOAP-to-REST traffic (source: deploy/lb-connectors/README.md).

Supported Vendors and Status

The platform provides connector scripts and documentation for several load balancer vendors. The status indicates the level of support and maintenance provided for each.

Vendor	Directory	Script type	v1 status	RFC section
F5 BIG-IP LTM	f5/	iRule (TCL)	Ship-and-maintain	docs/customer-roadmap/connector-strategy.md §1.2
HAProxy	haproxy/	Lua script	Ship-and-maintain	docs/rfc/lb-syslog-discovery.md §2.2
nginx	nginx/	njs (JavaScript)	Ship-and-maintain	docs/rfc/lb-syslog-discovery.md §2.3
Citrix ADC	citrix/	NITRO callout	Documentation-only	docs/rfc/lb-syslog-discovery.md §2.1
Kemp LoadMaster	kemp/	Syslog / AppShape++	Documentation-only	docs/rfc/lb-syslog-discovery.md §2.4
A10 Thunder ADC	a10/	aFleX (TCL)	Documentation-only	docs/rfc/lb-syslog-discovery.md §2.5
Radware Alteon	radware/	AppShape++ (JS)	Documentation-only	docs/rfc/lb-syslog-discovery.md §2.6
(source: deploy/lb-connectors/README.md)

• Ship-and-maintain: These scripts are tested, versioned, and updated with each platform release. Bug reports and pull requests are actively triaged.
• Documentation-only: For these vendors, the platform provides documentation outlining the configuration approach. API consumers are expected to adapt from the provided RFCs and can contribute back via pull requests. For v1, only HAProxy and nginx are shipped as maintained scripts (source: deploy/lb-connectors/README.md).

Quick Start Guide

To quickly set up and verify the load balancer connector scripts:

1. Read the README file located in the relevant vendor-specific directory within lb-connectors/ (source: deploy/lb-connectors/README.md).
2. Set the S2R_ENDPOINT and GATEWAY_IP environment variables to point to your SOAP-to-REST platform host. The default ingest port is 8081 (source: deploy/lb-connectors/README.md).
3. Follow the installation steps specific to your vendor, as detailed in their respective documentation (source: deploy/lb-connectors/README.md).
4. Verify that events appear in the platform UI under Observability > Live Traffic Log (source: deploy/lb-connectors/README.md).

Configuration Parameters

The following environment variables and endpoint details are crucial for configuring the load balancer connectors.

Ingest Endpoint

All connector scripts POST captured metadata to the following endpoint:

http://<platform-host>:<S2R_INGEST_HOST_PORT>/ingest/v1/generic/traffic

The default ingest port is 8081 (source: deploy/lb-connectors/README.md).

Environment Variables

Name	Type	Default	Description
S2R_ENDPOINT	string		The base URL or IP address of your SOAP-to-REST platform host.
GATEWAY_IP	string		The IP address of your SOAP-to-REST platform host.
S2R_INGEST_HOST_PORT	integer	8081	The port on which the ingest service is listening.
S2R_INGEST_CREDENTIALS	string		Credentials for HTTP Basic Authentication required by the ingest endpoint. These must be set in the platform's .env file and matched in your connector configuration.
(source: deploy/lb-connectors/README.md)

Troubleshooting

Authentication Failures

The ingest endpoint requires HTTP Basic Authentication. If traffic is not being ingested, ensure that S2R_INGEST_CREDENTIALS is correctly set in the platform's .env file and that the same credentials are provided in your load balancer connector configuration (source: deploy/lb-connectors/README.md).

Event Visibility

After configuring and deploying a connector script, verify that events are successfully reaching the platform by checking the Observability > Live Traffic Log section in the platform UI. If no events appear, review the quick start steps and vendor-specific installation instructions (source: deploy/lb-connectors/README.md).

References

For further details, consult the following resources:

• Integration guide: docs/load-balancer-integration.md (source: deploy/lb-connectors/README.md)
• Configuration reference: docs/configuration-reference.md (source: deploy/lb-connectors/README.md)

---

All SOAP-to-REST docs