# What is Ddosify? Test, Observe and Detect in a Single Platform

Ddosify automatically generates Service Map of your K8s cluster

## What is Ddosify? Ddosify is an [open-source](https://github.com/ddosify/ddosify) **Kubernetes Monitoring** and **Performance Testing** platform**.** ### **🔎 Kubernetes Monitoring:** * **Automatic Service Map Creation:** Ddosify automatically creates a **service map** of your cluster without code instrumentation or sidecars. So you can easily find the bottlenecks in your system. * **Performance Insights:** It helps you spot issues like services taking too long to respond or slow SQL queries. * **Real-Time Metrics:** The platform tracks and displays live data on your cluster instances CPU, memory, disk, and network usage. * **Ease of Use:** You don't need to change any code, restart services, or add extra components (like sidecars) to get these insights, thanks to the eBPF technology. * **Alerts for Anomalies:** If something unusual, like a sudden increase in CPU usage, happens in your Kubernetes (K8s) cluster, Ddosify immediately sends alerts to your Slack.

Ddosify tracks and displays live data on your cluster instances CPU, memory, disk, and network usage.

### **🔨 Performance Testing:** * **Multi-Location Based:** Generate load/performance tests from over 25 countries worldwide. * **Easy Scenario Builder:** Create test scenarios easily without writing any code. * **Seamless Integration with Kubernetes Monitoring:** Performance testing is natively integrated with Kubernetes monitoring for a unified experience. * **Postman Integration:** Import tests directly from Postman, making it convenient for those already using Postman for API development and testing.

Ddosify generates load from worldwide with no-code scenario builder

## Ddosify Stack Ddosify Stack consists of 4 parts: * [Ddosify Engine](#ddosify-engine) * [Ddosify eBPF Agent (Alaz)](#ddosify-ebpf-agent-alaz) * [Ddosify Self-Hosted](#ddosify-self-hosted) * [Ddosify Cloud](#ddosify-cloud)

### 🚀 Ddosify Engine [Ddosify Engine](https://github.com/ddosify/ddosify) is the load engine, written in Golang. It's a CLI load-testing tool. Ddosify Self-Hosted and Ddosify Cloud use it under the hood for load generation. It is fully open-source and can be used on the CLI as a standalone tool. It has **\~8K** Github Stars. Ddosify Engine is available via [Docker](https://hub.docker.com/r/ddosify/ddosify), [Docker Extension](https://hub.docker.com/extensions/ddosify/ddosify-docker-extension), [Homebrew Tap](https://github.com/ddosify/ddosify#homebrew-tap-macos-and-linux), and downloadable pre-compiled binaries from the [releases page](https://github.com/ddosify/ddosify/releases/latest) for macOS, Linux, and Windows. Check out our [GitHub Page](https://github.com/ddosify/ddosify) for more information and usage. ### 🐝 Ddosify eBPF Agent (Alaz) [Alaz](https://github.com/ddosify/alaz) is an open-source Ddosify eBPF agent that can inspect and collect Kubernetes (K8s) service traffic without needing code instrumentation, sidecars, or service restarts. Alaz is deployed as a DaemonSet on your Kubernetes cluster. It collects metrics and service traffic and then sends them to Ddosify Cloud or Ddosify Self-Hosted. It is also Prometheus compatible, so that you can use it as a standalone tool. Check out the [Alaz](https://github.com/ddosify/alaz) repository for more information and usage. ### 🏠 Ddosify Self-Hosted [Ddosify Self-Hosted](https://github.com/ddosify/ddosify/tree/master/selfhosted) features a web-based user interface, **Performance Testing**, and **Kubernetes Monitoring** capabilities. You can add your servers as Load Engines to the platform for distributed performance testing. While it shares many of the same functionalities as Ddosify Cloud, the Self-Hosted version is designed to be deployed within your infrastructure for enhanced control and customization. It has two versions: Community Edition (CE) and Enterprise Edition (EE). You can see the differences in the below [comparison table](#comparison-of-ddosify-cloud-self-hosted-ee-self-hosted-ce). Check out our [Github Page](https://github.com/ddosify/ddosify/tree/master/selfhosted) for more information and usage. ### ☁️ Ddosify Cloud [Ddosify Cloud](https://app.ddosify.com/) features a SaaS, web-based user interface, multi-location-based **Performance Testing**, and **Kubernetes Monitoring**. Anyone can test the performance of backend endpoints, monitor Kubernetes Clusters, and find the bottlenecks in the system. It has a simple/no code UI, insightful charts, service maps, and more features. With Ddosify Cloud, you can generate traffic to your endpoints from 25+ countries without code or scripting. Check out [Ddosify Cloud](https://app.ddosify.com/) to find the performance issues on your system instantly. ## Comparison of Ddosify Cloud, Self-Hosted EE, Self-Hosted CE

Ddosify Cloud	Ddosify Self-Hosted (EE)	Ddosify Self-Hosted (CE)
✅ Kubernetes Monitoring	✅ Kubernetes Monitoring	✅ Kubernetes Monitoring
✅ Alerts	✅ Alerts	❌ Alerts
✅ Distributed Load Testing	✅ Distributed Load Testing	✅ Distributed Load Testing
✅ Assertion, Correlation, Test Data, Debugging	✅ Assertion, Correlation, Test Data, Debugging	✅ Assertion, Correlation, Test Data, Debugging
✅ Insightful Test Reports	✅ Insightful Test Reports	✅ Insightful Test Reports
✅ Postman Import	✅ Postman Import	✅ Postman Import
✅ Team Plan	✅ Team Plan	❌ Team Plan
✅ SSO	✅ SSO	❌ SSO
✅ API Integration	✅ API Integration	❌ API Integration
✅ Global Load Zones	❌ Load zones deployed by you	❌ Load zones deployed by you

{% hint style="info" %} **CE:** Community Edition **EE:** Enterprise Edition {% endhint %} # Getting Started

Ddosify detects high latency service calls on your K8s cluster

### Ddosify Features :white\_check\_mark: **Kubernetes Monitoring** Effortlessly visualize Kubernetes clusters as Service Map. Inspect HTTP latencies, find idle services, and get actionable insights. :white\_check\_mark: **No-code Performance Testing,** You can create complex and realistic user flows on Ddosify's No-code UI. Here are the list of key concepts on Ddosify's No-code UI. * [Parametrization](/ddosify/performance-testing/parametrization) * [Test Data Import](/ddosify/performance-testing/test-data-import) * [Environment Variables](/ddosify/performance-testing/environment-variables) * [Correlation](/ddosify/performance-testing/correlation) * [Assertion](/ddosify/performance-testing/assertion) * [Debugging](/ddosify/performance-testing/debugging) * [Postman Import](/ddosify/performance-testing/postman-import) :white\_check\_mark: **Detailed Reporting** Insightful reports and charts to improve your observations. Analyze the failed requests on UI. ### **How to start** ➡️ Follow the [Kubernetes Monitoring](/ddosify/kubernetes-monitoring) section to learn about effortless Kubernetes Monitoring using eBPF. ➡️ To understand how to set up no-code Performance/Load Testing using Ddosify Cloud or Ddosify Self-hosted, check [Performance Testing](/ddosify/performance-testing). # Dashboard The first page that welcomes you after logging in is the dashboard. Here, you can think of this page as a summary of your account. Through the dashboard, you can view your observability summary, latest load/latency tests, subscription status etc.

There are 7 sections in the dashboard: * Available Credits * Observability Stats * Load Test Stats * Latency Test Stats * Latest Load Test Runs * Latest Latency Test Runs * Usage Report ### Available Credits

Here, information about your plan and subscription status is written. Your Cloud and Self-Hosted plans differ and thus they are represented separately. You can also use the button below to change your subscription plan. ### Observability Stats

Here, you can view the number of clusters you’ve created and the latest data collected from any of them. You can also use the button below to create a new cluster. ### Load Test Stats

Here, you can view the total number of load test results and the number of test plans you have. You can also use the button below to create a new load test. ### Latency Test Stats

Here, you can view the total number of latency test plans and the number of schedulers you have. Schedulers are based on these test plans and they are designed to run regularly. You can also use the button below to create a new latency test. ### Latest Load Test Runs

Here, you can view your latest 5 load tests and their status. You can also click on the “List All” button to view all of your load test results. ### Latest Latency Test Runs

Here, you can view your latest 5 latency tests and their run counts along with the last run timestamp. You can also click on the “List All” button to view all of your latency test schedulers. ### Usage Report

Here, you can view your request count and duration usage summary for the last 30 days. You can see more details if you hover on the data:

# Pricing In Ddosify, you can choose from different subscription plans depending on your needs as upgrading your plan allows you to do more. You can compare different plans, evaluate what they offer depending on your requirements and pick the best option for you. Here’s how you can do that:

In the pricing page (that you can reach through the “Pricing” button that appears when you click on your user on the upper right corner), there are two tabs: Cloud and Self-Hosted. You can pick whichever one that suits your needs.

In Cloud, you can choose from the following: * Free * Small * Medium * Enterprise * Custom Here is a comparison between plans: | **Explanation** | **Feature** | **Free** | **Small** | **Medium** | **Enterprise** | **Custom** | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ----------------------- | --------------------------------------- | --------------------------------------- | ------------------------------------ | -------------------------------------------------------- | | Maximum number of Kubernetes nodes to observe | Kubernetes Nodes Count | 1 | 2 | 10 | 60 | Custom | | Once the data retention period has expired, you will no longer be able to access your observability data | Observability Data Retention | 1 Day | 2 Days | 3 Days | 7 Days | Custom | | Maximum number of active alerts | Alert Count | 3 | 5 | 10 | 25 | Custom | |

The request represents an individual network request fired by

Ddosify. Your request count balance will be decreased every time

Ddosify sent a network request.

Once the data retention period has expired, you will no longer be

able to access your information.

Technical support

| Support | Community (Best Effort) | Community (Business hours, 3 days max.) | Community (Business hours, 1 to 2 days) | Premium (Business Hours, 1 day max.) | Dedicated (Professional support through a Slack channel) | | Manage your team members and their access. | Team Management | No | No | No | Yes (Up to 5 users) | Yes | | Single Sign On (SSO) support like Okta, Onelogin etc. | SSO (Single Sign On) | No | No | No | Yes | Yes | In Self-Hosted, you can choose from the following: * Free * Enterprise * Custom |

