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!

Log Collection Setup

Follow these steps to set up log collection from syslog formatted messages sent to a specific port.


Ensure the desired agent host is not blocking access to the port you wish to send Syslog formatted messages.

Configure a Syslog Source

  1. Install the BindPlane Log Agent on the host system.
  2. Login to BindPlane and select the Logs tab.

Logs Tab

  1. Select the Sources tab.

Sources Tab

  1. In the top-right portion of the screen, click on the Add Source Configuration button

Add Source Configuration Button

  1. Choose Syslog
  2. Fill out the Syslog configuration options.

Syslog Configuration Form



If you are sending formatted data in your syslog messages, like JSON, you can use the 'Format' option in the Syslog Source configuration to parse the message further.

This will allow for more flexible use of the data in the end Destination.

Updated about a year ago


Suggested Edits are limited on API Reference Pages

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