[service]: add new subcommand to examine the initial configuration

.chloggen/examine-subcommand.yaml

@@ -0,0 +1,28 @@
+# 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: service
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Create a new subcommand to dump the initial configuration after resolving/merging.
+
+# One or more tracking issues or pull requests related to the change
+issues: [11479]
+
+# (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: |
+  To use the `print-initial-config` subcommand, invoke the Collector with the subcommand and corresponding feature gate: `otelcol print-initial-config --feature-gates=otelcol.printInitialConfig --config=config.yaml`.
+  Note that the feature gate enabling this flag is currently in alpha stability, and the subcommand may
+  be changed in the future.
+
+# 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: []

internal/e2e/go.mod

@@ -249,3 +249,7 @@ replace go.opentelemetry.io/collector/extension/auth/authtest => ../../extension
 replace go.opentelemetry.io/collector/extension/xextension => ../../extension/xextension
 
 replace go.opentelemetry.io/collector/otelcol => ../../otelcol
+
+replace go.opentelemetry.io/collector/confmap/provider/yamlprovider => ../../confmap/provider/yamlprovider
+
+replace go.opentelemetry.io/collector/confmap/provider/fileprovider => ../../confmap/provider/fileprovider

otelcol/command.go

@@ -42,6 +42,7 @@ func NewCommand(set CollectorSettings) *cobra.Command {
 	rootCmd.AddCommand(newFeatureGateCommand())
 	rootCmd.AddCommand(newComponentsCommand(set))
 	rootCmd.AddCommand(newValidateSubCommand(set, flagSet))
+	rootCmd.AddCommand(newConfigPrintSubCommand(set, flagSet))
 	rootCmd.Flags().AddGoFlagSet(flagSet)
 	return rootCmd
 }

otelcol/command_print.go

@@ -0,0 +1,58 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package otelcol // import "go.opentelemetry.io/collector/otelcol"
+
+import (
+	"errors"
+	"flag"
+	"fmt"
+
+	"github.com/spf13/cobra"
+	"gopkg.in/yaml.v3"
+
+	"go.opentelemetry.io/collector/confmap"
+	"go.opentelemetry.io/collector/featuregate"
+)
+
+var printCommandFeatureFlag = featuregate.GlobalRegistry().MustRegister(
+	"otelcol.printInitialConfig",
+	featuregate.StageAlpha,
+	featuregate.WithRegisterFromVersion("v0.120.0"),
+	featuregate.WithRegisterDescription("if set to true, turns on the print-initial-config command"),
+)
+
+// newConfigPrintSubCommand constructs a new config print sub command using the given CollectorSettings.
+func newConfigPrintSubCommand(set CollectorSettings, flagSet *flag.FlagSet) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "print-initial-config",
+		Short: "Prints the Collector's configuration in YAML format after all config sources are resolved and merged",
+		Long:  `Note: This command prints the final yaml configuration before it is unmarshaled into config structs, which may contain sensitive values.`,
+		Args:  cobra.ExactArgs(0),
+		RunE: func(cmd *cobra.Command, _ []string) error {
+			if !printCommandFeatureFlag.IsEnabled() {
+				return errors.New("print-initial-config is currently experimental, use the otelcol.printInitialConfig feature gate to enable this command")
+			}
+			err := updateSettingsUsingFlags(&set, flagSet)
+			if err != nil {
+				return err
+			}
+			resolver, err := confmap.NewResolver(set.ConfigProviderSettings.ResolverSettings)
+			if err != nil {
+				return fmt.Errorf("failed to create new resolver: %w", err)
+			}
+			conf, err := resolver.Resolve(cmd.Context())
+			if err != nil {
+				return fmt.Errorf("error while resolving config: %w", err)
+			}
+			b, err := yaml.Marshal(conf.ToStringMap())
+			if err != nil {
+				return fmt.Errorf("error while marshaling to YAML: %w", err)
+			}
+			fmt.Printf("%s\n", b)
+			return nil
+		},
+	}
+	cmd.Flags().AddGoFlagSet(flagSet)
+	return cmd
+}

otelcol/command_print_test.go

