[cmd/builder] Allow setting DefaultScheme in builder config

.chloggen/builder-configure-default-scheme.yaml

@@ -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: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: cmd/builder
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Allow setting `CollectorSettings.ResolverSettings.DefaultScheme` via the builder's `conf_resolver_settings.default_uri_scheme` configuration option
+
+# One or more tracking issues or pull requests related to the change
+issues: [10296]
+
+# (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: []

cmd/builder/README.md

@@ -131,6 +131,16 @@ replaces:
   - github.com/open-telemetry/opentelemetry-collector-contrib/internal/common => github.com/open-telemetry/opentelemetry-collector-contrib/internal/common v0.40.0
 ```
 
+The builder also allows setting the scheme to use as the default URI scheme via `resolver_settings.default_uri_scheme`:
+
+```yaml
+conf_resolver_settings:
+   default_uri_scheme: "env"
+```
+
+This tells the builder to produce a Collector that uses the `env` scheme when expanding configuration that does not
+provide a scheme, such as `${HOST}` (instead of doing `${env:HOST}`).
+
 ## Steps
 
 The builder has 3 steps:

cmd/builder/internal/builder/config.go

@@ -43,9 +43,18 @@ type Config struct {
 	Replaces     []string     `mapstructure:"replaces"`
 	Excludes     []string     `mapstructure:"excludes"`
 
+	ConfResolverSettings ConfResolverSettings `mapstructure:"conf_resolver_settings"`
+
 	downloadModules retry `mapstructure:"-"`
 }
 
+type ConfResolverSettings struct {
+	// When set, will be used to set the CollectorSettings.ConfResolverSettings.DefaultScheme value,
+	// which determines how the Collector interprets URIs that have no scheme, such as ${ENV}.
+	// See https://pkg.go.dev/go.opentelemetry.io/collector/confmap#ResolverSettings for more details.
+	DefaultURIScheme string `mapstructure:"default_uri_scheme"`
+}
+
 // Distribution holds the parameters for the final binary
 type Distribution struct {
 	Module                   string `mapstructure:"module"`

cmd/builder/internal/builder/main_test.go

@@ -316,6 +316,18 @@ func TestGenerateAndCompile(t *testing.T) {
 				return cfg
 			},
 		},
+		{
+			testCase: "ResolverSettingsDefaultURIScheme set",
+			cfgBuilder: func(t *testing.T) Config {
+				cfg := newTestConfig()
+				cfg.ConfResolverSettings = ConfResolverSettings{
+					DefaultURIScheme: "env",
+				}
+				cfg.Distribution.OutputPath = t.TempDir()
+				cfg.Replaces = append(cfg.Replaces, replaces...)
+				return cfg
+			},
+		},
 	}
 
 	for _, tt := range testCases {

cmd/builder/internal/builder/templates/main.go.tmpl

@@ -35,6 +35,9 @@ func main() {
 					{{.Name}}.NewFactory(),
 					{{- end}}
 				},
+				{{- if .ConfResolverSettings.DefaultURIScheme }}
+				DefaultScheme: "{{ .ConfResolverSettings.DefaultURIScheme }}",
+				{{- end }}
 				ConverterFactories: []confmap.ConverterFactory{
 					expandconverter.NewFactory(),
 				},

cmd/builder/internal/command.go

@@ -174,6 +174,8 @@ func applyCfgFromFile(flags *flag.FlagSet, cfgFromFile builder.Config) {
 	cfg.Replaces = cfgFromFile.Replaces
 	cfg.Excludes = cfgFromFile.Excludes
 
+	cfg.ConfResolverSettings.DefaultURIScheme = cfgFromFile.ConfResolverSettings.DefaultURIScheme
+
 	if !flags.Changed(skipGenerateFlag) && cfgFromFile.SkipGenerate {
 		cfg.SkipGenerate = cfgFromFile.SkipGenerate
 	}

cmd/builder/internal/command_test.go

@@ -84,7 +84,7 @@ func Test_applyCfgFromFile(t *testing.T) {
 		wantErr bool
 	}{
 		{
-			name: "distribution, excludes, exporters, receivers, processors, replaces are applied correctly",
+			name: "distribution, scheme, excludes, exporters, receivers, processors, replaces are applied correctly",
 			args: args{
 				flags: flag.NewFlagSet("version=1.0.0", 1),
 				cfgFromFile: builder.Config{
@@ -95,16 +95,22 @@ func Test_applyCfgFromFile(t *testing.T) {
 					Receivers:    []builder.Module{testModule},
 					Exporters:    []builder.Module{testModule},
 					Replaces:     testStringTable,
+					ConfResolverSettings: builder.ConfResolverSettings{
+						DefaultURIScheme: "env",
+					},
 				},
 			},
 			want: builder.Config{
 				Logger:       zap.NewNop(),
 				Distribution: testDistribution,
-				Excludes:     testStringTable,
-				Processors:   []builder.Module{testModule},
-				Receivers:    []builder.Module{testModule},
-				Exporters:    []builder.Module{testModule},
-				Replaces:     testStringTable,
+				ConfResolverSettings: builder.ConfResolverSettings{
+					DefaultURIScheme: "env",
+				},
+				Excludes:   testStringTable,
+				Processors: []builder.Module{testModule},
+				Receivers:  []builder.Module{testModule},
+				Exporters:  []builder.Module{testModule},
+				Replaces:   testStringTable,
 			},
 			wantErr: false,
 		},
@@ -246,6 +252,7 @@ func Test_applyCfgFromFile(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			applyCfgFromFile(tt.args.flags, tt.args.cfgFromFile)
+			assert.Equal(t, tt.want.ConfResolverSettings.DefaultURIScheme, cfg.ConfResolverSettings.DefaultURIScheme)
 			assert.Equal(t, tt.want.Distribution, cfg.Distribution)
 			assert.Equal(t, tt.want.SkipGenerate, cfg.SkipGenerate)
 			assert.Equal(t, tt.want.SkipCompilation, cfg.SkipCompilation)

cmd/builder/internal/config/default.yaml

@@ -5,6 +5,9 @@ dist:
   version: 0.101.0-dev
   otelcol_version: 0.101.0
 
+conf_resolver_settings:
+  default_uri_scheme: "env"
+
 receivers:
   - gomod: go.opentelemetry.io/collector/receiver/nopreceiver v0.101.0
   - gomod: go.opentelemetry.io/collector/receiver/otlpreceiver v0.101.0