bindplaneextension

README

Bindplane Extension

This extension is used by Bindplane in custom distributions to store Bindplane specific information. It is not currently included in the official bindplane-agent.

Configuration

Field	Type	Default	Required	Description
labels	string		false	Labels for the agent, formatted in k1=v1,k2=v2 format.

Examples

Setting labels for Bindplane

Bindplane expects a single unnamed bindplane extension in the configuration. It may be used to specify labels:

receivers:
  nop:

exporters:
  nop:

extensions:
  bindplane:
    labels: "labelA=valueA,labelB=valueB"

service:
  extensions: [bindplane]
  pipelines:
    logs:
      receivers: [nop]
      exporters: [nop]

In this configuration, two labels are specified - labelA, with a value of valueA, and labelB, with a value of valueB

Documentation

Overview

Package bindplaneextension provides an extension that facilitates communication with Bindplane

Index

• func NewFactory() extension.Factory
• type Config
  • func (c Config) Validate() error

Functions

func NewFactory

func NewFactory() extension.Factory

NewFactory creates a new factory for the bindplane extension

Types

type Config

type Config struct {
	// Labels in "k1=v1,k2=v2" format
	Labels string `mapstructure:"labels"`
	// Component ID of the opamp extension. If not specified, then
	// this extension will not generate any custom messages for throughput metrics or topology.
	OpAMP component.ID `mapstructure:"opamp"`
	// MeasurementsInterval is the interval on which to report measurements.
	// Measurements reporting is disabled if this duration is 0.
	MeasurementsInterval time.Duration `mapstructure:"measurements_interval"`
	// ExtraMeasurementsAttributes are a map of key-value pairs to add to all reported measurements.
	ExtraMeasurementsAttributes map[string]string `mapstructure:"extra_measurements_attributes,omitempty"`
}

Config is the configuration for the bindplane extension

func (Config) Validate

func (c Config) Validate() error

Validate returns an error if the config is invalid