make intel resource control collector optional

dims · dims · commit 616ec6ee11bd · 2025-03-01T18:50:00.000-05:00
Signed-off-by: Davanum Srinivas &lt;davanum@gmail.com&gt;
diff --git a/manager/manager.go b/manager/manager.go
@@ -221,7 +221,7 @@ func New(memoryCache *memory.InMemoryCache, sysfs sysfs.SysFs, HousekeepingConfi
 		return nil, err
 	}
 
-	newManager.resctrlManager, err = resctrl.NewManager(resctrlInterval, resctrl.Setup, machineInfo.CPUVendorID, inHostNamespace)
+	newManager.resctrlManager, err = resctrl.NewManager(resctrlInterval, machineInfo.CPUVendorID, inHostNamespace)
 	if err != nil {
 		klog.V(4).Infof("Cannot gather resctrl metrics: %v", err)
 	}
@@ -264,8 +264,8 @@ type manager struct {
 	containerWatchers        []watcher.ContainerWatcher
 	eventsChannel            chan watcher.ContainerEvent
 	collectorHTTPClient      *http.Client
-	perfManager              stats.Manager
-	resctrlManager           resctrl.Manager
+	perfManager    stats.Manager
+	resctrlManager resctrl.Manager
 	// List of raw container cgroup path prefix whitelist.
 	rawContainerCgroupPathPrefixWhiteList []string
 	// List of container env prefix whitelist, the matched container envs would be collected into metrics as extra labels.
diff --git a/resctrl/intel/collector.go b/resctrl/intel/collector.go
@@ -16,7 +16,7 @@
 // limitations under the License.
 
 // Collector of resctrl for a container.
-package resctrl
+package intel
 
 import (
 	"fmt"
diff --git a/resctrl/intel/collector_test.go b/resctrl/intel/collector_test.go
@@ -16,7 +16,7 @@
 // limitations under the License.
 
 // Collector tests.
-package resctrl
+package intel
 
 import (
 	"fmt"
diff --git a/resctrl/intel/install/install.go b/resctrl/intel/install/install.go
@@ -0,0 +1,28 @@
+// Copyright 2025 Google Inc. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package install
+
+import (
+	"github.com/google/cadvisor/resctrl"
+	"github.com/google/cadvisor/resctrl/intel"
+	"k8s.io/klog/v2"
+)
+
+func init() {
+	err := resctrl.RegisterManager("intel", &intel.IntelManager{})
+	if err != nil {
+		klog.Fatalf("Failed to register resource control plugin: %v", err)
+	}
+}
diff --git a/resctrl/intel/manager.go b/resctrl/intel/manager.go
@@ -0,0 +1,68 @@
+//go:build linux
+// +build linux
+
+// Copyright 2021 Google Inc. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package intel
+
+import (
+	"errors"
+	"time"
+
+	"k8s.io/klog/v2"
+
+	"github.com/google/cadvisor/container/raw"
+	"github.com/google/cadvisor/stats"
+)
+
+type IntelManager struct {
+	stats.NoopDestroy
+	interval        time.Duration
+	vendorID        string
+	inHostNamespace bool
+}
+
+func (m *IntelManager) GetCollector(containerName string, getContainerPids func() ([]string, error), numberOfNUMANodes int) (stats.Collector, error) {
+	collector := newCollector(containerName, getContainerPids, m.interval, numberOfNUMANodes, m.vendorID, m.inHostNamespace)
+	err := collector.setup()
+	if err != nil {
+		return &stats.NoopCollector{}, err
+	}
+
+	return collector, nil
+}
+
+func (m *IntelManager) Init(interval time.Duration, vendorID string, inHostNamespace bool) error {
+	err := Setup()
+	if err != nil {
+		return err
+	}
+
+	if !isResctrlInitialized {
+		return errors.New("the resctrl isn't initialized")
+	}
+	if !(enabledCMT || enabledMBM) {
+		return errors.New("there are no monitoring features available")
+	}
+
+	if !*raw.DockerOnly {
+		klog.Warning("--docker_only should be set when collecting Resctrl metrics! See the runtime docs.")
+	}
+
+	m.interval = interval
+	m.vendorID = vendorID
+	m.inHostNamespace = inHostNamespace
+	return nil
+}
diff --git a/resctrl/intel/manager_test.go b/resctrl/intel/manager_test.go
@@ -16,12 +16,13 @@
 // limitations under the License.
 
 // Manager tests.
-package resctrl
+package intel
 
 import (
 	"os"
 	"testing"
 
+	"github.com/google/cadvisor/resctrl"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -32,7 +33,7 @@ func TestNewManager(t *testing.T) {
 		enabledMBM           bool
 		inHostNamespace      bool
 		err                  string
-		expected             Manager
+		expected             resctrl.Manager
 	}{
 		{
 			true,
@@ -64,39 +65,39 @@ func TestNewManager(t *testing.T) {
 			false,
 			false,
 			"the resctrl isn't initialized",
-			&NoopManager{},
+			&resctrl.NoopManager{},
 		},
 		{
 			false,
 			false,
 			true,
 			false,
 			"the resctrl isn't initialized",
-			&NoopManager{},
+			&resctrl.NoopManager{},
 		},
 		{
 			false,
 			true,
 			true,
 			true,
 			"the resctrl isn't initialized",
-			&NoopManager{},
+			&resctrl.NoopManager{},
 		},
 		{
 			false,
 			false,
 			false,
 			true,
 			"the resctrl isn't initialized",
-			&NoopManager{},
+			&resctrl.NoopManager{},
 		},
 		{
 			true,
 			false,
 			false,
 			true,
 			"there are no monitoring features available",
-			&NoopManager{},
+			&resctrl.NoopManager{},
 		},
 	}
 
diff --git a/resctrl/intel/testing/tasks_empty b/resctrl/intel/testing/tasks_empty
diff --git a/resctrl/intel/testing/tasks_invalid b/resctrl/intel/testing/tasks_invalid
diff --git a/resctrl/intel/testing/tasks_one b/resctrl/intel/testing/tasks_one
diff --git a/resctrl/intel/testing/tasks_two b/resctrl/intel/testing/tasks_two
diff --git a/resctrl/intel/utils.go b/resctrl/intel/utils.go
@@ -16,7 +16,7 @@
 // limitations under the License.
 
 // Utilities.
-package resctrl
+package intel
 
 import (
 	"bufio"
diff --git a/resctrl/intel/utils_test.go b/resctrl/intel/utils_test.go
@@ -20,7 +20,7 @@
 // Mocked environment:
 // - "container" first container with {1, 2, 3} processes.
 // - "another" second container with {5, 6} processes.
-package resctrl
+package intel
 
 import (
 	"fmt"
diff --git a/resctrl/manager.go b/resctrl/manager.go
@@ -1,79 +1,53 @@
-//go:build linux
-// +build linux
-
-// Copyright 2021 Google Inc. All Rights Reserved.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-// Manager of resctrl for containers.
 package resctrl
 
 import (
-	"errors"
-	"time"
-
-	"k8s.io/klog/v2"
-
-	"github.com/google/cadvisor/container/raw"
+	"fmt"
 	"github.com/google/cadvisor/stats"
+	"k8s.io/klog/v2"
+	"sync"
+	"time"
 )
 
+// Manager of resctrl for containers.
 type Manager interface {
 	Destroy()
 	GetCollector(containerName string, getContainerPids func() ([]string, error), numberOfNUMANodes int) (stats.Collector, error)
+	Init(interval time.Duration, id string, namespace bool) error
 }
 
-type manager struct {
-	stats.NoopDestroy
-	interval        time.Duration
-	vendorID        string
-	inHostNamespace bool
-}
+// All registered resource control plugins.
+var managersLock sync.Mutex
+var managers = make(map[string]Manager)
 
-func (m *manager) GetCollector(containerName string, getContainerPids func() ([]string, error), numberOfNUMANodes int) (stats.Collector, error) {
-	collector := newCollector(containerName, getContainerPids, m.interval, numberOfNUMANodes, m.vendorID, m.inHostNamespace)
-	err := collector.setup()
-	if err != nil {
-		return &stats.NoopCollector{}, err
+func RegisterManager(name string, manager Manager) error {
+	managersLock.Lock()
+	defer managersLock.Unlock()
+	if _, found := managers[name]; found {
+		return fmt.Errorf("Plugin %q was registered twice", name)
 	}
-
-	return collector, nil
-}
-
-func NewManager(interval time.Duration, setup func() error, vendorID string, inHostNamespace bool) (Manager, error) {
-	err := setup()
-	if err != nil {
-		return &NoopManager{}, err
-	}
-
-	if !isResctrlInitialized {
-		return &NoopManager{}, errors.New("the resctrl isn't initialized")
-	}
-	if !(enabledCMT || enabledMBM) {
-		return &NoopManager{}, errors.New("there are no monitoring features available")
-	}
-
-	if !*raw.DockerOnly {
-		klog.Warning("--docker_only should be set when collecting Resctrl metrics! See the runtime docs.")
-	}
-
-	return &manager{interval: interval, vendorID: vendorID, inHostNamespace: inHostNamespace}, nil
+	klog.V(4).Infof("Registered Plugin %q", name)
+	managers[name] = manager
+	return nil
 }
 
 type NoopManager struct {
 	stats.NoopDestroy
 }
 
+func (np *NoopManager) Init(_ time.Duration, _ string, _ bool) error {
+	return nil
+}
+
 func (np *NoopManager) GetCollector(_ string, _ func() ([]string, error), _ int) (stats.Collector, error) {
 	return &stats.NoopCollector{}, nil
 }
+
+func NewManager(interval time.Duration, vendorID string, inHostNamespace bool) (Manager, error) {
+	if len(managers) == 0 {
+		return &NoopManager{}, nil
+	}
+	// Currently only intel manager is supported
+	manager := managers["intel"]
+	manager.Init(interval, vendorID, inHostNamespace)
+	return manager, nil
+}
