Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Setup Requirements

Data Collection Setup

Metrics are collected via the JMX interface on the Kafka Broker server.

Network Requirements

Port: 9999 (TCP) connection to the Apache Kafka Broker server.

Least Privileged User

If authentication is setup on the Kalfka Broker server, then use a Kafka user.
For more information see: Security in the Apache Kafka Documentation

Supported Versions

Apache Kafka: 1.0.0 - 2.0.10+

Connection Parameters

Name

Required?

Description

Brokers

Required

Comma-separated list of one or more brokers to connect to.

Port

The port for communication to the Apache Kafka platform.

Producers

Comma-separated list of one or more producers to connect to.

Consumers

Comma-separated list of one or more consumers to connect to.

Username

Password

SSL Configuration

The SSL mode to use when connecting to the target. Can be configured to not use SSL (No SSL), use SSL but do not verify the target's certificate (No Verify), and use SSL and verify the target's certificate (Verify).

Connection Timeout (seconds)

The number of seconds to allow for connecting to the Apache Kafka platform.

Request Timeout (seconds)

The number of seconds to allow for the API to return a response.

Updated 11 months ago

Setup Requirements


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.