Add "components" Command

.chloggen/build-info-flag.yaml

@@ -0,0 +1,16 @@
+# 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: build-info command
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note:  Added build-info sub command which outputs components in collector distribution.
+
+# One or more tracking issues or pull requests related to the change
+issues: [#4671]
+
+# (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:

CHANGELOG.md

@@ -64,7 +64,6 @@
 - Add prometheus metric prefix to Collector's own telemetry when using OpenTelemetry for internal telemetry (#6223)
 - `exporter/logging`: Apply consistent rendering of map values (#6244)
 - Add support in the confmap.Resolver to expand embedded config URIs inside configuration. (#6276)
-
 ### 🧰 Bug fixes 🧰
 
 - Fixed bug where `telemetryInitializer` is not cleaned up when `newService` errors (#6239)

service/README.md

@@ -36,6 +36,33 @@ For more technical details about how configuration is resolved you can read the
 
     `./otelcorecol --config=file:examples/local/otel-config.yaml --config="yaml:exporters::logging::loglevel: info"`
 
+
+# How to check components available in a distribution
+
+Use the sub command build-info. Below is an example:
+
+```bash
+   .\otelcol build-info
+```
+Sample output:
+
+```yaml
+
+version: 0.62.1-dev
+receivers:
+   - otlp
+processors:
+   - memory_limiter
+   - batch
+exporters:
+   - logging
+   - otlp
+   - otlphttp
+extensions:
+   - memory_ballast
+   - zpages
+
+```
 ## How to override config properties?
 
 The `--set` flag allows to set arbitrary config property. The `--set` values are merged into the final configuration
@@ -94,4 +121,5 @@ key:
 
 1. Does not support setting a key that contains a dot `.`.
 2. Does not support setting a key that contains a equal sign `=`.
-3. The configuration key separator inside the value part of the property is "::". For example `--set "name={a::b: c}"` is equivalent with `--set name.a.b=c`.
+3. The configuration key separator inside the value part of the property is "::". For example `--set "name={a::b: c}"` is equivalent with `--set name.a.b=c`.
+

service/command.go

@@ -16,12 +16,58 @@ package service // import "go.opentelemetry.io/collector/service"
 
 import (
 	"errors"
+	"fmt"
 
 	"github.com/spf13/cobra"
+	"gopkg.in/yaml.v3"
+
+	"go.opentelemetry.io/collector/config"
 
 	"go.opentelemetry.io/collector/featuregate"
 )
 
+type componentsOutput struct {
+	Version    string
+	Receivers  []config.Type
+	Processors []config.Type
+	Exporters  []config.Type
+	Extensions []config.Type
+}
+
+// newBuildCommand constructs a new cobra.Command sub command using the given CollectorSettings.
+func newBuildSubCommand(set CollectorSettings) *cobra.Command {
+	buildCmd := &cobra.Command{
+		Use:   "build-info",
+		Short: "Outputs available components in a given collector distribution",
+		Args:  cobra.ExactArgs(0),
+		RunE: func(cmd *cobra.Command, args []string) error {
+
+			components := componentsOutput{}
+			for ext := range set.Factories.Extensions {
+				components.Extensions = append(components.Extensions, ext)
+			}
+			for prs := range set.Factories.Processors {
+				components.Processors = append(components.Processors, prs)
+			}
+			for rcv := range set.Factories.Receivers {
+				components.Receivers = append(components.Receivers, rcv)
+			}
+			for exp := range set.Factories.Exporters {
+				components.Exporters = append(components.Exporters, exp)
+			}
+			components.Version = set.BuildInfo.Version
+			yamlData, err := yaml.Marshal(components)
+			if err != nil {
+				return err
+			}
+			fmt.Println(string(yamlData))
+			return nil
+
+		},
+	}
+	return buildCmd
+}
+
 // NewCommand constructs a new cobra.Command using the given CollectorSettings.
 func NewCommand(set CollectorSettings) *cobra.Command {
 	flagSet := flags()
@@ -53,7 +99,7 @@ func NewCommand(set CollectorSettings) *cobra.Command {
 			return col.Run(cmd.Context())
 		},
 	}
-
+	rootCmd.AddCommand(newBuildSubCommand(set))
 	rootCmd.Flags().AddGoFlagSet(flagSet)
 	return rootCmd
 }

service/command_test.go

@@ -15,9 +15,18 @@
 package service
 
 import (
+	"bytes"
+	"io"
+	"os"
 	"path/filepath"
+	"strings"
 	"testing"
 
+	"gopkg.in/yaml.v3"
+
+	"go.opentelemetry.io/collector/config"
+	"go.opentelemetry.io/collector/featuregate"
+
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
@@ -48,3 +57,56 @@ func TestNewCommandInvalidComponent(t *testing.T) {
 	cmd := NewCommand(CollectorSettings{Factories: factories, ConfigProvider: cfgProvider})
 	require.Error(t, cmd.Execute())
 }
+
+func TestBuildSubCommand(t *testing.T) {
+	factories, err := componenttest.NopFactories()
+	require.NoError(t, err)
+
+	cfgProvider, err := NewConfigProvider(newDefaultConfigProviderSettings([]string{filepath.Join("testdata", "otelcol-nop.yaml")}))
+	require.NoError(t, err)
+
+	set := CollectorSettings{
+		BuildInfo:      component.NewDefaultBuildInfo(),
+		Factories:      factories,
+		ConfigProvider: cfgProvider,
+		telemetry:      newColTelemetry(featuregate.NewRegistry()),
+	}
+	cmd := NewCommand(set)
+	cmd.SetArgs([]string{"build-info"})
+
+	ExpectedYamlStruct := componentsOutput{
+		Version:    "latest",
+		Receivers:  []config.Type{"nop"},
+		Processors: []config.Type{"nop"},
+		Exporters:  []config.Type{"nop"},
+		Extensions: []config.Type{"nop"},
+	}
+	ExpectedOutput, err := yaml.Marshal(ExpectedYamlStruct)
+	require.NoError(t, err)
+
+	// Obtaining StdOutput of cmd.Execute()
+	oldStdOut := os.Stdout
+	r, w, _ := os.Pipe()
+	os.Stdout = w //Write to os.StdOut
+
+	err = cmd.Execute()
+	require.NoError(t, err)
+
+	bufChan := make(chan string)
+
+	go func() {
+		var buf bytes.Buffer
+		_, err = io.Copy(&buf, r)
+		require.NoError(t, err)
+		bufChan <- buf.String()
+	}()
+
+	err = w.Close()
+	require.NoError(t, err)
+	defer func() { os.Stdout = oldStdOut }() //Restore os.Stdout to old value after test
+	output := <-bufChan
+	//Trim new line at the end of the two strings to make a better comparison as string() adds an extra new
+	//line that makes the test fail.
+	assert.Equal(t, strings.Trim(output, "\n"), strings.Trim(string(ExpectedOutput), "\n"))
+
+}