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!

Requirements

Before installing a new Collector, ensure your system meets the following requirements:

System Requirements

  • 2 CPU cores recommended
  • 4 GB RAM recommended
  • 1 GB of storage space for installation and logs

A Collector running on a system with the above requirements can typically handle about 75,000 metrics per minute.

Supported Operating Systems

  • GNU/Linux

    • Red Hat Enterprise Linux 6, 7
    • CentOS 6, 7
    • Ubuntu 14, 16, 18
  • Windows

    • All Editions, including Core
    • Server 2008 R2 (Requires Powershell 3.0 or later)
    • Server 2012
    • Server 2012 R2
    • Server 2016
    • Server 2019
    • 10, 8.1, 7

📘

.NET 4.5 Requirement

Make sure to that .NET Framework 4.5 or later is installed. (This comes standard on all versions of 2012 & 2016 except Core)

  • macOS
    • El Capitan (10.11)
    • Sierra (10.12)
    • High Sierra (10.13)

CLI Utilities Required for Linux and OSX

  • curl
  • unzip
  • uname

🚧

Installing the Collector

While you can install a Collector on the Source's host, we recommend installing it on its own server. This limits your configuration effort and allows you to have one Collector that monitors multiple Sources. Running the Collector on the same system as a Source is not a problem, but it risks having to share limited hardware resources and losing information should a system-wide failure occur.

Communication with BindPlane

All communication with BindPlane is initiated by the collector as HTTPS requests. Requests are sent to *api.bindplane.bluemedora.com on port 443.

Testing Connection

A simple test will let you know if your collector's host is able to communicate with BindPlane.

  • macOS/Linux:
    curl https://api.bindplane.bluemedora.com/test
  • Windows (Powershell):
    Invoke-RestMethod -Uri https://api.bindplane.bluemedora.com/test

Expected Response:

{"result":"Able to reach BindPlane"}

Setting up a Proxy

After installing the collector, the following will need to be set in the collector's config.json file.

{
  "metric_service_endpoint": "https://api.bindplane.bluemedora.com",
  "ssl_verify": false,
  "http_proxy": "http://my.domain.com:9999"
}

Note: You will need to restart the collector after making the configuration change.

Collector Service Management

Below are built in ways to control the collector.

Windows

The Collector installs as a Windows Service with the name BindPlane Collector.

init.d Systems

service bindplane-collector start/stop/restart

systemd Systems

systemctl start/stop/restart bindplane-collector

launchd (macOS) Systems

launchctl stop/start bindplane-collector

Updated 6 months ago

Requirements


Suggested Edits are limited on API Reference Pages

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