extensions

Documentation

Index

• type Config
• type Extensions
  • func New(ctx context.Context, set Settings, cfg Config) (*Extensions, error)
  • func (bes *Extensions) GetExtensions() map[config.ComponentID]component.Extension
  • func (bes *Extensions) HandleZPages(w http.ResponseWriter, r *http.Request)
  • 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 Settings

Types

type Config

type Config []config.ComponentID

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) (*Extensions, error)

New creates a new Extensions from Config.

func (*Extensions) GetExtensions

func (bes *Extensions) GetExtensions() map[config.ComponentID]component.Extension

func (*Extensions) HandleZPages

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

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 Settings

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

	// Configs is a map of config.ComponentID to config.Extension.
	Configs map[config.ComponentID]config.Extension

	// Factories maps extension type names in the config to the respective component.ExtensionFactory.
	Factories map[config.Type]component.ExtensionFactory
}

Settings holds configuration for building Extensions.