For the complete documentation index, see llms.txt. This page is also available as Markdown.

Kong API Gateway Integration

This section provides comprehensive documentation for integrating Traceable with Kong API Gateway to secure and monitor your API traffic with enterprise-grade security and observability.

Getting Started

Prerequisites

  • Kong Gateway 2.4.0 or later (Enterprise or Open Source)

  • Network connectivity to Traceable Platform Agent (TPA)

  • Administrative access to Kong Admin API or Kong Manager

Supported Kong Versions

Kong Version
Enterprise
Open Source

3.0.x

2.8.x

2.7.x

2.6.x

2.5.x

2.4.x

Installation Methods

1. Docker Deployment

For containerized Kong environments:

2. Kubernetes Deployment

For Kong in Kubernetes:

3. VM/Bare Metal Deployment

For traditional server deployments:

4. Kong Konnect (SaaS)

For Kong's managed service:

5. Kong Ingress Controller

For Kong Ingress Controller in Kubernetes:

Verification

After installation, verify that:

  1. The Traceable plugin is enabled in Kong

  2. Traffic is being forwarded to the Traceable Platform Agent

  3. API calls appear in the Traceable dashboard

Troubleshooting

Troubleshooting guide is available here.

Deployment Architectures

Before installing, review the Deployment Architectures section for reference patterns on sync vs async mode, SSE capture, cloud metadata enrichment, fail-open/timeout behavior, and service naming.

Last updated

Was this helpful?