Skip to content

Commit

Permalink
Merge pull request #290 from getanteon/master
Browse files Browse the repository at this point in the history
Master -> Develop
  • Loading branch information
fatihbaltaci authored Apr 30, 2024
2 parents 178b9a6 + a2433ab commit dcdae43
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 22 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@
<img src="assets/anteon-logo-wb.svg#gh-light-mode-only" alt="Anteon logo light" width="336px" /><br />
</div>

<h1 align="center">Effortless Kubernetes Monitoring and Performance Testing</h1>
<h1 align="center">Kickstart Kubernetes Monitoring in 1 min - Free up time for DevOps and Coding</h1>

<p align="center">
<a href="https://github.com/getanteon/anteon/releases" target="_blank"><img src="https://img.shields.io/github/v/release/getanteon/anteon?style=for-the-badge&logo=github&color=orange" alt="anteon latest version" /></a>&nbsp;
<a href="https://github.com/getanteon/anteon/actions/workflows/test.yml" target="_blank"><img src="https://img.shields.io/github/actions/workflow/status/getanteon/anteon/test.yml?branch=master&style=for-the-badge&logo=github" alt="Anteon build result" /></a>&nbsp;
<a href="https://github.com/getanteon/anteon/blob/master/LICENSE" target="_blank"><img src="https://img.shields.io/badge/LICENSE-AGPL--3.0-orange?style=for-the-badge&logo=none" alt="Anteon license" /></a>
<a href="https://discord.gg/9KdnrSUZQg" target="_blank"><img src="https://img.shields.io/discord/898523141788287017?style=for-the-badge&logo=discord&label=DISCORD" alt="Anteon discord server" /></a>
<a href="https://landscape.cncf.io/?item=observability-and-analysis--observability--anteon" target="_blank"><img src="https://img.shields.io/badge/CNCF%20Landscape-5699C6?style=for-the-badge&logo=cncf&label=cncf" alt="cncf landscape" /></a>
Expand Down Expand Up @@ -46,7 +45,7 @@ Anteon (formerly Ddosify) is an [open-source](https://github.com/getanteon/anteo

### 🔨 Performance Testing

- **Multi-Location Based:** Generate load/performance tests from over 25 countries worldwide. Its available on [Anteon Cloud](https://app.getanteon.com/).
- **Multi-Location Based:** Generate load/performance tests from over 25 countries worldwide. Its available on [Anteon Cloud](https://getanteon.com/).
- **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.
Expand All @@ -60,21 +59,21 @@ Anteon (formerly Ddosify) is an [open-source](https://github.com/getanteon/anteo

Anteon Stack consists of 4 parts:

- [Anteon Engine](#anteon-engine)
- [Anteon Load Engine (Ddosify)](#anteon-load-engine-ddosify)
- [Anteon eBPF Agent (Alaz)](#anteon-ebpf-agent-alaz)
- [Anteon Self-Hosted](#anteon-self-hosted)
- [Anteon Cloud](#anteon-cloud)


<p align="center">
<img src="assets/anteon_stack.jpg" alt="Anteon Stack" />
<img src="assets/anteon_stack.png" alt="Anteon Stack" />
</p>

### Anteon Engine
### Anteon Load Engine (Ddosify)

[Anteon Engine](https://github.com/getanteon/anteon) is the load engine, written in Golang. It's a CLI load-testing tool. Anteon Self-Hosted and Anteon 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. Anteon Engine is available via [Docker](https://hub.docker.com/r/getanteon/anteon), [Docker Extension](https://hub.docker.com/extensions/getanteon/anteon-docker-extension), [Homebrew Tap](https://github.com/getanteon/anteon#homebrew-tap-macos-and-linux), and downloadable pre-compiled binaries from the [releases page](https://github.com/getanteon/anteon/releases/latest) for macOS, Linux, and Windows.
[Ddosify](https://github.com/getanteon/anteon/tree/master/ddosify_engine) is the load engine, written in Golang. It's a CLI load-testing tool. Anteon Self-Hosted and Anteon 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 is available via [Docker](https://hub.docker.com/r/getanteon/anteon), [Docker Extension](https://hub.docker.com/extensions/getanteon/anteon-docker-extension), [Homebrew Tap](https://github.com/getanteon/anteon/tree/master/ddosify_engine#homebrew-tap-macos-and-linux), and downloadable pre-compiled binaries from the [releases page](https://github.com/getanteon/anteon/releases/tag/v1.0.6) for macOS, Linux, and Windows.

Check out the [Engine Docs](https://github.com/getanteon/anteon/tree/master/engine_docs) page for more information and usage.
Check out the [Ddosify Docs](https://github.com/getanteon/anteon/tree/master/ddosify_engine) page for more information and usage.

### Anteon eBPF Agent (Alaz)
[Alaz](https://github.com/getanteon/alaz) is an open-source Anteon eBPF agent that can inspect and collect Kubernetes (K8s) service traffic without the need for code instrumentation, sidecars, or service restarts. Alaz is deployed as a DaemonSet on your Kubernetes cluster. It collects metrics and sends them to Anteon Cloud or Anteon Self-Hosted. It is also Prometheus compatible, so that you can use it as a standalone tool.
Expand Down Expand Up @@ -109,8 +108,6 @@ curl -sSL https://raw.githubusercontent.com/getanteon/anteon/master/selfhosted/i

With Anteon Cloud, you can generate traffic to your endpoints from 25+ countries without code or scripting.

With [Latency Testing](https://getanteon.com/docs/latency-testing), you can test the latency of your endpoints from 60+ cities worldwide.

Check out [Anteon Cloud](https://app.getanteon.com/) to find the performance issues on your system instantly.

### Comparison of Anteon Cloud, Self-Hosted EE, Self-Hosted CE
Expand Down Expand Up @@ -206,9 +203,9 @@ Import Postman collections with ease and transform them into load testing scenar

## About This Repository

This repository includes the source code for the Anteon Engine. You can access Docker Images for the Anteon Engine and Self Hosted on <a href="https://hub.docker.com/u/getanteon" target="_blank">Docker Hub</a>. Since Anteon is a Verified Publisher on Docker Hub, you do not have any pull limits.
This repository includes the source code for the Anteon Load Engine(Ddosify). You can access Docker Images for the Anteon Engine and Self Hosted on <a href="https://hub.docker.com/u/getanteon" target="_blank">Docker Hub</a>. Since Anteon is a Verified Publisher on Docker Hub, you do not have any pull limits.

The [Engine Docs](https://github.com/getanteon/anteon/tree/master/engine_docs) folder provides information on the installation, usage, and features of the Anteon Engine. The [Self-Hosted](https://github.com/getanteon/anteon/tree/master/selfhosted) folder contains installation instructions for the Self-Hosted version. [Anteon eBPF agent (Alaz)](https://github.com/getanteon/alaz) has its own repository.
The [Ddosify Docs](https://github.com/getanteon/anteon/tree/master/ddosify_engine) folder provides information on the installation, usage, and features of the Anteon Load Engine (Ddosify). The [Self-Hosted](https://github.com/getanteon/anteon/tree/master/selfhosted) folder contains installation instructions for the Self-Hosted version. [Anteon eBPF agent (Alaz)](https://github.com/getanteon/alaz) has its own repository.

To learn about the **Performance Testing** usage of both Self-Hosted and Cloud versions, please refer to the [this documentation](https://getanteon.com/docs/performance-testing/test-suite). For the **Kubernetes Monitoring** usage, please refer to the [this documentation](https://getanteon.com/docs/kubernetes-monitoring).

Expand Down
Binary file removed assets/anteon_stack.jpg
Binary file not shown.
Binary file added assets/anteon_stack.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 9 additions & 10 deletions ddosify_engine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@
<img src="../assets/anteon-logo-wb.svg#gh-light-mode-only" alt="Anteon logo light" width="336px" /><br />
</div>

<h1 align="center">Ddosify Engine: High-performance load testing tool</h1>
<h1 align="center">Ddosify: High-performance load testing tool</h1>

<p align="center">
<a href="https://github.com/getanteon/anteon/actions/workflows/test.yml" target="_blank"><img src="https://img.shields.io/github/actions/workflow/status/ddosify/ddosify/test.yml?branch=master&style=for-the-badge&logo=github" alt="ddosify build result" /></a>&nbsp;
<a href="https://pkg.go.dev/go.ddosify.com/ddosify" target="_blank"><img src="https://img.shields.io/github/go-mod/go-version/ddosify/ddosify?style=for-the-badge&logo=go" alt="golang version" /></a>&nbsp;
<a href="https://app.codecov.io/gh/ddosify/ddosify" target="_blank"><img src="https://img.shields.io/codecov/c/github/ddosify/ddosify?style=for-the-badge&logo=codecov" alt="go coverage" /></a>&nbsp;
<a href="https://goreportcard.com/report/github.com/getanteon/ddosify" target="_blank"><img src="https://goreportcard.com/badge/github.com/getanteon/ddosify?style=for-the-badge&logo=go" alt="go report" /></a>&nbsp;
Expand Down Expand Up @@ -44,7 +43,7 @@

## Installation

`ddosify` is available via [Docker](https://hub.docker.com/r/anteon/ddosify), [Docker Extension](https://hub.docker.com/extensions/ddosify/ddosify-docker-extension), [Homebrew Tap](#homebrew-tap-macos-and-linux), and downloadable pre-compiled binaries from the [releases page](https://github.com/getanteon/anteon/releases/latest) for macOS, Linux and Windows. For auto-completion, see: [Ddosify Completions](https://github.com/getanteon/anteon/blob/master/completions/README.md).
`ddosify` is available via [Docker](https://hub.docker.com/r/anteon/ddosify), [Docker Extension](https://hub.docker.com/extensions/ddosify/ddosify-docker-extension), [Homebrew Tap](#homebrew-tap-macos-and-linux), and downloadable pre-compiled binaries from the [releases page](https://github.com/getanteon/anteon/releases/tag/v1.0.6) for macOS, Linux and Windows. For auto-completion, see: [Ddosify Completions](https://github.com/getanteon/anteon/tree/master/ddosify_engine/completions).

### Docker

Expand Down Expand Up @@ -102,7 +101,7 @@ pkg install ddosify
### Using the convenience script (macOS and Linux)

- The script requires root or sudo privileges to move ddosify binary to `/usr/local/bin`.
- The script attempts to detect your operating system (macOS or Linux) and architecture (arm64, x86, amd64) to download the appropriate binary from the [releases page](https://github.com/getanteon/anteon/releases/latest).
- The script attempts to detect your operating system (macOS or Linux) and architecture (arm64, x86, amd64) to download the appropriate binary from the [releases page](https://github.com/getanteon/anteon/tree/master/ddosify_engine/completions).
- By default, the script installs the latest version of `ddosify`.
- If you have problems, check [common issues](#common-issues)
- Required packages: `curl` and `sudo`
Expand Down Expand Up @@ -249,7 +248,7 @@ Usage;
ddosify -config <json_config_path>


There is an example config file at [config_examples/config.json](/config_examples/config.json). This file contains all of the parameters you can use. Details of each parameter;
There is an example config file at [config_examples/config.json](https://github.com/getanteon/anteon/blob/master/ddosify_engine/config_examples/config.json). This file contains all of the parameters you can use. Details of each parameter;

- `iteration_count` *optional*

Expand Down Expand Up @@ -299,7 +298,7 @@ There is an example config file at [config_examples/config.json](/config_example

- `data` *optional*
Config for loading test data from a CSV file.
[CSV data](https://github.com/getanteon/anteon/tree/master/config/config_testdata/test.csv) used in below config.
[CSV data](https://github.com/getanteon/anteon/blob/master/ddosify_engine/config/config_testdata/test.csv) used in below config.
```json
"data":{
"info": {
Expand Down Expand Up @@ -725,11 +724,11 @@ If Ddosify can't receive the response for a request, that step is marked as Fail

Ddosify supports success criteria, allowing users to verify the success of their load tests based on response times and failure counts of iterations. With this feature, users can assert the percentile of response times and the failure counts of all the iterations in a test.

Users can specify the required percentile of response times and failure counts in the configuration file, and the engine will compare the actual response times and failure counts to these values throughout the test continuously. According to users configuration test can be aborted or continue running until end. Check the [example config](https://github.com/getanteon/anteon/blob/master/config_examples/config.json) to see how it looks the `success_criterias` keyword.
Users can specify the required percentile of response times and failure counts in the configuration file, and the engine will compare the actual response times and failure counts to these values throughout the test continuously. According to users configuration test can be aborted or continue running until end. Check the [example config](https://github.com/getanteon/anteon/blob/master/ddosify_engine/config_examples/config.json) to see how it looks the `success_criterias` keyword.

Note that the functions and operators mentioned in the [Step Assertion](#assertion) section can also be utilized for the Success Criteria keywords listed below.

You can see an success criteria example in [EXAMPLES](https://github.com/getanteon/anteon/blob/master/engine_docs/EXAMPLES.md#example-2-success-criteria) file.
You can see an success criteria example in [EXAMPLES](https://github.com/getanteon/anteon/blob/master/ddosify_engine/EXAMPLES.md#example-2-success-criteria) file.

## Difference Between Success Criteria and Step Assertions

Expand Down Expand Up @@ -982,11 +981,11 @@ In `repeated-user` mode Ddosify uses the same cookie jar for all iterations exec

In `distinct-user` mode Ddosify uses a different cookie jar for each iteration, cookies passed through steps in one iteration only.

You can see an cookie example in [EXAMPLES](https://github.com/getanteon/anteon/blob/master/engine_docs/EXAMPLES.md#example-1-cookie-support) file.
You can see an cookie example in [EXAMPLES](https://github.com/getanteon/anteon/blob/master/ddosify_engine/EXAMPLES.md#example-1-cookie-support) file.

### Initial / Custom Cookies

You can set initial/custom cookies for your test scenario using `cookie_jar` field in the config file. You can enable/disable custom cookies with `enabled` key. Check the [example config](https://github.com/getanteon/anteon/tree/master/config/config_testdata/config_init_cookies.json).
You can set initial/custom cookies for your test scenario using `cookie_jar` field in the config file. You can enable/disable custom cookies with `enabled` key. Check the [example config](https://github.com/getanteon/anteon/blob/master/ddosify_engine/config/config_testdata/config_init_cookies.json).


| Key | Description | Example |
Expand Down

0 comments on commit dcdae43

Please sign in to comment.