This example shows how PodDisruptor can be used for testing the effect of faults injected in the HTTP requests served by a pod.
You will find the complete source code at the end of this document. Next sections examine the code in detail.
The example uses httpbin, a simple request/response application that offers endpoints for testing different HTTP requests.
The test requires httpbin to be deployed in a cluster in the namespace httpbin and exposed with an external IP. the IP address is expected in the environment variable SVC_IP.
You will find the Kubernetes manifests and the instructions of how to deploy it to a cluster in the test setup section at the end of this document. You can learn more about how to get the external IP address in the expose your application section.
The initialization code imports the external dependencies required by the test. The PodDisruptor class imported from the xk6-disruptor extension provides functions for injecting faults in pods. The k6/http module provides functions for executing HTTP requests.
The test load is generated by the default function, which executes a request to the httpbin pod using the IP obtained from the environment variable SVC_IP. The test makes requests to the endpoint delay/0.1 which will return after 0.1 seconds (100ms).
The test uses the delay endpoint which return after the requested delay. It requests a 0.1s (100ms) delay to ensure the baseline scenario (see scenarios below) has meaningful statistics for the request duration. If we were simply calling a locally deployed http server (for example nginx), the response time would exhibit a large variation between a few microseconds to a few milliseconds. Having 100ms as baseline response time has proved to offer more consistent results.
The disrupt function creates a PodDisruptor using a selector that matches pods in the namespace httpbin with the label app: httpbin.
The http faults are injected by calling the PodDisruptor.injectHTTPFaults method using a fault definition that introduces a delay of 50ms on each request and an error code 500 in 10% of the requests.
Notice the following code snippet in the injectFaults function above:
This code makes the function return without injecting faults if the SKIP_FAULTS environment variable is passed to the execution of the test with a value of "1". We will use this option to obtain a baseline execution without faults.
This test defines two scenarios to be executed. The load scenario applies the test load to the httpbin application for 30s invoking the default function. The disrupt scenario invokes the disrupt function to inject a fault in the HTTP requests of the target application.
Notice that the disrupt scenario uses a shared-iterations executor with one iteration and one VU. This setting ensures the disrupt function is executed only once. Executing this function multiples times concurrently may have unpredictable results.
The commands in this section assume the xk6-disruptor binary is available in your current directory. This location can change depending on the installation process and the platform. Refer to the installation section for details on how to install it in your environment.
We will first execute the test without introducing faults to have an baseline using the following command:
Notice the argument --env SKIP_FAULT=1 which makes the disrupt function to return without injecting any fault as explained in the fault injection section above. Also notice the --env SVC_IP=$SVC_IP argument which passes the external IP used to access the httpbin application.
You should get an output similar to the one shown below (click Expand button to see all output).
We repeat the execution injecting the faults. Notice we have removed the --env SKIP_FAULTS=1 argument.
Let's take a closer look at the results for the requests on each scenario. We can observe that he base scenario has an average of 103ms and an error rate of 0% while the faults scenario has a median around 151.9ms and an error rate of nearly 10%, matching the definition of the faults defined in the disruptor.
|Execution||Avg. Response||Failed requests|
|Fault injection||151.9 ms||9.65%|
Notice we have used the average response time reported as expected_response:true because this metric only consider successful requests while http_req_duration considers all requests, including those returning a fault.
The tests requires the deployment of the httpbin application. The application must also be accessible using an external IP available in the SVC_IP environment variable.
The manifests below define the resources required for deploying the application and exposing it as a LoadBalancer service.
You can deploy the application using the following commands:
You can retrieve the resources using the following command:
You can retrieve the external IP address in the environment variable SVC_IP using the following command: