Kemp LoadMaster Syslog Configuration for API Discovery

Learn how to configure Kemp LoadMaster syslog for API discovery, including log format and field mapping. Note limitations on body capture.

Overview

This document outlines the approach for configuring Kemp LoadMaster syslog to support API discovery. It describes where to find detailed configuration instructions and highlights specific limitations of Kemp LoadMaster in this context. Operators are advised to consult the referenced RFC for comprehensive configuration details and to adapt the syslog log format to their specific environment (source: deploy/lb-connectors/kemp/README.md).

How it Works: Integrating Kemp LoadMaster for API Discovery

API discovery using Kemp LoadMaster relies on configuring its syslog functionality to export relevant access log data. This data, once formatted correctly, can then be processed by the API platform for discovery purposes. The core mechanism involves:

  1. Syslog Target Configuration: Directing Kemp LoadMaster to send its logs to a specified syslog server.
  2. Extended Access Log Format: Configuring Kemp LoadMaster to use a specific, extended access log format that includes necessary fields for API discovery.
  3. Field Mapping: Mapping the fields from the extended access log format to the standardized envelope fields used by the API platform (specifically, BB #12 envelope fields).

Detailed instructions for these steps are provided in a separate RFC (source: deploy/lb-connectors/kemp/README.md).

Where to Find Configuration Details

The comprehensive configuration details for Kemp LoadMaster syslog and the required field-mapping are documented in:

docs/rfc/lb-syslog-discovery.md §2.4 — "Kemp LoadMaster (BB #8)" (source: deploy/lb-connectors/kemp/README.md)

This RFC covers:

  • Syslog target configuration, accessible via Settings > Logging > Syslog in the Kemp LoadMaster interface.
  • The recommended extended access log format.
  • The specific field mapping required to align Kemp LoadMaster log fields with the BB #12 envelope fields (source: deploy/lb-connectors/kemp/README.md).

Limitations

Kemp LoadMaster has specific limitations regarding body capture within its syslog path:

  • No Native Body Capture: Standard Kemp LoadMaster builds do not include a native mechanism for capturing request or response bodies (request_payload / response_payload) directly within the syslog path.
  • Custom AppShape++ Requirement: Achieving full body capture would necessitate a custom AppShape++ script, which typically requires specialist engagement (source: deploy/lb-connectors/kemp/README.md).

Contributions

The API publisher welcomes contributions for Kemp LoadMaster configurations that enhance its capabilities for API discovery. If you have a tested Kemp LoadMaster AppShape++ script or a working body-capture configuration, you are encouraged to open a Pull Request (PR) that includes:

  • The AppShape++ script or configuration file itself.
  • An updated version of this README.md document, detailing the installation steps for the contributed script or configuration.

For general contribution guidelines, refer to docs/lld/contribution-guidelines.md. Alternatively, you may open an issue describing your environment and the tested configuration (source: deploy/lb-connectors/kemp/README.md).

Tagsreference

All SOAP-to-REST docs