Continuous Integration License

BindPlane OP

BindPlane OP is an open source observability pipeline that gives you the ability to collect, refine, and ship metrics, logs, and traces to any destination. BindPlane OP provides the controls you need to reduce observability costs and simplify the deployment and management of telemetry agents at scale.

Features

  • Manage the lifecycle of telemetry agents, starting with the observIQ OpenTelemetry Collector
  • Build, deploy, and manage telemetry configurations for different Sources and deploy them to your agents
  • Ship metric, log, and trace data to one or many Destinations
  • Utilize flow controls to adjust the flow of your data in realtime

Architecture

BindPlane OP is a lightweight web server (no dependencies) that you can deploy anywhere in your environment. It’s composed of the following components:

  • GraphQL Server: provides configuration and agent details via GraphQL
  • REST Server: BindPlane CLI and UI make requests to the server via REST
  • WebSocket Server: Agents connect to receive configuration updates via OpAMP
  • Store: pluggable storage manages configuration and Agent state
  • Manager: dispatches configuration changes to Agents

Support

BindPlane OP does not have any dependencies and can run on Windows, Linux, or macOS although we recommend installing BindPlane OP server one of the following supported Linux distributions:

  • Red Hat, Centos, Oracle Linux 7 and 8
  • Debian 10 and 11
  • Ubuntu LTS 18.04, 20.04
  • Suse Linux 12 and 15
  • Alma and Rocky Linux

The BindPlane CLI (included in the BindPlane OP binary) will run on Linux, Windows, and macOS. For a detailed list of commands and installation instructions for remote clients, see our CLI documentation page.

Quick Start

The following are our recommended installation options. For more details on installation, please visit our Getting Started page or Installation page.

Server

To install BindPlane Server, we recommend using our single-line installer. Alternatively, packages are available for download on our releases page.

Linux

curl -fsSlL https://github.com/observiq/bindplane-op/releases/latest/download/install-linux.sh | bash -s --

After the installer finishes, initialize the server using the init command. The specific command for your system is found in the installer output under the Server Initialization section. By default it is the following command for Linux:

sudo /usr/local/bin/bindplane init server --config /etc/bindplane/config.yaml

Client

To install BindPlane CLI on macOS or Linux, we recommend using the following installation commands. Alternatively, packages are available for download on our releases page.

Linux

curl -fsSlL https://github.com/observiq/bindplane-op/releases/latest/download/install-linux.sh | bash -s --

macOS

curl -fsSlL https://github.com/observiq/bindplane-op/releases/latest/download/install-macos.sh | bash -s --

Configuration

The configuration of BindPlane OP is best done through the UI which can be accessed via a web browser on port 3001. The URL will be http://<IP Address>:3001 with IP Address being the IP of the BindPlane server. To log in, use the credentials you specified when running the init command.

For more information on configuration, view our Configuration documentation page.

Community

BindPlane OP is an open source project. If you’d like to contribute, take a look at our contribution guidelines. We look forward to building with you.

Code of Conduct

BindPlane OP follows the CNCF Code of Conduct. Please report violations of the Code of Conduct to any or all maintainers.

Other questions?

Join the conversation at the BindPlane Slack!

You can also check out our documentation, send us an email, or open an issue with your question. We’d love to hear from you!

GitHub

View Github