While the main branch is stable, it is still under development and documentation may not fully reflect the current feature set. Please refer to documentation for your specific release.
BindPlane Agent is observIQ’s distribution of the OpenTelemetry collector. It provides a simple and unified solution to collect, refine, and ship telemetry data anywhere.
Increases the accessibility of OpenTelemetry by providing simplified installation scripts, tested example configurations, and end-to-end documentation making it easy to get started
Bundled with all core OpenTelemetry receivers, processors, and exporters as well as additional capabilities for monitoring complex or enterprise technologies not yet available in upstream releases
Tested, verified, and supported by observIQ
To install using the installation script, you may run:
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.shTo install directly with the appropriate package manager, see installing on Linux.
To install the BindPlane Agent on Windows run the Powershell command below to install the MSI with no UI.
msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quietAlternately, for an interactive installation download the latest MSI.
After downloading the MSI, simply double click it to open the installation wizard. Follow the instructions to configure and install the agent.
For more installation information see installing on Windows.
To install using the installation script, you may run:
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_macos.sh)" install_macos.shFor more installation information see installing on macOS.
To deploy the agent on Kubernetes, further documentation can be found at our observiq-otel-collector-k8s repository.
Now that the agent is installed it is collecting basic metrics about the host machine printing them to the log. If you want to further configure your agent you may do so by editing the config file. To find your config file based on your OS reference the table below:
| OS | Default Location |
|---|---|
| Linux | /opt/observiq-otel-collector/config.yaml |
| Windows | C:\Program Files\observIQ OpenTelemetry Collector\config.yaml |
| macOS | /opt/observiq-otel-collector/config.yaml |
For more information on configuration see the Configuration section.
The BindPlane Agent uses OpenTelemetry configuration.
For sample configs, see the config directory. For general configuration help, see the OpenTelemetry docs.
For configuration options of a specific component, take a look at the README found in their respective module roots. For a list of currently supported components see Included Components.
For a list of possible command line arguments to use with the agent, run the agent with the --help argument.
For supported receivers and their documentation see receivers.
For supported processors and their documentation see processors.
For supported exporters and their documentation see exporters.
For supported extensions and their documentation see extensions.
For supported connectors and their documentation see connectors.
Here is an example config.yaml setup for hostmetrics on Google Cloud. To make sure your environment is set up with required prerequisites, see our Google Cloud Exporter Prerequisites page. Further details for this GCP example can be found here.
# Receivers collect metrics from a source. The hostmetrics receiver will get
# CPU load metrics about the machine the agent is running on every minute.
receivers:
hostmetrics:
collection_interval: 60s
scrapers:
cpu:
disk:
load:
filesystem:
memory:
network:
paging:
processes:
# Exporters send the data to a destination, in this case GCP.
exporters:
googlecloud:
# Service specifies how to construct the data pipelines using the configurations above.
service:
pipelines:
metrics:
receivers: [hostmetrics]
exporters: [googlecloud]The BindPlane Agent is an open source project. If you'd like to contribute, take a look at our contribution guidelines and developer guide. We look forward to building with you.
If you need any additional help feel free to file a GitHub issue or reach out to us at [email protected].