extensions

Documentation

Index

• type Config
• type Extensions
  • func New(ctx context.Context, set Settings, cfg Config, options ...Option) (*Extensions, error)
  • func (bes *Extensions) GetExtensions() map[component.ID]component.Component
  • func (bes *Extensions) HandleZPages(w http.ResponseWriter, r *http.Request)
  • func (bes *Extensions) NotifyComponentStatusChange(source *componentstatus.InstanceID, event *componentstatus.Event)
  • func (bes *Extensions) NotifyConfig(ctx context.Context, conf *confmap.Conf) error
  • func (bes *Extensions) NotifyPipelineNotReady() error
  • func (bes *Extensions) NotifyPipelineReady() error
  • func (bes *Extensions) Shutdown(ctx context.Context) error
  • func (bes *Extensions) Start(ctx context.Context, host component.Host) error
• type Option
  • func WithReporter(reporter status.Reporter) Option
• type Settings

Types

type Config

type Config []component.ID

Config represents the ordered list of extensions configured for the service.

type Extensions

type Extensions struct {
	// contains filtered or unexported fields
}

Extensions is a map of extensions created from extension configs.

func New

func New(ctx context.Context, set Settings, cfg Config, options ...Option) (*Extensions, error)

New creates a new Extensions from Config.

func (*Extensions) GetExtensions

func (bes *Extensions) GetExtensions() map[component.ID]component.Component

func (*Extensions) HandleZPages

func (bes *Extensions) HandleZPages(w http.ResponseWriter, r *http.Request)

func (*Extensions) NotifyComponentStatusChange

func (bes *Extensions) NotifyComponentStatusChange(source *componentstatus.InstanceID, event *componentstatus.Event)

func (*Extensions) NotifyConfig

func (bes *Extensions) NotifyConfig(ctx context.Context, conf *confmap.Conf) error

func (*Extensions) NotifyPipelineNotReady

func (bes *Extensions) NotifyPipelineNotReady() error

func (*Extensions) NotifyPipelineReady

func (bes *Extensions) NotifyPipelineReady() error

func (*Extensions) Shutdown

func (bes *Extensions) Shutdown(ctx context.Context) error

Shutdown stops all extensions.

func (*Extensions) Start

func (bes *Extensions) Start(ctx context.Context, host component.Host) error

Start starts all extensions.

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithReporter

func WithReporter(reporter status.Reporter) Option

type Settings

type Settings struct {
	Telemetry  component.TelemetrySettings
	BuildInfo  component.BuildInfo
	ModuleInfo extension.ModuleInfo

	// Extensions builder for extensions.
	Extensions builders.Extension
}

Settings holds configuration for building Extensions.