[otelcol] add converters to components command

.chloggen/jackgopack4-add-converters-component-command.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: otelcol
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Converters are now available in the `components` command. 
+
+# One or more tracking issues or pull requests related to the change
+issues: [11900, 12385]
+
+# (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: buildinfo in components command is now reported as "build_info" for legibility.
+
+# 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: [user, api]

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

@@ -49,7 +49,12 @@ func main() {
 			{{- range .ConfmapProviders}}
 			{{.Name}}.NewFactory().Create(confmap.ProviderSettings{}).Scheme(): "{{.GoMod}}",
 			{{- end}}
-           },
+    }, ConverterModules: map[string]string{
+		  {{- range .ConfmapConverters}}
+			{{.Name}}: "{{.GoMod}}",
+			{{- end}}
+		},
+
 	}
 
 	if err := run(set); err != nil {

otelcol/collector.go

@@ -72,6 +72,9 @@ type CollectorSettings struct {
 	// ProviderModules maps provider schemes to their respective go modules.
 	ProviderModules map[string]string
 
+	// ConverterModules maps converter names to their respective go modules.
+	ConverterModules map[string]string
+
 	// LoggingOptions provides a way to change behavior of zap logging.
 	LoggingOptions []zap.Option
 

otelcol/collector_test.go

@@ -594,3 +594,31 @@ func newConfFromFile(tb testing.TB, fileName string) map[string]any {
 
 	return confmap.NewFromStringMap(data).ToStringMap()
 }
+
+func TestProviderAndConverterModules(t *testing.T) {
+	set := CollectorSettings{
+		BuildInfo:              component.NewDefaultBuildInfo(),
+		Factories:              nopFactories,
+		ConfigProviderSettings: newDefaultConfigProviderSettings(t, []string{filepath.Join("testdata", "otelcol-nop.yaml")}),
+		ProviderModules: map[string]string{
+			"nop": "go.opentelemetry.io/collector/confmap/provider/testprovider v1.2.3",
+		},
+		ConverterModules: map[string]string{
+			"nopconverter": "go.opentelemetry.io/collector/converter/testconverter v1.2.3",
+		},
+	}
+	col, err := NewCollector(set)
+	require.NoError(t, err)
+	wg := startCollector(context.Background(), t, col)
+	require.NoError(t, err)
+	providerModules := map[string]string{
+		"nop": "go.opentelemetry.io/collector/confmap/provider/testprovider v1.2.3",
+	}
+	converterModules := map[string]string{
+		"nopconverter": "go.opentelemetry.io/collector/converter/testconverter v1.2.3",
+	}
+	assert.Equal(t, providerModules, col.set.ProviderModules)
+	assert.Equal(t, converterModules, col.set.ConverterModules)
+	col.Shutdown()
+	wg.Wait()
+}

otelcol/command_components.go

@@ -19,24 +19,26 @@ import (
 )
 
 type componentWithStability struct {
-	Name      component.Type
-	Module    string
-	Stability map[string]string
+	Name      component.Type    `yaml:"name"`
+	Module    string            `yaml:"module"`
+	Stability map[string]string `yaml:"stability"`
 }
 
 type componentWithoutStability struct {
-	Scheme string
-	Module string
+	Name   string `yaml:"name,omitempty"`
+	Scheme string `yaml:"scheme,omitempty"`
+	Module string `yaml:"module"`
 }
 
 type componentsOutput struct {
-	BuildInfo  component.BuildInfo
-	Receivers  []componentWithStability
-	Processors []componentWithStability
-	Exporters  []componentWithStability
-	Connectors []componentWithStability
-	Extensions []componentWithStability
-	Providers  []componentWithoutStability
+	BuildInfo  component.BuildInfo         `yaml:"build_info"`
+	Receivers  []componentWithStability    `yaml:"receivers"`
+	Processors []componentWithStability    `yaml:"processors"`
+	Exporters  []componentWithStability    `yaml:"exporters"`
+	Connectors []componentWithStability    `yaml:"connectors"`
+	Extensions []componentWithStability    `yaml:"extensions"`
+	Providers  []componentWithoutStability `yaml:"providers"`
+	Converters []componentWithoutStability `yaml:"converters,omitempty"`
 }
 
 // newComponentsCommand constructs a new components command using the given CollectorSettings.
@@ -123,6 +125,13 @@ func newComponentsCommand(set CollectorSettings) *cobra.Command {
 				})
 			}
 
+			for converterName, converterModule := range set.ConverterModules {
+				components.Converters = append(components.Converters, componentWithoutStability{
+					Name:   converterName,
+					Module: converterModule,
+				})
+			}
+
 			yamlData, err := yaml.Marshal(components)
 			if err != nil {
 				return err

otelcol/command_components_test.go

@@ -24,6 +24,9 @@ func TestNewBuildSubCommand(t *testing.T) {
 		ProviderModules: map[string]string{
 			"nop": "go.opentelemetry.io/collector/confmap/provider/testprovider v1.2.3",
 		},
+		ConverterModules: map[string]string{
+			"nopconverter": "go.opentelemetry.io/collector/converter/testconverter v1.2.3",
+		},
 	}
 	cmd := NewCommand(set)
 	cmd.SetArgs([]string{"components"})

otelcol/testdata/components-output.yaml

@@ -1,4 +1,4 @@
-buildinfo:
+build_info:
     command: otelcol
     description: OpenTelemetry Collector
     version: latest
@@ -44,3 +44,6 @@ extensions:
 providers:
     - scheme: nop
       module: go.opentelemetry.io/collector/confmap/provider/testprovider v1.2.3
+converters:
+    - name: nopconverter
+      module: go.opentelemetry.io/collector/converter/testconverter v1.2.3