Categorygithub.com/open-telemetry/opentelemetry-collector-contrib/cmd/configschema

# README

Deprecated: [v0.92.0] This tool is deprecated and will be removed in a future release. See https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/30187

ConfigSchema API

This package contains an API that can be used to introspect the configuration struct of a collector component. It can be used to generate documentation or tools to help users configure the collector.

# Packages

Deprecated: [v0.92.0] This package is deprecated and will be removed in a future release.
Deprecated: [v0.92.0] This package is deprecated and will be removed in a future release.

# Functions

GetAllCfgInfos accepts a Factories struct, then creates and returns a CfgInfo for each of its components.
GetCfgInfo accepts a Factories struct, then creates and returns the default config for the component specified by the passed-in componentType and componentName.
NewDefaultDirResolver creates a DirResolver with a default SrcRoot and ModuleName, suitable for using this package's API using otelcol with an executable running from the otelcol's source root (not tests).
NewDirResolver creates a DirResolver with a custom SrcRoot and ModuleName.
ReadFields accepts both a config struct's Value, as well as a DirResolver, and returns a Field pointer for the top level struct as well as all of its recursive subfields.

# Constants

DefaultModule is the module prefix of contrib.
DefaultSrcRoot is the default root of the collector repo, relative to the current working directory.

# Structs

CfgInfo contains a component config instance, as well as its group name and type.
DirResolver is used to resolve the base directory of a given reflect.Type.
Field holds attributes and subfields of a config struct.

# Interfaces

No description provided by the author