github.com/google/cadvisor@v0.49.1/utils/cpuload/cpuload.go (about)

     1  // Copyright 2015 Google Inc. All Rights Reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package cpuload
    16  
    17  import (
    18  	"fmt"
    19  
    20  	info "github.com/google/cadvisor/info/v1"
    21  
    22  	"k8s.io/klog/v2"
    23  
    24  	"github.com/google/cadvisor/utils/cpuload/netlink"
    25  )
    26  
    27  type CpuLoadReader interface {
    28  	// Start the reader.
    29  	Start() error
    30  
    31  	// Stop the reader and clean up internal state.
    32  	Stop()
    33  
    34  	// Retrieve Cpu load for a given group.
    35  	// name is the full hierarchical name of the container.
    36  	// Path is an absolute filesystem path for a container under CPU cgroup hierarchy.
    37  	GetCpuLoad(name string, path string) (info.LoadStats, error)
    38  }
    39  
    40  func New() (CpuLoadReader, error) {
    41  	reader, err := netlink.New()
    42  	if err != nil {
    43  		return nil, fmt.Errorf("failed to create a netlink based cpuload reader: %v", err)
    44  	}
    45  	klog.V(4).Info("Using a netlink-based load reader")
    46  	return reader, nil
    47  }