BindPlane OP works in conjunction with the observIQ Distro for OpenTelemetry Collector which can be installed on Linux, Windows, or macOS.

Installation Script

🚧

Install Agents from BindPlane OP

To install the collector, you should get the installation script from BindPlane OP Server as outlined in Step 3 of our Quickstart Guide. Doing so ensures the agent instantly connects to BindPlane OP and can be managed without additional configuration.

📘

Agent or Collector: What's the difference?

We often use the term Agent and Collector interchangeably. When you see either throughout the product or the documentation, we're always referring to the observIQ Distro for OpenTelemetry Collector

Ansible

Ansible can be used as an alternative to the agent install script. The BindPlane Agent Ansible Role can be integrated into your Ansible playbooks to manage installation of BindPlane OP managed agents.

Ansible is useful for installing agents at scale, where the installation script would be cumbersome to manage on hundreds or thousands of systems.

Usage

The BindPlane Agent role must be cloned to your workstation and added to your playbook before it can be deployed.

Clone Repo

Clone the Ansible Role Git repository to your roles directory.

The following command will clone the repository to the directory roles/bindplane_agent.

git clone https://github.com/observIQ/bindplane-agent-ansible.git roles/bindplane_agent 

Update Playbook

Update your Ansible Playbook to include the bindplane_agent role. The role requires the following parameters:

• version: BindPlane Agent version
• endpoint: The remote URL of the BindPlane OP server
• secret_key: The secret key of the BindPlane OP server

- name: my-playbook
  hosts: my-hosts
  become: yes
  roles:
    - role: bindplane_agent
      version: "1.29.1"
      endpoint: "wss://app.bindplane.com/v1/opamp"
      secret_key: "xxxx-xxxx-xxxxx-xxxx"

Deploy

Once the role is configured in your playbook, you can deploy the agents to your hosts group. For example:

ansible-playbook playbook.yml -i ./site.yml

This command assumes you have a playbook file playbook.yml and a site file site.yml in your working directory, along with the roles/bindplane_agent directory.

Additional Documentation

A comprehensive list of configuration options can be found in the BindPlane Agent Role Github repository.

Uninstall observIQ Distro for OpenTelemetry Collector

On Linux, macOS, or Windows run the following command to uninstall the collector:

sudo sh -c "$(curl -fsSlL https://github.com/observiq/observiq-otel-collector/releases/latest/download/install_unix.sh)" install_unix.sh -r

sh -c "$(curl -fsSlL https://github.com/observiq/observiq-otel-collector/releases/latest/download/install_macos.sh)" install_macos.sh -r

(Get-WmiObject -Class Win32_Product -Filter "Name = 'observIQ OpenTelemetry Collector'").Uninstall()

Optionally on Windows you can uninstall the collector via the control panel. Simply follow the steps below.

1. Navigate to the control panel, then to the "Uninstall a program" dialog.
2. Locate the observIQ OpenTelemetry Collector entry, and select uninstall.
3. Follow the wizard to complete removal of the collector.