Kemp LoadMaster Syslog Configuration for API Platform

Configure Kemp LoadMaster for API platform syslog output. Details syslog target, extended access log format, and field mapping. Notes lack of native body

Overview

The Kemp LoadMaster connector documentation describes how to configure Kemp LoadMaster devices to integrate with the API platform's logging and data ingestion mechanisms.

This component serves as a load balancer connector, responsible for forwarding relevant traffic metadata to the API platform via syslog. It is currently designated as "documentation-only" for v1 of the API platform, meaning it is not actively maintained within this directory. For v1, HAProxy and Nginx body-capture scripts are the officially supported and maintained solutions.

API publishers operating Kemp LoadMaster devices can refer to this documentation for guidance on adapting their syslog log format to their environment, particularly for scenarios where HAProxy or Nginx are not used.

How it Works (Conceptual)

The integration with Kemp LoadMaster primarily involves configuring the device to emit syslog messages containing extended access log data. The core mechanism relies on:

Syslog Target Configuration: Setting up the Kemp LoadMaster to send logs to a specified syslog receiver.
Extended Access Log Format: Defining a custom log format that includes specific fields required by the API platform.
Field Mapping: Establishing a correspondence between the fields in the Kemp LoadMaster's extended access log and the BB #12 envelope fields used by the API platform.

Limitations on Body Capture

A significant limitation of Kemp LoadMaster, as documented, is the absence of a native body-capture mechanism within its standard syslog path. This means that request_payload and response_payload fields are not available in standard Kemp builds when using syslog for data transmission.

Achieving full body capture with Kemp LoadMaster would necessitate the development and implementation of a custom AppShape++ script, which requires specialist engagement.

Configuration Reference

Specific configuration details for Kemp LoadMaster, including syslog target configuration (under Settings > Logging > Syslog) and the recommended extended access log format with its field mapping to BB #12 envelope fields, are documented externally.

The provided source (deploy/lb-connectors/kemp/README.md) does not directly define any configuration options, parameters, or fields. It refers to docs/rfc/lb-syslog-discovery.md §2.4 for these details.

Examples

The provided source (deploy/lb-connectors/kemp/README.md) does not contain concrete, step-by-step examples of Kemp LoadMaster configuration, request/response payloads, or command invocations. It refers to docs/rfc/lb-syslog-discovery.md §2.4 for these examples.

API / CLI / Endpoint Reference

The provided source (deploy/lb-connectors/kemp/README.md) does not define any callable API endpoints, CLI commands, or exported functions related to Kemp LoadMaster integration.

Troubleshooting and Limitations

The primary limitation for Kemp LoadMaster integration with the API platform is related to data capture capabilities:

No Native Body Capture: Kemp LoadMaster lacks a built-in mechanism for capturing request and response bodies directly within its syslog path.
Unavailable Payload Fields: Consequently, standard syslog configurations from Kemp LoadMaster will not include request_payload or response_payload fields.
Custom Script Requirement: To achieve full body capture, a custom AppShape++ script is required, which is not part of the standard integration and requires specialist development.

Operators should be aware of these limitations when planning their data ingestion strategy for the API platform using Kemp LoadMaster.

Contributions

The API publisher encourages contributions for Kemp LoadMaster integration. If an API consumer develops a tested Kemp LoadMaster AppShape++ script or a working body-capture configuration, they are invited to submit a Pull Request (PR).

A contribution should include:

The AppShape++ script or configuration file.
An updated version of this README, incorporating installation steps for the contributed solution.

Refer to docs/lld/contribution-guidelines.md for general contribution guidelines, or open an issue detailing the environment and tested configuration.