sysprobeconfig

Documentation

Overview

Package sysprobeconfig implements a component to handle system-probe configuration. This component temporarily wraps pkg/config.

This component initializes pkg/config based on the bundle params, and will return the same results as that package. This is to support migration to a component architecture. When no code still uses pkg/config, that package will be removed.

The mock component does nothing at startup, beginning with an empty config. It also overwrites the pkg/config.SystemProbe for the duration of the test.

Package sysprobeconfig implements a component to handle system-probe configuration. This component temporarily wraps pkg/config.

This component initializes pkg/config based on the bundle params, and will return the same results as that package. This is to support migration to a component architecture. When no code still uses pkg/config, that package will be removed.

The mock component does nothing at startup, beginning with an empty config. It also overwrites the pkg/config.SystemProbe for the duration of the test.

Index

• func NoneModule() fxutil.Module
• type Component
• type Mock

Functions

func NoneModule

func NoneModule() fxutil.Module

NoneModule return a None optional type for sysprobeconfig.Component.

This helper allows code that needs a disabled Optional type for sysprobeconfig to get it. The helper is split from the implementation to avoid linking with the dependencies from sysprobeconfig.

Types

type Component

type Component interface {
	config.ReaderWriter

	// Warnings returns config warnings collected during setup.
	Warnings() *config.Warnings

	// SysProbeObject returns the wrapper sysconfig
	SysProbeObject() *sysconfigtypes.Config
}

Component is the component type.

type Mock

type Mock interface {
	Component
}

Mock implements mock-specific methods.