@@ -0,0 +1,179 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package otelcol // import "go.opentelemetry.io/collector/otelcol"
+
+import (
+	"bytes"
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"gopkg.in/yaml.v3"
+
+	"go.opentelemetry.io/collector/confmap"
+	"go.opentelemetry.io/collector/confmap/provider/fileprovider"
+	"go.opentelemetry.io/collector/confmap/provider/yamlprovider"
+	"go.opentelemetry.io/collector/featuregate"
+)
+
+func TestPrintCommand(t *testing.T) {
+	tests := []struct {
+		name      string
+		set       confmap.ResolverSettings
+		errString string
+	}{
+		{
+			name:      "no URIs",
+			set:       confmap.ResolverSettings{},
+			errString: "at least one config flag must be provided",
+		},
+		{
+			name: "valid URI - file not found",
+			set: confmap.ResolverSettings{
+				URIs: []string{"file:blabla.yaml"},
+				ProviderFactories: []confmap.ProviderFactory{
+					fileprovider.NewFactory(),
+				},
+				DefaultScheme: "file",
+			},
+			errString: "cannot retrieve the configuration: unable to read the file",
+		},
+		{
+			name: "valid URI",
+			set: confmap.ResolverSettings{
+				URIs: []string{"yaml:processors::batch/foo::timeout: 3s"},
+				ProviderFactories: []confmap.ProviderFactory{
+					yamlprovider.NewFactory(),
+				},
+				DefaultScheme: "yaml",
+			},
+		},
+		{
+			name: "valid URI - no provider set",
+			set: confmap.ResolverSettings{
+				URIs:          []string{"yaml:processors::batch/foo::timeout: 3s"},
+				DefaultScheme: "yaml",
+			},
+			errString: "at least one Provider must be supplied",
+		},
+		{
+			name: "valid URI - invalid scheme name",
+			set: confmap.ResolverSettings{
+				URIs:          []string{"yaml:processors::batch/foo::timeout: 3s"},
+				DefaultScheme: "foo",
+				ProviderFactories: []confmap.ProviderFactory{
+					yamlprovider.NewFactory(),
+				},
+			},
+			errString: "configuration: DefaultScheme not found in providers list",
+		},
+	}
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			err := featuregate.GlobalRegistry().Set(printCommandFeatureFlag.ID(), true)
+			require.NoError(t, err)
+			defer func() {
+				_ = featuregate.GlobalRegistry().Set(printCommandFeatureFlag.ID(), false)
+			}()
+
+			set := ConfigProviderSettings{
+				ResolverSettings: test.set,
+			}
+			cmd := newConfigPrintSubCommand(CollectorSettings{ConfigProviderSettings: set}, flags(featuregate.GlobalRegistry()))
+			err = cmd.Execute()
+			if test.errString != "" {
+				require.ErrorContains(t, err, test.errString)
+			} else {
+				require.NoError(t, err)
+			}
+		})
+	}
+}
+
+func TestPrintCommandFeaturegateDisabled(t *testing.T) {
+	cmd := newConfigPrintSubCommand(CollectorSettings{ConfigProviderSettings: ConfigProviderSettings{
+		ResolverSettings: confmap.ResolverSettings{
+			URIs:          []string{"yaml:processors::batch/foo::timeout: 3s"},
+			DefaultScheme: "foo",
+			ProviderFactories: []confmap.ProviderFactory{
+				yamlprovider.NewFactory(),
+			},
+		},
+	}}, flags(featuregate.GlobalRegistry()))
+	err := cmd.Execute()
+	require.ErrorContains(t, err, "print-initial-config is currently experimental, use the otelcol.printInitialConfig feature gate to enable this command")
+}
+
+func TestConfig(t *testing.T) {
+	tests := []struct {
+		name        string
+		configs     []string
+		finalConfig string
+	}{
+		{
+			name: "two-configs",
+			configs: []string{
+				"file:testdata/configs/1-config-first.yaml",
+				"file:testdata/configs/1-config-second.yaml",
+			},
+			finalConfig: "testdata/configs/1-config-output.yaml",
+		},
+		{
+			name: "two-configs-yaml",
+			configs: []string{
+				"file:testdata/configs/1-config-first.yaml",
+				"file:testdata/configs/1-config-second.yaml",
+				"yaml:service::pipelines::logs::receivers: [foo,bar]",
+				"yaml:service::pipelines::logs::exporters: [foo,bar]",
+			},
+			finalConfig: "testdata/configs/2-config-output.yaml",
+		},
+	}
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			err := featuregate.GlobalRegistry().Set(printCommandFeatureFlag.ID(), true)
+			require.NoError(t, err)
+			defer func() {
+				_ = featuregate.GlobalRegistry().Set(printCommandFeatureFlag.ID(), false)
+			}()
+			set := ConfigProviderSettings{
+				ResolverSettings: confmap.ResolverSettings{
+					URIs: test.configs,
+					ProviderFactories: []confmap.ProviderFactory{
+						fileprovider.NewFactory(),
+						yamlprovider.NewFactory(),
+					},
+					DefaultScheme: "file",
+				},
+			}
+			tmpFile, err := os.CreateTemp(t.TempDir(), "*")
+			require.NoError(t, err)
+			t.Cleanup(func() { _ = tmpFile.Close() })
+
+			// save the os.Stdout and temporarily set it to temp file
+			oldStdout := os.Stdout
+			os.Stdout = tmpFile
+
+			cmd := newConfigPrintSubCommand(CollectorSettings{ConfigProviderSettings: set}, flags(featuregate.GlobalRegistry()))
+			require.NoError(t, cmd.Execute())
+
+			// restore os.Stdout
+			os.Stdout = oldStdout
+
+			expectedOutput, err := os.ReadFile(test.finalConfig)
+			require.NoError(t, err)
+
+			actualOutput, err := os.ReadFile(tmpFile.Name())
+			require.NoError(t, err)
+
+			actualConfig := make(map[string]any, 0)
+			expectedConfig := make(map[string]any, 0)
+
+			require.NoError(t, yaml.Unmarshal(bytes.TrimSpace(actualOutput), actualConfig))
+			require.NoError(t, yaml.Unmarshal(bytes.TrimSpace(expectedOutput), expectedConfig))
+
+			require.Equal(t, expectedConfig, actualConfig)
+		})
+	}
+}

