Back to godoc.org
go.opentelemetry.io/collector/config/configcheck

package configcheck

v0.4.0
Latest Go to latest
Published: Jun 16, 2020 | License: Apache-2.0 | Module: go.opentelemetry.io/collector

Overview

Package configcheck has checks to be applied to configuration objects implemented by factories of components used in the OpenTelemetry collector. It is recommended for implementers of components to run the validations available on this package.

Index

func ValidateConfig

func ValidateConfig(config interface{}) error

ValidateConfig 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 ValidateConfigFromFactories

func ValidateConfigFromFactories(factories config.Factories) error

ValidateConfigFromFactories checks if all configurations for the given factories are satisfying the patterns used by the collector.

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
f or F : Jump to identifier