componenttest

Documentation

Overview

Package componenttest define types and functions used to help test packages implementing the component package interfaces.

Index

• func CheckConfigStruct(config any) error
• func NewNopHost() component.Host
• func NewNopTelemetrySettings() component.TelemetrySettings

Functions

func CheckConfigStruct

func CheckConfigStruct(config any) error

CheckConfigStruct enforces that given configuration object is following the patterns used by the collector. This ensures consistency between different implementations of components and extensions. It is recommended for implementers of components to call this function on their tests passing the default configuration of the component factory.

func NewNopHost

func NewNopHost() component.Host

NewNopHost returns a new instance of nopHost with proper defaults for most tests.

func NewNopTelemetrySettings

func NewNopTelemetrySettings() component.TelemetrySettings

NewNopTelemetrySettings returns a new nop telemetry settings for Create* functions.