telemetry/otelcol/command_components.go

// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

package otelcol // import "go.opentelemetry.io/collector/otelcol"

import (
	"fmt"
	"sort"

	"github.com/spf13/cobra"
	"go.yaml.in/yaml/v3"

	"go.opentelemetry.io/collector/component"
	"go.opentelemetry.io/collector/confmap"
	"go.opentelemetry.io/collector/connector"
	"go.opentelemetry.io/collector/exporter"
	"go.opentelemetry.io/collector/extension"
	"go.opentelemetry.io/collector/internal/componentalias"
	"go.opentelemetry.io/collector/processor"
	"go.opentelemetry.io/collector/receiver"
)

type componentWithStability struct {
	Name      component.Type
	Module    string
	Stability map[string]string
}

type componentWithoutStability struct {
	Scheme string `yaml:",omitempty"`
	Module string
}

type componentsOutput struct {
	BuildInfo  component.BuildInfo
	Receivers  []componentWithStability
	Processors []componentWithStability
	Exporters  []componentWithStability
	Connectors []componentWithStability
	Extensions []componentWithStability
	Providers  []componentWithoutStability
	Converters []componentWithoutStability `yaml:",omitempty"`
}

// newComponentsCommand constructs a new components command using the given CollectorSettings.
func newComponentsCommand(set CollectorSettings) *cobra.Command {
	return &cobra.Command{
		Use:   "components",
		Short: "Outputs available components in this collector distribution",
		Long:  "Outputs available components in this collector distribution including their stability levels. The output format is not stable and can change between releases.",
		Args:  cobra.ExactArgs(0),
		RunE: func(cmd *cobra.Command, _ []string) error {
			factories, err := set.Factories()
			if err != nil {
				return fmt.Errorf("failed to initialize factories: %w", err)
			}

			components := componentsOutput{}
			for _, con := range sortFactoriesByType[connector.Factory](factories.Connectors) {
				components.Connectors = append(components.Connectors, componentWithStability{
					Name:   con.Type(),
					Module: factories.ConnectorModules[con.Type()],
					Stability: map[string]string{
						"logs-to-logs":    con.LogsToLogsStability().String(),
						"logs-to-metrics": con.LogsToMetricsStability().String(),
						"logs-to-traces":  con.LogsToTracesStability().String(),

						"metrics-to-logs":    con.MetricsToLogsStability().String(),
						"metrics-to-metrics": con.MetricsToMetricsStability().String(),
						"metrics-to-traces":  con.MetricsToTracesStability().String(),

						"traces-to-logs":    con.TracesToLogsStability().String(),
						"traces-to-metrics": con.TracesToMetricsStability().String(),
						"traces-to-traces":  con.TracesToTracesStability().String(),
					},
				})
			}
			for _, ext := range sortFactoriesByType[extension.Factory](factories.Extensions) {
				components.Extensions = append(components.Extensions, componentWithStability{
					Name:   ext.Type(),
					Module: factories.ExtensionModules[ext.Type()],
					Stability: map[string]string{
						"extension": ext.Stability().String(),
					},
				})
			}
			for _, prs := range sortFactoriesByType[processor.Factory](factories.Processors) {
				components.Processors = append(components.Processors, componentWithStability{
					Name:   prs.Type(),
					Module: factories.ProcessorModules[prs.Type()],
					Stability: map[string]string{
						"logs":    prs.LogsStability().String(),
						"metrics": prs.MetricsStability().String(),
						"traces":  prs.TracesStability().String(),
					},
				})
			}
			for _, rcv := range sortFactoriesByType[receiver.Factory](factories.Receivers) {
				components.Receivers = append(components.Receivers, componentWithStability{
					Name:   rcv.Type(),
					Module: factories.ReceiverModules[rcv.Type()],
					Stability: map[string]string{
						"logs":    rcv.LogsStability().String(),
						"metrics": rcv.MetricsStability().String(),
						"traces":  rcv.TracesStability().String(),
					},
				})
			}
			for _, exp := range sortFactoriesByType[exporter.Factory](factories.Exporters) {
				components.Exporters = append(components.Exporters, componentWithStability{
					Name:   exp.Type(),
					Module: factories.ExporterModules[exp.Type()],
					Stability: map[string]string{
						"logs":    exp.LogsStability().String(),
						"metrics": exp.MetricsStability().String(),
						"traces":  exp.TracesStability().String(),
					},
				})
			}
			components.BuildInfo = set.BuildInfo

			components.Providers = append(components.Providers, sortProvidersByScheme(
				set.ProviderModules,
				set.ConfigProviderSettings.ResolverSettings.ProviderFactories,
				set.ConfigProviderSettings.ResolverSettings.ProviderSettings,
			)...)
			components.Converters = append(components.Converters, sortConverterModules(set.ConverterModules)...)

			yamlData, err := yaml.Marshal(components)
			if err != nil {
				return err
			}
			fmt.Fprint(cmd.OutOrStdout(), string(yamlData))
			return nil
		},
	}
}

func canonicalFactoryKeys[T component.Factory](factories map[component.Type]T) []component.Type {
	// Gather component types (factories map keys)
	componentTypes := make([]component.Type, 0, len(factories))
	for componentType, f := range factories {
		if componentType == f.Type() { // keep canonical keys only
			componentTypes = append(componentTypes, componentType)
		}
	}
	return componentTypes
}

func sortFactoriesByType[T component.Factory](factories map[component.Type]T) []T {
	componentTypes := canonicalFactoryKeys(factories)
	sort.Slice(componentTypes, func(i, j int) bool {
		return componentTypes[i].String() < componentTypes[j].String()
	})

	sortedFactories := make([]T, 0, len(componentTypes))
	for _, componentType := range componentTypes {
		if !isComponentAlias(factories[componentType]) {
			sortedFactories = append(sortedFactories, factories[componentType])
		}
	}
	return sortedFactories
}

func sortProvidersByScheme(providerModules map[string]string, provFactories []confmap.ProviderFactory, set confmap.ProviderSettings) []componentWithoutStability {
	schemes := make([]string, 0, len(provFactories))
	for _, f := range provFactories {
		provF := f.Create(set)
		scheme := provF.Scheme()
		if !isComponentAlias(f) {
			schemes = append(schemes, scheme)
		}
	}

	sort.Strings(schemes)

	providerComponents := make([]componentWithoutStability, 0, len(providerModules))
	for _, scheme := range schemes {
		providerComponents = append(providerComponents, componentWithoutStability{
			Scheme: scheme,
			Module: providerModules[scheme],
		})
	}
	return providerComponents
}

func sortConverterModules(modules []string) []componentWithoutStability {
	sortedModulesCopy := make([]string, len(modules))
	copy(sortedModulesCopy, modules)
	sort.Strings(sortedModulesCopy)

	sortedModules := make([]componentWithoutStability, 0, len(modules))
	for _, mod := range sortedModulesCopy {
		sortedModules = append(sortedModules, componentWithoutStability{
			Module: mod,
		})
	}
	return sortedModules
}

func isComponentAlias(component any) bool {
	if al, ok := component.(componentalias.TypeAliasHolder); ok {
		return al.DeprecatedAlias().String() != ""
	}
	return false
}