Skip to content

Commit

Permalink
Merge pull request #322 from orhun/docs/simplify_readme
Browse files Browse the repository at this point in the history 
Simplify README.md and move sections to the website
  • Loading branch information
@kursataktas
kursataktas authored Aug 8, 2024
2 parents e2e7af2 + cb9a88a commit 34f5803
Showing 1 changed file with 35 additions and 158 deletions.
193 changes: 35 additions & 158 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,17 @@
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon-logo-wb.svg#gh-light-mode-only" alt="Anteon logo light" width="336px" /><br />
</div>

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

<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/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.com/invite/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>
</p>

<p align="center">
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon_service_map.png" alt="Anteon Kubernetes Monitoring Service Map" />
<i>Anteon automatically generates 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.</i>
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon_service_map.png" alt="Anteon Kubernetes Monitoring Service Map" />
<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/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.com/invite/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>
</p>
<i>Anteon automatically generates 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.</i>
</p>

<h2 align="center">
Expand All @@ -23,14 +22,13 @@
<a href="https://discord.com/invite/9KdnrSUZQg" target="_blank">Discord</a>
</h2>

## What is Anteon (formerly Ddosify)?

Anteon (formerly Ddosify) is an [open-source](https://github.com/getanteon/anteon), eBPF-based **Kubernetes Monitoring** and **Performance Testing** platform.
## 🐝 What is Anteon?

**Anteon** (formerly Ddosify) is an [open-source](https://github.com/getanteon/anteon), eBPF-based **Kubernetes Monitoring** and **Performance Testing** platform.

### 🔎 Kubernetes Monitoring

- **Automatic Service Map Creation:** Anteon automatically creates a **service map** of your cluster without code instrumentation or sidecars. So you can easily find the bottlenecks in your system.
- **Automatic Service Map Creation:** Anteon automatically creates a **service map** of your cluster without code instrumentation or sidecars. So you can easily [find the bottlenecks](https://getanteon.com/docs/kubernetes-monitoring/#finding-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 based agent (Alaz)](https://github.com/getanteon/alaz).
Expand All @@ -54,164 +52,43 @@ Anteon (formerly Ddosify) is an [open-source](https://github.com/getanteon/anteo
<i>Anteon Performance Testing generates load from worldwide with no-code scenario builder.</i>
</p>

## Anteon Stack

Anteon Stack consists of 4 parts:

- [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="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon_stack.png" alt="Anteon Stack" />
</p>

### Anteon Load Engine (Ddosify)

[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/ddosify/ddosify), [Docker Extension](https://hub.docker.com/extensions/ddosify/ddosify-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 [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.

Check out the [Alaz](https://github.com/getanteon/alaz) repository for more information and usage.

### Anteon Self-Hosted
## 📚 Documentation

[Anteon Self-Hosted](https://github.com/getanteon/anteon/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 Anteon Cloud, the Self-Hosted version is designed to be deployed within your infrastructure for enhanced control and customization.
- [🐝 Anteon Stack](https://getanteon.com/docs/stack/)
- [🚀 Getting Started](https://getanteon.com/docs/getting-started/)
- [🔎 Kubernetes Monitoring](https://getanteon.com/docs/kubernetes-monitoring/)
- [🔨 Performance Testing](https://getanteon.com/docs/performance-testing/)

It has two versions: Community Edition (CE) and Enterprise Edition (EE). You can see the differences in the below [comparison table](#comparison-of-anteon-cloud-self-hosted-ee-self-hosted-ce).
## ✨ About This Repository

Check out our [Github Page](https://github.com/getanteon/anteon/tree/master/selfhosted) for more information and usage.
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/ddosify" target="_blank">Docker Hub</a>. Since Anteon is a Verified Publisher on Docker Hub, there isn't any pull limits.

- [Ddosify documentation](https://github.com/getanteon/anteon/tree/master/ddosify_engine) provides information on the installation, usage, and features of the Anteon Load 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.

#### Quick Start

(1) Deploy using Docker Compose:

```bash
curl -sSL https://raw.githubusercontent.com/getanteon/anteon/master/selfhosted/install.sh | bash
```
<p align="center">
<a href="https://aws.amazon.com/marketplace/pp/prodview-mwvnujtgjedjy" target="_blank"><img src="https://img.shields.io/badge/Available_on_aws_marketplace-FF9900?style=for-the-badge&logo=amazonaws&logoColor=white" height="40" alt="Available on aws marketplace" /></a>&nbsp;
</p>

(2) You can deploy Anteon Self Hosted on Kubernetes using the [Helm chart](https://github.com/getanteon/anteon-helm-charts).

### Anteon Cloud

[Anteon Cloud](https://app.getanteon.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 Anteon Cloud, you can generate traffic to your endpoints from 25+ countries without code or scripting.

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
<p align="center">
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon_comparison.jpg" alt="Anteon versus" />

*CE: Community Edition, EE: Enterprise Edition*
</p>

## Kubernetes Monitoring Features

#### ✅ Service Map
Easily get insights about what is going on in your cluster. You do not have to change your code or add sidecars anymore. <a href="https://getanteon.com/docs/kubernetes-monitoring/service-map/" target="_blank">More →</a>
<p align="left">
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon_service_map_detail.png" alt="Anteon - Service Map Feature" />
</p>

#### ✅ Detailed Insights
Inspect incoming, outgoing traffic, SQL queries, golden signals, HTTP 5xx status codes, Top Latencies and RPS, and more. <a href="https://getanteon.com/docs/kubernetes-monitoring/service-map/" target="_blank">More →</a>
<p align="left">
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon_service_summary.png" alt="Anteon - Detailed Insights Feature" />
</p>

#### ✅ Metrics Dashboard
The Metric Dashboard provides a straightforward way to observe Node Metrics. Anteon observes CPU, Memory, Disk, and Network usage of your nodes. You can also create alerts on these metrics. <a href="https://getanteon.com/docs/kubernetes-monitoring/metrics/" target="_blank">More →</a>

<p align="left">
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon_metrics_detailed.png" alt="Anteon - Metrics Dashboard Feature" />
</p>

#### ✅ Find Bottlenecks
Start a load test and monitor your system all within the same UI. You do not need to correlate the load test results with the monitoring data and switch between different tools.

You will see the outgoing requests, response times and status codes on the load test **Summary** tab.
<p align="left">
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon_load_test.png" alt="Anteon - Find Bottlenecks Feature" />
</p>

You will see the incoming requests to your K8s cluster, service-to-service traffic, RPS, latencies, SQL queries, and more on the **Monitoring** tab. So you can easily correlate the load test results with the monitoring data without switching between different tools.
<p align="left">
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon_load_test_monitoring.png" alt="Anteon - Find Bottlenecks Feature" />
</p>


## Performance Testing Features
#### ✅ Parametrization
Use built-in random data generators. <a href="https://getanteon.com/docs/performance-testing/parametrization/" target="_blank">More →</a>
<p align="left">
<img src="https://imagedelivery.net/jnIqn6NB1gbMLXIvlYKo5A/4dc3f294-6319-4c2b-a56b-c359276d5e00/public" alt="Anteon - Parametrization Feature" />
</p>


#### ✅ CSV Data Import
Import test data from CSV and use it in the scenario. <a href="https://getanteon.com/docs/performance-testing/test-data-import/" target="_blank">More →</a>
<p align="left">
<img src="https://imagedelivery.net/jnIqn6NB1gbMLXIvlYKo5A/6c769b68-e046-440d-137c-b20dd3518300/public" alt="Anteon - Test Data Feature" />
</p>

#### ✅ Environments
Store constant values as environment variables. <a href="https://getanteon.com/docs/performance-testing/environment-variables/" target="_blank">More →</a>
<p align="left">
<img src="https://imagedelivery.net/jnIqn6NB1gbMLXIvlYKo5A/78c45dca-03de-4cbf-0edc-fb2b8a2e6600/public" alt="Anteon - Environment Feature" />
</p>

#### ✅ Correlation
Extract variables from earlier phases and pass them on to the following ones. <a href="https://getanteon.com/docs/performance-testing/correlation/" target="_blank">More →</a>
<p align="left">
<img src="https://imagedelivery.net/jnIqn6NB1gbMLXIvlYKo5A/7ac98b0f-043b-494f-3c17-7a5436e81400/public" alt="Anteon - Correlation Feature" />
</p>

#### ✅ Assertion
Verify that the response matches your expectations. <a href="https://getanteon.com/docs/performance-testing/assertion/" target="_blank">More →</a>
<p align="left">
<img src="https://imagedelivery.net/jnIqn6NB1gbMLXIvlYKo5A/f2f0df70-8e2b-4308-ca6a-4259274d0400/public" alt="Anteon - Assertion Feature" />
</p>

#### ✅ Debugging
Analyze request and response data before starting the load test. <a href="https://getanteon.com/docs/performance-testing/debugging/" target="_blank">More →</a>
<p align="left">
<img src="https://imagedelivery.net/jnIqn6NB1gbMLXIvlYKo5A/82322e21-2e3a-4284-9643-1c8dacda2400/public" alt="Anteon - Debugging Feature" />
</p>

#### ✅ Postman Import
Import Postman collections with ease and transform them into load testing scenarios. <a href="https://getanteon.com/docs/performance-testing/postman-import/" target="_blank">More →</a>
<p align="left">
<img src="https://imagedelivery.net/jnIqn6NB1gbMLXIvlYKo5A/873bf1e3-07a0-427c-8f32-0791d1728900/public" alt="Anteon - Postman Import Feature" />
</p>
See the [Anteon website](https://getanteon.com/) for more information.

## 🛠️ Contributing

## About This Repository
See our [Contribution Guide](./CONTRIBUTING.md) and please follow the [Code of Conduct](./CODE_OF_CONDUCT.md) in all your interactions with the project.

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/ddosify" target="_blank">Docker Hub</a>. Since Anteon is a Verified Publisher on Docker Hub, you do not have any pull limits.
Thanks goes to these wonderful people!

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.
<a href="https://github.com/getanteon/anteon/graphs/contributors">
<img src="https://contrib.rocks/image?repo=getanteon/anteon" />
</a>

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/).
Made with [contrib.rocks](https://contrib.rocks).

## Communication
### 📨 Communication

You can join our [Discord Server](https://discord.com/invite/9KdnrSUZQg) for issues, feature requests, feedbacks or anything else.
You can join our [Discord Server](https://discord.com/invite/9KdnrSUZQg) for issues, feature requests, feedbacks or anything else.

## Disclaimer
### ⚠️ Disclaimer

Anteon is created for testing the performance of web applications. Users must be the owner of the target system. Using it for harmful purposes is extremely forbidden. Anteon team & company is not responsible for its’ usages and consequences.

## License
## 📜 License

Licensed under the AGPLv3: https://www.gnu.org/licenses/agpl-3.0.html
Licensed under the [AGPLv3](LICENSE)

0 comments on commit 34f5803

Please sign in to comment.