| **Selfhosted Community** | **Selfhosted Enterprise** | **Custom** | | ----------------------------- | ------------------------ | ------------------------- | ----------------- | | Distributed Load Testing | Yes | Yes | Yes | | Kubernetes Cluster Monitoring | Up to 1 node | Up to 20 nodes | Custom | | Alert Count | No | Up to 25 alerts | Custom | | SSO | No | Yes | Yes | | Team Plan | No | Up to 5 users | Custom | | Support | Community Support | Premium support | Dedicated support | To pick the best option for you, you can compare the plans [here](https://app.ddosify.com/pricing). {% hint style="info" %} **Note:** If you wish to create your own plan, you can click on the “Contact Sales” button or send an email to to get in touch with us. {% endhint %} {% hint style="info" %} **Note:** You can’t simultaneously use paid plans in both Cloud and Self-Hosted. You can either pick one. If you upgrade your plan to Self-Hosted enterprise, you will only be able to use Ddosify Cloud in the free plan and vice versa. {% endhint %} To change your plan, you can use the buttons below them:

### Buying Your First Plan To upgrade your plan, you can click on the “Upgrade” button below your selected plan. This will take you to the payment pop-up. For handling payments, Ddosify uses Paddle as a payment provider and its security is guaranteed. To learn more, you can check [Paddle](https://www.paddle.com/).

After you fill your payment information and submit the form, you can start to use your plan right away. Your request count and duration will be updated according to your new plan. ### Upgrading Your Plan To upgrade your plan, you can click on the “Upgrade” button below your selected plan. First, a notification will show up:

After you click on “Approve”, your plan will be upgraded and you can start to use your new plan right away. Your request count and duration will be updated according to your new plan. ### Downgrading Your Plan To downgrade your plan, you can click on the “Downgrade” button below your selected plan. First, a notification will show up:

After you click on “Approve”, your plan will be downgraded. Then you can start to use your new plan right away. Your request count and duration will be updated with your new plan. ### Canceling Your Plan To cancel your plan, click on the “Downgrade” button below the free plan in the pricing page. Then, this pop-up will appear:

After you click on “Approve”, your plan will be canceled. However, you can continue to use your existing plan until the next billing cycle. The pricing page will look like this until then:

After the billing cycle, your plan will be turned into free. ### Updating Your Payment Information If you wish to update your payment information, you can send a mail to . {% hint style="success" %} If you require assistance with upgrading/downgrading/canceling your subscription plans or updating your payment information, you can join our[ Discord](https://discord.com/invite/9KdnrSUZQg) or send an email to . {% endhint %} # Kubernetes Monitoring {% embed url="" %} If you have a Kubernetes Cluster that you want to observe, look no further. Ddosify Observability allows you to monitor your Kubernetes Clusters with nearly zero manual effort. You only need to run our [open-source eBPF agent (Alaz)](https://github.com/ddosify/alaz) as a DaemonSet on your Kubernetes cluster. Ddosify will handle the rest of the work and [Service Map](/ddosify/kubernetes-monitoring/service-map), [Metrics Dashboard](/ddosify/kubernetes-monitoring/metrics) and [Distributed Tracing](/ddosify/kubernetes-monitoring/distributed-tracing) will be available on Ddosify UI. ### Service Map Service Map allows you to view the interactions between the resources in your K8s Cluster. Here, you can take a look at the requests sent, their latency, RPS and many more. You can also filter them however you want to get the insights you require.

### Metrics Metrics allow you to view statistics about your K8s instances such as CPU/Memory/Disk usage. You can also see their change over time and apply time filtering if you want to take a look at a specific time interval.

### Distributed Tracing Distributed tracing allows you to trace the requests sent inside your cluster without needing any custom span generation or manual instrumentation. Here, you are able to view which requests triggered which ones and their durations alongside their call hierarchy. {% hint style="info" %} Kubernetes Monitoring section of the Ddosify Stack is available on both Ddosify Self-Hosted or Ddosify Cloud. {% endhint %} # Install eBPF Agent (Alaz) To start monitoring your Kubernetes Cluster, you need to create a new Cluster on the Ddosify platform. To achieve this, navigate to the [Clusters page](https://app.ddosify.com/clusters) and click the Add Cluster button. After providing a unique name for the Cluster, you will be navigated to the Observability page, where you will see the [Service Map](/ddosify/kubernetes-monitoring/service-map), [Metrics Dashboard](/ddosify/kubernetes-monitoring/metrics), and [Distributed Tracing](/ddosify/kubernetes-monitoring/distributed-tracing) for this Cluster. But before that, you have to install and run our [open-source eBPF agent (Alaz)](https://github.com/ddosify/alaz) as a DaemonSet in your Kubernetes Cluster. Follow the below instructions to set up a new cluster successfully. {% hint style="info" %} Installing Alaz on Ddosify Self-Hosted requires some extra steps. For that case, please refer [here](https://app.gitbook.com/o/jN3rtZ38DU58INyTNPm7/s/ugegoRCn84wtxrIelgft/~/changes/115/ddosify/self-hosted/install-ebpf-agent-alaz-on-self-hosted). {% endhint %} 1. Click the Set Up Cluster button

2. A pop-up will open and show you how to install Alaz via Kubectl or Helm:

#### Kubectl

This installs Alaz as a DaemonSet in your cluster. Let's see what each line does: ``` # Deploy Alaz with Kubectl 1. MONITORING_ID=0ce2ef05-ef64-459d-90d9-7f2cbd65fff8 2. curl -sSL https://raw.githubusercontent.com/ddosify/alaz/master/resources/alaz.yaml -o alaz.yaml 3. sed -i"" -e "s//$MONITORING_ID/g" alaz.yaml 4. kubectl create namespace ddosify 5. kubectl apply -f alaz.yaml ``` 1. Defines the monitoring id of the cluster. It's a unique id for the cluster and is auto-generated by Ddosify. 2. Retrieves the Alaz yaml file containing the required declarations. Check [file](https://raw.githubusercontent.com/ddosify/alaz/master/resources/alaz.yaml). 3. Replaces the $MONITORING\_ID variable with the monitoring id declared in Step 1. 4. Creates the `ddosify` namespace. 5. Applies the Alaz yaml file. #### Helm

This uses the Helm package manager to do the same. It installs Alaz as a DaemonSet in your cluster. Let's see what each line does:

# Deploy Alaz with Helm
1. MONITORING_ID=0ce2ef05-ef64-459d-90d9-7f2cbd65fff8 
2. helm repo add ddosify https://ddosify.github.io/ddosify-helm-charts/
3. helm repo update
4. kubectl create namespace ddosify
5. helm upgrade --install --namespace ddosify alaz ddosify/alaz --set monitoringID=$MONITORING_ID

1. Defines the monitoring id of the cluster. It's a unique id for the cluster and is auto-generated by Ddosify. 2. Adds the Ddosify Helm chart to your local Helm registry. Check [Helm Chart.](https://github.com/ddosify/ddosify-helm-charts) 3. Updates your Helm registry with the addition of Ddosify. 4. Creates the `ddosify` namespace. 5. Installs Alaz in your cluster using Helm by setting the monitoring id. You can also set other parameters like backendHost if you use Self-hosted. Check [Helm Chart parameters](https://github.com/ddosify/ddosify-helm-charts?tab=readme-ov-file#alaz-parameters). 6. After a few seconds, [Service Map](/ddosify/kubernetes-monitoring/service-map) and [Metrics Dashboard](/ddosify/kubernetes-monitoring/metrics) will be ready on Ddosify.

Inspect Kubernetes Service Map on Ddosify Platform

{% hint style="success" %} If you require assistance with setting up Alaz, you can join our[ Discord](https://discord.com/invite/9KdnrSUZQg) or send an email to . {% endhint %} # K8s Clusters Ddosify allows you to monitor your Kubernetes clusters in great detail while requiring minimal configuration. While monitoring your Kubernetes clusters from Ddosify, you can view their summary information. To do so, first click on the Clusters button on the left:

This will take you to the following page:

All the clusters you created are listed here. You can check all of your clusters through the page numbers below. If you haven’t set up Alaz in your cluster, you will see “-” for its summary information. If you successfully set Alaz up and it is currently live, you will see the following: * Last data timestamp * Status * Memory usage * Filesystem usage * CPU usage * Node count * Pod count * Alaz version If you set your cluster up successfully at some time, but it is currently not receiving data, you will see N/A for these. You can re-enable Alaz to continue from where you left off. You can scroll to the right to find the action buttons. Here, you can view your cluster in more detail, update its name or delete it.

To add a cluster, click the “Add Cluster” button in the upper right corner. Here, you can provide a name for your cluster and it will be created. This will take you to the metrics page of your cluster. You can then follow the steps to set Alaz up in your cluster. For more details on this, please check our [installation guide](https://app.gitbook.com/o/jN3rtZ38DU58INyTNPm7/s/ugegoRCn84wtxrIelgft/~/changes/105/ddosify/kubernetes-monitoring/installing-alaz).

{% hint style="success" %} If you require assistance with monitoring your Kubernetes clusters, you can join our[ Discord](https://discord.com/invite/9KdnrSUZQg) or send an email to . {% endhint %} # Service Map

You can inspect high latency, high RPS network calls on Ddosify Platform

Once you properly [set up your Cluster,](/ddosify/kubernetes-monitoring/k8s-clusters) Ddosify automatically creates a service map for this cluster so you can easily get insights about what is going on in your cluster. For example, you can easily find answers to the below questions: * What is the average latency between service X and service Y? * Which services have higher/lower latency than XX ms? * What is the average RPS between service X and service Y? * Is there a Zombie Service on your cluster? * How much time does it take to run SQL queries? * ... and more **Supported Protocols** Check [Alaz](https://github.com/ddosify/alaz#supported-protocols). Other protocols will be available soon. ## Monitoring Your Service Map Ddosify makes use of eBPF to monitor the requests sent in your cluster so that you can get a better view of what happens in it without any code changes, service restarts and side-cars. Here’s how you can do so:

After you click on a cluster you want to observe in the clusters page, click on the service map tab. This will take you to the service map page.

This is an example cluster service map page. If you haven’t completed the installation of Alaz, you will see this instead:

To complete your cluster installation, you can check the cogwheel button right next to the node selector dropdown or click “Set Up Cluster” on the center. This shows you the instructions to connect your cluster to Ddosify through Alaz. If you need help on this, you can check the [docs](https://app.gitbook.com/o/jN3rtZ38DU58INyTNPm7/s/ugegoRCn84wtxrIelgft/~/changes/105/ddosify/kubernetes-monitoring/installing-alaz). ## Filtering the data #### Namespaces Here, you can pick the namespaces present in your cluster on the upper right corner to filter them.

#### Protocols, Status Codes, Latencies, RPS You can use the filters button to filter out protocols, HTTP status codes and latency/rps values. HTTP status code filter only works for HTTP protocols and does not affect the other protocols. [Here](https://github.com/ddosify/alaz#supported-protocols) is the list of supported protocols.

Each edge in the service map represents the total traffic sent/received between those two resources with all of the protocols combined. Edges are also distinguished by the receiving port of the destination resource. Here’s what it looks like when the filters are applied. The resources satisfying the filters are highlighted whereas the others are shadowed.

{% hint style="info" %} **Note:** The latency and RPS filters filter the **endpoints** (or the SQL queries depending on the protocol of the traffic) in the edges. It **does not** filter the edges. This means that an edge (with all the endpoints in it) could have an RPS of 100 but an endpoint in it could have an RPS of 1.5. This filter looks at all of the endpoints in the edge and highlights it if a **single endpoint** satisfies the selection. If **none of the endpoints** satisfy the conditions, a shadow is applied to the edge. The same goes for the average latency. This allows you to detect bottlenecks in the traffic while still being able to see the total RPS and average latency of the edge. {% endhint %}

You can also click on the “Show Only Zombies” option to highlight the Kubernetes resources without any traffic. Selecting this disables the other filters.

Here are the zombie resources of the service map. These are the resources that do not have any traffic related to them. #### Time intervals You can also use the time selector in the same upper right corner. You can either specify one of the predetermined time intervals on the right or you can specify your custom time interval:

{% hint style="info" %} **Note:** The service map page is reloaded at about every 5 seconds. If you wish to observe an instant, you can pause the page from the play/pause button on the upper right corner. After you are done, you can enable the reloading by clicking on it again. {% endhint %} #### Searching If you want to look for specific resources, you can use the search bar. This highlights the matching resources with yellow and autofocuses on them. You can check the next/previous matches with the arrow buttons or by pressing Enter:

## Navigating through the service map #### Edges The requests sent between resources are represented by arrows/edges. The thickness and the colors of these edges depend on the average latencies and total RPS of them. To learn more, you can click on the eye icon on the upper left corner. While red colors represent higher latencies, thicker edges represent higher RPS values.

The edges are drawn from the source resource to the receiving port of the destination resource. When drawing the edges, the outgoing contact points are always the right center of the resource but the receiving contact points are determined by the receiving ports. This is because requests could be sent by any port whereas they are received only by specific ports.

{% hint style="info" %} **Note:** To ensure the stable performance of the service map, a resource limit is applied when returning the data. Currently, this limit is set to 50. When this number limits your service map visualization, you are notified at the top of the page. If you cannot see some of the desired resources, you can apply namespace filtering to narrow down your results. {% endhint %} {% hint style="info" %} **Note:** To be able to draw an edge on the service map, both the source and the destination resources should be present. If at least one of them is not drawn (due to resource limiting or filtering etc.), the edge cannot be drawn either. {% endhint %} You can also use the minimap on the bottom right corner to navigate through the service map. If you hover on the information button of an edge, you can see the source and the destination resources, the average latency and the total RPS of that edge.

If there is traffic sent to outer resources that are not present in the cluster, they are denoted as outbounds. They do not have namespaces and Kubernetes resource types.

#### Resources Let’s also learn what each icon/text means in a resource:

In the header of each resource, these are written respectively: * The most prominent protocol of the resource (if applicable) * The name of the resource * The namespace of the resource * The symbol of the resource type (Pod, Deployment, DaemonSet, etc.) The symbol of the resource type can be seen in more detail while hovering over it:

Each resource's receiving (port, protocol) pairs are also written on them. ## Monitoring individual resources You can click on the resources to learn more about them. There can be at most three tabs for a resource: * Summary * Resources (applicable only if that resource manages other smaller resources, like ReplicaSets for Deployments) * Metrics (applicable only if that resource receives traffic)

#### Summary {% hint style="info" %} **Note:** Services point their received traffic to other resources. This means that these traffic data are also present in the pointed resources and are denoted by “Forwarded From Service”. They are also written in the outgoing traffic section of the pointing Service and denoted by “Forwarded To Deployment/DaemonSet” etc. {% endhint %}

Resource details of the forwarding service

Resource details of the forwarded deployment

In this section, you will see the name and the namespace of the resource, incoming/outgoing traffic and the used ports. If you wish to filter the traffic data, you can click the “Filters” button on the right to use protocol and HTTP status code filters. After you click “Apply”, only the traffic satisfying the conditions will be visible. {% hint style="info" %} **Note:** HTTP status filters only work for HTTP and HTTPS protocols. They don’t have any effect on other protocols. {% endhint %}

If you wish to specify a time interval, use the button next to the filters. Here, you can either specify one of the predetermined time intervals, or you can specify your custom time interval:

In each traffic object, the other resource (sending resource if the traffic is incoming, receiving resource if the traffic is outgoing) and the receiving port of the receiving resource is written. Then, the traffic protocol is written alongside average latency and total RPS. If you wish to learn more about this traffic, you can click on it.

An example traffic inside the resource details

Here, you can view individual endpoints belonging to this traffic alongside their average latencies and total RPS. You can use the page buttons to navigate if there are more than five endpoints.

If you click on the methods, more details are shown, such as status codes and latency/RPS information of them:

If you are viewing Postgres traffic, the endpoints turn to queries. Here, if you click on the type and then on the query, you can examine the query up to a character limit. {% hint style="info" %} **Note:** Literal values inside the Postgres queries are turned to placeholders. {% endhint %}

A helpful way to understand which endpoints respond the slowest or take up most of the traffic is by using the sorting option in the upper right. Here, you can sort by latency or RPS and sort with descending or ascending. {% hint style="info" %} **Note:** There is a traffic object per each (resource, port, protocol) tuple. For example, in the below example, there are two traffic as their receiving ports are different: {% endhint %}

Two different traffic separated by ports

#### Resources This section is only applicable to Deployments, Services and DaemonSets. It shows the inner resources of the selected resource. This means ReplicaSets for Deployments, Pods for DaemonSets and Endpoints for Services. Here are some examples: *Deployment:*

ReplicaSets belonging to the Deployment are written alongside their Pods. *Service:*

Endpoints, their ports and the resources they point to are written. *DaemonSet:*

Pods belonging to the DaemonSet are written. #### Metrics {% hint style="info" %} **Note:** This section is only available for resources receiving traffic. {% endhint %}

Here, you can view the following: * The percentage of the requests ended up with 5xx status codes (only if HTTP/HTTPS). * The distribution of the status codes over time (0,1,2 if Postgres) * Endpoints (queries if Postgres) with the top 5 average latencies * Endpoints (queries if Postgres) with the top 5 RPS You can also specify a time interval of your choice on the upper right. You can either specify one of the predetermined time intervals on the upper right or your custom time interval.

In the top 5 latency/RPS sections, you can also filter protocols and/or search among them:

{% hint style="success" %} If you require assistance with monitoring your service map, you can join our[ Discord](https://discord.com/invite/9KdnrSUZQg) or send an email to . {% endhint %} # Metrics

lastYou can inspect CPU, Memory, Disk and Network metrics with out-of-box dashboards

Ddosify tracks and displays live data on your CPU, memory, disk, and network usage of your cluster instances. All the dashboards are generated out of the box, and you can create alerts based on these metrics' values. Check out [Alerts](/ddosify/kubernetes-monitoring/alerts) for more. You can filter based on Time and Kubernetes Instance. ## Monitoring Your Cluster Metrics Analyzing cluster metrics is one of the keystones of cluster observability. And it can’t get easier than it is on Ddosify. You can view metrics about your CPU, RAM, Memory, Network usage, etc. You can also apply time filters and examine specific nodes. Here’s how you can do that:

After you click on the cluster you want to observe on the clusters page, the first page that opens is the metrics.

This is an example cluster metrics page. If you haven’t completed the installation of Alaz, you will see this instead:

To complete your cluster installation, check the cogwheel button next to the node selector dropdown or click "Set Up Cluster" in the center. It shows you the instructions to connect your cluster to Ddosify through Alaz. If you need help on this, you can check the [docs](https://app.gitbook.com/o/jN3rtZ38DU58INyTNPm7/s/ugegoRCn84wtxrIelgft/~/changes/105/ddosify/kubernetes-monitoring/installing-alaz).

### Filtering #### Node selection Here, you can pick one of your cluster nodes to see how well they operate. To do so, use the node selector in the upper right corner:

#### Time selection You can also use the time selector right next to it. You can either specify one of the predetermined time intervals on the right or you can specify your custom time interval:

{% hint style="info" %} **Note:** The nodes on the dropdown menu depend on the selected time interval. It will not be shown if a node does not have corresponding data during the selected time interval. {% endhint %} {% hint style="info" %} **Note:** The metrics page is reloaded at about every 5 seconds. If you wish to observe an instant, you can pause the page from the play/pause button in the upper right corner. After you are done, you can enable the reloading by clicking on it again. {% endhint %} Now that you selected your node and desired interval let’s understand what each gauge and time graph presents: ### Gauges

Metric	Definition	Meaning	Numerics
CPU Busy	The amount of time the CPU spends executing non-idle tasks.	High CPU busy percentages over extended periods might indicate that the system is under heavy load, potentially leading to slower response times or performance issues.	It is given as a percentage of the time spent non-idle over the total time spent and can’t exceed 100%.
Sys Load (5m)	The average load on the CPU for the past 5 minutes. Sys load represents the number of processes currently running.	If the load consistently stays high compared to the system's capacity (number of CPU cores, for instance), it could signify that the system is under heavy demand or possibly overloaded.	It is given as a percentage of the average process count over the last 5 minutes and it can exceed 100% depending on the CPU core count.
Sys Load (15m)	The average load on the CPU for the past 15 minutes. Sys load represents the number of processes currently running.	If the load consistently stays high compared to the system's capacity (number of CPU cores, for instance), it could signify that the system is under heavy demand or possibly overloaded.	It is given as a percentage of the average process count over the last 15 minutes and it can exceed 100% depending on the CPU core count.
RAM Used	The amount of Random Access Memory (RAM) currently being utilized by active processes and the operating system.	Consistent high usage may lead to performance issues and it may result from memory leaks or inefficient resource usages.	It is given as a percentage of the used amount over the total amount and can’t exceed 100%.
Swap Used	Swap is a space on a disk that is used when the amount of RAM (physical memory) is full.	Swap usage indicates the amount of swap space currently being used by the system. High swap usage may indicate that the system is running out of physical memory and is relying more heavily on disk storage.	It is given as a percentage of the used swap space over the total swap space and can’t exceed 100%.
Root FS Used	The Root File System (Root FS) contains essential files required for the system to boot and operate. Root FS usage refers to the amount of space on the root filesystem that is currently in use.	High usage could potentially lead to system performance issues or, in extreme cases, cause the system to run out of space.	Given as a percentage of the used disk space over the total disk space. It can’t exceed 100%.

* **CPU Core:** Total CPU core count * **Uptime:** The duration for which the node has been continuously running without a restart or shutdown * **Last Data:** The timestamp of the last recorded data * **Total Root FS:** The total disk space of the root filesystem * **RAM Total:** The total RAM bytes of the node * **Total Swap:** The total Swap bytes of the node ### Time Graphs #### Avg CPU Usage %

Represents the average CPU usage percentage of the node in different modes over the selected time interval. #### Avg Memory Usage %

Represents the average memory usage percentage of the node in different modes over the selected time interval. #### Avg Disk Usage %

Represents the average disk usage percentage of the node over the selected time interval. #### Avg Memory Usage

Represents the node's memory usage over the selected time interval in bytes. #### Avg Network Usage

Represents the average network usage of the node over the selected time interval in bytes. You can select your node's network interfaces in the upper right for better monitoring.

{% hint style="info" %} **Note:** You can click on the colors of each time graph’s legend to enable or disable them. This way, you can focus only on the modes you care about. {% endhint %}

Avg CPU Usage % with 3 modes enabled (idle mode is disabled)

{% hint style="info" %} **Note:** To learn more about each metric, you can hover on the tooltip icon next to them: {% endhint %}

{% hint style="success" %} If you require assistance with monitoring your cluster metrics, you can join our[ Discord](https://discord.com/invite/9KdnrSUZQg) or send an email to . {% endhint %} # Distributed Tracing **Distributed Tracing** enables tracking of requests as they pass through the microservices in a system**.** Ddosify captures **Traces** and **Spans** out-of-the-box on your Kubernetes Cluster without modifying your code or restarting your services. Ddosify uses a lightweight [eBPF Agent (Alaz)](https://github.com/ddosify/alaz) to generate Distributed Tracing data and enable auto context propagation. To do so, on the [Ddosify Platform](https://app.ddosify.com/), click "Clusters" under the "Observability" tab first.

After you click on a cluster you want to observe on the clusters page, click on the distributed tracing tab. This will take you to the distributed tracing page. You will see this:

Here, you can filter and view traces in chart and list form. ### Filtering You can apply the following filtering: * Operations (trace names) * Trace count * Tags * Min/max duration (in ms) * Min/max span count * Time interval {% hint style="info" %} **Note:** Filtering affects both the trace chart and the trace list. They show the same traces but in different formats. {% endhint %} To apply filtering, click the "Filters" button on the upper right.

#### Operations Operations filtering allows you to select traces with specific names. It allows multi-select so that you can look for multiple names. {% hint style="info" %} **Note:** The name of a trace is the name of its first span. {% endhint %} #### Max Results This limits the number of traces shown. #### Tags Tags allow you to filter traces by the tags in their spans. Tag filtering accepts the [logfmt](https://brandur.org/logfmt) format. {% hint style="info" %} **Note:** Span attributes are not allowed to be nested; thus, tag filtering does not support nested filtering either. {% endhint %} Let's see how we can query traces by their tags. Let this be an example tags for a span: ```json { "path": "/", "to_ip": "192.168.20.73", "method": "GET", "to_uid": "d0210c8f-fe44-472c-bbb2-39d64973e5a4", "from_ip": "192.168.30.206", "to_name": "kube-state-metrics-shard", "to_port": "8081", "to_type": "daemonset", "from_uid": "2148b55d-cab8-41c6-ab5e-b12d9630ba0c", "protocol": "HTTP", "from_name": "aws-node", "from_port": "41736", "from_type": "daemonset", "status_code": "200" } ``` An example tag filter could look like this: ``` method=GET protocol=HTTP from_port=41736 ``` While filtering, it is enough for a single span of a trace to satisfy this filter. As a result, the traces with at least one span matching this filter are retrieved. #### Min/Max Duration You can filter the traces by the total time they took in ms. #### Min/Max Span Count You can also filter the traces by their span count. #### Time Interval To apply a time interval, click the "Last 5 min" button next to the "Filters" button. You will see this:

Here, you can specify your desired time interval. You can specify your start-end times yourself or pick predefined time intervals from the "Quick Selections" section. {% hint style="info" %} **Note:** The time interval between the start and the end could be apart at most 24 hours. {% endhint %} ### Trace Chart The trace chart allows you to view the distribution of your filtered traces by their dates and durations. While the x-axis is the date, the y-axis is the duration.

To view more details (start time, name, duration, span count) about a trace, you can hover on it:

### Trace List Under the trace chart, you can view the filtered traces in a listed format. You can delete them here as well. You can also use the page numbers below to see the remaining traces.

### Trace Details After you click on a trace (either on the chart or the list), you can view its details (including its call hierarchy and time).

Each row represents a trace, whereas the columns represent the time. No matter how long your trace took, the whole hierarchy is always fitted inside your view, so you would not need scrolling/zooming to understand the trace. You can expand/collapse spans by clicking on their "Name" column.

You can also hover over a span to see its details, such as: * Source/target ports * Path (endpoint) * Status code * Request method * Start/end time

For more details, you can click on a span:

Here, you can view the span's details, including: * From/to resources * From/to IPs * From/to port numbers * Start/end times * Duration * Path * Method * Protocol * Status code {% hint style="success" %} If you require assistance with **Distributed Tracing**, you can join our[ Discord](https://discord.com/invite/9KdnrSUZQg) or send an email to . {% endhint %} # Alerts Ddosify monitors your Kubernetes cluster with different rules and sends alerts when necessary. For example, it can send an alert when a node's CPU usage is too high or low Disk space via E-mail, [Slack](/ddosify/integrations#slack-integration), [Opsgenie](/ddosify/integrations#opsgenie-integration) or [Webhook](/ddosify/integrations#webhook-integration). Ddosify monitors CPU, memory, disk space, and network usage, sending alerts when exceeding thresholds. {% hint style="info" %} Alerts feature is available on Ddosify Cloud and Ddosify Self-hosted Enterprise. {% endhint %} ### Key Features and Benefits * **Comprehensive Monitoring**: Continuously tracks the health of your system's vital signs like CPU, Memory, Disk and Network. * **Customizable Alerts**: Set up alerts based on specific conditions that matter to you. * **Scalable**: The system scales with your needs, whether you’re monitoring a single node or a thousand nodes. * **Integrative**: Seamlessly integrates with popular platforms like Slack, E-mail, Opsgenie, and Webhooks for streamlined notifications. For more integrations, check [Integrations](/ddosify/integrations). ### Prerequisites Before adding an alert, you must install the Ddosify eBPF agent ([Alaz](https://github.com/ddosify/alaz)) on your Kubernetes cluster. You can find the installation guide here: [K8s Clusters](/ddosify/kubernetes-monitoring/k8s-clusters). {% hint style="info" %} If you need help creating clusters or adding alerts, you can ask a question on our [Discord server](https://discord.com/invite/9KdnrSUZQg). {% endhint %} ### Add Alert On Ddosify, click the Observability tab and then the Alerts tab. On this page, you can see the list of alerts that you have added before. To add a new alert, click on the **+ Add Alert** button.

Give a name and select your Kubernetes Cluster.

**Monitor All Current & Future Nodes** checkbox is selected by default. This means all current and future nodes will be monitored, irrespective of the K8s autoscale. However, if you want to monitor only specific nodes, you can uncheck the **Monitor All Current & Future Nodes** checkbox and manually select the nodes you want to monitor.

Select Metric for alerting. Here are the metrics that Ddosify supports: #### CPU Metrics:

Metric Name	Max. Value	Description
CPU Busy Percent	100	Measures the percentage of time the CPU is working on processes instead of being idle. A value close to 100% indicates that your CPU is very busy.
CPU Usage Percent IRQ	100	Tracks the percentage of CPU usage consumed by interrupt requests from hardware devices.
CPU Usage Percent Other	100	Percentage of CPU time spent in non-idle, non-user, non-system modes
CPU Usage Percent Idle	100	Shows the percentage of time the CPU is not being used by any process.
CPU Usage Percent User	100	Indicates the percentage of CPU utilized by user-initiated processes or applications.
CPU Usage Percent IOWait	100	Measures the percentage of time the CPU is waiting for Input/Output operations to complete.
CPU Usage Percent System	100	Refers to the percentage of CPU used by system processes (kernel code).
CPU Core	-	Gives the count of CPU cores available on your system.

#### System Load Metrics:

Metric Name	Min. Value	Max. Value	Description
Sys Load 5m	0	-	Represents the system load average over the last 5 minutes, indicating how many processes are actively running or waiting to run. The max. value is your CPU core count * 100.
Sys Load 15m	0	-	Similar to the 5-minute metric but averaged over 15 minutes.

#### RAM Metrics in Percent:

Metric Name	Max. Value	Description
RAM Used Percent	100	Shows the percentage of the total RAM that is currently being used.
Swap Used Percent	100	Indicates the percentage of the swap space that is in use. Swap space is used when the RAM is full.
RAM Usage Percent Cache and Buffer	100	Displays the percentage of RAM used for buffers and cache.
RAM Usage Percent Used	100	Reflects the portion of RAM being actively used by processes.
RAM Usage Percent Free	100	Shows the percentage of RAM that is free and available for new processes.
RAM Usage Percent Swap	100	Measures the percentage of the swap space currently in use.
RAM Usage Percent Total	100	Represents the total percentage of RAM used, including all buffers and caches.

#### RAM Metrics in Bytes: These metrics are similar to their percent-used counterparts but provide the raw values in bytes, giving you an exact memory usage figure.

Metric Name	Max. Value	Description
Total RAM Bytes	-	The total amount of RAM available on the system, in bytes.
Total Swap Bytes	-	The total size of swap space available on the system, in bytes.
RAM Usage Bytes Cache and Buffer	-	The amount of RAM in bytes used for cache and buffers.
RAM Usage Bytes Used	-	The total bytes of RAM that are currently used by processes.
RAM Usage Bytes Free	-	The amount of free RAM available in bytes.
RAM Usage Bytes Swap	-	The size of used swap space in bytes.
RAM Usage Bytes Total	-	The total size of RAM in bytes.

#### Disk Metrics:

Metric Name	Max. Value	Description
Root FS Used Percent	100	Displays the percentage of the root filesystem that is used.
Total Root FS Bytes	-	The total size of the root filesystem, measured in bytes.
Disk Usage Percent Used	100	Indicates the percentage of disk space used across all mounted filesystems.

#### Network Metrics:

Metric Name	Min. Value	Max. Value	Description
Network Usage Amount Bits Received	0	-	The total number of bits received over the network.
Network Usage Amount Bits Transmitted	0	-	The total number of bits transmitted over the network.

#### Miscellaneous Metrics:

Metric Name	Min. Value	Max. Value	Description
Uptime Seconds	0	-	The total time, in seconds, that the system has been running since the last reboot.

After you select the **Metric**, select **Threshold** and **Threshold Value**. Select **Priority,** which will be used for urgency level. P1 represents the highest priority, while P5 is the lowest. This helps prioritize response to alerts and is used for escalation in integrated systems like Opsgenie and PagerDuty. Optionally, you can add Tags. Select **Window Duration** to specify the time window when the metric value should meet the threshold condition to trigger an alert. This helps prevent false positives and ensures consistent problematic behavior before alerting. **All the data points in the window duration should be alerted to make an alert.** For example, in this configuration, an alert will be triggered if the RAM Used Percent exceeds 80 for at least 30 seconds.

By default, your e-mail address is used for notifications. You can add additional e-mail addresses by clicking the **Add New Recipient** button.

You can add another integration with e-mail notification by clicking the **New Integration** button. In this configuration, if an alert is triggered, a notification will be sent using e-mail, Slack and OpsGenie.

{% hint style="success" %} To add new integrations, check [Integrations](/ddosify/integrations) page. {% endhint %} Click **Save Alert** to save the alert. Every 30 seconds, the condition will be checked and if an alert is triggered. {% hint style="warning" %} Ddosify alert system sends notifications on the **1st**, **10th**, **20th**, and **30th** occurrence of an issue. This allows you to stay on top of critical events with minimal distractions. {% endhint %} ### List Alerts On the Alerts page, you can see your alerts as a list. You can enable/disable alerts by active column, Edit and Delete alerts. Status columns can be **OK** if everything is fine and **Alert** if there is an alert condition.

### Alert History You can access the Alert History by clicking the Alert name in the Alert list. In this section, you can see **Alert Count**, **OK Count** and **Alert Rate** with time period (Last 5 min, Last 30 min, ...). In this example, the Alert Rate is 26.09% in the last 30 minutes. The table shows the **Time**, **Rule**, **Actual value** on the window, **Priority** and **Integrations** for Alerted checks.

{% hint style="success" %} If you require assistance with Alerts, you can join our [Discord](https://discord.com/invite/9KdnrSUZQg) or send an email to . {% endhint %} # Performance Testing

You can simulate users on no-code Ddosify Platform

You can create complex and realistic user flows on Ddosify No-code UI. Here are the list of key concepts on Ddosify Performance Testing: * [Parametrization](/ddosify/performance-testing/parametrization) * [Test Data Import](/ddosify/performance-testing/test-data-import) * [Environment Variables](/ddosify/performance-testing/environment-variables) * [Correlation](/ddosify/performance-testing/correlation) * [Assertion](/ddosify/performance-testing/assertion) * [Debugging](/ddosify/performance-testing/debugging) * [Postman Import](/ddosify/performance-testing/postman-import) If you need CLI based load testing tool, [Ddosify Engine](https://github.com/ddosify/ddosify/tree/master/engine_docs) is the open-source and high-performance load testing tool, written in Golang. # Test Suite

Test Suite is the place where the magic happens. It will let you configure scenario steps, iteration count, duration, load type, geographical distributions of the requests, etc. Once you finalize your configurations, you can start the test immediately or save it as [Test Plan](/ddosify/performance-testing/test-plan) to use for future tests. ### Where to Start 1. [Prepare Scenario Flow](/ddosify/performance-testing/test-suite/scenario-flow) 2. [Configure Load](/ddosify/performance-testing/test-suite/load-configuration) 3. [Configure Location Distribution](/ddosify/performance-testing/test-suite/location-configuration) 4. [Finalize](/ddosify/performance-testing/test-suite/finalize) # Scenario Flow

### What is Scenario? In essence, a scenario represents a series of steps designed to mimic the actions of an end-user. This end-user could be a real person using a browser to access your website or another software program that sends API requests to your endpoints. For instance, imagine you own an e-commerce business and wish to evaluate the performance of the following user flow: 1. User visits the home page 2. User logs in 3. User adds a product to the shopping cart To accomplish this, you must construct a scenario containing these 3 steps. It is essential to ensure that the steps are executed in the correct order, as the sequence is critical to accurately simulating the end-user's experience.

### What is a Step? Step represents the individual network request. * **Step Name** is not mandatory. But it is nice to have since you can easily distinguish your steps on the Test Report page if you provide it. * **Target** is where you supply network protocol and URL. * **Method** is the HTTP method. {% hint style="warning" %} **Caution:** Don't put query parameters in the target field. There is a section for query parameters in the [Step Details](#step-details) section. For example, instead of **`http://example.com/search?q=term`** write **`http://example.com/search`** and put **`q=term`** parameter to the key-value form in [Step Details](#step-details) modal. {% endhint %} * Click the **New Step** button if you would like to add another step to the scenario. * Click the 'More' (three-dot icon at the right) button to provide [Step Details](#step-details).

#### Step Details You can provide query parameters, request headers, payload, authentication, and network details of the request here. You can also [Capture Variables](/ddosify/performance-testing/correlation) and create [Assertion](/ddosify/performance-testing/assertion) logic in Step Detail.

#### Other Important Concepts on Scenario Builder * [Parametrization](/ddosify/performance-testing/parametrization) * [Test Data](/ddosify/performance-testing/test-data-import) * [Environments](/ddosify/performance-testing/environment-variables) * [Correlation](/ddosify/performance-testing/correlation) * [Assertion](/ddosify/performance-testing/assertion) * [Debugging](/ddosify/performance-testing/debugging) * [Postman Import](/ddosify/performance-testing/postman-import) # Load Configuration Once you configured your scenario, the next step is configuring the shape and duration of the load.

There are two methods for configuring the load: [Predefined Load](#predefined-load) and [Custom Load](#custom-load). However, both methods share two common elements: the total [iteration count](#iteration-count) and the [total test duration](#duration). Let's familiarize ourselves with these elements first. #### Iteration Count The Scenario is composed of a series of Steps that are executed in order. The term "iteration count" refers to the number of times the entire Scenario is executed. While some might call this the run or transaction count, we prefer to use "iteration count." It's important to clarify that the iteration count is distinct from the request count. The relationship between these two depends on the number of Steps in the Scenario. For instance, if a Scenario contains three Steps and has an iteration count of 100, the total request count would be 300 (100 iterations multiplied by 3 Steps). #### Duration The Duration simply indicates the total length of the test in seconds, without any hidden significance. {% hint style="info" %} **Good to know:** You can see the maximum test duration you can supply at the bottom of the Duration label. {% endhint %} ### Predefined Load The predefined load is designed to save you time on setup. Simply input the Iteration count and Duration, then choose one of the load types. That's all it takes. Ddosify offers 3 unique load types for various scenarios: #### Linear Load With a linear load, the iteration count remains constant every second. For example, if the iteration count is 100 and Duration is 10 seconds, Ddosify will execute 10 iterations per second. #### Incremental Load In contrast to the linear load, the iteration count increases each second in this load type. #### Waved Load Real-life traffic doesn't follow a consistent pattern, with both busy and quiet periods. To replicate this type of load, Ddosify provides the waved load option. ### Custom Load Ddosify comes with pre-defined load types for convenience, but you might want to design your own load type. Using the Custom Load Type Builder, you can set the number of iterations for specific time intervals. To view the load profile you've created, check the Load Preview section, which is situated to the right of the pane.

# Location Configuration In this step, you will configure load volumes from global locations that reflect your user base.

{% hint style="info" %} The location module is only available in Ddosify Cloud. {% endhint %} Just like the[ Load Configuration](/ddosify/performance-testing/test-suite/load-configuration) feature, the Location Configuration offers two methods for geographically distributing the load you set up earlier. ### Auto Distribution Opt for auto mode when you prefer not to allocate load volumes for individual countries. In this mode, Ddosify evenly distributes the load across your chosen countries. For instance, if you select 5 countries and have a total of 100 iterations, Ddosify sends 20 (100/5) iterations from each location. ### Manual Distribution Choose this mode if you prefer to personally allocate the load across different countries. This option provides you with greater control over the distribution of the load.

# Finalize

After setting up your scenario, configuring the load, and distributing it across locations, you now need to decide what to do with this configuration. You can launch the test immediately or save the configuration as a [Test Plan](/ddosify/performance-testing/test-plan) for future use. ### Starting a New Test 1. First, enter a unique test name, which is required to differentiate test results. 2. Click the "Start New Test" button. 3. If successful, you will be redirected to the[ Live Test Reporting Page.](/ddosify/performance-testing/test-report/live-report) ### Saving as Test Plan 1. To save the configuration for later use, enter a unique test plan name and click "Save."

2. If the test plan saves successfully, you will see the test plan name displayed next to the Test Suite title, indicating that the Test Suite has switched from "New" to "Test Plan Edit" mode. Any subsequent changes will update this test plan.

To create a new test using a saved test plan, simply enter a test name and click the "Start New Test" button. If successful, you will be redirected to the [Live Test Reporting Page](/ddosify/performance-testing/test-report/live-report). # Test Plan A test plan is a helpful tool for reusing test configurations. ### Creating a Test Plan 1. To create a new test plan, go to the ['Finalize' phase of the Test Suite.](/ddosify/performance-testing/test-suite/finalize) ### Editing Existing Test Plan Go to the [Test Plans](https://app.ddosify.com/test-plans) page and click the **Edit Button** of the test plan you want to change.

You will be taken to the Test Suite. The test plan name will appear on the right side of the Test Suite title, indicating that you are in 'Test Plan Edit' mode.

Save your changes by clicking the 'Save' button on the 'Finalize' step of the Test Suite.

### Starting a New Test From Test Plan Go to the [Test Plans](https://app.ddosify.com/test-plans) page and click the **Edit Button** of the test plan. Click the **Next** buttons until the Finalize step. Ddosify will give a unique test name by default, but you can change the test name if you would like. Click the **Start New Test** button to start the new test.

# Test Report

The Test Report module is specifically designed to display a comprehensive set of metrics gathered during load testing of your target system. It operates in two distinct modes depending on the test status. If the test is ongoing, the Test Report will be in [Live Mode](/ddosify/performance-testing/test-report/live-report). Once the test is completed, the module will switch to [Final Mode](/ddosify/performance-testing/test-suite/finalize). # Live Report ![](https://2539979715-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FugegoRCn84wtxrIelgft%2Fuploads%2Fi8HT84tXDE2pbyKwkmL1%2FScreen%20Shot%202022-03-14%20at%2012.15.02.png?alt=media\&token=dc62a1b3-3925-411f-abcd-3cbbe0be52ea) In Live Mode, essential metrics are displayed, allowing you to monitor the test and halt it if any unforeseen issues arise. To stop the test immediately, click the Terminate button located at the top-right corner of the page. When the test is stopped, the Test Report mode will switch to Final Mode. If the test concludes without any interruptions, the Test Report mode will also transition to [Final Mode.](/ddosify/performance-testing/test-report/final-report) # Final Report

The Final Report provides all the necessary information to evaluate your load test. Before diving into the details of interpreting this data, let's discuss the three possible states of the Final Report. ### States When the test is finished, it can have 3 different states. #### Finished When the test is complete, it may be in the Finished state. This means Ddosify successfully executed your configuration. The word "Finished" will appear in green at the top left corner of the screen. ![](https://2539979715-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FugegoRCn84wtxrIelgft%2Fuploads%2FCtwOYEAigyGaShZiS6iy%2FScreen%20Shot%202022-03-14%20at%2012.38.32.png?alt=media\&token=ea8a81c5-3c55-4fab-bc1e-504f7ab104e5) #### Stopped If you click the 'Terminate' button in[ Live Mode](/ddosify/performance-testing/test-report/live-report), Ddosify will stop the test and set its status to Stopped. ![](https://2539979715-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FugegoRCn84wtxrIelgft%2Fuploads%2FaZfoKVj4lS7cNCSckPdR%2FScreen%20Shot%202022-03-14%20at%2012.37.57.png?alt=media\&token=8b67da35-8dfd-499f-9a71-04462b8f44d4) #### Failed A Failed test means something went wrong on Ddosify's end. If this occurs, you'll be refunded all credits used for that test. ### Reports When the State shows either Finished or Stopped, the Report page will display four sections: Summary, Scenario Report, Location Report, Stats, and Analyze. Let's explore these sections and their functions. {% hint style="info" %} **Good to know:** Charts have a zoom feature. Don't hesitate to play with it. {% endhint %} #### Summary Similar to Live Mode reports, the Summary section offers a comprehensive overview of your test results. If you notice any anomalies or unexpected behavior, you can examine the corresponding detailed reports. For instance, if the Location Stats section (located at the bottom left of the screen) shows high response times for a specific country, you can access the Location Report for a more in-depth analysis. #### Scenario Report The Scenario Report section allows you to closely examine the metrics for each step in the scenario.

#### Location Report This section allows you to analyze your system's performance across various countries.

#### Stats The performance metrics table displays all combinations of relevant data, making it simple to identify underperforming steps in specific countries.

#### Analyze The "Analyze" section presents information about failed iterations. A chart at the top illustrates the number of failures over time, while a table beneath it lists the individual failed iterations. Although the chart may indicate multiple failures within a specific second, the table only displays one failed iteration for that second. This is because Ddosify retains the content of only one failed iteration per second. To examine and investigate the content of a failed iteration, simply click on the corresponding table row. A pop-up window will appear, allowing you to easily review request and response contents, environment variables, captured variables, assertion status, and test data associated with that particular iteration.

### Modify and Re-run Test To re-run the test with the same settings or to modify some of its configurations, click the "Configure" button. You will be redirected to the Test Suite, which will be pre-filled with the current test's settings. ![](https://2539979715-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FugegoRCn84wtxrIelgft%2Fuploads%2FrOAIAb2hoKdcw7PTfYMv%2FScreen%20Shot%202022-03-17%20at%2018.38.38.png?alt=media\&token=dfa0076d-1f22-42a0-8f90-e8c988036dc7) {% hint style="info" %} **Good to know:** When you click the 'Configure' button, it opens the Test Suite in a 'New' mode. This means that even if you initially created the test from a Test Plan, any modifications made in this mode won't impact the original Test Plan. To learn about editing a Test Plan and creating a new test from it, please refer to the [Test Plan](/ddosify/performance-testing/test-plan) documentation. {% endhint %} # Parametrization

When designing a test scenario, accurately simulating user behavior is essential. The testing platform should be capable of injecting random variables in the appropriate locations. Ddosify supports parametrization (dynamic variables) in URLs, headers, payload (body), and basic authentication. We support all the random methods that [Postman does](https://learning.postman.com/docs/writing-scripts/script-references/variables-list/). If you use `{{$randomVariable}}` in Postman, simply replace it with `{{_randomVariable}}` in Ddosify by changing `$` to `_`. This allows Ddosify to send requests with dynamic variables, simulating a realistic load test on your system. {% hint style="info" %} Please check the [Dynamic Variables](/ddosify/performance-testing/dynamic-variables-parametrization) section to see the complete list. {% endhint %} In addition to Dynamic Variables, Ddosify offers support for [Test Data](/ddosify/performance-testing/test-data-import) injection using CSV files and [Correlation](/ddosify/performance-testing/correlation), allowing you to extract variables from one step and utilize the extracted values in subsequent steps. # Test Data Import {% embed url="" %} Ddosify Test Data Import Feature {% endembed %} Import your CSV-formatted Test Data into the Ddosify Platform and incorporate it into your scenarios for more realistic testing experiences. #### Test Data Creation 1. Navigate to the Test Data listing page within the Ddosify App, and find the 'Upload CSV' button situated at the top-right corner of the page.

2. Once you've selected the CSV file on your computer, you will be prompted to indicate whether the first row contains column headers or not. Although you can rename the column headers later, it's crucial to inform Ddosify at this stage, as it will affect how the first row of the CSV is processed.

3. Upon uploading the CSV, you can configure the metadata, modify column headers, remove unwanted columns, and assign data types to columns. The configurations are detailed below:\ \ **Settings** * **Name:** Provide a unique identifier for this test data. * **Order:** Choose between 'Random' or 'Sequential'. In 'Random' mode, Ddosify selects and sends test data randomly for each iteration. In 'Sequential' mode, Ddosify reads and sends test data line by line. * **Skip Empty Line:** Ddosify will skip any empty rows in the CSV file if enabled. * **Allow Quota:** Enable this option if a quote may appear in an unquoted field, and a non-doubled quote may appear in a quoted field. By default, this is set to 'false'. **Data Preview** * Ddosify displays the first 10 rows of the CSV as a preview. In this section, you can change the column header names. Keep in mind that you will use these header names in the test scenario for data injection. * By disabling the 'Include Header' option, you can exclude a column, and Ddosify will not import it. * Lastly, assign a data type to each column to ensure proper formatting. For instance, prevent sending integer values as strings by configuring them here.

#### Incorporate Test Data into Tests 1. In the Ddosify App, go to the Test Suite and choose the Test Data you previously created using the dropdown menu in the top-right corner of the Test Suite. You have the option to attach multiple Test Data to a single test.

2. Utilize the `{{data.test_data_name.header_name}}` format to insert test data into one of the following locations: URL, headers, query parameters, or authentication.

# Environment Variables {% embed url="" %} Ddosify Environment Variables Feature {% endembed %} Similar to Postman, the Ddosify Platform offers an Environment Variables feature that allows you to store constants in variables for convenient use within your test scenarios. #### Environment Variable Creation 1. Navigate to the Environments listing page within the Ddosify App, and find the 'New' button situated at the top-left corner of the page.

2. Assign a unique name to the new environment, which will be used to link the environment to a test. Next, create your name-value pairs. The values can be of various types, such as Number, String, or Array.

#### Attach Environment into Tests 1. In the Ddosify App, go to the Test Suite and choose the Environment you previously created using the dropdown menu in the top-right corner of the Test Suite.

2. Utilize the `{{environmentVariableName}}` format to insert test data into one of the following locations: URL, headers, query parameters, or authentication.

# Correlation {% embed url="" %} Correlation allows you to link steps together. For instance, you can design a test scenario to evaluate your authentication process by taking the following steps: First, obtain the authentication token from the response of a login request. Then, insert the extracted token into subsequent requests. This short example demonstrates how correlation works in practice. #### Capture Value from the Response 1. Click the ***More*** button located to the right of the step and open the "Step Details" section.

2. To capture a value from the response of a step, go to the "Capture" tab in the "Step Detail" section and follow these steps: * Give a unique name to a variable that you will use to access the captured value in subsequent requests. * Select whether to extract the value from the response body or response headers. * Choose the appropriate extraction type based on where you extract the value. * If you're extracting from the response body, you can use JSON path, XML path, or regular expressions to extract the value. * If you're extracting from response headers, you can extract the entire header value or a part of the header value by using regular expressions.

#### Use Captured Value in Requests You can use the format {{captured\_variable\_name}} to insert a value that was previously captured into various parts of subsequent requests. This includes the URL, the request body, query parameters, headers, and authentication information.

# Assertion {% embed url="" %} Ddosify Assertion Feature {% endembed %} At default, Ddosify marks the step result as successful if it sends the request and receives the response without any network error happening. Status code, body type (or content), or other metrics does not have any effect on success/failure criteria. But this may not be a good test result for your use case and you may want to create your success/fail logic. That's where you can use Assertions. Using the no-code capabilities of the Ddosify Platform, you can easily create assertion logic based on various factors, such as status code, response time, response size, response body, response header, or captured variables. Additionally, you can combine multiple assertions to develop more intricate logic. #### Create Assertion Logic 1. Click the ***More*** button located to the right of the step and open the "Step Details" section.

2. To create an Assertion logic based on the response of a step, go to the "Assertions" tab in the "Step Detail".

3. You can also join assertions using the 'And' operator. If any assertion does not match the specified value, Ddosify will mark the step as failed.

# Debugging {% embed url="" %} Ddosify Debug Feature {% endembed %} Before beginning a load test, it is highly recommended to test the scenario. The debug feature of Ddosify runs the scenario only once, displaying both sent and received packet contents. This includes the environment variables, test data, and captured variables used at each step. {% hint style="info" %} You will not incur any charges for using Debug requests within the Ddosify Cloud platform. {% endhint %} #### Steps to Debug Scenario 1. In the Ddosify App, go to the Test Suite and click the 'Debug' button in the top-right corner of the Test Suite.

2. Once the debugging process is complete, a pop-up window appears, displaying all the necessary information to assist you in examining your configuration.

# Postman Import {% embed url="" %} Ddosify Postman Import Feature {% endembed %} Easily import your Postman Collection into the Ddosify App to test your API endpoints, eliminating the need to configure endpoints separately on both platforms. Additionally, you can import Postman Environments for use as Environment Variables within Ddosify. #### To import Postman Collections, follow these easy steps: 1. Select the 'Import' button located in the top-right corner of the Scenario Step.

2. You have two options for importing your collection into the Ddosify App: either through an exported API from Postman or by uploading a collection file. To learn more about exporting your Postman Collections, refer to the [Postman Export documentation.](https://learning.postman.com/docs/getting-started/importing-and-exporting-data/#exporting-postman-data)

3. On the left side of the screen, choose the requests you'd like to import into Ddosify. Then, on the right side, arrange the selected requests by dragging and dropping them to create a user flow. Ddosify will import the requests in the order you've configured on the right side.

4. When importing a Postman Collection that utilizes environment variables, you can also import these variables into Ddosify. Upon import, Ddosify will save the Postman Environment as a [Ddosify Environment](/ddosify/performance-testing/environment-variables) and associate it with the corresponding test.

Postman Environment Import on Ddosify Platform

5. After clicking the 'Submit' button, Ddosify will generate the specified scenario.

Ddosify Scenairo based on Postman Collection

# Dynamic Variables (Parametrization) Make a load test with dynamic data. Just like the [Postman](https://learning.postman.com/docs/writing-scripts/script-references/variables-list/), Ddosify supports dynamic variables. Actually, we support all the random methods Postman supports. If you use `{{$randomVariable}}` on Postman you can use it as `{{_randomVariable}}` on Ddosify. Just change `$` to `_` and you will be fine. For example, to generate fake integers, you can use `{{_randomInt}}` on *URL, header, body or basic authentication.* To simulate a realistic load test on your system, Ddosify sends every request with the new random value that corresponds to the variable you provide. If you wonder, Ddosify uses [go-faker](https://github.com/ddosify/go-faker) library to generate fake data. Here is the list of all available dynamic variables. ### Common

Variable	Description	Examples
`_guid`	UUID	`5066a748-9a72-404d-94f7-512c0779ff8e`, `adda49b1-7148-4a89-92de-6c4b756c1226`
`_timestamp`	Current timestamp in seconds	`1654037772`, `1654037847`
`_isoTimestamp`	Current ISO timestamp in seconds	`2022-05-31T22:58:40.653Z`, `2022-05-31T22:59:06.013Z`
`_randomUUID`	UUID	`35334fa3-fa83-4589-97e7-7419c9a2173e`, `6661c4cb-ec3a-464c-9ecc-d9fd051e8def`

### Text, Numbers and Colors

Variable	Description	Examples
`_randomAlphaNumeric`	Alphanumberic character	`b`, `6`
`_randomBoolean`	Random boolean value	`true`, `false`
`_randomInt`	Random integer btw. 0 and 1000	`352`, `518`
`_randomColor`	Random color	`silver`, `yellow`
`_randomHexColor`	Random HEX color	`#269423`, `#2859B0`
`_randomAbbreviation`	Rancom abbreviation	`THX`, `XML`

### Internet and IP Addresses | Variable | Description | Examples | | ------------------- | ----------------------- | ------------------------------------------------------------------------------------ | | `_randomIP` | Random IPv4 | `213.102.60.64`, `83.3.166.18` | | `_randomIPV6` | Random IPv6 | `b915:b036:2e09:cb24:5ffc:942c:9592:01f2`, `b915:b036:2e09:cb24:5ffc:942c:9592:01f2` | | `_randomMACAddress` | Random MAC Address | `AE:8E:83:84:A8:98`, `CD:1A:D6:66:88:13` | | `_randomPassword` | Random password | `cprvljasdymm}trs`, `yiqot{uw` | | `_randomLocale` | Random locale | `bo`, `ia` | | `_randomUserAgent` | Random User Agent | `Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.8.0.5) Gecko/20060820 Firefox/1.5.0.5` | | `_randomProtocol` | Random Protocol | `http`, `https` | | `_randomSemver` | Random Semantic Version | `4.2.2`, `8.0.4` | ### Names | Variable | Description | Examples | | ------------------- | ------------------ | ------------------------------- | | `_randomFirstName` | Random first name | `Dorothy`, `Alek` | | `_randomLastName` | Random last name | `Corkery`, `Friesen` | | `_randomFullName` | Random full name | `Patsy Becker`, `Camron Graham` | | `_randomNamePrefix` | Random name prefix | `Mr.`, `Ms.` | | `_randomNameSuffix` | Random name suffix | `I`, `DVM` | ### Profession | Variable | Description | Examples | | ---------------------- | --------------------- | -------------------------------------------------------------- | | `_randomJobArea` | Random job area | `Infrastructure`, `Usability` | | `_randomJobDescriptor` | Random job descriptor | `Regional`, `Global` | | `_randomJobTitle` | Random job title | `Internal Factors Administrator`, `Central Metrics Technician` | | `_randomJobType` | Random job type | `Agent`, `Coordinator` | ### Phone, Address, and Location | Variable | Description | Examples | | ----------------------- | ---------------------------------- | ------------------------------------------------------- | | `_randomPhoneNumber` | Random phone number | `601-272-3813`, `208-658-9378` | | `_randomPhoneNumberExt` | Random phone number with extension | `50-859-544-9083`, `86-685-370-3469` | | `_randomCity` | Random city name | `Ethelfurt`, `Bergstromport` | | `_randomStreetName` | Random street name | `Ethel Roads`, `Bergstrom Valley` | | `_randomStreetAddress` | Random street address | `88 Cassandra Trail`, `847147 Helmer Corners Suite 777` | | `_randomCountry` | Random country | `Malta`, `Bermuda` | | `_randomCountryCode` | Random 2 letter country code | `UG`, `IE` | | `_randomLatitude` | Random latitude | `72.240845`, `13.890682` | | `_randomLongitude` | Random longitude | `68.437796`, `98.146903` | ### Images | Variable | Description | Examples | | ----------------------- | --------------------------- | ------------------------------------------------------------- | | `_randomAvatarImage` | Random avatar image | `http://placeimg.com/640/480/people` | | `_randomImageUrl` | Random image URL | `http://placeimg.com/640/480` | | `_randomAbstractImage` | Random abstract image URL | `http://placeimg.com/640/480/abstract` | | `_randomAnimalsImage` | Random animal image URL | `http://placeimg.com/640/480/animals` | | `_randomBusinessImage` | Random business image URL | `http://placeimg.com/640/480/busines` | | `_randomCatsImage` | Random cat image URL | `http://placeimg.com/640/480/cats` | | `_randomCityImage` | Random city image URL | `http://placeimg.com/640/480/city` | | `_randomFoodImage` | Random food image URL | `http://placeimg.com/640/480/food` | | `_randomNightlifeImage` | Random night life image URL | `http://placeimg.com/640/480/nightlife` | | `_randomFashionImage` | Random fashion image URL | `http://placeimg.com/640/480/fashion` | | `_randomPeopleImage` | Random people image URL | `http://placeimg.com/640/480/people` | | `_randomNatureImage` | Random nature image URL | `http://placeimg.com/640/480/nature` | | `_randomSportsImage` | Random sport image URL | `http://placeimg.com/640/480/sports` | | `_randomTransportImage` | Random transport image URL | `http://placeimg.com/640/480/transport` | | `_randomImageDataUri` | Random image data URI | `data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%22htt...` | ### Finance | Variable | Description | Examples | | ------------------------ | ----------------------------------- | -------------------------------------------------------------------- | | `_randomBankAccount` | Random eight digit bank bumber | `44014606`, `21604863` | | `_randomBankAccountName` | Random bank account name | `Checking`, `Home Loan` | | `_randomCreditCardMask` | Random credit card mask number | `6520`, `5339` | | `_randomBankAccountBic` | Random bank identifier code (swift) | `BKTRTRIS`, `SOGEFRPPRIG` | | `_randomBankAccountIban` | Random IBAN | `HU63755471863115172345115723`, `EE268872311844634138` | | `_randomTransactionType` | Random transaction type | `invoice`, `payment` | | `_randomCurrencyCode` | Random three letter currency code | `BIF`, `QAR` | | `_randomCurrencyName` | Random currency name | `Uzbekistan Sum`, `Rupiah` | | `_randomCurrencySymbol` | Random currency symbol | `J$`, `£` | | `_randomBitcoin` | Random bitcoin address | `XBvHFJHdGdszbgqwDi6yZy7QXgeU`, `XBvHFJHdGdszbgqwDi6yZy7QXgeUSiH5kT` | ### Business | Variable | Description | Examples | | ---------------------- | ------------------------------- | ---------------------------------------------------------------- | | `_randomCompanyName` | Random company name | `Daniel Bruen`, `Michael Cassin` | | `_randomCompanySuffix` | Random company suffix | `und Söhne`, `Inc.` | | `_randomBs` | Random business speak words | `synthesize efficient systems`, `matrix virtual functionalities` | | `_randomBsAdjective` | Random business speak adjective | `interactive`, `plug-and-play` | | `_randomBsBuzz` | Random business speak buzzword | `harness`, `morph` | | `_randomBsNoun` | Random business speak noun | `paradigms`, `infrastructures` | ### Catchphrases | Variable | Description | Examples | | ------------------------------ | ------------------------------ | ---------------------------------------------------------------------- | | `_randomCatchPhrase` | Random catchpharase | `Monitored explicit throughput`, `Secured stable budgetary management` | | `_randomCatchPhraseAdjective` | Random catchpharase adjective | `Implemented`, `Secured` | | `_randomCatchPhraseDescriptor` | Random catchpharase descriptor | `bandwidth-monitored`, `hybrid` | | `_randomCatchPhraseNoun` | Random catchpharase noun | `array`, `installation` | ### Databases | Variable | Description | Examples | | -------------------------- | ------------------------- | -------------------------------- | | `_randomDatabaseColumn` | Random database column | `updatedAt`, `createdAt` | | `_randomDatabaseType` | Random database type | `serial`, `datetime` | | `_randomDatabaseCollation` | Random database collation | `cp1250_general_ci`, `ascii_bin` | | `_randomDatabaseEngine` | Random database engine | `ARCHIVE`, `BLACKHOLE` | ### Dates | Variable | Description | Examples | | ------------------- | ---------------------- | -------------------------------------------------------------- | | `_randomDateFuture` | Random future datetime | `Wed Mar 18 09:19:24 UTC 2026`, `Fri Aug 1 09:58:13 UTC 2025` | | `_randomDatePast` | Random past datetime | `Tue Dec 20 21:06:56 UTC 2016`, `Sun Dec 5 07:14:23 UTC 2021` | | `_randomDateRecent` | Random recent datetime | `Thu Apr 14 12:14:25 UTC 2022`, `Thu Apr 14 12:14:33 UTC 2022` | | `_randomWeekday` | Random weekday | `Wednesday`, `Thursday` | | `_randomMonth` | Random month | `March`, `August` | ### Domains, Emails, and Usernames | Variable | Description | Examples | | --------------------- | -------------------------------- | ------------------------------------------------------------ | | `_randomDomainName` | Random domain name | `claudiabeier.com`, `chasescott.ac.uk` | | `_randomDomainSuffix` | Random domain suffix | `scot`, `info` | | `_randomDomainWord` | Random domain word | `jessecormier`, `victoriafisher` | | `_randomEmail` | Random email | `max.smitham@hotmail.com`, `ivy.wood@outlook.com` | | `_randomExampleEmail` | Random email with example domain | `isabella.bauch@example.net`, `tahlia.baumbach@example.org` | | `_randomUserName` | Random username | `Hayden.Heaney`, `Lara.Durgan` | | `_randomUrl` | Random URL | `https://sophiemills.scot`, `https://harrisongoldner.ltd.uk` | ### Files and Directories | Variable | Description | Examples | | ----------------------- | ---------------------------- | ---------------------------------------------------------------- | | `_randomFileName` | Random file name | `matthew_moore.gdoc`, `angus_daniel.mov` | | `_randomFileType` | Random file type | `video` `application` | | `_randomFileExt` | Random file extension | `xml`, `gif` | | `_randomCommonFileName` | Random common file name | `marcuswaters.csv`, `elizaowen.html` | | `_randomCommonFileType` | Random common file tyoe | `application`, `image` | | `_randomCommonFileExt` | Random common file extension | `m3a`, `gif` | | `_randomFilePath` | Random file path | `/usr/X11R6/hugoschmidt.mp4`, `/usr/libexec/mitchelloreilly.mp4` | | `_randomDirectoryPath` | Random directory path | `/proc`, `/usr` | | `_randomMimeType` | Random mime type | `image/gif`, `image/png` | ### Stores | Variable | Description | Examples | | ------------------------- | --------------------------- | ----------------------------------------------------- | | `_randomPrice` | Random price (0.00-1000.00) | `445.60`, `802.67` | | `_randomProduct` | Random product | `Hat`, `Shoes` | | `_randomProductAdjective` | Random product adjective | `Fantastic`, `Tasty` | | `_randomProductMaterial` | Random product material | `Cotton`, `Steel` | | `_randomProductName` | Random product name | `Gorgeous Frozen Chicken`, `Recycled Bronze Sausages` | | `_randomDepartment` | Random stores department | `Tools`, `Health` | ### Grammar | Variable | Description | Examples | | ------------------ | ---------------- | -------------------------------------------------------------------- | | `_randomNoun` | Random noun | `interface`, `port` | | `_randomVerb` | Random verb | `calculate`, `parse` | | `_randomIngverb` | Random ing verb | `indexing`, `hacking` | | `_randomAdjective` | Random adjective | `multi-byte`, `neural` | | `_randomWord` | Random word | `program`, `overriding` | | `_randomWords` | Random words | `virtual navigate 1080p`, `reboot online alarm` | | `_randomPhrase` | Random phrase | `nobis iste omnis iusto aut. aliquam illo maxime aperiam nobis. ...` | ### Lorem Ipsum | Variable | Description | Examples | | ------------------------ | ----------------------------- | ------------------------------------------------------------------------- | | `_randomLoremWord` | Random lorem ipsum word | `iusto`, `quaerat` | | `_randomLoremWords` | Random lorem ipsum words | `officiis iusto`, `deleniti molestiae veritatis non` | | `_randomLoremSentence` | Random lorem ipsum sentence | `delectus iure qui qui veritatis sit accusantium.` | | `_randomLoremSentences` | Random lorem ipsum sentences | `ab perferendis cupiditate atque. saepe sed nulla ut deserunt.` | | `_randomLoremParagraph` | Random lorem ipsum paragraph | `provident asperiores dolorum. beatae totam ut. ...` | | `_randomLoremParagraphs` | Random lorem ipsum paragraphs | `eum reiciendis modi. ab minus vero. exercitationem nisi. ...` | | `_randomLoremText` | Random lorem ipsum text | `quia officim laborum. aliquid ullam blanditiis voluptatem ipsam labore.` | | `_randomLoremSlug` | Random lorem ipsum slug | `cupiditate-consectetur-et`, `adipisci-suscipit-qui` | | `_randomLoremLines` | Random lorem ipsum lines | `esse soluta voluptatem atque aut ut \n exercitationem optio est` | # Integrations Ddosify sends alerts through three integration options: [Slack](#slack-integration), [Opsgenie](#opsgenie-integration), and [Webhook](#webhook-integration). ### Add Integration On Ddosify, click the Integrations tab. You can see the list of integrations you have added on this page. To add a new integration, click on the **+ Add Integration** button.

#### Slack Integration Send alerting messages to your Slack channels. Ddosify uses its own Slack application for the integration. {% hint style="info" %} If you use Ddosify Self-hosted EE, you can make a Slack integration for alerts. Check [docs](/ddosify/self-hosted/self-hosted-slack-integration) for more. {% endhint %} 1\) Select Slack from the left menu, give it a name and click the Make Integration button.

2\) Ddosify application requests permission to access your Slack workspace to send notifications. Click the Allow button.

3\) Select a Slack channel for notifications and click the Save Channel button. You can change the channel later.

4\) You should see the Success message. Click the **Test Integration** button to check everything is working as expected. Ddosify will send a test message to the channel.

On Slack, you should see the test message.

#### Opsgenie Integration Integrate Opsgenie to manage alert escalations and on-call schedules. 1\) Select Opsgenie from the left menu, give it a name, paste your Opsgenie API Key (Check [Opsgenie docs](https://support.atlassian.com/opsgenie/docs/api-key-management/)) and select **Notification Type** (Alert or Incident) and click the **Make Integration** button.

2\) Click the **Test Integration** button to check everything is working as expected. You should see a success message if the integration is successful.

#### Webhook Integration Send a HTTP POST request when an alert occurs. For testing the webhook integration, you can use [Beeceptor](https://beeceptor.com/), [ngrok](https://ngrok.com/) or similar tools. 1\) Select Webhook from the left menu and give it a name, URL, and Headers for Webhook integration. Ddosify sends a HTTP POST request to the URL with the given Headers and Basic Auth.

2\) Click the **Test Integration** button to ensure everything works as expected. You should see a success message if the integration is successful.

{% hint style="success" %} If you require assistance with Slack, Opsgenie or Webhook integration, you can join our [Discord](https://discord.com/invite/9KdnrSUZQg) or send an email to . {% endhint %} # Deployment There are various deployment options for: * 🏠 [Ddosify Self-hosted](#ddosify-self-hosted) * 🚀 [Ddosify Engine](#ddosify-engine) * 🐝 [Ddosify eBPF Agent (Alaz)](#ddosify-ebpf-agent-alaz) * ☁️ [Ddosify Cloud](#ddosify-cloud) <- *If you need a complete SaaS solution* ### 🏠 Ddosify Self-hosted

Ddosify automatically generates a Service Map of your K8s cluster without code instrumentation or sidecars. So you can easily find the bottlenecks in your system. Red lines indicate the high latency between services.

If you need a web-based user interface with **Performance Testing**, and **Kubernetes Monitoring** capabilities and want to maintain it on your own, Ddosify Self-hosted is the right choice for you. Check out the [Ddosify Self-hosted](https://github.com/ddosify/ddosify/tree/master/selfhosted) guide for reference. You can also deploy Ddosify Self-hosted on [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-mwvnujtgjedjy). ### 🚀 Ddosify Engine

With Ddosify Engine you can simulate and load test your endpoints on your terminal without writing code.

If you need CLI-based load testing tool, [Ddosify Engine](https://github.com/ddosify/ddosify/tree/master/engine_docs) is an open-source and high-performance load testing tool, written in Golang. Check out the [Ddosify Engine Installation](https://github.com/ddosify/ddosify/tree/master/engine_docs#installation) guide for reference. ### 🐝 Ddosify eBPF Agent (Alaz) If you use Kubernetes Monitoring either on Ddosify Cloud or Ddosify Self-hosted, the Ddosify eBPF Agent (Alaz) must be installed as a Daemonset on your Kubernetes cluster. The system resources are limited to 1 CPU core and 1Gi Memory per K8s node, so it it very lightweight. Check out the [Alaz GitHub](https://github.com/ddosify/alaz) repository for reference. ### ☁️ Ddosify Cloud If you need a complete SaaS solution for Performance Testing **worldwide** and Kubernetes Monitoring and do not want to manage the services, Ddosify Cloud is the right choice. Check out the [Ddosify Cloud](https://app.ddosify.com/) guide for reference. {% hint style="success" %} If you require assistance with deploying Ddosify, you can join our [Discord](https://discord.com/invite/9KdnrSUZQg) or send an email to . {% endhint %} # API Ddosify Load Testing API Although you can use Ddosify Cloud Web UI to create and analyze load tests, we support API integration to let you automate your tasks. In this documentation, we'll provide detailed descriptions of each API endpoint, along with example requests and responses. We'll also include code samples in several programming languages to help you start quickly. Additionally, we have a [public Postman collection](https://www.postman.com/ddosify/workspace/ddosify-public/overview) that you can use to quickly and easily test out our API endpoints. The collection includes requests and responses for each API endpoint, so you can see how the API works and test out different parameters and inputs. * [Load Testing API](/ddosify/api/load-testing-api) ### Get Your API Key You'll need your secret API Key to successfully send requests to the Ddosify endpoints. To get your API Key, go to your [Account Settings](https://app.ddosify.com/account-settings) page. Then copy your API Key. {% hint style="warning" %} It is your responsibility to store your API Key safely. {% endhint %}

# Load Testing API Ddosify Load Testing API You can automate the process of load testing your web applications or APIs, and easily incorporate load testing into your CI/CD pipeline. Our API provides a wide range of features, including the ability to create load test plans, run load tests, and retrieve detailed reports and metrics on test results. You can also create environment variables and test data (CSV) using this API. The API is designed to be easy to use, with a RESTful architecture and JSON-based responses. In this section, you will find the APIs for `test` and `plan` endpoints. It's recommended to start the load test with a test plan using [this](#create-a-load-test-with-plan-recommended) endpoint. You can create test plans easily with no-code UI using [Ddosify Cloud](https://app.ddosify.com/load/test-plans). You can select the `Save as Test Plan` in the summary page of the test suite. Once you create the test plan you can get the test plan id from the URL: `https://app.ddosify.com/load/configure-test-plans/` * [Create a Load Test (POST)](#create-a-load-test) * [Create a Load Test with Plan (POST)](#create-a-load-test-with-plan-recommended) <- Recommended * [List Load Tests (GET)](#get-load-tests) * [Retrieve the Load Test (GET)](#retrieve-details-of-the-load-test) * [Result of the Load Test (GET)](#result-of-load-test) * [Stop the Load Test (GET)](#stop-the-load-test) * [Get Supported Load Locations (GET)](#get-supported-load-locations)
* [Create Test Plan (POST)](#create-a-load-test-plan) * [List Test Plans (GET)](#get-load-test-plans) * [Retrieve the Test Plan (GET)](#retrieve-details-of-the-load-test-plan) * [Update the Test Plan (PATCH)](#update-the-load-test-plan) * [Delete the Test Plan (DELETE)](#delete-the-load-test-plan)
* [Create Environment (POST)](#create-environment) * [List Environments (GET)](#get-environments) * [Retrieve the Environment (GET)](#retrieve-details-of-the-environment) * [Update the Environment (PATCH)](#update-the-environment) * [Delete the Environment (DELETE)](#delete-the-environment)
* [Create Test Data (POST)](#create-test-data) * [List Test Data (GET)](#get-test-data) * [Retrieve the Test Data (GET)](#retrieve-details-of-the-test-data) * [Delete the Test Data (DELETE)](#delete-the-test-data) You can also find different [examples](/ddosify/api/load-testing-api/load-testing-examples) of this API. {% hint style="warning" %} All endpoints require the `X-API-KEY` header for authentication. Please check the [Get Your API Key](/ddosify/api#get-your-api-key) section to learn how you can get it. {% endhint %} {% hint style="info" %} For every successful load test, you'll be charged for `request_count` and `duration` in the body `config_data`. {% endhint %} {% hint style="info" %} API concurrency limit is 5 **requests per second** for GET endpoints and 2 **requests per second** for others. You will get `HTTP 429` (Concurrency Limit Exceeded) when you reach the concurrency. {% endhint %} ### Load Test ## Create a Load Test `POST` `https://api.ddosify.com/v1/load/test/` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | #### Request Body | Name | Type | Description | | ---------------------------------------------- | ------ | ----------------------------------------------------- | | name\* | String | Name of the test | | config\_data\* | JSON | Configuration of the load test. [More](#config-data). | {% tabs %} {% tab title="201: Created Test Created" %} ```json { "id": "fda3642b-df27-409d-b24d-63f861840ac5", "test_url": "https://app.ddosify.com/load/report/fda3642b-df27-409d-b24d-63f861840ac5", "status": "initial", "failure_reason": null } ``` {% endtab %} {% tab title="400: Bad Request Invalid Request Parameters" %} ```javascript { "msg": "Detail..." } ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```javascript { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} ```javascript ``` {% endtab %} {% endtabs %} ## Create a Load Test with Plan (Recommended) `POST` `https://api.ddosify.com/v1/load/test/` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | #### Request Body | Name | Type | Description | | ---------------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------- | | name\* | String | Name of the test | | test\_plan\_template\_id\* | UUID | Test Plan ID. Create test plan with [this](#create-a-load-test-plan) endpoint. | | environment\_id | UUID | Environment ID to override the test. Get the environments from [this](#get-environments) endpoint. | {% tabs %} {% tab title="201: Created Test Created" %} ```javascript { "id": "fda3642b-df27-409d-b24d-63f861840ac5", "test_url": "https://app.ddosify.com/load/report/fda3642b-df27-409d-b24d-63f861840ac5", "status": "initial", "failure_reason": null } ``` {% endtab %} {% tab title="400: Bad Request Invalid Request Parameters" %} ```javascript { "msg": "Detail..." } ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```javascript { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} ```javascript ``` {% endtab %} {% endtabs %} ## Get Load Tests `GET` `https://api.ddosify.com/v1/load/test/` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | {% tabs %} {% tab title="200: OK List of load tests" %} ```json [ { "id": "0b04ac74-b389-4749-9fa8-7484900d8319", "environment_id": null, "test_plan_template_id": null, "name": "Test 14", "testdata_ids": null, "date_created": "2023-03-04T00:25:50.225449Z", "status": "done", "failure_reason": null }, { "id": "83cef293-3929-4137-a107-8890d96c43b1", "environment_id": null, "test_plan_template_id": null, "name": "Admin Test 10", "testdata_ids": null, "date_created": "2023-02-24T09:56:01.765072Z", "status": "done", "failure_reason": null }, { "id": "82d8b25f-6e78-4281-b7db-b7235c0a9a2d", "environment_id": null, "test_plan_template_id": null, "name": "Admin Test 10", "testdata_ids": null, "date_created": "2023-02-23T11:54:50.012640Z", "status": "done", "failure_reason": null } ] ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```javascript { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} ```javascript ``` {% endtab %} {% endtabs %} ## Retrieve details of the Load Test `GET` `https://api.ddosify.com/v1/load/test//` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | {% tabs %} {% tab title="200: OK Details of load test" %} ```json { "id": "5308bc3c-7bc3-4a25-95d8-abdb57042098", "environment_id": null, "test_plan_template_id": null, "name": "Test 14", "config_data": { "steps": [ { "id": 1, "url": "https://servdown.com", "name": "Home Page", "method": "GET", "others": { "h2": false, "keep-alive": false, "disable-redirect": false, "disable-compression": false }, "headers": { "Host": "asgfasfgas" }, "payload": "{\"id\": 5}", "timeout": 15 } ], "duration": 20, "load_type": "linear", "proxy_config": { "DE": 50, "US": 50 }, "request_count": 100 }, "testdata_ids": null, "date_created": "2023-03-02T18:01:45.819888Z", "status": "done", "failure_reason": null } ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```javascript { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} ```javascript ``` {% endtab %} {% endtabs %} ## Result of Load Test `GET` `https://api.ddosify.com/v1/load/test//result/` This endpoint waits until the test is finished. [More](#test-result). #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | {% tabs %} {% tab title="200: OK Result of load test." %} ```json { "test_url": "https://app.ddosify.com/load/report/9272cecd-b844-43bc-9702-469895f20d90", "results": { "steps": [ { "id": 1, "error_dist": {}, "fail_count": 0, "location_dist": { "DE": { "error_dist": {}, "fail_count": 0, "location_dist": {}, "success_count": 500, "response_times": { "avg": 26, "max": 63, "min": 19, "p80": 29, "p90": 33, "p95": 37, "p99": 56, "median": 24, "stddev": 6 }, "iteration_count": 500, "status_code_dist": { "405": 500 } }, "US": { "error_dist": {}, "fail_count": 0, "location_dist": {}, "success_count": 500, "response_times": { "avg": 172, "max": 201, "min": 162, "p80": 175, "p90": 178, "p95": 181, "p99": 193, "median": 171, "stddev": 5 }, "iteration_count": 500, "status_code_dist": { "405": 500 } } }, "success_count": 1000, "response_times": { "avg": 99, "max": 201, "min": 19, "p80": 172, "p90": 175, "p95": 178, "p99": 189, "median": 113, "stddev": 73 }, "iteration_count": 1000, "status_code_dist": { "405": 1000 } }, { "id": 2, "error_dist": {}, "fail_count": 0, "location_dist": { "DE": { "error_dist": {}, "fail_count": 0, "location_dist": {}, "success_count": 500, "response_times": { "avg": 48, "max": 242, "min": 35, "p80": 51, "p90": 57, "p95": 70, "p99": 131, "median": 44, "stddev": 17 }, "iteration_count": 500, "status_code_dist": { "200": 500 } }, "US": { "error_dist": {}, "fail_count": 0, "location_dist": {}, "success_count": 500, "response_times": { "avg": 323, "max": 807, "min": 296, "p80": 317, "p90": 332, "p95": 383, "p99": 684, "median": 307, "stddev": 64 }, "iteration_count": 500, "status_code_dist": { "200": 500 } } }, "success_count": 1000, "response_times": { "avg": 186, "max": 807, "min": 35, "p80": 309, "p90": 317, "p95": 332, "p99": 678, "median": 269, "stddev": 145 }, "iteration_count": 1000, "status_code_dist": { "200": 1000 } } ], "fail_count": 0, "location_dist": { "DE": { "fail_count": 0, "success_count": 500, "response_times": { "avg": 37, "max": 242, "min": 19, "p80": 46, "p90": 52, "p95": 59, "p99": 96, "median": 37, "stddev": 17 }, "iteration_count": 500 }, "US": { "fail_count": 0, "success_count": 500, "response_times": { "avg": 247, "max": 807, "min": 162, "p80": 309, "p90": 317, "p95": 332, "p99": 678, "median": 249, "stddev": 88 }, "iteration_count": 500 } }, "success_count": 1000, "response_times": { "avg": 142, "max": 807, "min": 19, "p80": 303, "p90": 309, "p95": 317, "p99": 400, "median": 163, "stddev": 122 }, "iteration_count": 1000 } } ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```javascript { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} ```javascript ``` {% endtab %} {% endtabs %} ## Stop the Load Test `GET` `https://api.ddosify.com/v1/load/test//stop/` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | {% tabs %} {% tab title="200: OK Load test is stopped" %} {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```javascript { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} {% endtab %} {% endtabs %} ## Get Supported Load Locations `GET` `https://api.ddosify.com/v1/load/locations/` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | {% tabs %} {% tab title="200: OK List of supported load locations" %} ```json { "countries": [ "AU", "BE", "CA", "CH", "CN", "DE", "ES", "FI", "FR", "GB", "HK", "HR", "HU", "IL", "IT", "JP", "NL", "NO", "PL", "RO", "RS", "SE", "TR", "UA", "US" ] } ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```json { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} {% endtab %} {% endtabs %} #### Config Data Config data contains the configuration of the load test to [start a load test](#start-a-load-test) and [create load test plan](#create-a-load-test-plan) endpoints. Here is an example: ```json { "steps": [ { "id": 1, "url": "https://servdown.com", "name": "Home Page", "method": "POST", "others": { "h2": false, "disable-redirect": false, "disable-compression": false }, "headers": { "Test-Header": "Test Value", "Test-Header2": "Test Value2" }, "payload": "{\"id\": 24}", "timeout": 15 }, { "id": 2, "url": "https://app.servdown.com", "name": "Servdown App", "method": "GET", "others": { "h2": false, "disable-redirect": false, "disable-compression": false }, "timeout": 15 } ], "proxy_config": { "US": 50, "DE": 50 }, "iteration_count": 1000, "load_type": "linear", "duration": 20 } ``` This load-testing configuration includes `two` steps, each of which represents a specific action to be executed by the load-testing tool. The first step represents a `POST` request to the "[https://servdown.com](https://servdown.com/)" URL with a payload of `{"id": 24}`. The headers of the request include `Test-Header` with a value of `Test Value` and `Test-Header2` with a value of `Test Value2`. The timeout for this step is set to `15` seconds. The second step represents a `GET` request to the "[https://app.servdown.com](https://app.servdown.com/)" URL. The timeout for this step is also set to `15` seconds. The `proxy_config` field indicates that the load testing tool will use a mix of `US (United States)` and `DE (Germany)` servers, with a `50/50` distribution. You can get the full list of the supported locations by using [this](#get-supported-load-locations) endpoint. The `iteration_count` field indicates that the load testing tool will execute each step `1000` times. There will be a total of `1000*2=2000` requests. The `load_type` field specifies a `linear` load pattern, which means that the load will be the same over time. The `duration` field indicates that the load testing will last for `20` seconds. | Key | Supported | Description | | -------------- | ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- | | `proxy_config` | `"AU","BE","CA","CH","CN","DE","ES","FI","FR","GB","HK","HR","HU","IL","IT","JP","NL","NO","PL","RO","RS","SE","TR","UA","US"` | Supported locations. You can get the list with [this](#get-supported-load-locations) endpoint. | | `load_type` | `"linear", "waved", "incremental"` | Type of the load. [More](https://github.com/ddosify/ddosify#load-types). | ### Load Test Plan ## Create a Load Test Plan `POST` `https://api.ddosify.com/v1/load/plan/` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | #### Request Body | Name | Type | Description | | ---------------------------------------------- | ------ | ----------------------------------------------------- | | name\* | String | Test plan name. It's unique. | | config\_data\* | JSON | Configuration of the load test. [More](#config-data). | {% tabs %} {% tab title="201: Created Test Plan Created" %} ```json { "id": "49350aff-1b77-493f-bb20-9742ed345a0c" } ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```json { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} ```javascript ``` {% endtab %} {% tab title="400: Bad Request Invalid Request Parameters" %} ```javascript { "msg": "Detail..." } ``` {% endtab %} {% endtabs %} ## Get Load Test Plans `GET` `https://api.ddosify.com/v1/load/plan/` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | {% tabs %} {% tab title="200: OK List of load test plans" %} ```json [ { "id": "6c140d00-c01f-4d60-935a-6d4424f49497", "test_count": 1, "environment_id": null, "name": "Fatih Test TestPlan Template 392124212242", "testdata_ids": null, "date_created": "2023-02-23T10:33:20.848546Z" }, { "id": "d5c3b48c-cea1-4949-aae0-caa73bea6242", "environment_name": "Test Environment Name 6", "test_count": 2, "environment_id": "0fe50223-32a5-4cf6-9079-58e02d256331", "name": "Fatih Test TestPlan Template 434", "testdata_ids": [ "7feefbce-8189-42f5-9c93-edfe58023b46" ], "date_created": "2023-02-18T22:06:04.647822Z" }, { "id": "3010a2ed-3b01-41cb-a2f0-78b32ddda6c8", "test_count": 0, "environment_id": null, "name": "Fatih Test TestPlan New Name", "testdata_ids": null, "date_created": "2023-02-14T12:46:14.250734Z" } ] ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```json { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} ```javascript ``` {% endtab %} {% endtabs %} ## Retrieve details of the Load Test Plan `GET` `https://api.ddosify.com/v1/load/plan//` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | {% tabs %} {% tab title="200: OK Load test plan" %} ```json { "id": "6d0a3cd4-a625-407c-9dc7-c7702b670550", "environment_id": null, "name": "Test TestPlan Template 1241241", "config_data": { "steps": [ { "id": 1, "url": "https://app.servdown.com/accounts/login/?next=/", "method": "GET", "headers": { "ContenType": "application/xml", "X-ddosify-key": "ajkndalnasd" }, "payload": "", "timeout": 5 } ], "duration": 10, "load_type": "linear", "proxy_config": { "DE": 30, "GB": 20, "US": 50 }, "request_count": 100 }, "testdata_ids": null, "date_created": "2023-02-28T15:36:36.510444Z" } ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```json { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} ```javascript ``` {% endtab %} {% endtabs %} ## Update the Load Test Plan `PATCH` `https://api.ddosify.com/v1/load/plan//` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | #### Request Body | Name | Type | Description | | ------------ | ------ | ----------------------------------------------------- | | name | String | Test plan name | | config\_data | JSON | Configuration of the load test. [More](#config-data). | {% tabs %} {% tab title="200: OK " %} ```json { "id": "49350aff-1b77-493f-bb20-9742ed345a0c", "environment_id": null, "name": "TestPlan New Name", "config_data": { "steps": [ { "id": 1, "url": "https://app.servdown.com/accounts/login/?next=/", "method": "GET", "headers": { "ContenType": "application/xml", "X-ddosify-key": "ajkndalnasd" }, "payload": "", "timeout": 5 } ], "duration": 10, "load_type": "linear", "proxy_config": { "DE": 30, "GB": 20, "US": 50 }, "request_count": 100 }, "testdata_ids": null } ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```json { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} ```javascript ``` {% endtab %} {% endtabs %} ## Delete the Load Test Plan `DELETE` `https://api.ddosify.com/v1/load/plan//` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | {% tabs %} {% tab title="204: No Content " %} ```javascript { // Response } ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```json { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} ```javascript ``` {% endtab %} {% endtabs %} ### Environment ## Create Environment `POST` `https://api.ddosify.com/v1/environment/` [Example](/ddosify/api/load-testing-api/load-testing-examples#create-environment). #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | #### Request Body | Name | Type | Description | | -------------------------------------- | ------ | ------------------------------ | | name\* | String | Environment name. It's unique. | | vars\* | JSON | Variables. [More](#vars). | {% tabs %} {% tab title="201: Created Environment Created" %} ```json { "id": "e5cf444d-9d76-4ba6-843c-b20d2bcf3302" } ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```json { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} ```javascript ``` {% endtab %} {% tab title="400: Bad Request Invalid Request Parameters" %} ```javascript { "msg": "Detail..." } ``` {% endtab %} {% endtabs %} ## Get Environments `GET` `https://api.ddosify.com/v1/environment/` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | {% tabs %} {% tab title="200: OK List of environments" %} ````javascript ```json [ { "id": "e5cf444d-9d76-4ba6-843c-b20d2bcf3302", "name": "Test Environment Name 5", "vars": [ { "key": "test_key_1_bool", "value": false }, { "key": "test_key_2_string", "value": "test_value_2" }, { "key": "test_key_2_number_int", "value": 15 }, { "key": "test_key_2_number_float", "value": 15.2 }, { "key": "test_key_2_number_list", "value": [ 14, 12, 15 ] } ], "date_created": "2023-03-05T20:59:13.440806Z" }, { "id": "8ad0f224-c338-4722-9c6d-ef14abcf8449", "name": "Test Environment Name 3", "vars": [ { "key": "test_key_1", "value": false }, { "key": "test_key_2", "value": "test_value_2" } ], "date_created": "2023-03-05T19:29:20.582063Z" } ] ```` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```json { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} ```javascript ``` {% endtab %} {% endtabs %} ## Retrieve details of the Environment `GET` `https://api.ddosify.com/v1/environment//` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | {% tabs %} {% tab title="200: OK Environment" %} ```json { "id": "e5cf444d-9d76-4ba6-843c-b20d2bcf3302", "name": "Test Environment Name 5", "vars": [ { "key": "test_key_1_bool", "value": false }, { "key": "test_key_2_string", "value": "test_value_2" }, { "key": "test_key_2_number_int", "value": 15 }, { "key": "test_key_2_number_float", "value": 15.2 }, { "key": "test_key_2_number_list", "value": [ 14, 12, 15 ] } ], "date_created": "2023-03-05T20:59:13.440806Z" } ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```json { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} ```javascript ``` {% endtab %} {% endtabs %} ## Update the Environment `PATCH` `https://api.ddosify.com/v1/environment//` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | #### Request Body | Name | Type | Description | | ---- | ------ | ------------------------------ | | name | String | Environment name. It's unique. | | vars | JSON | Variables. [More](#vars). | {% tabs %} {% tab title="200: OK " %} ```json { "id": "e5cf444d-9d76-4ba6-843c-b20d2bcf3302", "name": "Test Environment Name 12421", "vars": [ { "key": "test_key_3", "value": 1234 }, { "key": "test_key_2", "value": "test_value_2" } ] } ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```json { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} ```javascript ``` {% endtab %} {% endtabs %} ## Delete the Environment `DELETE` `https://api.ddosify.com/v1/environment//` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | {% tabs %} {% tab title="204: No Content " %} {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```json { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} {% endtab %} {% endtabs %} #### vars `vars` represents the environment variables for [Create Environment](#create-environment) endpoint. Each key-value pair consists of a `key` and a `value`. The `key` represents the name of the environment variable to be set, and the `value` represents the value to be assigned to that variable. The types of values can be `bool`, `number`, `string` and `array`. Here is an example of vars: ```json [ {"key": "test_key_bool", "value": false}, {"key": "test_key_string", "value": "test_value_2"}, {"key": "test_key_number_int", "value": 15}, {"key": "test_key_number_float", "value": 15.2}, {"key": "test_key_array", "value": [14, 12, 15]} ] ``` In this specific example, there are five environment variables: * `test_key_bool` with a type of bool and value of `false` * `test_key_string` with a type of string and value of `test_value_2` * `test_key_number_int` with a type of number and value of `15` * `test_key_number_float` with a type of number and value of `15.2` * `test_key_array` with a type of `array` and value of `[14, 12, 15]` ### Test Data (CSV) ## Create Test Data `POST` `https://api.ddosify.com/v1/testdata/` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | #### Request Body | Name | Type | Description | | ---------------------------------------------- | ------ | ---------------------------------- | | name\* | String | Test Data name. It's unique. | | file\* | File | CSV File | | type | String | Default is `csv`. | | file\_config\* | JSON | File config. [More](#file_config). | {% tabs %} {% tab title="201: Created Test Data Created" %} ```json { "id": "6c50cc89-8c1f-46f1-af9d-d61fdfc4c2f4", "name": "name_of_file", "file": "https://URL/media/testdata/38f79dbc-742f-4c73-9451-d30b54f412d2/6c50cc89-8c1f-46f1-af9d-d61fdfc4c2f4/original/medals.csv", "type": "csv", "file_config": { "delimiter": ";", "vars": { "0": { "tag": "year", "type": "int" }, "1": { "tag": "city" }, "2": { "tag": "sport" }, "5": { "tag": "event", "type": "json" }, "7": { "tag": "medal" }, "8": { "tag": "no" } }, "allow_quota": true, "order": "random", "skip_first_line": true, "skip_empty_line": true }, "no_of_records": 2311, "size": 147343, "date_created": "2023-01-25T09:47:42.592256Z" } ``` {% endtab %} {% tab title="400: Bad Request Invalid Request Parameters" %} ```javascript { "msg": "Detail..." } ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```javascript { "msg": "Detail..." } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} {% endtab %} {% endtabs %} ## Get Test Data `GET` `https://api.ddosify.com/v1/testdata/` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | {% tabs %} {% tab title="200: OK List of Test Data" %} ```json [ { "id": "0696f680-96db-4b1a-b435-28238c2d7ecd", "name": "transactions2", "file": "https://URL/media/staging/testdata/d8beff19-9310-426b-9e21-a610ae956884/0696f680-96db-4b1a-b435-28238c2d7ecd/original/transactions.csv", "type": "csv", "file_config": { "vars": { "0": { "tag": "api_key", "type": "string" }, "1": { "tag": "amount", "type": "string" }, "2": { "tag": "from", "type": "string" }, "3": { "tag": "to", "type": "string" } }, "order": "random", "delimiter": ",", "allow_quota": false, "skip_empty_line": true, "skip_first_line": true }, "no_of_records": 1000, "size": 52772, "date_created": "2023-02-20T18:59:54.037321Z" }, { "id": "f6903569-1a14-4f86-b5c8-5b2e034d739c", "name": "test_data", "file": "https://URL/media/staging/testdata/d8beff19-9310-426b-9e21-a610ae956884/f6903569-1a14-4f86-b5c8-5b2e034d739c/original/test_data.csv", "type": "csv", "file_config": { "vars": { "0": { "tag": "Username", "type": "string" }, "1": { "tag": "City", "type": "string" }, "2": { "tag": "Team", "type": "string" }, "3": { "tag": "Payload", "type": "json" }, "4": { "tag": "Age", "type": "int" } }, "order": "random", "delimiter": ",", "allow_quota": false, "skip_empty_line": true, "skip_first_line": true }, "no_of_records": 99, "size": 1177, "date_created": "2023-02-20T18:59:14.151061Z" } ] ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```javascript { // Response } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} {% endtab %} {% endtabs %} ## Retrieve details of the Test Data `GET` `https://api.ddosify.com/v1/testdata//` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | {% tabs %} {% tab title="200: OK Test Data" %} ```json { "id": "3a6bf234-38c5-4858-87e3-b3fdfb4ffcd2", "name": "test_data_success", "file": "https://URL/media/staging/testdata/d8beff19-9310-426b-9e21-a610ae956884/3a6bf234-38c5-4858-87e3-b3fdfb4ffcd2/original/test_data.csv", "type": "csv", "file_config": { "vars": { "0": { "tag": "Username", "type": "string" }, "1": { "tag": "City", "type": "string" }, "2": { "tag": "Team", "type": "string" }, "3": { "tag": "Payload", "type": "json" }, "4": { "tag": "Age", "type": "int" } }, "order": "random", "delimiter": ",", "allow_quota": true, "skip_empty_line": true, "skip_first_line": true }, "no_of_records": 99, "size": 1177, "date_created": "2023-02-20T20:48:45.864423Z" } ``` {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```javascript { // Response } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} {% endtab %} {% endtabs %} ## Delete the Test Data `DELETE` `https://api.ddosify.com/v1/testdata//` #### Headers | Name | Type | Description | | ------------------------------------------- | ---- | ------------ | | X-API-KEY\* | UUID | Your API KEY | {% tabs %} {% tab title="204: No Content " %} {% endtab %} {% tab title="403: Forbidden API key is not found or not valid" %} ```javascript { // Response } ``` {% endtab %} {% tab title="429: Too Many Requests Concurrency Limit Exceeded" %} {% endtab %} {% endtabs %} #### file\_config Here is an example of **file\_config** for [Create Test Data endpoint](#create-test-data): ```json { "delimiter": ";", "vars": { "0": { "tag": "year" }, "1": { "tag": "city" }, "2": { "tag": "sport" }, "5": { "tag": "event" }, "7": { "tag": "medal" }, "8": { "tag": "no" } }, "allow_quota": true, "order": "random", "skip_first_line": true, "skip_empty_line": true } ``` This configuration defines the settings for parsing a CSV file. Here's a breakdown of each of the options specified: * `delimiter`: The delimiter is used to separate fields in the CSV file. In this case, the delimiter is `;` * `vars`: A mapping of column numbers to variable names. Each key represents the column number (starting from 0), and the value is an object that specifies the variable name (tag). For example, the column at index 0 (the first column) will be mapped to the variable `year`, the column at index 1 will be mapped to the variable `city`, and so on. * `allow_quota`: A boolean value that specifies whether or not the CSV file allows the use of quotes to enclose fields. In this case, it is set to true, indicating that quotes are allowed. * `order`: Specifies the order in which the rows in the CSV file should be parsed. In this case, it is set to `random`, indicating that the rows should be parsed in random order. **Options**: `random`, `sequential` * `skip_first_line`: A boolean value that specifies whether or not the first line of the CSV file should be skipped during parsing. In this case, it is set to true, indicating that the first line should be skipped. * `skip_empty_line`: A boolean value that specifies whether or not empty lines should be skipped during parsing. In this case, it is set to true, indicating that empty lines should be skipped. # Load Testing Examples Ddosify Load Testing API Examples Here are the examples of the Load Testing API with cURL and Python. {% hint style="info" %} Change `` with your API key. [More](/ddosify/api#get-your-api-key). {% endhint %} ### Start a Load Test {% tabs %} {% tab title="cURL" %} ```bash curl --location 'https://api.ddosify.com/v1/load/test/' \ --header 'X-API-KEY: ' \ --header 'Content-Type: application/json' \ --data '{ "name": "Test 14", "config_data": { "steps": [ { "id": 1, "url": "https://servdown.com", "name": "Home Page", "method": "POST", "others": { "h2": false, "disable-redirect": false, "disable-compression": false }, "headers": { "Test-Header":"Test Value", "Test-Header2":"Test Value2" }, "payload": "{\"id\": 24}", "timeout": 15 }, { "id": 2, "url": "https://app.servdown.com", "name": "Servdown App", "method": "GET", "others": { "h2": false, "disable-redirect": false, "disable-compression": false }, "timeout": 15 } ], "proxy_config": { "US": 50, "DE": 50 }, "iteration_count": 1000, "load_type": "linear", "duration": 20 } }' ``` {% endtab %} {% tab title="Python" %} ```python import requests import json url = "https://api.ddosify.com/v1/load/test/" payload = json.dumps({ "name": "Test 14", "config_data": { "steps": [ { "id": 1, "url": "https://servdown.com", "name": "Home Page", "method": "POST", "others": { "h2": False, "disable-redirect": False, "disable-compression": False }, "headers": { "Test-Header": "Test Value", "Test-Header2": "Test Value2" }, "payload": "{\"id\": 24}", "timeout": 15 }, { "id": 2, "url": "https://app.servdown.com", "name": "Servdown App", "method": "GET", "others": { "h2": False, "disable-redirect": False, "disable-compression": False }, "timeout": 15 } ], "proxy_config": { "US": 50, "DE": 50 }, "iteration_count": 1000, "load_type": "linear", "duration": 20 } }) headers = { 'X-API-KEY': '', 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) ``` {% endtab %} {% endtabs %} ### Retrieve the details of the Load Test Plan {% tabs %} {% tab title="cURL" %} ```bash PLAN_ID=6d0a3cd4-a625-407c-9dc7-c7702b670550 curl --location 'https://api.ddosify.com/v1/load/plan/$PLAN_ID/' \ --header 'X-API-KEY: ' ``` {% endtab %} {% tab title="Python" %} ```bash import requests plan_id="6d0a3cd4-a625-407c-9dc7-c7702b670550" url = f"https://api.ddosify.com/v1/load/plan/{plan_id}/" payload={} headers = { 'X-API-KEY': '' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text) ``` {% endtab %} {% endtabs %} ### Create Environment {% tabs %} {% tab title="cURL" %} ```bash curl --location 'https://api.ddosify.com/v1/environment/' \ --header 'X-API-KEY: ' \ --header 'Content-Type: application/json' \ --data '{ "name": "Test Environment Name 6", "vars": [ {"key": "test_key_bool", "value": false}, {"key": "test_key_string", "value": "test_value_2"}, {"key": "test_key_number_int", "value": 15}, {"key": "test_key_number_float", "value": 15.2}, {"key": "test_key_array", "value": [14, 12, 15]} ] }' ``` {% endtab %} {% tab title="Python" %} ```python import requests import json url = "https://api.ddosify.com/v1/environment/" payload = json.dumps({ "name": "Test Environment Name 6", "vars": [ { "key": "test_key_bool", "value": False }, { "key": "test_key_string", "value": "test_value_2" }, { "key": "test_key_number_int", "value": 15 }, { "key": "test_key_number_float", "value": 15.2 }, { "key": "test_key_array", "value": [ 14, 12, 15 ] } ] }) headers = { 'X-API-KEY': '', 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) ``` {% endtab %} {% endtabs %} ### Create Test Data {% tabs %} {% tab title="cURL" %} ```bash curl --location 'https://api.ddosify.com/v1/testdata/' \ --header 'X-API-KEY: ' \ --form 'name="medals222"' \ --form 'file=@"/Users/test/medals.csv"' \ --form 'type="csv"' \ --form 'file_config="{ \"delimiter\": \";\", \"vars\": { \"0\": { \"tag\": \"year\" }, \"1\": { \"tag\": \"city\" }, \"2\": { \"tag\": \"sport\" }, \"5\": { \"tag\": \"event\" }, \"7\": { \"tag\": \"medal\" }, \"8\": { \"tag\": \"no\" } }, \"allow_quota\": true, \"order\": \"random\", \"skip_first_line\": true, \"skip_empty_line\": true }"' ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.ddosify.com/v1/testdata/" payload={'name': 'medals222', 'type': 'csv', 'file_config': '{ "delimiter": ";", "vars": { "0": { "tag": "year" }, "1": { "tag": "city" }, "2": { "tag": "sport" }, "5": { "tag": "event" }, "7": { "tag": "medal" }, "8": { "tag": "no" } }, "allow_quota": true, "order": "random", "skip_first_line": true, "skip_empty_line": true }'} files=[ ('file',('medals.csv',open('/Users/test/medals.csv','rb'),'text/csv')) ] headers = { 'X-API-KEY': '' } response = requests.request("POST", url, headers=headers, data=payload, files=files) print(response.text) ``` {% endtab %} {% endtabs %} ### Test Result Here is an example of a load testing result from [test result](#result-of-load-test) endpoint:

{
    "test_url": "https://app.ddosify.com/load/report/9272cecd-b844-43bc-9702-469895f20d90",
    "results": {
        "steps": [
            {
                "id": 1,
                "error_dist": {},
                "fail_count": 0,
                "location_dist": {
                    "DE": {
                        "error_dist": {},
                        "fail_count": 0,
                        "location_dist": {},
                        "success_count": 500,
                        "response_times": {
                            "avg": 26,
                            "max": 63,
                            "min": 19,
                            "p80": 29,
                            "p90": 33,
                            "p95": 37,
                            "p99": 56,
                            "median": 24,
                            "stddev": 6
                        },
                        "iteration_count": 500,
                        "status_code_dist": {
                            "405": 500
                        }
                    },
                    "US": {
                        "error_dist": {},
                        "fail_count": 0,
                        "location_dist": {},
                        "success_count": 500,
                        "response_times": {
                            "avg": 172,
                            "max": 201,
                            "min": 162,
                            "p80": 175,
                            "p90": 178,
                            "p95": 181,
                            "p99": 193,
                            "median": 171,
                            "stddev": 5
                        },
                        "iteration_count": 500,
                        "status_code_dist": {
                            "405": 500
                        }
                    }
                },
                "success_count": 1000,
                "response_times": {
                    "avg": 99,
                    "max": 201,
                    "min": 19,
                    "p80": 172,
                    "p90": 175,
                    "p95": 178,
                    "p99": 189,
                    "median": 113,
                    "stddev": 73
                },
                "iteration_count": 1000,
                "status_code_dist": {
                    "405": 1000
                }
            },
            {
                "id": 2,
                "error_dist": {},
                "fail_count": 0,
                "location_dist": {
                    "DE": {
                        "error_dist": {},
                        "fail_count": 0,
                        "location_dist": {},
                        "success_count": 500,
                        "response_times": {
                            "avg": 48,
                            "max": 242,
                            "min": 35,
                            "p80": 51,
                            "p90": 57,
                            "p95": 70,
                            "p99": 131,
                            "median": 44,
                            "stddev": 17
                        },
                        "iteration_count": 500,
                        "status_code_dist": {
                            "200": 500
                        }
                    },
                    "US": {
                        "error_dist": {},
                        "fail_count": 0,
                        "location_dist": {},
                        "success_count": 500,
                        "response_times": {
                            "avg": 323,
                            "max": 807,
                            "min": 296,
                            "p80": 317,
                            "p90": 332,
                            "p95": 383,
                            "p99": 684,
                            "median": 307,
                            "stddev": 64
                        },
                        "iteration_count": 500,
                        "status_code_dist": {
                            "200": 500
                        }
                    }
                },
                "success_count": 1000,
                "response_times": {
                    "avg": 186,
                    "max": 807,
                    "min": 35,
                    "p80": 309,
                    "p90": 317,
                    "p95": 332,
                    "p99": 678,
                    "median": 269,
                    "stddev": 145
                },
                "iteration_count": 1000,
                "status_code_dist": {
                    "200": 1000
                }
            }
        ],
        "fail_count": 0,
        "location_dist": {
            "DE": {
                "fail_count": 0,
                "success_count": 500,
                "response_times": {
                    "avg": 37,
                    "max": 242,
                    "min": 19,
                    "p80": 46,
                    "p90": 52,
                    "p95": 59,
                    "p99": 96,
                    "median": 37,
                    "stddev": 17
                },
                "iteration_count": 500
            },
            "US": {
                "fail_count": 0,
                "success_count": 500,
                "response_times": {
                    "avg": 247,
                    "max": 807,
                    "min": 162,
                    "p80": 309,
                    "p90": 317,
                    "p95": 332,
                    "p99": 678,
                    "median": 249,
                    "stddev": 88
                },
                "iteration_count": 500
            }
        },
        "success_count": 1000,
        "response_times": {
            "avg": 142,
            "max": 807,
            "min": 19,
            "p80": 303,
            "p90": 309,
            "p95": 317,
            "p99": 400,
            "median": 163,
            "stddev": 122
        },
        "iteration_count": 1000
    }
}

This load testing result shows the performance of a web application under load testing. The result is presented in JSON format and has `two` steps, each with `two` locations: `DE` and `US`. The `summary` section gives an overview of the test results, which includes the success and fail count, response times, iteration count, and status code distribution for each step and location. The `location_dist` section shows the response times for each location, and the `response_times` section shows the average, maximum, minimum, and percentile response times for each step and location. In general, the load testing result indicates that the web application's performance varies significantly across locations. Because the target server is located in Frankfurt (Germany), the response times in the US are generally higher than in DE, which indicates that the application is slower for users in the US. The `status_code_dist` shows that all requests in the test returned a status code of 405 in step 1 and 200 in step 2. The `test_url` gives the Ddosify Cloud test URL for detailed reporting using charts and tables.

# Self-Hosted Ddosify Platform has two versions: * Cloud (available at [here](https://app.ddosify.com/)) * Self-Hosted (installation at [here](https://github.com/ddosify/ddosify/tree/master/selfhosted)) While you can directly start to use [Ddosify Cloud](https://app.ddosify.com/) without any overhead or installation, you can also use Ddosify in-house and host it yourself using Ddosify Self-Hosted. It has two editions: * Community * Enterprise While Community Edition allows you to monitor your Kubernetes clusters and use distributed mode for performance testing, Enterprise Edition allows you to do much more. For more information, you can compare the editions [here](https://github.com/ddosify/ddosify?tab=readme-ov-file#comparison-of-ddosify-cloud-self-hosted-ee-self-hosted-ce). # Install eBPF Agent (Alaz) on Self-Hosted To start monitoring your Kubernetes Cluster, you need to create a new Cluster on the Ddosify Self-Hosted platform. To achieve this, navigate to the [Clusters page](https://app.ddosify.com/clusters) and click the Add Cluster button. After providing a unique name for the Cluster, you will be navigated to the Observability page, where you will see the [Service Map](/ddosify/kubernetes-monitoring/service-map), [Metrics Dashboard](/ddosify/kubernetes-monitoring/metrics) and [Distributed Tracing](/ddosify/kubernetes-monitoring/distributed-tracing) for this Cluster. But before that, you have to install and run our [open-source eBPF agent (Alaz)](https://github.com/ddosify/alaz) as a DaemonSet in your Kubernetes Cluster. Follow the below instructions to set up a new cluster successfully. First, you need to expose your Self-Hosted application URL so that Alaz could write data to it. For this purpose, you can use tools such as [ngrok](https://ngrok.com/) or [Cloudflare Tunnels](https://www.cloudflare.com/products/tunnel/). Here, we will use ngrok. 1. **Expose the application URL to the public** 1. For this, you can follow the first 2 steps in this post to configure ngrok: [https://ngrok.com/docs/getting-started/](https://ngrok.com/docs/getting-started/?os=macos). 2. Then run ``` ngrok http http://localhost:8014 ``` 3. This will take your terminal into a session. In this session, copy the URL in the "Forwarding" row. In the below example image, the URL [`https://aa3a-31-223-64-94.ngrok-free.app`](https://aa3a-31-223-64-94.ngrok-free.app) points traffic to the URL `http://localhost:8014`. Copy the first URL.

2. **Install Alaz** 1. Open the cluster you want to monitor 2. Click on the Set Up Cluster button 3. A pop-up will open and show you how to install Alaz via Kubectl or Helm:

Self-Hosted Alaz Installation Instructions for Kubectl

4. Here, you will see a line that only exists on Ddosify Self-Hosted just above the code block. Here, change the protocol and the URL according to your exposed URL. In our example, we set `http` to `https` and set our URL as `aa3a-31-223-64-94.ngrok-free.app`. 5. The pop-ups now look like this:

Modified Self-Hosted Alaz Installation Instructions for Kubectl

Modified Self-Hosted Alaz Installation Instructions for Helm

6. Now you can execute these commands to install Alaz. For more details about them, you can check [here](/ddosify/kubernetes-monitoring/install-ebpf-agent-alaz). {% hint style="success" %} If you require assistance with setting up Alaz, you can join our[ Discord](https://discord.com/invite/9KdnrSUZQg) or send an email to . {% endhint %} # Upgrading to Self-Hosted Enterprise There are two plans for Ddosify Self-Hosted: **Enterprise** and **Community** Edition. While Community Edition allows you to execute load/latency tests and monitor your Kubernetes clusters **up to 1 node**, Enterprise Edition additionally allows you to * Set up alerts (up to 25) * Create teams * Monitor your Kubernetes clusters **up to 20 nodes** To use Ddosify Self-Hosted Enterprise Edition, first, you should upgrade your plan from Ddosify Cloud. To upgrade your plan, follow these steps:\ \ 1\. Click on your user icon in the upper right corner\ 2\. Select "Pricing" from the dropdown menu\ 3\. Click on the "Self Hosted" tab\ 4\. You will be taken to the upgrade page where you can select your desired plan.

For more details on changing your subscription, you can check the [docs](https://app.gitbook.com/o/jN3rtZ38DU58INyTNPm7/s/ugegoRCn84wtxrIelgft/~/changes/105/ddosify/getting-started/pricing). After that, the Ddosify Self-Hosted pricing page should look like this:

Self-Hosted pricing page after the upgrade

You can also check your subscription status from the dashboard in Ddosify Cloud:

Subscription information in the dashboard

Here, you can see that the Self-Hosted subscription is not activated. To do so, set up your Self-Hosted application. For more details on setting up Ddosify Self-Hosted, you can check [here](https://github.com/ddosify/ddosify/tree/master/selfhosted). To activate Ddosify Self-Hosted Enterprise, you can do the following: 1. Open Ddosify Self-Hosted. You will see the dashboard:

Ddosify Self-Hosted Community Edition Dashboard

2. Click on the “Upgrade to Enterprise Edition” on the upper right corner. Here, you will see instructions on how to validate your license key.

Pop-up for Ddosify Self-Hosted Enterprise Edition Upgrade

3. Go to Ddosify Cloud and open the account settings (which appears when you click on your account on the upper right corner). Below, you will see this:

4. Click on “Create License Key”. This will create a license key for you. If you wish, you can use the button next to it to revoke it and create a new license key. This allows you to upgrade Ddosify Self-Hosted again if you want to re-deploy it. 5. Go ahead and copy this license key to the pop-up that appeared in Ddosify Self-Hosted. After you click on “Approve”, your license key is validated and then you will be redirected to the login page. After you log in, you can start to use Ddosify Self-Hosted Enterprise Edition.

Ddosify Self-Hosted Enterprise Edition dashboard

{% hint style="info" %} **Note:** If you paste your Self-Hosted license key while **not being subscribed to Self-Hosted Enterprise on Ddosify Cloud**, you can still use distributed mode on Ddosify Self-Hosted Community Edition but you **can’t use Enterprise** features. If you wish to upgrade to Self-Hosted Enterprise Edition after this, you can first upgrade your plan on Ddosify Cloud. Then when you click on “Upgrade to Enterprise Edition” on Ddosify Self-Hosted, a **pop-up will appear**. Then, the license key you’ve already entered will be checked again after you click on “Check Subscription”. If your Cloud plan is Self-Hosted Enterprise, your license key will be validated and you will be redirected to the login page. After you login, you can start to use Ddosify Self-Hosted Enterprise Edition. {% endhint %}

{% hint style="success" %} If you require assistance with activating Ddosify Self-Hosted Enterprise Edition, you can join our[ Discord](https://discord.com/invite/9KdnrSUZQg) or send an email to . {% endhint %} # Self-Hosted Slack Integration You can use Slack to get notified about anomalies in your Kubernetes cluster using alerts. While Ddosify Cloud allows you to integrate your Slack workspace into Ddosify seamlessly, you need to follow some steps to do the same on Ddosify Self-Hosted. Here’s how you can do so: {% hint style="info" %} **Note:** This doc is only applicable to Ddosify Self-Hosted Enterprise Edition. Ddosify Self-Hosted Community Edition does not support alerts and integrations. {% endhint %} #### Creating A Slack App To create a Slack integration for Ddosify Self-Hosted, you need to create a Slack application. Go to [Slack Apps](https://api.slack.com/apps). You need to sign in to your Slack workspace. 1. Click on “Create New App”.

2. Choose “From scratch”.

3. Give it a name (you can type in Ddosify) and choose a workspace you already logged in. 4. Click on “Create App”. 5. Go to “OAuth & Permissions” from the tabs on the left.

6. Scroll down to “Scopes”.

7. Click on “Add an OAuth Scope” in the “Bot Token Scopes” part. 8. Add the following permissions: * channels:join * channels:read * chat:write * groups:read * im:read * mpim:read 9. After that, your “Bot Token Scopes” should look like this:

10. Then click on “Install to Workspace” under the section “OAuth Tokens for Your Workspace”

The button to add the slack app to workspace

11. You will be redirected to a Slack page asking for permissions on your selected workspace. Click on “Allow” to continue.

12. Then, in the “OAuth Tokens for your Workspace” section, you will see a “Bot User OAuth Token”. Copy it and paste it on Slack integration creation in Ddosify.

Congratulations! :tada: You've successfully configured your Slack app. Now there remain only a few steps to connect it to Ddosify. #### Setting Up The Slack App in Ddosify 1. After you create your Slack application, go to the integrations section in Ddosify Self-Hosted EE. You can find it here:

2. After that, click on “Add Integration”. A pop-up will show up:

2. Here, provide a name for your integration, paste the Bot User OAuth Token you copied from the earlier step, and click on “Make Integration”. This will take you to the channel selection page. {% hint style="info" %} **Note:** If your Bot Token is correct, you will be able to see the channels present in your Slack workspace. If your token is invalid, this channel dropdown will be stuck at loading. In that case, you can delete the integration and retry. {% endhint %}

3. After you choose a channel and click on “Save Channel”, your slack app will join that channel and will be able to send messages there. 4. Once successful, you can test your integration by clicking “Test Integration”. If you are able to see the test message sent to your selected Slack channel, that means you've successfully set up your Slack app and you can start to use this integration in your alerts.

This is what you will see if your integration works successfully:

{% hint style="success" %} If you require assistance with setting up Slack integration for Ddosify Self-Hosted, you can join our[ Discord](https://discord.com/invite/9KdnrSUZQg) or send an email to . {% endhint %} # Learning Center Discover detailed resources about Kubernetes, Performance/Load Testing, Observability, eBPF, DevOps and more on the [Ddosify Blog](https://ddosify.com/blog/). * [Kubernetes Articles](#kubernetes-articles) * [Performance / Load Testing Articles](#performance-load-testing-articles) * [eBPF (Extended Berkeley Packet Filter) Articles](#ebpf-extended-berkeley-packet-filter-articles) * [Additional Articles](#additional-articles) ### Kubernetes Articles


How to Securely Expose Your Kubernetes Application using NGINX Ingress	https://ddosify.com/blog/how-to-securely-expose-your-kubernetes-application-using-nginx-ingress/	00.jpg
Kubernetes 101 - Introduction & Architecture	https://ddosify.com/blog/kubernetes101-introduction-to-kubernetes-and-kubernetes-architecture/	00.jpg
Detect Slow SQL Queries on Kubernetes Before Your Customers Do	https://ddosify.com/blog/how-to-detect-slow-sql-queries/	00.jpg
5 Tips To Help You Monitor Your Kubernetes Cluster	https://ddosify.com/blog/five-tips-to-help-you-monitor-your-kubernetes-cluster/	00.png
Effortless Kubernetes Monitoring and Bottleneck Detection using eBPF 🐝	https://ddosify.com/blog/effortless-kubernetes-monitoring-using-ebpf/	00_Effortless_Kubernetes_Monitoring_and_Bottleneck_Detection_using_eBPF.png

### Performance / Load Testing Articles


Preparing Your E-commerce Website for Black Friday Success	00.png	https://ddosify.com/blog/preparing-your-ecommerce-website-for-black-friday-success/
Django Rest Framework Throttling with API Key	django_rest_framework_blog_preview.jpg	https://ddosify.com/blog/django-restframework-throttling-with-apikey/
Load Testing a Fintech API with CSV Test Data Import	load-testing-a-fintech-api-preview.png	https://ddosify.com/blog/load-testing-a-fintech-exchange-api-with-csv-test-data-import/
Performance Benchmarking Popular JS Web Frameworks - Express.js vs Koa.js vs Fastify	preview.jpeg	https://ddosify.com/blog/performance-benchmarking-popular-js-web-frameworks-expressjs-vs-koajs-vs-fastify/
Testing the Performance of User Authentication Flow	auth_performance_testing_preview.png	https://ddosify.com/blog/testing-the-performance-of-user-authentication-flow/
Cold Start Comparison of AWS Lambda, Cloudflare Workers and AWS Cloudfront Function	cold_start_comparison.jpg	https://medium.com/ddosify/cold-start-comparison-of-aws-lambda-and-cloudflare-workers-a3f9021ee60a
A Comprehensive Guide to Using Postman Collections for Effective API Endpoint Load Testing	00.jpg	https://ddosify.com/blog/a-comprehensive-guide-to-using-postman-collections-for-effective-api-endpoint-load-testing/

### eBPF (Extended Berkeley Packet Filter) Articles


Exploring Function Tracing with eBPF and Uprobes - Episode 1	00.jpg	https://ddosify.com/blog/exploring-function-tracing-with-ebpf-and-uprobes/
Effortless Kubernetes Monitoring and Bottleneck Detection using eBPF 🐝	00_Effortless_Kubernetes_Monitoring_and_Bottleneck_Detection_using_eBPF.png	https://ddosify.com/blog/effortless-kubernetes-monitoring-using-ebpf/
Unveiling eBPF Verifier Errors - Episode 1	00.jpg	https://ddosify.com/blog/unveiling-ebpf-verifier-errors/

### Additional Articles


10 Performance Comparison of String Operations in Python	preview.jpeg	https://ddosify.com/blog/10-performance-comparison-of-string-operations-in-python/
A New Era Driven by Low Latency	latency-driven-new-era-cover-img.png	https://ddosify.com/blog/latency-driven-new-era/
Ddosify Latency Testing GitHub Action	latency-testing-cover.jpg	https://ddosify.com/blog/ddosify-latency-testing-github-action/
10 Frontend Performance Monitoring Tools in 2023	cover.png	https://ddosify.com/blog/ten-frontend-performance-monitoring-tools-in-2023/
Introduction to Software Supply Chain using Docker Scout	00.jpg	https://ddosify.com/blog/introduction-to-software-supply-chain-using-docker-scout/

# AWS (Amazon Web Services) Marketplace **Ddosify Performance Testing Community Edition** is a versatile, high-performance testing tool designed for both public and private endpoints within your AWS infrastructure. It is self-hosted, providing complete control over your testing environment, seamlessly integrating with AWS for an optimal blend of scalability and security. Its strength lies in its roots, built upon a robust open-source load engine that you can explore at . You can deploy [Ddosify Self Hosted](https://github.com/ddosify/ddosify/blob/master/selfhosted/README.md) on your AWS (Amazon Web Services) account as an EC2 instance and perform performance testing on your private endpoints easily. ### Deployment Ddosify Performance Testing Community Edition is available on [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-mwvnujtgjedjy?sr=0-1\&ref_=beagle\&applicationId=AWSMPContessa). Click **Continue to Subscribe** button.

Ddosify Performance Testing Community Edition on AWS Marketplace

Click **Accept Terms** button.

After a few minutes, the application will be ready to launch. After the application is ready, Click **Continue to Configuration** button.

Select any [AWS Region](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) to launch the EC2 instance. Ddosify supports all of the AWS regions. In this example, Zurich is selected as the region. Click **Continue to Launch** button.

You can see the Usage Instructions of Ddosify. Make sure to: * Select EC2 Instance Type (c5.xlarge, c5.2xlarge). c5.2xlarge is recommended. * Select or Create VPC and Subnet. * Create New Based On Seller Settings security groups. Give it a Name, Description and click the Save button. * 8014 is used for application access. * 22 is used for SSH access to the EC2 instance. * Select or Create Key Pairs. Click the **Launch** button.

Now you can see your Subscriptions on [AWS Subscriptions Page](https://us-east-1.console.aws.amazon.com/marketplace/home#/subscriptions). Click the **Manage** button.

### Access the Application Click the **View instances** button to see the deployed EC2 instance.

You can see the Instance ID for Ddosify. Click the **Access software** link to access Ddosify Performance Testing Community Edition.

Congratulations! 🎉 Ddosify Performance Testing Community Edition has been successfully deployed on your AWS account. You have complete control over the Ddosify EC2 instance and it will be billed directly to your AWS account.

### Performance Testing on AWS Private Endpoint Let's say we have an internal **nginx** server running on port **8090** and we want to conduct performance testing without making any ports accessible to the outside world. Fortunately, we have deployed Ddosify Performance Testing Community Edition on our AWS account so that we can restrict access to only Ddosify EC2 on the Security Groups. On the target EC2 instance (nginx:8090) security groups, add an Inbound Rule: * **Type:** Custom TCP * **Port Range:** 8090 * **Source:** Custom - ddosify\_aws\_marketplace\_sg... (Ddosify EC2 Instance Security Group) * **Description:** Allow access from Ddosify Performance Testing Community Edition Click the **Save rules** button.

Copy the target EC2 instance (nginx:8090) private IPv4 Address from the EC2 detail.

[Open](#access-the-application) Ddosify Performance Testing Community Edition and Click the **New Load Test** button.

Type **** as the target and Click Debug button.

As you can see, Ddosify successfully accessed the private nginx server by sending a GET request. Close the Debug modal and click Next. Then Configure the Load. Click Next and type a Test Name and click the Start Instant Test button.

Ddosify performed a successful performance testing to a private endpoint with 1200 iterations for 1 minute.