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

Custom

The Custom extension lets you configure any supported OpenTelemetry extension by providing its raw YAML configuration. It is a collector-level capability: rather than receiving, processing, or exporting telemetry, it injects an extension block directly into the collector configuration. Use it when an extension is supported by the Bindplane OpenTelemetry Collector but does not have a dedicated Bindplane extension form of its own. A list of supported extensions is available in the collector extension reference.

Configuration

Basic Configuration

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

Choose Telemetry Type

Telemetry Selector

No

(empty)

The telemetry types (Logs, Metrics, Traces) the extension supports. The extension is added to the pipelines for the selected signals.

Configuration

YAML

Yes

The raw YAML configuration for the extension. Enter any supported extension and its YAML is inserted into the collector configuration.

Examples

Inject a health check extension

This example uses the Custom extension to add the OpenTelemetry health check extension. Set Choose Telemetry Type to the signals the extension applies to, and paste the extension's YAML into the Configuration field:

The extension's name (here health_check) is the top-level key in the YAML. Bindplane inserts the block into the collector configuration's extensions section.

Configuration Tips

  • The Configuration value is the extension's own YAML, keyed by the extension's name (for example health_check:), exactly as it would appear in a hand-written collector config. Do not add an enclosing extensions: key, Bindplane adds it.

  • Choose Telemetry Type controls which signal pipelines the extension is attached to. Select every signal the extension should apply to.

  • Verify the extension name is one of the supported extensions before using it, an unsupported name produces a collector that fails to start.

Troubleshooting

The collector fails to start after adding the extension

Symptoms: the collector reports an unknown extension type or an invalid configuration error.

Solutions:

  1. Confirm the top-level key in the Configuration field matches a supported extension name.

  2. Validate the YAML indentation and structure against the upstream extension's reference documentation.

The extension is configured but never runs

Symptoms: the extension YAML is valid but the capability never activates.

Solutions:

  1. Confirm Choose Telemetry Type includes at least one signal, an extension with no selected telemetry type is not attached to any pipeline.

Standalone Extension

Last updated

Was this helpful?