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

     1  /*
     2  Copyright 2019 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  	"time"
    22  
    23  	"k8s.io/klog/v2"
    24  	"k8s.io/perf-tests/clusterloader2/pkg/errors"
    25  	"k8s.io/perf-tests/clusterloader2/pkg/measurement"
    26  	measurementutil "k8s.io/perf-tests/clusterloader2/pkg/measurement/util"
    27  	"k8s.io/perf-tests/clusterloader2/pkg/util"
    28  )
    29  
    30  const (
    31  	metricsServerPrometheusMeasurementName = "MetricsServerPrometheus"
    32  
    33  	metricsServerLatencyQuery = `histogram_quantile(%v, sum(rate(%v_bucket{group="metrics.k8s.io",resource="pods",scope="cluster"}[%v])) by (le))`
    34  )
    35  
    36  var (
    37  	desiredMsPercentiles = []float64{0.5, 0.9, 0.99}
    38  )
    39  
    40  func init() {
    41  	create := func() measurement.Measurement { return CreatePrometheusMeasurement(&metricsServerGatherer{}) }
    42  	if err := measurement.Register(metricsServerPrometheusMeasurementName, create); err != nil {
    43  		klog.Fatalf("Cannot register %s: %v", metricsServerPrometheusMeasurementName, err)
    44  	}
    45  }
    46  
    47  type metricsServerGatherer struct{}
    48  
    49  func (g *metricsServerGatherer) Gather(executor QueryExecutor, startTime, endTime time.Time, config *measurement.Config) ([]measurement.Summary, error) {
    50  	latencyMetrics, err := g.gatherLatencyMetrics(executor, startTime, endTime, config)
    51  	if err != nil {
    52  		return nil, err
    53  	}
    54  	content, err := util.PrettyPrintJSON(latencyMetrics)
    55  	if err != nil {
    56  		return nil, err
    57  	}
    58  	summaries := []measurement.Summary{measurement.CreateSummary(metricsServerPrometheusMeasurementName, "json", content)}
    59  	return summaries, nil
    60  }
    61  
    62  func (g *metricsServerGatherer) Configure(config *measurement.Config) error {
    63  	return nil
    64  }
    65  
    66  func (g *metricsServerGatherer) IsEnabled(config *measurement.Config) bool {
    67  	return config.CloudProvider.Features().SupportMetricsServerMetrics
    68  }
    69  
    70  func (g *metricsServerGatherer) String() string {
    71  	return metricsServerPrometheusMeasurementName
    72  }
    73  
    74  func (g *metricsServerGatherer) gatherLatencyMetrics(executor QueryExecutor, startTime, endTime time.Time, config *measurement.Config) (*measurementutil.LatencyMetric, error) {
    75  	measurementDuration := endTime.Sub(startTime)
    76  	promDuration := measurementutil.ToPrometheusTime(measurementDuration)
    77  	apiserverSLI := measurementutil.GetApiserverSLI(config.ClusterVersion)
    78  
    79  	errList := errors.NewErrorList()
    80  	result := &measurementutil.LatencyMetric{}
    81  
    82  	for _, percentile := range desiredMsPercentiles {
    83  
    84  		query := fmt.Sprintf(metricsServerLatencyQuery, percentile, apiserverSLI, promDuration)
    85  		samples, err := executor.Query(query, endTime)
    86  		if err != nil {
    87  			errList.Append(fmt.Errorf("failed to execute query %q, err - %v", query, err))
    88  			continue
    89  		}
    90  
    91  		if len(samples) != 1 {
    92  			errList.Append(fmt.Errorf("got unexpected number of samples: %d for query %q", len(samples), query))
    93  			continue
    94  		}
    95  
    96  		result.SetQuantile(percentile, time.Duration(float64(samples[0].Value)*float64(time.Second)))
    97  	}
    98  
    99  	if !errList.IsEmpty() {
   100  		return nil, fmt.Errorf("failed to compute latencies, errors - %s", errList.Error())
   101  	}
   102  
   103  	return result, nil
   104  }