[extension/cgroupruntime]: Initial implementation

.chloggen/add_cgroupruntime_extension.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: extension/cgroupruntime
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Initial implementation for cgroupruntime extension.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [30289]
+
+# (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: []

.github/CODEOWNERS

@@ -89,6 +89,7 @@ extension/asapauthextension/                      @open-telemetry/collector-cont
 extension/awsproxy/                               @open-telemetry/collector-contrib-approvers @Aneurysm9 @mxiamxia
 extension/basicauthextension/                     @open-telemetry/collector-contrib-approvers @jpkrohling @frzifus
 extension/bearertokenauthextension/               @open-telemetry/collector-contrib-approvers @jpkrohling @frzifus
+extension/cgroupruntimeextension/                 @open-telemetry/collector-contrib-approvers @mx-psi @rogercoll
 extension/encoding/                               @open-telemetry/collector-contrib-approvers @atoulme @dao-jun @dmitryax @MovieStoreGuy @VihasMakwana
 extension/encoding/avrologencodingextension/      @open-telemetry/collector-contrib-approvers @thmshmm
 extension/encoding/jaegerencodingextension/       @open-telemetry/collector-contrib-approvers @MovieStoreGuy @atoulme

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -88,6 +88,7 @@ body:
       - extension/awsproxy
       - extension/basicauth
       - extension/bearertokenauth
+      - extension/cgroupruntime
       - extension/encoding
       - extension/encoding/avrologencoding
       - extension/encoding/jaegerencoding

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -82,6 +82,7 @@ body:
       - extension/awsproxy
       - extension/basicauth
       - extension/bearertokenauth
+      - extension/cgroupruntime
       - extension/encoding
       - extension/encoding/avrologencoding
       - extension/encoding/jaegerencoding

.github/ISSUE_TEMPLATE/other.yaml

@@ -82,6 +82,7 @@ body:
       - extension/awsproxy
       - extension/basicauth
       - extension/bearertokenauth
+      - extension/cgroupruntime
       - extension/encoding
       - extension/encoding/avrologencoding
       - extension/encoding/jaegerencoding

.github/ISSUE_TEMPLATE/unmaintained.yaml

@@ -87,6 +87,7 @@ body:
       - extension/awsproxy
       - extension/basicauth
       - extension/bearertokenauth
+      - extension/cgroupruntime
       - extension/encoding
       - extension/encoding/avrologencoding
       - extension/encoding/jaegerencoding

extension/cgroupruntimeextension/Makefile

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

extension/cgroupruntimeextension/README.md

