io.hyperfoil.api.config.SLA Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hyperfoil-api Show documentation
There is a newer version: 0.27
/*
 * Copyright 2018 Red Hat Inc. and/or its affiliates and other contributors
 * as indicated by the @authors tag. All rights reserved.
 * See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * 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 io.hyperfoil.api.config;

import java.io.Serializable;
import java.util.Collection;
import java.util.Collections;

import io.hyperfoil.api.statistics.StatisticsSnapshot;

public class SLA implements Serializable {
   private final long window;
   private final double errorRatio;
   private final double invalidRatio;
   private final long meanResponseTime;
   private final double blockedRatio;
   private final Collection limits;

   public SLA(long window, double errorRatio, double invalidRatio, long meanResponseTime, double blockedRatio, Collection limits) {
      this.window = window;
      this.meanResponseTime = meanResponseTime;
      this.errorRatio = errorRatio;
      this.invalidRatio = invalidRatio;
      this.blockedRatio = blockedRatio;
      this.limits = limits;
   }

   public long window() {
      return window;
   }

   public double errorRatio() {
      return errorRatio;
   }

   public double invalidRatio() {
      return invalidRatio;
   }

   public long meanResponseTime() {
      return meanResponseTime;
   }

   public double blockedRatio() {
      return blockedRatio;
   }

   public Collection percentileLimits() {
      return Collections.unmodifiableCollection(limits);
   }

   public SLA.Failure validate(String phase, String metric, StatisticsSnapshot statistics) {
      double actualErrorRatio = (double) statistics.errors() / statistics.requestCount;
      if (statistics.errors() > 0 && actualErrorRatio >= errorRatio) {
         return new SLA.Failure(this, phase, metric, statistics.clone(),
               String.format("Error ratio exceeded: required %.3f, actual %.3f", errorRatio, actualErrorRatio));
      }
      // Note: when a handler throws an exception the request is marked as invalid.
      // However the response is not recorded (because we might not be finished reading the response).
      // Therefore we rather compute the ration from requests to make sure invalid <= all.
      double actualInvalidRatio = statistics.responseCount == 0 ? 0 : (double) statistics.invalid / statistics.requestCount;
      if (statistics.invalid > 0 && actualInvalidRatio >= invalidRatio) {
         return new SLA.Failure(this, phase, metric, statistics.clone(),
               String.format("Invalid response ratio exceeded: required %.3f, actual %.3f", invalidRatio, actualInvalidRatio));
      }
      if (meanResponseTime < Long.MAX_VALUE) {
         double mean = statistics.histogram.getMean();
         if (mean >= meanResponseTime) {
            return new SLA.Failure(this, phase, metric, statistics.clone(),
                  String.format("Mean response time exceeded: required %d, actual %.3f", meanResponseTime, mean));
         }
      }
      if (statistics.blockedTime > 0) {
         double actualBlockedRatio = statistics.blockedTime / (statistics.blockedTime + statistics.histogram.getMean() * statistics.histogram.getTotalCount());
         if (actualBlockedRatio > blockedRatio) {
            return new SLA.Failure(this, phase, metric, statistics.clone(),
                  String.format("Progress was blocked waiting for a free connection. Hint: increase http.sharedConnections."));
         }
      }
      for (SLA.PercentileLimit limit : limits) {
         long value = statistics.histogram.getValueAtPercentile(limit.percentile());
         if (value >= limit.responseTime()) {
            return new SLA.Failure(this, phase, metric, statistics.clone(),
                  String.format("Response time at percentile %f exceeded: required %d, actual %d", limit.percentile, limit.responseTime, value));
         }
      }
      return null;
   }

   public static class PercentileLimit implements Serializable {
      private final double percentile;
      private final long responseTime;

      public PercentileLimit(double percentile, long responseTime) {
         this.percentile = percentile;
         this.responseTime = responseTime;
      }

      public double percentile() {
         return percentile;
      }

      /**
       * @return Maximum allowed response time for given percentile, in nanoseconds.
       */
      public long responseTime() {
         return responseTime;
      }
   }

   public static class Failure {
      private final SLA sla;
      private final String phase;
      private final String metric;
      private final StatisticsSnapshot statistics;
      private final String message;

      public Failure(SLA sla, String phase, String metric, StatisticsSnapshot statistics, String message) {
         this.sla = sla;
         this.phase = phase;
         this.metric = metric;
         this.statistics = statistics;
         this.message = message;
      }

      public SLA sla() {
         return sla;
      }

      public String phase() {
         return phase;
      }

      public String metric() {
         return metric;
      }

      public StatisticsSnapshot statistics() {
         return statistics;
      }

      public String message() {
         return message;
      }
   }

   public interface Provider extends Step {
      /**
       * @return Step ID that will allow us to match against the SLA.
       */
      int id();

      SLA[] sla();
   }
}