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

     1  /*
     2  Copyright 2020 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  	"time"
    21  )
    22  
    23  type apiAvailabilityMetrics struct {
    24  	numSuccesses               int
    25  	numFailures                int
    26  	maxConsecutiveFailedProbes int
    27  	consecutiveFailedProbes    int
    28  }
    29  
    30  type apiAvailabilitySummary struct {
    31  	IP                       string  `json:"IP,omitempty"`
    32  	AvailabilityPercentage   float64 `json:"availabilityPercentage"`
    33  	LongestUnavailablePeriod string  `json:"longestUnavailablePeriod"`
    34  }
    35  
    36  type apiAvailabilityOutput struct {
    37  	ClusterSummary apiAvailabilitySummary   `json:"clusterMetrics"`
    38  	HostSummaries  []apiAvailabilitySummary `json:"hostMetrics"`
    39  }
    40  
    41  func (a *apiAvailabilityMetrics) update(availability bool) {
    42  	if availability {
    43  		a.numSuccesses++
    44  		a.consecutiveFailedProbes = 0
    45  		return
    46  	}
    47  	a.numFailures++
    48  	a.consecutiveFailedProbes++
    49  	if a.consecutiveFailedProbes > a.maxConsecutiveFailedProbes {
    50  		a.maxConsecutiveFailedProbes = a.consecutiveFailedProbes
    51  	}
    52  }
    53  
    54  func (a *apiAvailabilityMetrics) buildSummary(pollFrequency time.Duration, hostIP string) apiAvailabilitySummary {
    55  	availabilityPercentage := float64(100)
    56  	if a.numSuccesses > 0 || a.numFailures > 0 {
    57  		availabilityPercentage = (float64(a.numSuccesses) / float64(a.numSuccesses+a.numFailures)) * 100
    58  	}
    59  	longestUnavailablePeriod := time.Duration(a.maxConsecutiveFailedProbes) * pollFrequency
    60  	return apiAvailabilitySummary{
    61  		AvailabilityPercentage:   availabilityPercentage,
    62  		LongestUnavailablePeriod: longestUnavailablePeriod.String(),
    63  		IP:                       hostIP,
    64  	}
    65  }
    66  
    67  func createHostSummary(metrics map[string]*apiAvailabilityMetrics, hostIPs []string, pollFrequency time.Duration) []apiAvailabilitySummary {
    68  	summaries := []apiAvailabilitySummary{}
    69  	for _, ip := range hostIPs {
    70  		hostSummary := metrics[ip].buildSummary(pollFrequency, ip)
    71  		summaries = append(summaries, hostSummary)
    72  	}
    73  	return summaries
    74  }
    75  
    76  func createClusterSummary(metrics *apiAvailabilityMetrics, pollFrequency time.Duration) apiAvailabilitySummary {
    77  	return metrics.buildSummary(pollFrequency, "")
    78  }