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

Deploy a Bindplane Gateway

The Bindplane Gateway pattern routes telemetry from edge collectors through a central gateway collector using two paired components:

This prevents double-counting of telemetry in the Bindplane Summary view.

This guide covers the Bindplane Gateway telemetry pattern (telemetry data routing). For the OpAMP Gateway — a separate feature that relays OpAMP management traffic between Bindplane and collectors — see the OpAMP Gateway feature guide.

Prerequisites

  • Bindplane Collector v1.52.0 or later on all agent and gateway hosts

  • A dedicated host (or hosts) for the gateway role, separate from monitored hosts

  • Network access: edge collectors must reach the gateway on port 4317 (gRPC) or 4318 (HTTP)

  • Destination credentials only needed on gateway host(s)

Set Up a Single-Node Gateway

Edge collectors in a DaemonSet forward telemetry to a single Bindplane Collector Gateway, which fans out to multiple destinations.

Step 1: Create the Gateway Configuration

  1. In the Bindplane UI, go to Configurations and click New Configuration. Select the Gateway collector type.

  2. Add a Bindplane Gateway Source. Defaults work for most deployments — gRPC on port 4317, HTTP on port 4318, listening on 0.0.0.0. Enable TLS if agents connect over an untrusted network.

Gateway Configuration with a Bindplane Gateway Source added.
Bindplane Gateway Source settings showing port and listen address fields.
  1. Add any processors to run centrally (filtering, enrichment, sampling).

  2. Add your final destination(s). Destination credentials live here — not on edge collectors.

  3. Save and deploy to your gateway host.

Step 2: Configure Edge Collectors

  1. Open or create a configuration in Bindplane.

  2. Keep existing sources. Remove any direct destinations.

  3. Add a Bindplane Gateway Destination:

    • Hostname: gateway host IP or hostname

    • Port: 4317 (gRPC) or 4318 (HTTP)

    • Protocol: gRPC is recommended for production

Edge collector configuration with a Bindplane Gateway Destination added.
Bindplane Gateway Destination settings panel showing hostname and port.
  1. Save and deploy to edge collectors.

Step 3: Verify Data Flow

  1. Open the Visualize view. Telemetry should appear flowing through a Gateway.

  2. In the Gateway Configuration, verify inbound traffic from edge collectors (Bindplane Gateway Source).

Bindplane Gateway data flow validation.

Set Up a Multi-Node Gateway (High Availability)

Run two or more gateway nodes behind a load balancer. Size the cluster so remaining nodes can handle full load if one goes offline (N+1).

Edge collectors in a DaemonSet forward telemetry through a Load Balancer to a set of Bindplane Gateway Collectors, which fan out to multiple destinations.

Deploy the same gateway configuration to all nodes. Bindplane manages configuration consistency across the cluster.

Option 1: External Load Balancer (Nginx or cloud LB)

The simplest option. A standard TCP load balancer forwards port 4317 (gRPC) or 4318 (HTTP) across gateway nodes. Update the Hostname in the Bindplane Gateway Destination to point at the load balancer.

Example Nginx upstream for gRPC:

Option 2: OTel Load Balancing Exporter

The OTel loadbalancing exporter routes telemetry across backend gateway collectors while keeping spans from the same trace on the same node. Use this option when running trace sampling at the gateway tier — a round-robin LB splits traces across nodes, breaking head-based and tail-based samplers.

Use the load balancing exporter only when trace sampling correctness matters. For logs and metrics only, Option 1 is simpler.

Option 3: Kubernetes — Deployment + HPA

  • Run gateway nodes as a Deployment exposed via a ClusterIP Service

  • Use a HorizontalPodAutoscaler to scale replicas (e.g. 2–10) based on CPU

  • Edge agents (DaemonSet) point their Bindplane Gateway Destination at the ClusterIP service

Kubernetes ClusterIP endpoints for the Bindplane Gateway Source:

Protocol
Service
Endpoint

gRPC

clusterIP

bindplane-gateway-agent.bindplane-agent.svc.cluster.local:4317

gRPC

headless clusterIP

bindplane-gateway-agent-headless.bindplane-agent.svc.cluster.local:4317

HTTP

clusterIP

http://bindplane-gateway-agent.bindplane-agent.svc.cluster.local:4318

Use the Gateway collector type (Deployment) rather than the Node collector type (DaemonSet) for the gateway tier. The Gateway collector scales independently of cluster node count.

Last updated

Was this helpful?