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!

Getting Started

Basic Concepts

This section is about providing clarity on the concepts used in BindPlane, and how to use them to setup log monitoring for your cloud and on premise environments.

An Agent is the BindPlane software that installs in your environment and captures logs. This software typically will be installed on the system the log files exist. It can also be configured to receive logs from other systems through protocols like Syslog.

A configuration that specifies which and what type of logs to collect and how to parse them, this configuration can be deployed on many agents.

A Destination is the configuration used to send the collected log data to. This data is sent directly from the agent to the destination.

A Template is a set of configured Sources and a Destination. This is a list that can be used to install an Agent with sources and destinations that are already configured.

BindPlane Log monitoring configuration is fairly flexible to fit your specific configuration and deployment needs. We do recommend when setting up your first Agent you follow the steps of installing an agent, then configuring a Source and Destination for that agent. Once you have some familiarity we recommend leveraging templates as they provide more powerful deployment features useful for Infrastructure as Code and cluster environments like Kubernetes.

First time setup

Installing an Agent

To create an agent, navigate to the “Agents” page in the “Logs” tab. Click the “Add Agent” button.

At this point, you will be prompted to add a destination. You can skip configuration of a destination by clicking “Skip”. This can be done after installing the agent. Similarly, on the subsequent page, you can skip configuring the agent with a source.

Next, you will be prompted to select a deployment platform. Select the platform you want to deploy to, then follow the instructions to install the agent.

After installation completes, within a minute or two, the agent should appear on the Agents page.

Create a Destination

To create a new destination, navigate to the Agent and click “Deploy Destination” and choose "Add New". Here, you will be asked where you want to stream your logs. Currently, the only supported option is Google Stackdriver.

After selecting the platform you want to stream your logs to, you will be asked to configure the destination. For Google Stackdriver, the required fields are Name, Credentials, and Location. For more information about a field, hover over the information icon.

After filling out the fields, click “Test Destination”. This will check that the credentials you configured have the permissions to write logs to Stackdriver. If the test connection succeeds, click “Create”. This will redirect you back to the Agent, where you should see your newly-configured destination.

Create a Source

To create a new source click “Deploy Source” and choose 'Add New'. Next, choose the technology you would like to collect logs for.

If the technology you want to monitor is not yet supported, you can use one of the generic sources such as Syslog or Tail. If these still do not fit your needs, you can use the Custom Input plugin which accepts a raw Fluentd configuration block.

After selecting the technology you would like to monitor, fill in the required fields and click “Create”. For more information about the fields, hover over the information icon above the field.

Install an Agent with preconfigured Sources and Destinations

In many cases, it is useful to have an install command that can be run on multiple hosts and have the hosts preconfigured to collect logs and send them to a destination. This is especially useful for platforms like Kubernetes, where the agent runs in transient containers.

To do this, navigate to the “Agents” page, and click “New Agent”. Then, choose the destination and sources you would like the agent to be deployed with. Finally, select your deployment platform and follow the instructions to install on that platform.

Within a couple of minutes, you should see the agents appear on the “Agents” page, already configured with the destination and sources you selected in the install process.

Getting Started

Suggested Edits are limited on API Reference Pages

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