gadgetcontext

Documentation

Overview

Package gadgetcontext handles initializing gadgets and installed operators before handing them over to a specified runtime.

Index

• func WaitForTimeoutOrDone(c gadgets.GadgetContext)
• func WithTimeoutOrCancel(ctx context.Context, timeout time.Duration) (context.Context, context.CancelFunc)
• type GadgetContext
  • func New(ctx context.Context, imageName string, options ...Option) *GadgetContext
  • func NewBuiltIn(ctx context.Context, id string, runtime runtime.Runtime, ...) *GadgetContext
  • func (c *GadgetContext) Args() []string
  • func (c *GadgetContext) Cancel()
  • func (c *GadgetContext) Context() context.Context
  • func (c *GadgetContext) DataOperators() []operators.DataOperator
  • func (c *GadgetContext) GadgetDesc() gadgets.GadgetDesc
  • func (c *GadgetContext) GadgetParams() *params.Params
  • func (c *GadgetContext) GetDataSources() map[string]datasource.DataSource
  • func (c *GadgetContext) GetVar(varName string) (any, bool)
  • func (c *GadgetContext) GetVars() map[string]any
  • func (c *GadgetContext) ID() string
  • func (c *GadgetContext) ImageName() string
  • func (c *GadgetContext) LoadGadgetInfo(info *api.GadgetInfo, paramValues api.ParamValues, run bool) error
  • func (c *GadgetContext) Logger() logger.Logger
  • func (c *GadgetContext) Operators() operators.Operators
  • func (c *GadgetContext) OperatorsParamCollection() params.Collection
  • func (c *GadgetContext) Params() []*api.Param
  • func (c *GadgetContext) Parser() parser.Parser
  • func (c *GadgetContext) PrepareGadgetInfo(paramValues api.ParamValues) error
  • func (c *GadgetContext) RegisterDataSource(t datasource.Type, name string) (datasource.DataSource, error)
  • func (c *GadgetContext) Run(paramValues api.ParamValues) error
  • func (c *GadgetContext) Runtime() runtime.Runtime
  • func (c *GadgetContext) RuntimeParams() *params.Params
  • func (c *GadgetContext) SerializeGadgetInfo() (*api.GadgetInfo, error)
  • func (c *GadgetContext) SetMetadata(m []byte)
  • func (c *GadgetContext) SetParams(params []*api.Param)
  • func (c *GadgetContext) SetVar(varName string, value any)
  • func (c *GadgetContext) Timeout() time.Duration
• type Option
  • func WithDataOperators(ops ...operators.DataOperator) Option
  • func WithLogger(logger logger.Logger) Option
  • func WithTimeout(timeout time.Duration) Option

Functions

func WaitForTimeoutOrDone

func WaitForTimeoutOrDone(c gadgets.GadgetContext)

func WithTimeoutOrCancel

func WithTimeoutOrCancel(ctx context.Context, timeout time.Duration) (context.Context, context.CancelFunc)

Types

type GadgetContext

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

GadgetContext handles running gadgets by the gadget interface; it orchestrates the whole lifecycle of the gadget instance and communicates with gadget and runtime.

func New

func New(
	ctx context.Context,
	imageName string,
	options ...Option,
) *GadgetContext

func NewBuiltIn

func NewBuiltIn(
	ctx context.Context,
	id string,
	runtime runtime.Runtime,
	runtimeParams *params.Params,
	gadget gadgets.GadgetDesc,
	gadgetParams *params.Params,
	args []string,
	operatorsParamCollection params.Collection,
	parser parser.Parser,
	logger logger.Logger,
	timeout time.Duration,
) *GadgetContext

func (*GadgetContext) Args

func (c *GadgetContext) Args() []string

func (*GadgetContext) Cancel

func (c *GadgetContext) Cancel()

func (*GadgetContext) Context

func (c *GadgetContext) Context() context.Context

func (*GadgetContext) DataOperators

func (c *GadgetContext) DataOperators() []operators.DataOperator

func (*GadgetContext) GadgetDesc

func (c *GadgetContext) GadgetDesc() gadgets.GadgetDesc

func (*GadgetContext) GadgetParams

func (c *GadgetContext) GadgetParams() *params.Params

func (*GadgetContext) GetDataSources

func (c *GadgetContext) GetDataSources() map[string]datasource.DataSource

func (*GadgetContext) GetVar

func (c *GadgetContext) GetVar(varName string) (any, bool)

func (*GadgetContext) GetVars

func (c *GadgetContext) GetVars() map[string]any

func (*GadgetContext) ID

func (c *GadgetContext) ID() string

func (*GadgetContext) ImageName

func (c *GadgetContext) ImageName() string

func (*GadgetContext) LoadGadgetInfo

func (c *GadgetContext) LoadGadgetInfo(info *api.GadgetInfo, paramValues api.ParamValues, run bool) error

func (*GadgetContext) Logger

func (c *GadgetContext) Logger() logger.Logger

func (*GadgetContext) Operators

func (c *GadgetContext) Operators() operators.Operators

func (*GadgetContext) OperatorsParamCollection

func (c *GadgetContext) OperatorsParamCollection() params.Collection

func (*GadgetContext) Params

func (c *GadgetContext) Params() []*api.Param

func (*GadgetContext) Parser

func (c *GadgetContext) Parser() parser.Parser

func (*GadgetContext) PrepareGadgetInfo

func (c *GadgetContext) PrepareGadgetInfo(paramValues api.ParamValues) error

func (*GadgetContext) RegisterDataSource

func (c *GadgetContext) RegisterDataSource(t datasource.Type, name string) (datasource.DataSource, error)

func (*GadgetContext) Run

func (c *GadgetContext) Run(paramValues api.ParamValues) error

func (*GadgetContext) Runtime

func (c *GadgetContext) Runtime() runtime.Runtime

func (*GadgetContext) RuntimeParams

func (c *GadgetContext) RuntimeParams() *params.Params

func (*GadgetContext) SerializeGadgetInfo

func (c *GadgetContext) SerializeGadgetInfo() (*api.GadgetInfo, error)

func (*GadgetContext) SetMetadata

func (c *GadgetContext) SetMetadata(m []byte)

func (*GadgetContext) SetParams

func (c *GadgetContext) SetParams(params []*api.Param)

func (*GadgetContext) SetVar

func (c *GadgetContext) SetVar(varName string, value any)

func (*GadgetContext) Timeout

func (c *GadgetContext) Timeout() time.Duration

type Option

type Option func(gadgetCtx *GadgetContext)

func WithDataOperators

func WithDataOperators(ops ...operators.DataOperator) Option

func WithLogger

func WithLogger(logger logger.Logger) Option

func WithTimeout

func WithTimeout(timeout time.Duration) Option