Skip to content

Commit

Permalink
Deprecate WithSettings functions
Browse files Browse the repository at this point in the history
  • Loading branch information
TylerHelmuth committed Jun 21, 2024
1 parent 27275c8 commit 950bcd5
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 13 deletions.
25 changes: 25 additions & 0 deletions .chloggen/move-otelcoltest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: deprecation

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: otelcoltest

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Deprecates `LoadConfigWithSettings` and `LoadConfigAndValidateWithSettings`. Use `LoadConfig` and `LoadConfigAndValidate` instead.

# One or more tracking issues or pull requests related to the change
issues: [10417]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: [api]
23 changes: 10 additions & 13 deletions otelcol/otelcoltest/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ import (
)

// LoadConfigWithSettings loads a config.Config from the provider settings, and does NOT validate the configuration.
//
// Deprecated: [v0.104.0] Use LoadConfig instead
func LoadConfigWithSettings(factories otelcol.Factories, set otelcol.ConfigProviderSettings) (*otelcol.Config, error) {
// Read yaml config from file
provider, err := otelcol.NewConfigProvider(set)
Expand All @@ -27,7 +29,7 @@ func LoadConfigWithSettings(factories otelcol.Factories, set otelcol.ConfigProvi

// LoadConfig loads a config.Config from file, and does NOT validate the configuration.
func LoadConfig(fileName string, factories otelcol.Factories) (*otelcol.Config, error) {
return LoadConfigWithSettings(factories, otelcol.ConfigProviderSettings{
provider, err := otelcol.NewConfigProvider(otelcol.ConfigProviderSettings{
ResolverSettings: confmap.ResolverSettings{
URIs: []string{fileName},
ProviderFactories: []confmap.ProviderFactory{
Expand All @@ -39,9 +41,15 @@ func LoadConfig(fileName string, factories otelcol.Factories) (*otelcol.Config,
ConverterFactories: []confmap.ConverterFactory{expandconverter.NewFactory()},
},
})
if err != nil {
return nil, err
}
return provider.Get(context.Background(), factories)
}

// LoadConfigAndValidateWithSettings loads a config from the provider settings, and validates the configuration.
//
// Deprecated: [v0.104.0] Use LoadConfigAndValidate instead
func LoadConfigAndValidateWithSettings(factories otelcol.Factories, set otelcol.ConfigProviderSettings) (*otelcol.Config, error) {
cfg, err := LoadConfigWithSettings(factories, set)
if err != nil {
Expand All @@ -52,18 +60,7 @@ func LoadConfigAndValidateWithSettings(factories otelcol.Factories, set otelcol.

// LoadConfigAndValidate loads a config from the file, and validates the configuration.
func LoadConfigAndValidate(fileName string, factories otelcol.Factories) (*otelcol.Config, error) {
cfg, err := LoadConfigWithSettings(factories, otelcol.ConfigProviderSettings{
ResolverSettings: confmap.ResolverSettings{
URIs: []string{fileName},
ProviderFactories: []confmap.ProviderFactory{
fileprovider.NewFactory(),
envprovider.NewFactory(),
yamlprovider.NewFactory(),
httpprovider.NewFactory(),
},
ConverterFactories: []confmap.ConverterFactory{expandconverter.NewFactory()},
},
})
cfg, err := LoadConfig(fileName, factories)
if err != nil {
return nil, err
}
Expand Down

0 comments on commit 950bcd5

Please sign in to comment.