setup collector receiver

Co-authored-by: Tim Rühsen <[email protected]>

LICENSES/golang.org/x/net/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 The Go Authors. All rights reserved.
+Copyright 2009 The Go Authors.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are
@@ -10,7 +10,7 @@ notice, this list of conditions and the following disclaimer.
 copyright notice, this list of conditions and the following disclaimer
 in the documentation and/or other materials provided with the
 distribution.
-   * Neither the name of Google Inc. nor the names of its
+   * Neither the name of Google LLC nor the names of its
 contributors may be used to endorse or promote products derived from
 this software without specific prior written permission.
 

LICENSES/golang.org/x/text/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 The Go Authors. All rights reserved.
+Copyright 2009 The Go Authors.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are
@@ -10,7 +10,7 @@ notice, this list of conditions and the following disclaimer.
 copyright notice, this list of conditions and the following disclaimer
 in the documentation and/or other materials provided with the
 distribution.
-   * Neither the name of Google Inc. nor the names of its
+   * Neither the name of Google LLC nor the names of its
 contributors may be used to endorse or promote products derived from
 this software without specific prior written permission.
 

collector/factory.go

@@ -0,0 +1,45 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package collector // import "go.opentelemetry.io/ebpf-profiler/collector"
+
+import (
+	"context"
+	"errors"
+
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/consumer/consumerprofiles"
+	"go.opentelemetry.io/collector/receiver"
+	"go.opentelemetry.io/collector/receiver/receiverprofiles"
+
+	"go.opentelemetry.io/ebpf-profiler/collector/internal"
+)
+
+var (
+	typeStr = component.MustNewType("otelreceiver")
+
+	errInvalidConfig = errors.New("invalid config")
+)
+
+// NewFactory creates a factory for the receiver.
+func NewFactory() receiver.Factory {
+	return receiver.NewFactory(
+		typeStr,
+		internal.CreateDefaultConfig,
+		receiverprofiles.WithProfiles(createProfilesReceiver, component.StabilityLevelAlpha))
+}
+
+func createProfilesReceiver(
+	_ context.Context,
+	params receiver.Settings, //nolint:gocritic // we must respect the collector API
+	baseCfg component.Config,
+	nextConsumer consumerprofiles.Profiles) (receiverprofiles.Profiles, error) {
+	logger := params.Logger
+	cfg, ok := baseCfg.(*internal.Config)
+	if !ok {
+		return nil, errInvalidConfig
+	}
+
+	rcvr := internal.NewController(logger, nextConsumer, cfg)
+	return rcvr, nil
+}

collector/factory_test.go

@@ -0,0 +1,50 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package collector
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/consumer/consumertest"
+	"go.opentelemetry.io/collector/receiver/receivertest"
+	"go.opentelemetry.io/ebpf-profiler/collector/internal"
+)
+
+func TestNewFactory(t *testing.T) {
+	f := NewFactory()
+	require.NotNil(t, f)
+}
+
+func TestCreateProfilesReceiver(t *testing.T) {
+	for _, tt := range []struct {
+		name   string
+		config component.Config
+
+		wantError error
+	}{
+		{
+			name:   "Default config",
+			config: internal.CreateDefaultConfig(),
+		},
+		{
+			name:      "Nil config",
+			wantError: errInvalidConfig,
+		},
+	} {
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			_, err := createProfilesReceiver(
+				context.Background(),
+				receivertest.NewNopSettings(),
+				tt.config,
+				consumertest.NewNop(),
+			)
+			require.ErrorIs(t, err, tt.wantError)
+		})
+	}
+}

collector/internal/config.go

@@ -0,0 +1,95 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package internal // import "go.opentelemetry.io/ebpf-profiler/collector/internal"
+
+import (
+	"errors"
+	"fmt"
+	"time"
+
+	log "github.com/sirupsen/logrus"
+	"github.com/tklauser/numcpus"
+	"go.opentelemetry.io/collector/component"
+
+	tracertypes "go.opentelemetry.io/ebpf-profiler/tracer/types"
+)
+
+const (
+	defaultProjectID = "1"
+	defaultHostID    = 0x1234
+)
+
+// Config represents the receiver config settings within the collector's config.yaml
+type Config struct {
+	ProjectID              string        `mapstructure:"project-id"`
+	HostID                 uint64        `mapstructure:"host-id"`
+	SecretToken            string        `mapstructure:"secret-token"`
+	CollectionAgent        string        `mapstructure:"collection-agent"`
+	Tracers                string        `mapstructure:"tracers"`
+	Tags                   string        `mapstructure:"tags"`
+	BpfVerifierLogSize     int           `mapstructure:"bpf-log-size"`
+	BpfVerifierLogLevel    uint          `mapstructure:"bpf-log-level"`
+	MapScaleFactor         uint8         `mapstructure:"map-scale-factor"`
+	Verbose                bool          `mapstructure:"verbose"`
+	DisableTLS             bool          `mapstructure:"disable-tls"`
+	NoKernelVersionCheck   bool          `mapstructure:"no-kernel-version-check"`
+	ProbabilisticThreshold uint          `mapstructure:"probabilistic-threshold"`
+	ProbabilisticInterval  time.Duration `mapstructure:"probabilistic-interval"`
+	EnvironmentType        string        `mapstructure:"environment-type"`
+	ReporterInterval       time.Duration `mapstructure:"reporter-interval"`
+	MonitorInterval        time.Duration `mapstructure:"monitor-interval"`
+	SamplesPerSecond       int           `mapstructure:"samples-per-second"`
+	SendErrorFrames        bool          `mapstructure:"send-error-frames"`
+
+	// Written in CreateDefaultConfig()
+	PresentCPUCores int
+}
+
+// Validate checks if the receiver configuration is valid.
+func (cfg *Config) Validate() error {
+	if cfg.ReporterInterval.Seconds() < 1 {
+		return errors.New("the interval has to be set to at least 1 second (1s)")
+	}
+
+	if cfg.ProjectID == "" {
+		return errors.New("projectid must be set")
+	}
+
+	if cfg.PresentCPUCores <= 0 {
+		return errors.New("failed to determine number of CPUs")
+	}
+
+	if cfg.SamplesPerSecond <= 0 {
+		return errors.New("samples per second must be > 0")
+	}
+
+	if _, err := tracertypes.Parse(cfg.Tracers); err != nil {
+		return fmt.Errorf("failed to parse tracers '%s': %v", cfg.Tracers, err)
+	}
+
+	// todo: Add more validation
+
+	return nil
+}
+
+func CreateDefaultConfig() component.Config {
+	presentCores, err := numcpus.GetPresent()
+	if err != nil {
+		log.Errorf("Failed to read CPU file: %v", err)
+	}
+
+	// todo: export default values (currently in main.go)
+	return &Config{
+		ProjectID:              defaultProjectID,
+		HostID:                 defaultHostID,
+		ReporterInterval:       5 * time.Second,
+		MonitorInterval:        5 * time.Second,
+		SamplesPerSecond:       20,
+		ProbabilisticInterval:  1 * time.Minute,
+		ProbabilisticThreshold: 100,
+		CollectionAgent:        "127.0.0.1:11000", // devfiler
+		Tracers:                "all",
+		PresentCPUCores:        presentCores,
+	}
+}