[receiver/stef] Add enough code to make the stefreceiver function (open-telemetry#39044)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
Adds just enough code to make the stefreceiver work.

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes open-telemetry#38979 

<!--Describe what testing was performed and which tests were added.-->
#### Testing
Roundtrip with the exporter

<!--Describe the documentation added.-->
#### Documentation
README

<!--Please delete paragraphs that you did not use before submitting.-->

---------

Co-authored-by: Curtis Robert <[email protected]>

Author: 2 people

.chloggen/stefreceiver.yaml

@@ -0,0 +1,27 @@
+# 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. filelogreceiver)
+component: stefreceiver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Make the receiver initially code complete
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [38979]
+
+# (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:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# 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: []

receiver/stefreceiver/README.md

@@ -11,3 +11,24 @@
 [development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development
 <!-- end autogenerated section -->
 
+The STEF receiver runs a gRPC server accepting data using the Sequential Tabular Encoding Format (STEF).
+
+## Configuration
+
+- `endpoint` (default = localhost:4320 for grpc protocol):
+  host:port on which the receiver is going to receive data. Refer to
+  [naming documentation](https://github.com/grpc/grpc/blob/master/doc/naming.md)
+  for valid syntax.
+- `ack_interval` (default: 10ms). The periodical interval of time when sending acknowledgements back to the client.
+
+Example:
+
+```yaml
+stef:
+  endpoint: 0.0.0.0:4320
+```
+
+Several common configuration structures provide additional capabilities automatically:
+
+- [gRPC settings](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configgrpc/README.md)
+- [TLS and mTLS settings](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md)

receiver/stefreceiver/config.go

@@ -3,8 +3,17 @@
 
 package stefreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/stefreceiver"
 
+import (
+	"time"
+
+	"go.opentelemetry.io/collector/config/configgrpc"
+)
+
 // Config defines configuration for STEF receiver.
-type Config struct{}
+type Config struct {
+	configgrpc.ServerConfig `mapstructure:",squash"`
+	AckInterval             time.Duration `mapstructure:"ack_interval"`
+}
 
 func (c *Config) Validate() error {
 	return nil

receiver/stefreceiver/config_test.go

@@ -0,0 +1,52 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package stefreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/stefreceiver"
+import (
+	"fmt"
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/collector/config/configtls"
+	"go.opentelemetry.io/collector/confmap/confmaptest"
+)
+
+func TestConfig(t *testing.T) {
+	tests := []struct {
+		name           string
+		expectedConfig *Config
+	}{
+		{
+			name: "endpoint",
+			expectedConfig: func() *Config {
+				cfg := createDefaultConfig().(*Config)
+				cfg.ServerConfig.NetAddr.Endpoint = "0.0.0.0:3456"
+				return cfg
+			}(),
+		},
+		{
+			name: "tls",
+			expectedConfig: func() *Config {
+				cfg := createDefaultConfig().(*Config)
+				tls := configtls.NewDefaultServerConfig()
+				cfg.ServerConfig.TLSSetting = &tls
+				cfg.ServerConfig.TLSSetting.KeyFile = "server.key"
+				return cfg
+			}(),
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			cm, err := confmaptest.LoadConf(filepath.Join("testdata", "config.yaml"))
+			require.NoError(t, err)
+			conf, err := cm.Sub(fmt.Sprintf("stef/%s", test.name))
+			require.NoError(t, err)
+			cfg := createDefaultConfig()
+			require.NoError(t, conf.Unmarshal(cfg))
+			assert.Equal(t, test.expectedConfig, cfg)
+		})
+	}
+}

receiver/stefreceiver/e2e_test.go

@@ -0,0 +1,61 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package stefreceiver
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/collector/component/componenttest"
+	"go.opentelemetry.io/collector/consumer/consumertest"
+	"go.opentelemetry.io/collector/exporter/exportertest"
+	"go.opentelemetry.io/collector/pdata/pcommon"
+	"go.opentelemetry.io/collector/pdata/pmetric"
+	"go.opentelemetry.io/collector/receiver/receivertest"
+	"go.uber.org/zap"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/stefexporter"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/stefreceiver/internal/metadata"
+)
+
+func TestRoundtrip(t *testing.T) {
+	sink := &consumertest.MetricsSink{}
+	settings := receivertest.NewNopSettings(metadata.Type)
+	settings.Logger, _ = zap.NewDevelopment()
+	m, err := NewFactory().CreateMetrics(context.Background(), settings, createDefaultConfig(), sink)
+	t.Cleanup(func() {
+		err = m.Shutdown(context.Background())
+		require.NoError(t, err)
+	})
+	require.NoError(t, m.Start(context.Background(), componenttest.NewNopHost()))
+	require.NoError(t, err)
+	cfg := stefexporter.NewFactory().CreateDefaultConfig().(*stefexporter.Config)
+	cfg.Endpoint = "localhost:4320"
+	cfg.TLSSetting.Insecure = true
+	exporterSettings := exportertest.NewNopSettings(metadata.Type)
+	exporterSettings.Logger, _ = zap.NewDevelopment()
+	exporter, err := stefexporter.NewFactory().CreateMetrics(context.Background(), exporterSettings, cfg)
+	require.NoError(t, err)
+	t.Cleanup(func() {
+		err = exporter.Shutdown(context.Background())
+		require.NoError(t, err)
+	})
+
+	require.NoError(t, exporter.Start(context.Background(), componenttest.NewNopHost()))
+	data := pmetric.NewMetrics()
+	metricPoint := data.ResourceMetrics().AppendEmpty().ScopeMetrics().AppendEmpty().Metrics().AppendEmpty()
+	metricPoint.SetName("foo")
+	gauge := metricPoint.SetEmptyGauge()
+	dp := gauge.DataPoints().AppendEmpty()
+	dp.SetIntValue(1)
+	dp.SetTimestamp(pcommon.NewTimestampFromTime(time.Now()))
+	err = exporter.ConsumeMetrics(context.Background(), data)
+	require.NoError(t, err)
+	assert.EventuallyWithT(t, func(tt *assert.CollectT) {
+		assert.Len(tt, sink.AllMetrics(), 1)
+	}, 1*time.Minute, 10*time.Millisecond)
+}

receiver/stefreceiver/factory.go

@@ -5,8 +5,11 @@ package stefreceiver // import "github.com/open-telemetry/opentelemetry-collecto
 
 import (
 	"context"
+	"time"
 
 	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/config/configgrpc"
+	"go.opentelemetry.io/collector/config/confignet"
 	"go.opentelemetry.io/collector/consumer"
 	"go.opentelemetry.io/collector/receiver"
 
@@ -23,24 +26,28 @@ func NewFactory() receiver.Factory {
 }
 
 func createDefaultConfig() component.Config {
-	return &Config{}
+	grpcCfg := configgrpc.NewDefaultServerConfig()
+	grpcCfg.NetAddr = confignet.NewDefaultAddrConfig()
+	grpcCfg.NetAddr.Endpoint = "localhost:4320"
+	grpcCfg.NetAddr.Transport = confignet.TransportTypeTCP
+	grpcCfg.ReadBufferSize = 512 * 1024
+
+	return &Config{
+		ServerConfig: *grpcCfg,
+		AckInterval:  10 * time.Millisecond,
+	}
 }
 
 func createMetricsReceiver(
 	_ context.Context,
-	_ receiver.Settings,
-	_ component.Config,
-	_ consumer.Metrics,
+	set receiver.Settings,
+	cfg component.Config,
+	nextConsumer consumer.Metrics,
 ) (receiver.Metrics, error) {
-	return &stefReceiver{}, nil
-}
-
-type stefReceiver struct{}
-
-func (s stefReceiver) Start(_ context.Context, _ component.Host) error {
-	return nil
-}
-
-func (s stefReceiver) Shutdown(_ context.Context) error {
-	return nil
+	oCfg := cfg.(*Config)
+	return &stefReceiver{
+		cfg:                 oCfg,
+		nextMetricsConsumer: nextConsumer,
+		settings:            set,
+	}, nil
 }

receiver/stefreceiver/go.mod

@@ -3,57 +3,89 @@ module github.com/open-telemetry/opentelemetry-collector-contrib/receiver/stefre
 go 1.23.0
 
 require (
+	github.com/open-telemetry/opentelemetry-collector-contrib/exporter/stefexporter v0.123.0
+	github.com/splunk/stef/go/grpc v0.0.5-0.20250328192643-20ae67012e0c
+	github.com/splunk/stef/go/otel v0.0.5-0.20250328192643-20ae67012e0c
+	github.com/splunk/stef/go/pdata v0.0.5-0.20250328192643-20ae67012e0c
 	github.com/stretchr/testify v1.10.0
 	go.opentelemetry.io/collector/component v1.29.1-0.20250402200755-cb5c3f4fb9dc
+	go.opentelemetry.io/collector/component/componentstatus v0.123.1-0.20250402200755-cb5c3f4fb9dc
 	go.opentelemetry.io/collector/component/componenttest v0.123.1-0.20250402200755-cb5c3f4fb9dc
+	go.opentelemetry.io/collector/config/configgrpc v0.123.1-0.20250402200755-cb5c3f4fb9dc
+	go.opentelemetry.io/collector/config/confignet v1.29.1-0.20250402200755-cb5c3f4fb9dc
+	go.opentelemetry.io/collector/config/configtls v1.29.1-0.20250402200755-cb5c3f4fb9dc
 	go.opentelemetry.io/collector/confmap v1.29.1-0.20250402200755-cb5c3f4fb9dc
 	go.opentelemetry.io/collector/consumer v1.29.1-0.20250402200755-cb5c3f4fb9dc
+	go.opentelemetry.io/collector/consumer/consumererror v0.123.1-0.20250402200755-cb5c3f4fb9dc
 	go.opentelemetry.io/collector/consumer/consumertest v0.123.1-0.20250402200755-cb5c3f4fb9dc
+	go.opentelemetry.io/collector/exporter/exportertest v0.123.1-0.20250402200755-cb5c3f4fb9dc
+	go.opentelemetry.io/collector/pdata v1.29.1-0.20250402200755-cb5c3f4fb9dc
 	go.opentelemetry.io/collector/receiver v1.29.1-0.20250402200755-cb5c3f4fb9dc
 	go.opentelemetry.io/collector/receiver/receivertest v0.123.1-0.20250402200755-cb5c3f4fb9dc
 	go.uber.org/goleak v1.3.0
+	go.uber.org/zap v1.27.0
+	golang.org/x/sync v0.12.0
+	google.golang.org/grpc v1.71.1
 )
 
 require (
+	github.com/cenkalti/backoff/v5 v5.0.2 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/fsnotify/fsnotify v1.8.0 // indirect
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-viper/mapstructure/v2 v2.2.1 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang/snappy v0.0.4 // indirect
 	github.com/google/uuid v1.6.0 // indirect
 	github.com/hashicorp/go-version v1.7.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/klauspost/compress v1.17.9 // indirect
 	github.com/knadh/koanf/maps v0.1.2 // indirect
 	github.com/knadh/koanf/providers/confmap v0.1.0 // indirect
 	github.com/knadh/koanf/v2 v2.1.2 // indirect
 	github.com/mitchellh/copystructure v1.2.0 // indirect
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/mostynb/go-grpc-compression v1.2.3 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/splunk/stef/go/pkg v0.0.5-0.20250328192643-20ae67012e0c // indirect
 	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
-	go.opentelemetry.io/collector/consumer/consumererror v0.123.1-0.20250402200755-cb5c3f4fb9dc // indirect
+	go.opentelemetry.io/collector/client v1.29.1-0.20250402200755-cb5c3f4fb9dc // indirect
+	go.opentelemetry.io/collector/config/configauth v0.123.1-0.20250402200755-cb5c3f4fb9dc // indirect
+	go.opentelemetry.io/collector/config/configcompression v1.29.1-0.20250402200755-cb5c3f4fb9dc // indirect
+	go.opentelemetry.io/collector/config/configopaque v1.29.1-0.20250402200755-cb5c3f4fb9dc // indirect
+	go.opentelemetry.io/collector/config/configretry v1.29.1-0.20250402200755-cb5c3f4fb9dc // indirect
 	go.opentelemetry.io/collector/consumer/xconsumer v0.123.1-0.20250402200755-cb5c3f4fb9dc // indirect
+	go.opentelemetry.io/collector/exporter v0.123.1-0.20250402200755-cb5c3f4fb9dc // indirect
+	go.opentelemetry.io/collector/exporter/xexporter v0.123.1-0.20250402200755-cb5c3f4fb9dc // indirect
+	go.opentelemetry.io/collector/extension v1.29.1-0.20250402200755-cb5c3f4fb9dc // indirect
+	go.opentelemetry.io/collector/extension/extensionauth v1.29.1-0.20250402200755-cb5c3f4fb9dc // indirect
+	go.opentelemetry.io/collector/extension/xextension v0.123.1-0.20250402200755-cb5c3f4fb9dc // indirect
 	go.opentelemetry.io/collector/featuregate v1.29.1-0.20250402200755-cb5c3f4fb9dc // indirect
 	go.opentelemetry.io/collector/internal/telemetry v0.123.1-0.20250402200755-cb5c3f4fb9dc // indirect
-	go.opentelemetry.io/collector/pdata v1.29.1-0.20250402200755-cb5c3f4fb9dc // indirect
 	go.opentelemetry.io/collector/pdata/pprofile v0.123.1-0.20250402200755-cb5c3f4fb9dc // indirect
 	go.opentelemetry.io/collector/pipeline v0.123.1-0.20250402200755-cb5c3f4fb9dc // indirect
 	go.opentelemetry.io/collector/receiver/xreceiver v0.123.1-0.20250402200755-cb5c3f4fb9dc // indirect
 	go.opentelemetry.io/contrib/bridges/otelzap v0.10.0 // indirect
+	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.60.0 // indirect
 	go.opentelemetry.io/otel v1.35.0 // indirect
 	go.opentelemetry.io/otel/log v0.11.0 // indirect
 	go.opentelemetry.io/otel/metric v1.35.0 // indirect
 	go.opentelemetry.io/otel/sdk v1.35.0 // indirect
 	go.opentelemetry.io/otel/sdk/metric v1.35.0 // indirect
 	go.opentelemetry.io/otel/trace v1.35.0 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
-	go.uber.org/zap v1.27.0 // indirect
 	golang.org/x/net v0.37.0 // indirect
 	golang.org/x/sys v0.31.0 // indirect
 	golang.org/x/text v0.23.0 // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20250115164207-1a7da9e5054f // indirect
-	google.golang.org/grpc v1.71.1 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20250218202821-56aae31c358a // indirect
 	google.golang.org/protobuf v1.36.6 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
+	modernc.org/b/v2 v2.1.0 // indirect
 )
+
+replace github.com/open-telemetry/opentelemetry-collector-contrib/exporter/stefexporter => ../../exporter/stefexporter
+
+replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/common => ../../internal/common