For the complete documentation index, see llms.txt. This page is also available as Markdown.

Custom

The Custom source lets you configure an OpenTelemetry receiver directly by pasting its YAML. It is useful for testing a new receiver or for fulfilling a use case that Bindplane does not yet support natively. You choose which telemetry types the receiver produces (Logs, Metrics, Traces), and Bindplane inserts your YAML into the matching pipelines.

The Custom source can only use components that ship with the Bindplane Collector. See the Included Components list for the receivers, processors, and exporters that are available.

Supported Telemetry Types

The Custom source can emit any signal the chosen receiver supports. The signals actually collected are limited to those allowed by the specific receiver in your configuration, and to the telemetry types you select.

Platform
Metrics
Logs
Traces

Linux

✓

✓

✓

Windows

✓

✓

✓

macOS

✓

✓

✓

AIX

✓

✓

✓

Kubernetes Node

✓

✓

✓

Kubernetes Cluster

✓

✓

✓

Kubernetes Gateway

✓

✓

✓

OpenShift Node

✓

✓

✓

OpenShift Cluster

✓

✓

✓

OpenShift Gateway

✓

✓

✓

Prerequisites

This source is part of Bindplane's pipeline plumbing rather than a packaged integration, so it requires no external setup of its own. You do need:

  • A receiver that is included in the Bindplane Collector. See the Included Components list.

  • Whatever access the receiver itself requires (network reachability, host read permissions, credentials, and so on). Those requirements come from the receiver you configure, not from this source.

Configuration

Bindplane docs - Custom - image 1
Parameter
Type
Required
Default
Description

Choose Telemetry Type

Telemetry Selector

No

(empty)

The telemetry types the receiver produces. Any combination of Logs, Metrics, and Traces. Bindplane inserts the configuration into the pipelines for the selected signals only.

Configuration

YAML

Yes

(empty)

The YAML configuration for the receiver. Enter any supported OpenTelemetry receiver and the YAML is inserted into the collector configuration. See the Receiver Syntax reference.

Examples

SQL Server Receiver

The SQL Server Receiver is already configurable through the Microsoft SQL Server source, but the Custom source can reach configuration options that the native source does not expose.

Select Metrics as the telemetry type for this receiver.

Configuration Tips

  • Select only the telemetry types the receiver actually produces. Selecting a signal a receiver does not emit results in an empty pipeline for that signal.

  • Paste only the receiver block (the receiver name as the top-level key and its settings beneath). Do not include the surrounding receivers: key or other collector sections; Bindplane wraps the YAML for you.

  • Confirm the receiver is part of the Bindplane Collector before using it. Components outside the Included Components list will not start.

Troubleshooting

The collector fails to start after adding the source

Symptoms: the collector reports a configuration or unknown-type error after the Custom source is applied.

Solutions:

  1. Verify the receiver name is spelled correctly and is present in the Included Components list.

  2. Validate the YAML indentation. The receiver settings must be nested under the receiver name, and the block must be valid YAML on its own.

No data flows from the source

Symptoms: the pipeline is healthy but no telemetry arrives.

Solutions:

  1. Confirm the telemetry type you selected matches what the receiver emits. A metrics-only receiver produces nothing on the Logs or Traces pipelines.

  2. Check the receiver-specific requirements (endpoint reachability, credentials, file permissions) described in that receiver's upstream documentation.

Standalone Source

Last updated

Was this helpful?