Add profiles support in connector

.chloggen/profiles-connector.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: new_component
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: connector/connectorprofiles
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Allow handling profiles in connector.
+
+# One or more tracking issues or pull requests related to the change
+issues: [10703]
+
+# (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: [api]

Makefile

@@ -259,6 +259,7 @@ check-contrib:
 		-replace go.opentelemetry.io/collector=$(CURDIR) \
 		-replace go.opentelemetry.io/collector/client=$(CURDIR)/client \
 		-replace go.opentelemetry.io/collector/component=$(CURDIR)/component  \
+		-replace go.opentelemetry.io/collector/component/componentprofiles=$(CURDIR)/component/componentprofiles  \
 		-replace go.opentelemetry.io/collector/config/configauth=$(CURDIR)/config/configauth  \
 		-replace go.opentelemetry.io/collector/config/configcompression=$(CURDIR)/config/configcompression  \
 		-replace go.opentelemetry.io/collector/config/configgrpc=$(CURDIR)/config/configgrpc  \
@@ -321,6 +322,7 @@ restore-contrib:
 		-dropreplace go.opentelemetry.io/collector \
 		-dropreplace go.opentelemetry.io/collector/client \
 		-dropreplace go.opentelemetry.io/collector/component \
+		-dropreplace go.opentelemetry.io/collector/component/componentprofiles \
 		-dropreplace go.opentelemetry.io/collector/config/configauth  \
 		-dropreplace go.opentelemetry.io/collector/config/configcompression  \
 		-dropreplace go.opentelemetry.io/collector/config/configgrpc  \

cmd/builder/internal/builder/main_test.go