@@ -0,0 +1,42 @@
+# Cgroup Go runtime extension
+
+
+<!-- status autogenerated section -->
+| Status        |           |
+| ------------- |-----------|
+| Stability     | [development]  |
+| Distributions | [contrib] |
+| Issues        | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Aextension%2Fcgroupruntime%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Aextension%2Fcgroupruntime) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Aextension%2Fcgroupruntime%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Aextension%2Fcgroupruntime) |
+| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner)    | [@mx-psi](https://www.github.com/mx-psi), [@rogercoll](https://www.github.com/rogercoll) |
+
+[development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development
+[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
+<!-- end autogenerated section -->
+
+## Overview
+
+The OpenTelemetry CGroup Auto-Config Extension is designed to optimize Go runtime performance in containerized environments by automatically configuring GOMAXPROCS and GOMEMLIMIT based on the Linux cgroup filesystem. This extension leverages [automaxprocs](https://github.com/uber-go/automaxprocs) and [automemlimit](https://github.com/KimMachineGun/automemlimit) packages to dynamically adjust Go runtime variables, ensuring efficient resource usage aligned with container limits.
+
+## Configuration
+
+The following settings can be configured:
+
+- `gomaxprocs`: Configures the behavior of setting `GOMAXPROCS`, the maximum number of CPUs for Go runtime. Options:
+  - `enabled`: A boolean value to enable or disable automatic configuration of `GOMAXPROCS` based on the system’s cgroup settings (default: true).
+
+- `gomemlimit`: Configures the behavior of setting `GOMEMLIMIT`, the maximum memory limit for Go runtime. Options:
+  - `enabled`: A boolean value to enable or disable automatic configuration of `GOMEMLIMIT` (default: true).
+  - `ratio`: A floating-point value between 0 and 1 that represents the fraction of the detected memory limit to allocate for the Go runtime (default: 0.9).
+
+## Examples
+
+```yaml
+extension:
+    # processor name: cgroupruntime
+    cgroupruntime:
+      gomaxprocs:
+        enable: true
+      gomemlimit:
+        enable: true
+        ratio: 0.8
+```

extension/cgroupruntimeextension/config.go

@@ -0,0 +1,28 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package cgroupruntimeextension // import "github.com/open-telemetry/opentelemetry-collector-contrib/extension/cgroupruntimeextension"
+
+import "errors" // Config contains the configuration for the cgroup runtime extension.
+
+type Config struct {
+	GoMaxProcs GoMaxProcsConfig `mapstructure:"gomaxprocs"`
+	GoMemLimit GoMemLimitConfig `mapstructure:"gomemlimit"`
+}
+
+type GoMaxProcsConfig struct {
+	Enabled bool `mapstructure:"enabled"`
+}
+
+type GoMemLimitConfig struct {
+	Enabled bool    `mapstructure:"enabled"`
+	Ratio   float64 `mapstructure:"ratio"`
+}
+
+// Validate checks if the extension configuration is valid
+func (cfg *Config) Validate() error {
+	if cfg.GoMemLimit.Ratio < 0 || cfg.GoMemLimit.Ratio > 1 {
+		return errors.New("gomemlimit ratio must be between 0 and 1")
+	}
+	return nil
+}

extension/cgroupruntimeextension/config_test.go

@@ -0,0 +1,73 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package cgroupruntimeextension
+
+import (
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/confmap/confmaptest"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/extension/cgroupruntimeextension/internal/metadata"
+)
+
+func TestLoadConfig(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		id                    component.ID
+		expected              component.Config
+		unmarshalErrorMessage string
+		validateErrorMessage  string
+	}{
+		{
+			id: component.NewID(metadata.Type),
+			expected: &Config{
+				GoMaxProcs: GoMaxProcsConfig{Enabled: true},
+				GoMemLimit: GoMemLimitConfig{
+					Enabled: true,
+					Ratio:   0.9,
+				},
+			},
+		},
+		{
+			id:                   component.NewIDWithName(metadata.Type, "invalid_ratio"),
+			validateErrorMessage: "gomemlimit ratio must be between 0 and 1",
+		},
+		{
+			id:                    component.NewIDWithName(metadata.Type, "invalid_ratio_type"),
+			unmarshalErrorMessage: "decoding failed due to the following error(s):\n\n'gomemlimit.ratio' expected type 'float64', got unconvertible type 'string', value: 'not_valid'",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.id.String(), func(t *testing.T) {
+			cm, err := confmaptest.LoadConf(filepath.Join("testdata", "config.yaml"))
+			require.NoError(t, err)
+
+			factory := NewFactory()
+			cfg := factory.CreateDefaultConfig()
+
+			sub, err := cm.Sub(tt.id.String())
+			require.NoError(t, err)
+
+			if tt.unmarshalErrorMessage != "" {
+				assert.ErrorContains(t, sub.Unmarshal(cfg), tt.unmarshalErrorMessage)
+				return
+			}
+			require.NoError(t, sub.Unmarshal(cfg))
+
+			if tt.validateErrorMessage != "" {
+				assert.EqualError(t, component.ValidateConfig(cfg), tt.validateErrorMessage)
+				return
+			}
+
+			assert.NoError(t, component.ValidateConfig(cfg))
+			assert.Equal(t, tt.expected, cfg)
+		})
+	}
+}

extension/cgroupruntimeextension/doc.go

@@ -0,0 +1,6 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+//go:generate mdatagen metadata.yaml
+
+package cgroupruntimeextension // import "github.com/open-telemetry/opentelemetry-collector-contrib/extension/cgroupruntimeextension"

extension/cgroupruntimeextension/extension.go

@@ -0,0 +1,77 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package cgroupruntimeextension // import "github.com/open-telemetry/opentelemetry-collector-contrib/extension/cgroupruntimeextension"
+
+import (
+	"context"
+	"runtime"
+	"runtime/debug"
+
+	"go.opentelemetry.io/collector/component"
+	"go.uber.org/zap"
+)
+
+type (
+	undoFunc            func()
+	maxProcsFn          func() (undoFunc, error)
+	memLimitWithRatioFn func(float64) (undoFunc, error)
+)
+
+type cgroupRuntimeExtension struct {
+	config *Config
+	logger *zap.Logger
+
+	// runtime modifiers
+	maxProcsFn
+	undoMaxProcsFn undoFunc
+
+	memLimitWithRatioFn
+	undoMemLimitFn undoFunc
+}
+
+func newCgroupRuntime(cfg *Config, logger *zap.Logger, maxProcsFn maxProcsFn, memLimitFn memLimitWithRatioFn) *cgroupRuntimeExtension {
+	return &cgroupRuntimeExtension{
+		config:              cfg,
+		logger:              logger,
+		maxProcsFn:          maxProcsFn,
+		memLimitWithRatioFn: memLimitFn,
+	}
+}
+
+func (c *cgroupRuntimeExtension) Start(_ context.Context, _ component.Host) error {
+	var err error
+	if c.config.GoMaxProcs.Enabled {
+		c.undoMaxProcsFn, err = c.maxProcsFn()
+		if err != nil {
+			return err
+		}
+
+		c.logger.Info("GOMAXPROCS has been set",
+			zap.Int("GOMAXPROCS", runtime.GOMAXPROCS(-1)),
+		)
+	}
+
+	if c.config.GoMemLimit.Enabled {
+		c.undoMemLimitFn, err = c.memLimitWithRatioFn(c.config.GoMemLimit.Ratio)
+		if err != nil {
+			return err
+		}
+
+		c.logger.Info("GOMEMLIMIT has been set",
+			zap.Int64("GOMEMLIMIT", debug.SetMemoryLimit(-1)),
+		)
+	}
+	return nil
+}
+
+func (c *cgroupRuntimeExtension) Shutdown(_ context.Context) error {
+	if c.undoMaxProcsFn != nil {
+		c.undoMaxProcsFn()
+	}
+	if c.undoMemLimitFn != nil {
+		c.undoMemLimitFn()
+	}
+
+	return nil
+}

extension/cgroupruntimeextension/extension_test.go

@@ -0,0 +1,67 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package cgroupruntimeextension
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/collector/component/componenttest"
+	"go.opentelemetry.io/collector/extension/extensiontest"
+)
+
+func TestExtension(t *testing.T) {
+	tests := []struct {
+		name          string
+		config        *Config
+		expectedCalls int
+	}{
+		{
+			name: "all enabled",
+			config: &Config{
+				GoMaxProcs: GoMaxProcsConfig{
+					Enabled: true,
+				},
+				GoMemLimit: GoMemLimitConfig{
+					Enabled: true,
+					Ratio:   0.5,
+				},
+			},
+			expectedCalls: 4,
+		},
+		{
+			name: "everything disabled",
+			config: &Config{
+				GoMaxProcs: GoMaxProcsConfig{
+					Enabled: false,
+				},
+				GoMemLimit: GoMemLimitConfig{
+					Enabled: false,
+				},
+			},
+			expectedCalls: 0,
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			allCalls := 0
+			var _err error
+			setterMock := func() (undoFunc, error) {
+				allCalls++
+				return func() { allCalls++ }, _err
+			}
+			settings := extensiontest.NewNopSettings()
+			cg := newCgroupRuntime(test.config, settings.Logger, setterMock, func(_ float64) (undoFunc, error) { return setterMock() })
+			ctx := context.Background()
+
+			err := cg.Start(ctx, componenttest.NewNopHost())
+			require.NoError(t, err)
+
+			require.NoError(t, cg.Shutdown(ctx))
+			require.Equal(t, test.expectedCalls, allCalls)
+		})
+	}
+}