extensions

Documentation

Index

• type Extensions
  • func Build(ctx context.Context, set Settings) (*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) ShutdownAll(ctx context.Context) error
  • func (bes *Extensions) StartAll(ctx context.Context, host component.Host) error
• type Settings

Types

type Extensions

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

Extensions is a map of extensions created from extension configs.

func Build

func Build(ctx context.Context, set Settings) (*Extensions, error)

Build builds 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) ShutdownAll

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

ShutdownAll stops all extensions.

func (*Extensions) StartAll

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

StartAll 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

	// ServiceExtensions are the ordered list of extensions configured for the service.
	ServiceExtensions []config.ComponentID
}

Settings holds configuration for building Extensions.