k8s.io/perf-tests/clusterloader2@v0.0.0-20240304094227-64bdb12da87e/pkg/measurement/common/metrics_for_e2e.go (about)

     1  /*
     2  Copyright 2018 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package common
    18  
    19  import (
    20  	"fmt"
    21  
    22  	"k8s.io/klog/v2"
    23  
    24  	"k8s.io/perf-tests/clusterloader2/pkg/measurement"
    25  	"k8s.io/perf-tests/clusterloader2/pkg/measurement/common/metrics"
    26  	"k8s.io/perf-tests/clusterloader2/pkg/util"
    27  )
    28  
    29  const (
    30  	metricsForE2EName = "MetricsForE2E"
    31  )
    32  
    33  var interestingKubeletMetricsLabels = []string{
    34  	"kubelet_container_manager_latency_microseconds",
    35  	"kubelet_docker_errors",
    36  	"kubelet_docker_operations_latency_microseconds",
    37  	"kubelet_generate_pod_status_latency_microseconds",
    38  	"kubelet_pod_start_latency_microseconds",
    39  	"kubelet_pod_worker_latency_microseconds",
    40  	"kubelet_pod_worker_start_latency_microseconds",
    41  	"kubelet_sync_pods_latency_microseconds",
    42  }
    43  
    44  func init() {
    45  	if err := measurement.Register(metricsForE2EName, createmetricsForE2EMeasurement); err != nil {
    46  		klog.Fatalf("Cannot register %s: %v", metricsForE2EName, err)
    47  	}
    48  }
    49  
    50  func createmetricsForE2EMeasurement() measurement.Measurement {
    51  	return &metricsForE2EMeasurement{}
    52  }
    53  
    54  type metricsForE2EMeasurement struct{}
    55  
    56  // Execute gathers and prints e2e metrics data.
    57  func (m *metricsForE2EMeasurement) Execute(config *measurement.Config) ([]measurement.Summary, error) {
    58  	provider := config.ClusterFramework.GetClusterConfig().Provider
    59  
    60  	grabMetricsFromKubelets, err := util.GetBoolOrDefault(config.Params, "gatherKubeletsMetrics", false)
    61  	if err != nil {
    62  		return nil, err
    63  	}
    64  	grabMetricsFromKubelets = grabMetricsFromKubelets && provider.Features().SupportGrabMetricsFromKubelets
    65  
    66  	grabber, err := metrics.NewMetricsGrabber(
    67  		config.ClusterFramework.GetClientSets().GetClient(),
    68  		nil, /*external client*/
    69  		grabMetricsFromKubelets,
    70  		true, /*grab metrics from scheduler*/
    71  		true, /*grab metrics from controller manager*/
    72  		true, /*grab metrics from apiserver*/
    73  		false /*grab metrics from cluster autoscaler*/)
    74  	if err != nil {
    75  		return nil, fmt.Errorf("failed to create MetricsGrabber: %v", err)
    76  	}
    77  	// Grab apiserver, scheduler, controller-manager metrics and (optionally) nodes' kubelet metrics.
    78  	received, err := grabber.Grab()
    79  	if err != nil {
    80  		klog.Errorf("%s: metricsGrabber failed to grab some of the metrics: %v", m, err)
    81  	}
    82  	filterMetrics(&received)
    83  	content, jsonErr := util.PrettyPrintJSON(received)
    84  	if jsonErr != nil {
    85  		return nil, jsonErr
    86  	}
    87  	summary := measurement.CreateSummary(metricsForE2EName, "json", content)
    88  	return []measurement.Summary{summary}, err
    89  }
    90  
    91  // Dispose cleans up after the measurement.
    92  func (m *metricsForE2EMeasurement) Dispose() {}
    93  
    94  // String returns string representation of this measurement.
    95  func (*metricsForE2EMeasurement) String() string {
    96  	return metricsForE2EName
    97  }
    98  
    99  func filterMetrics(m *metrics.Collection) {
   100  	interestingKubeletMetrics := make(map[string]metrics.KubeletMetrics)
   101  	for kubelet, grabbed := range (*m).KubeletMetrics {
   102  		interestingKubeletMetrics[kubelet] = make(metrics.KubeletMetrics)
   103  		for _, metric := range interestingKubeletMetricsLabels {
   104  			interestingKubeletMetrics[kubelet][metric] = grabbed[metric]
   105  		}
   106  	}
   107  	(*m).KubeletMetrics = interestingKubeletMetrics
   108  }