otelcol/go.mod

@@ -9,6 +9,8 @@ require (
 	go.opentelemetry.io/collector/component/componentstatus v0.120.0
 	go.opentelemetry.io/collector/config/configtelemetry v0.120.0
 	go.opentelemetry.io/collector/confmap v1.26.0
+	go.opentelemetry.io/collector/confmap/provider/fileprovider v1.25.0
+	go.opentelemetry.io/collector/confmap/provider/yamlprovider v1.25.0
 	go.opentelemetry.io/collector/confmap/xconfmap v0.120.0
 	go.opentelemetry.io/collector/connector v0.120.0
 	go.opentelemetry.io/collector/connector/connectortest v0.120.0
@@ -209,4 +211,8 @@ replace go.opentelemetry.io/collector/extension/auth/authtest => ../extension/au
 
 replace go.opentelemetry.io/collector/extension/xextension => ../extension/xextension
 
+replace go.opentelemetry.io/collector/confmap/provider/fileprovider => ../confmap/provider/fileprovider
+
+replace go.opentelemetry.io/collector/confmap/provider/yamlprovider => ../confmap/provider/yamlprovider
+
 replace go.opentelemetry.io/collector/internal/telemetry => ../internal/telemetry

otelcol/testdata/configs/1-config-first.yaml

@@ -0,0 +1,6 @@
+receivers:
+    bar:
+        key: val
+exporters:
+    bar:
+        key: val

otelcol/testdata/configs/1-config-output.yaml

@@ -0,0 +1,10 @@
+exporters:
+    bar:
+        key: val
+    foo:
+        key: val
+receivers:
+    bar:
+        key: val
+    foo:
+        key: val

otelcol/testdata/configs/1-config-second.yaml

@@ -0,0 +1,6 @@
+receivers:
+    foo:
+        key: val
+exporters:
+    foo:
+        key: val

otelcol/testdata/configs/2-config-output.yaml

@@ -0,0 +1,19 @@
+exporters:
+    bar:
+        key: val
+    foo:
+        key: val
+receivers:
+    bar:
+        key: val
+    foo:
+        key: val
+service:
+    pipelines:
+        logs:
+            exporters:
+                - foo
+                - bar
+            receivers:
+                - foo
+                - bar

service/README.md

@@ -149,3 +149,9 @@ extensions:
 ```bash
    ./otelcorecol validate --config=file:examples/local/otel-config.yaml
 ```
+
+## How to examine the final configuration after merging and resolving from various sources?
+
+```bash
+   ./otelcorecol print-initial-config --config=file:file.yaml --config=http:http://remote:8080/config --config=file:file2.yaml
+```

service/go.mod

@@ -226,3 +226,7 @@ replace go.opentelemetry.io/collector/extension/auth/authtest => ../extension/au
 replace go.opentelemetry.io/collector/extension/xextension => ../extension/xextension
 
 replace go.opentelemetry.io/collector/otelcol => ../otelcol
+
+replace go.opentelemetry.io/collector/confmap/provider/yamlprovider => ../confmap/provider/yamlprovider
+
+replace go.opentelemetry.io/collector/confmap/provider/fileprovider => ../confmap/provider/fileprovider