builder

Documentation

Index

• Variables
• func Compile(cfg Config) error
• func Generate(cfg Config) error
• func GenerateAndCompile(cfg Config) error
• func GetModules(cfg Config) error
• type Config
  • func NewDefaultConfig() Config
  • func (c *Config) ParseModules() error
  • func (c *Config) SetGoPath() error
  • func (c *Config) Validate() error
• type Distribution
• type Module

Variables

var (
	// ErrGoNotFound is returned when a Go binary hasn't been found
	ErrGoNotFound = errors.New("go binary not found")
)

var ErrInvalidGoMod = errors.New("invalid gomod specification for module")

ErrInvalidGoMod indicates an invalid gomod

Functions

func Compile

func Compile(cfg Config) error

Compile generates a binary from the sources based on the configuration

func Generate

func Generate(cfg Config) error

Generate assembles a new distribution based on the given configuration

func GenerateAndCompile

func GenerateAndCompile(cfg Config) error

GenerateAndCompile will generate the source files based on the given configuration, update go mod, and will compile into a binary

func GetModules

func GetModules(cfg Config) error

GetModules retrieves the go modules, updating go.mod and go.sum in the process

Types

type Config

type Config struct {
	Logger          *zap.Logger
	SkipCompilation bool   `mapstructure:"-"`
	SkipGetModules  bool   `mapstructure:"-"`
	LDFlags         string `mapstructure:"-"`

	Distribution Distribution `mapstructure:"dist"`
	Exporters    []Module     `mapstructure:"exporters"`
	Extensions   []Module     `mapstructure:"extensions"`
	Receivers    []Module     `mapstructure:"receivers"`
	Processors   []Module     `mapstructure:"processors"`
	Connectors   []Module     `mapstructure:"connectors"`
	Replaces     []string     `mapstructure:"replaces"`
	Excludes     []string     `mapstructure:"excludes"`
}

Config holds the builder's configuration

func NewDefaultConfig

func NewDefaultConfig() Config

NewDefaultConfig creates a new config, with default values

func (*Config) ParseModules

func (c *Config) ParseModules() error

ParseModules will parse the Modules entries and populate the missing values

func (*Config) SetGoPath

func (c *Config) SetGoPath() error

SetGoPath sets go path

func (*Config) Validate

func (c *Config) Validate() error

Validate checks whether the current configuration is valid

type Distribution

type Distribution struct {
	Module           string `mapstructure:"module"`
	Name             string `mapstructure:"name"`
	Go               string `mapstructure:"go"`
	Description      string `mapstructure:"description"`
	OtelColVersion   string `mapstructure:"otelcol_version"`
	OutputPath       string `mapstructure:"output_path"`
	Version          string `mapstructure:"version"`
	BuildTags        string `mapstructure:"build_tags"`
	DebugCompilation bool   `mapstructure:"debug_compilation"`
}

Distribution holds the parameters for the final binary

type Module

type Module struct {
	Name   string `mapstructure:"name"`   // if not specified, this is package part of the go mod (last part of the path)
	Import string `mapstructure:"import"` // if not specified, this is the path part of the go mods
	GoMod  string `mapstructure:"gomod"`  // a gomod-compatible spec for the module
	Path   string `mapstructure:"path"`   // an optional path to the local version of this module
}

Module represents a receiver, exporter, processor or extension for the distribution