PricingSign inRequest a Demo

Build Your First Configuration

Configure a collector to start collecting telemetry and exporting it to your preferred destination

To set up a collector configuration, navigate to the Configurations tab and click Create Configuration.

Bindplane docs - Build Your First Configuration - image 1

You'll now be in the configuration wizard.

  1. Give your config a name (see naming rules below)

  2. Choose a platform for it to run on that corresponds to your collector(s)

  3. You can optionally add a description for the config, then click Next

Bindplane docs - Build Your First Configuration - image 2

NOTE

Rules for naming configs:

  • must be 63 characters or less

  • must begin and end with an alphanumeric character ( [a-z0-9A-Z] )

  • can contain dashes ( - ), underscores ( _ ), dots ( . ), and alphanumerics between

Add a Source

Next, we'll add sources to our configuration. Sources are where you'd like to collect metrics, logs, or traces. We will start by collecting some host metrics using the Host source.

  1. Click Add Source

  2. Choose "Host"

  3. Choose the metrics you'd like to collect

  4. Click Save when you're all done

Click Save when you're done with the source configuration. You can add more sources, click on existing ones to see their configuration and edit or remove them, or click Next to move on to adding a destination.

Bindplane docs - Build Your First Configuration - image 3

Add a Destination

The last step is to add a destination. This is where you'd like to ship your telemetry for storage or analysis. Bindplane supports the most popular destinations out of the box. You can find a full list here.

For this example, we will show you how to configure a Google Cloud destination.

  1. Click Add Destination

  2. Select "Google Cloud" from the list of destinations

  3. Enter a name (corresponding with the same naming rules listed above)

  4. Fill in your Project ID

  5. Select the desired authentication method

NOTE

📘 If the VM running your Bindplane collector is already in Google Cloud, then you can leave the authentication method as auto.

📘 Creating a credentials file for Google Cloud

A Google Cloud Service Account can used for authentication by creating a service account and key.

Create a service account with the following roles:

  • Metrics: roles/monitoring.metricWriter

  • Logs: roles/logging.logWriter

  • Traces: roles/cloudtrace.agent

Create a service account JSON key and place it on the system that is running the collector.

  1. Click Save to save the destination

  2. Click Save again to finish building your configuration

Bindplane docs - Build Your First Configuration - image 4

Apply Configuration

The next page is the Details page for the config you just created.

  1. Click the Add Agents button to add a collector

  2. Select which collectors you'd like to apply the config to

  3. Click Apply

Bindplane docs - Build Your First Configuration - image 5

Rollout The Configuration

Now that you've built your configuration and specified the collectors it should be applied to, you need to roll out the configuration. Rollouts are how we deploy configuration changes to our collectors.

Click "Start Rollout", and your configuration will be sent to your collector(s)!

Bindplane docs - Build Your First Configuration - image 6

Next Steps

Congratulations! You've successfully configured Bindplane, and you should now see telemetry flowing into your destination. If you run into any issues during setup, don't hesitate to contact us on Slack; we'd be happy to help.

Next, you should take some time to explore the integrations available in Bindplane on our Sources page and Destinations page.

Once you've configured your first pipeline, we can begin exploring the real power of Bindplane: routing, transforming, and reducing your telemetry data.

PreviousInstall Your First CollectorNextDeployment

Last updated

Was this helpful?