@@ -41,6 +41,7 @@ var (
 	replaceModules = []string{
 		"",
 		"/component",
+		"/component/componentprofiles",
 		"/client",
 		"/config/configauth",
 		"/config/configcompression",

cmd/builder/test/core.builder.yaml

@@ -21,6 +21,7 @@ replaces:
   - go.opentelemetry.io/collector => ${WORKSPACE_DIR}
   - go.opentelemetry.io/collector/client => ${WORKSPACE_DIR}/client
   - go.opentelemetry.io/collector/component => ${WORKSPACE_DIR}/component
+  - go.opentelemetry.io/collector/component/componentprofiles => ${WORKSPACE_DIR}/component/componentprofiles
   - go.opentelemetry.io/collector/config/configauth => ${WORKSPACE_DIR}/config/configauth
   - go.opentelemetry.io/collector/config/configcompression => ${WORKSPACE_DIR}/config/configcompression
   - go.opentelemetry.io/collector/config/configgrpc => ${WORKSPACE_DIR}/config/configgrpc

cmd/otelcorecol/builder-config.yaml

@@ -45,6 +45,7 @@ replaces:
   - go.opentelemetry.io/collector/client => ../../client
   - go.opentelemetry.io/collector/otelcol => ../../otelcol
   - go.opentelemetry.io/collector/component => ../../component
+  - go.opentelemetry.io/collector/component/componentprofiles => ../../component/componentprofiles
   - go.opentelemetry.io/collector/config/configauth => ../../config/configauth
   - go.opentelemetry.io/collector/config/configcompression => ../../config/configcompression
   - go.opentelemetry.io/collector/config/configgrpc => ../../config/configgrpc

cmd/otelcorecol/go.mod

@@ -82,6 +82,7 @@ require (
 	go.opencensus.io v0.24.0 // indirect
 	go.opentelemetry.io/collector v0.106.1 // indirect
 	go.opentelemetry.io/collector/client v0.106.1 // indirect
+	go.opentelemetry.io/collector/component/componentprofiles v0.0.0-00010101000000-000000000000 // indirect
 	go.opentelemetry.io/collector/config/configauth v0.106.1 // indirect
 	go.opentelemetry.io/collector/config/configcompression v1.12.0 // indirect
 	go.opentelemetry.io/collector/config/configgrpc v0.106.1 // indirect
@@ -148,6 +149,8 @@ replace go.opentelemetry.io/collector/otelcol => ../../otelcol
 
 replace go.opentelemetry.io/collector/component => ../../component
 
+replace go.opentelemetry.io/collector/component/componentprofiles => ../../component/componentprofiles
+
 replace go.opentelemetry.io/collector/config/configauth => ../../config/configauth
 
 replace go.opentelemetry.io/collector/config/configcompression => ../../config/configcompression

connector/connectorprofiles/Makefile

@@ -0,0 +1 @@
+include ../../Makefile.Common

connector/connectorprofiles/connector.go

@@ -0,0 +1,80 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package connector // import "go.opentelemetry.io/collector/connector/connectorprofiles"
+
+import (
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/connector"
+	"go.opentelemetry.io/collector/connector/internal"
+)
+
+// A Profiles connector acts as an exporter from a profiles pipeline and a receiver
+// to one or more traces, metrics, logs, or profiles pipelines.
+// Profiles feeds a consumer.Traces, consumer.Metrics, consumer.Logs, or consumerprofiles.Profiles with data.
+//
+// Examples:
+//   - Profiles could be collected in one pipeline and routed to another profiles pipeline
+//     based on criteria such as attributes or other content of the profile. The second
+//     pipeline can then process and export the profile to the appropriate backend.
+//   - Profiles could be summarized by a metrics connector that emits statistics describing
+//     the number of profiles observed.
+//   - Profiles could be analyzed by a logs connector that emits events when particular
+//     criteria are met.
+type Profiles = internal.Profiles
+
+// CreateTracesToProfilesFunc is the equivalent of Factory.CreateTracesToProfiles().
+type CreateTracesToProfilesFunc = internal.CreateTracesToProfilesFunc
+
+// CreateMetricsToProfilesFunc is the equivalent of Factory.CreateMetricsToProfiles().
+type CreateMetricsToProfilesFunc = internal.CreateMetricsToProfilesFunc
+
+// CreateLogsToProfilesFunc is the equivalent of Factory.CreateLogsToProfiles().
+type CreateLogsToProfilesFunc = internal.CreateLogsToProfilesFunc
+
+// CreateProfilesToProfilesFunc is the equivalent of Factory.CreateProfilesToProfiles().
+type CreateProfilesToProfilesFunc = internal.CreateProfilesToProfilesFunc
+
+// CreateProfilesToTracesFunc is the equivalent of Factory.CreateProfilesToTraces().
+type CreateProfilesToTracesFunc = internal.CreateProfilesToTracesFunc
+
+// CreateProfilesToMetricsFunc is the equivalent of Factory.CreateProfilesToMetrics().
+type CreateProfilesToMetricsFunc = internal.CreateProfilesToMetricsFunc
+
+// CreateProfilesToLogsFunc is the equivalent of Factory.CreateProfilesToLogs().
+type CreateProfilesToLogsFunc = internal.CreateProfilesToLogsFunc
+
+// WithTracesToProfiles overrides the default "error not supported" implementation for WithTracesToProfiles and the default "undefined" stability level.
+func WithTracesToProfiles(createTracesToProfiles CreateTracesToProfilesFunc, sl component.StabilityLevel) connector.FactoryOption {
+	return internal.WithTracesToProfiles(createTracesToProfiles, sl)
+}
+
+// WithMetricsToProfiles overrides the default "error not supported" implementation for WithMetricsToProfiles and the default "undefined" stability level.
+func WithMetricsToProfiles(createMetricsToProfiles CreateMetricsToProfilesFunc, sl component.StabilityLevel) connector.FactoryOption {
+	return internal.WithMetricsToProfiles(createMetricsToProfiles, sl)
+}
+
+// WithLogsToProfiles overrides the default "error not supported" implementation for WithLogsToProfiles and the default "undefined" stability level.
+func WithLogsToProfiles(createLogsToProfiles CreateLogsToProfilesFunc, sl component.StabilityLevel) connector.FactoryOption {
+	return internal.WithLogsToProfiles(createLogsToProfiles, sl)
+}
+
+// WithProfilesToProfiles overrides the default "error not supported" implementation for WithProfilesToProfiles and the default "undefined" stability level.
+func WithProfilesToProfiles(createProfilesToProfiles CreateProfilesToProfilesFunc, sl component.StabilityLevel) connector.FactoryOption {
+	return internal.WithProfilesToProfiles(createProfilesToProfiles, sl)
+}
+
+// WithProfilesToTraces overrides the default "error not supported" implementation for WithProfilesToTraces and the default "undefined" stability level.
+func WithProfilesToTraces(createProfilesToTraces CreateProfilesToTracesFunc, sl component.StabilityLevel) connector.FactoryOption {
+	return internal.WithProfilesToTraces(createProfilesToTraces, sl)
+}
+
+// WithProfilesToMetrics overrides the default "error not supported" implementation for WithProfilesToMetrics and the default "undefined" stability level.
+func WithProfilesToMetrics(createProfilesToMetrics CreateProfilesToMetricsFunc, sl component.StabilityLevel) connector.FactoryOption {
+	return internal.WithProfilesToMetrics(createProfilesToMetrics, sl)
+}
+
+// WithProfilesToLogs overrides the default "error not supported" implementation for WithProfilesToLogs and the default "undefined" stability level.
+func WithProfilesToLogs(createProfilesToLogs CreateProfilesToLogsFunc, sl component.StabilityLevel) connector.FactoryOption {
+	return internal.WithProfilesToLogs(createProfilesToLogs, sl)
+}

connector/connectorprofiles/connector_test.go

@@ -0,0 +1,144 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package connector // import "go.opentelemetry.io/collector/connector"
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/component/componentprofiles"
+	"go.opentelemetry.io/collector/connector"
+	"go.opentelemetry.io/collector/connector/internal"
+	"go.opentelemetry.io/collector/consumer"
+	"go.opentelemetry.io/collector/consumer/consumerprofiles"
+	"go.opentelemetry.io/collector/consumer/consumertest"
+)
+
+var (
+	testType = component.MustNewType("test")
+	testID   = component.MustNewIDWithName("type", "name")
+)
+
+func TestNewFactoryNoOptions(t *testing.T) {
+	defaultCfg := struct{}{}
+	factory := connector.NewFactory(testType, func() component.Config { return &defaultCfg })
+	assert.EqualValues(t, testType, factory.Type())
+	assert.EqualValues(t, &defaultCfg, factory.CreateDefaultConfig())
+
+	_, err := factory.CreateTracesToProfiles(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.Equal(t, err, internal.ErrDataTypes(testID, component.DataTypeTraces, componentprofiles.DataTypeProfiles))
+	_, err = factory.CreateMetricsToProfiles(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.Equal(t, err, internal.ErrDataTypes(testID, component.DataTypeMetrics, componentprofiles.DataTypeProfiles))
+	_, err = factory.CreateLogsToProfiles(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.Equal(t, err, internal.ErrDataTypes(testID, component.DataTypeLogs, componentprofiles.DataTypeProfiles))
+
+	_, err = factory.CreateProfilesToTraces(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.Equal(t, err, internal.ErrDataTypes(testID, componentprofiles.DataTypeProfiles, component.DataTypeTraces))
+	_, err = factory.CreateProfilesToMetrics(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.Equal(t, err, internal.ErrDataTypes(testID, componentprofiles.DataTypeProfiles, component.DataTypeMetrics))
+	_, err = factory.CreateProfilesToLogs(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.Equal(t, err, internal.ErrDataTypes(testID, componentprofiles.DataTypeProfiles, component.DataTypeLogs))
+}
+
+func TestNewFactoryWithSameTypes(t *testing.T) {
+	defaultCfg := struct{}{}
+	factory := connector.NewFactory(testType, func() component.Config { return &defaultCfg },
+		WithProfilesToProfiles(createProfilesToProfiles, component.StabilityLevelAlpha),
+	)
+	assert.EqualValues(t, testType, factory.Type())
+	assert.EqualValues(t, &defaultCfg, factory.CreateDefaultConfig())
+
+	assert.Equal(t, component.StabilityLevelAlpha, factory.ProfilesToProfilesStability())
+	_, err := factory.CreateProfilesToProfiles(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.NoError(t, err)
+
+	_, err = factory.CreateProfilesToTraces(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.Equal(t, err, internal.ErrDataTypes(testID, componentprofiles.DataTypeProfiles, component.DataTypeTraces))
+	_, err = factory.CreateProfilesToMetrics(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.Equal(t, err, internal.ErrDataTypes(testID, componentprofiles.DataTypeProfiles, component.DataTypeMetrics))
+	_, err = factory.CreateProfilesToLogs(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.Equal(t, err, internal.ErrDataTypes(testID, componentprofiles.DataTypeProfiles, component.DataTypeLogs))
+}
+
+func TestNewFactoryWithTranslateTypes(t *testing.T) {
+	defaultCfg := struct{}{}
+	factory := connector.NewFactory(testType, func() component.Config { return &defaultCfg },
+		WithTracesToProfiles(createTracesToProfiles, component.StabilityLevelBeta),
+		WithMetricsToProfiles(createMetricsToProfiles, component.StabilityLevelDevelopment),
+		WithLogsToProfiles(createLogsToProfiles, component.StabilityLevelAlpha),
+
+		WithProfilesToTraces(createProfilesToTraces, component.StabilityLevelBeta),
+		WithProfilesToMetrics(createProfilesToMetrics, component.StabilityLevelDevelopment),
+		WithProfilesToLogs(createProfilesToLogs, component.StabilityLevelAlpha),
+	)
+	assert.EqualValues(t, testType, factory.Type())
+	assert.EqualValues(t, &defaultCfg, factory.CreateDefaultConfig())
+
+	_, err := factory.CreateProfilesToProfiles(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.Equal(t, err, internal.ErrDataTypes(testID, componentprofiles.DataTypeProfiles, componentprofiles.DataTypeProfiles))
+
+	assert.Equal(t, component.StabilityLevelBeta, factory.TracesToProfilesStability())
+	_, err = factory.CreateTracesToProfiles(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.NoError(t, err)
+
+	assert.Equal(t, component.StabilityLevelDevelopment, factory.MetricsToProfilesStability())
+	_, err = factory.CreateMetricsToProfiles(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.NoError(t, err)
+
+	assert.Equal(t, component.StabilityLevelAlpha, factory.LogsToProfilesStability())
+	_, err = factory.CreateLogsToProfiles(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.NoError(t, err)
+
+	assert.Equal(t, component.StabilityLevelBeta, factory.ProfilesToTracesStability())
+	_, err = factory.CreateProfilesToTraces(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.NoError(t, err)
+
+	assert.Equal(t, component.StabilityLevelDevelopment, factory.ProfilesToMetricsStability())
+	_, err = factory.CreateProfilesToMetrics(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.NoError(t, err)
+
+	assert.Equal(t, component.StabilityLevelAlpha, factory.ProfilesToLogsStability())
+	_, err = factory.CreateProfilesToLogs(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
+	assert.NoError(t, err)
+}
+
+var nopInstance = &nopConnector{
+	Consumer: consumertest.NewNop(),
+}
+
+// nopConnector stores consumed traces and metrics for testing purposes.
+type nopConnector struct {
+	component.StartFunc
+	component.ShutdownFunc
+	consumertest.Consumer
+}
+
+func createTracesToProfiles(context.Context, connector.Settings, component.Config, consumerprofiles.Profiles) (connector.Traces, error) {
+	return nopInstance, nil
+}
+
+func createMetricsToProfiles(context.Context, connector.Settings, component.Config, consumerprofiles.Profiles) (connector.Metrics, error) {
+	return nopInstance, nil
+}
+
+func createLogsToProfiles(context.Context, connector.Settings, component.Config, consumerprofiles.Profiles) (connector.Logs, error) {
+	return nopInstance, nil
+}
+
+func createProfilesToProfiles(context.Context, connector.Settings, component.Config, consumerprofiles.Profiles) (Profiles, error) {
+	return nopInstance, nil
+}
+
+func createProfilesToTraces(context.Context, connector.Settings, component.Config, consumer.Traces) (Profiles, error) {
+	return nopInstance, nil
+}
+func createProfilesToMetrics(context.Context, connector.Settings, component.Config, consumer.Metrics) (Profiles, error) {
+	return nopInstance, nil
+}
+func createProfilesToLogs(context.Context, connector.Settings, component.Config, consumer.Logs) (Profiles, error) {
+	return nopInstance, nil
+}

connector/connectorprofiles/go.mod

@@ -0,0 +1,66 @@
+module go.opentelemetry.io/collector/connector/connectorprofiles
+
+go 1.21.0
+
+require (
+	github.com/stretchr/testify v1.9.0
+	go.opentelemetry.io/collector/component v0.106.1
+	go.opentelemetry.io/collector/component/componentprofiles v0.0.0-20240723122248-8b5e2318374d
+	go.opentelemetry.io/collector/connector v0.106.1
+	go.opentelemetry.io/collector/consumer v0.106.1
+	go.opentelemetry.io/collector/consumer/consumerprofiles v0.106.1
+	go.opentelemetry.io/collector/consumer/consumertest v0.106.1
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	go.opentelemetry.io/collector v0.106.1 // indirect
+	go.opentelemetry.io/collector/config/configtelemetry v0.106.1 // indirect
+	go.opentelemetry.io/collector/pdata v1.12.0 // indirect
+	go.opentelemetry.io/collector/pdata/pprofile v0.106.1 // indirect
+	go.opentelemetry.io/otel v1.28.0 // indirect
+	go.opentelemetry.io/otel/metric v1.28.0 // indirect
+	go.opentelemetry.io/otel/trace v1.28.0 // indirect
+	go.uber.org/multierr v1.11.0 // indirect
+	go.uber.org/zap v1.27.0 // indirect
+	golang.org/x/net v0.26.0 // indirect
+	golang.org/x/sys v0.21.0 // indirect
+	golang.org/x/text v0.16.0 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20240701130421-f6361c86f094 // indirect
+	google.golang.org/grpc v1.65.0 // indirect
+	google.golang.org/protobuf v1.34.2 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)
+
+replace go.opentelemetry.io/collector/connector => ../
+
+replace go.opentelemetry.io/collector/consumer => ../../consumer
+
+replace go.opentelemetry.io/collector/consumer/consumertest => ../../consumer/consumertest
+
+replace go.opentelemetry.io/collector/pdata/pprofile => ../../pdata/pprofile
+
+replace go.opentelemetry.io/collector/featuregate => ../../featuregate
+
+replace go.opentelemetry.io/collector/consumer/consumerprofiles => ../../consumer/consumerprofiles
+
+replace go.opentelemetry.io/collector/component/componentprofiles => ../../component/componentprofiles
+
+replace go.opentelemetry.io/collector => ../..
+
+replace go.opentelemetry.io/collector/internal/globalgates => ../../internal/globalgates
+
+replace go.opentelemetry.io/collector/confmap => ../../confmap
+
+replace go.opentelemetry.io/collector/component => ../../component
+
+replace go.opentelemetry.io/collector/pdata => ../../pdata
+
+replace go.opentelemetry.io/collector/config/configtelemetry => ../../config/configtelemetry
+
+replace go.opentelemetry.io/collector/pdata/testdata => ../../pdata/testdata