Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readmes #303

Merged
merged 1 commit into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@ We believe that a strong community is key to the success of the Ddosify. You can
- Participating in discussions on GitHub [issues](https://github.com/ddosify/ddosify/issues) and [pull requests](https://github.com/ddosify/ddosify/pulls), providing feedback, suggestions, or sharing your experiences with the tool.
- Promoting the Ddosify by writing blog posts, creating video tutorials, or sharing the project on social media.

You can join our [Discord Server](https://discord.gg/9KdnrSUZQg) for issues, feature requests, feedbacks or anything else. We're happy to help you out!
You can join our [Discord Server](https://discord.com/invite/9KdnrSUZQg) for issues, feature requests, feedbacks or anything else. We're happy to help you out!
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
<div align="center">
<img src="assets/anteon-logo-db.svg#gh-dark-mode-only" alt="Anteon logo dark" width="336px" /><br />
<img src="assets/anteon-logo-wb.svg#gh-light-mode-only" alt="Anteon logo light" width="336px" /><br />
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon-logo-db.svg#gh-dark-mode-only" alt="Anteon logo dark" width="336px" /><br />
<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>

<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.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://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="assets/anteon_service_map.png" alt="Anteon Kubernetes Monitoring Service Map" />
<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>
</p>

<h2 align="center">
<a href="https://demo.getanteon.com/" target="_blank">Live Demo</a> •
<a href="https://getanteon.com/docs" target="_blank">Documentation</a> •
<a href="https://discord.gg/9KdnrSUZQg" target="_blank">Discord</a>
<a href="https://discord.com/invite/9KdnrSUZQg" target="_blank">Discord</a>
</h2>

## What is Anteon (formerly Ddosify)?
Expand All @@ -39,7 +39,7 @@ Anteon (formerly Ddosify) is an [open-source](https://github.com/getanteon/anteo
- **Distributed Tracing:** Anteon automatically collects traces from your Kubernetes cluster and generates context propagation without changing a single line of code.

<p align="center">
<img src="assets/anteon_metrics.png" alt="Anteon Kubernetes Monitoring Metrics" />
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon_metrics.png" alt="Anteon Kubernetes Monitoring Metrics" />
<i>Anteon tracks and displays live data on your cluster instances CPU, memory, disk, and network usage.</i>
</p>

Expand All @@ -51,7 +51,7 @@ Anteon (formerly Ddosify) is an [open-source](https://github.com/getanteon/anteo
- **Postman Integration:** Import tests directly from Postman, making it convenient for those already using Postman for API development and testing.

<p align="center">
<img src="assets/anteon_performance_testing.png" alt="Anteon Kubernetes Monitoring Metrics" />
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon_performance_testing.png" alt="Anteon Kubernetes Monitoring Metrics" />
<i>Anteon Performance Testing generates load from worldwide with no-code scenario builder.</i>
</p>

Expand All @@ -66,7 +66,7 @@ Anteon Stack consists of 4 parts:


<p align="center">
<img src="assets/anteon_stack.png" alt="Anteon Stack" />
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon_stack.png" alt="Anteon Stack" />
</p>

### Anteon Load Engine (Ddosify)
Expand Down Expand Up @@ -112,7 +112,7 @@ Check out [Anteon Cloud](https://app.getanteon.com/) to find the performance iss

### Comparison of Anteon Cloud, Self-Hosted EE, Self-Hosted CE
<p align="center">
<img src="assets/anteon_comparison.jpg" alt="Anteon versus" />
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon_comparison.jpg" alt="Anteon versus" />

*CE: Community Edition, EE: Enterprise Edition*
</p>
Expand All @@ -122,33 +122,33 @@ Check out [Anteon Cloud](https://app.getanteon.com/) to find the performance iss
#### ✅ 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="assets/anteon_service_map_detail.png" alt="Anteon - Service Map Feature" />
<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="assets/anteon_service_summary.png" alt="Anteon - Detailed Insights Feature" />
<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="assets/anteon_metrics_detailed.png" alt="Anteon - Metrics Dashboard Feature" />
<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="assets/anteon_load_test.png" alt="Anteon - Find Bottlenecks Feature" />
<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="assets/anteon_load_test_monitoring.png" alt="Anteon - Find Bottlenecks Feature" />
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon_load_test_monitoring.png" alt="Anteon - Find Bottlenecks Feature" />
</p>

#### ✅ Distributed Tracing
Expand Down Expand Up @@ -211,7 +211,7 @@ To learn about the **Performance Testing** usage of both Self-Hosted and Cloud v

## Communication

You can join our [Discord Server](https://discord.gg/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

Expand Down
6 changes: 3 additions & 3 deletions ddosify_engine/.goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,6 @@ release:
footer: |
## More? 🚀

- Get started on [Ddosify Cloud](https://ddosify.com)
- Join our [Discord server](https://discord.gg/9KdnrSUZQg)
- Follow us on [Twitter](https://twitter.com/ddosify)
- Get started on [Anteon Cloud](https://getanteon.com)
- Join our [Discord server](https://discord.com/invite/9KdnrSUZQg)
- Follow us on [Twitter](https://twitter.com/getanteon)
18 changes: 6 additions & 12 deletions ddosify_engine/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
<div align="center">
<img src="../assets/anteon-logo-db.svg#gh-dark-mode-only" alt="Anteon logo dark" width="336px" /><br />
<img src="../assets/anteon-logo-wb.svg#gh-light-mode-only" alt="Anteon logo light" width="336px" /><br />
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon-logo-db.svg#gh-dark-mode-only" alt="Anteon logo dark" width="336px" /><br />
<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">Ddosify: High-performance load testing tool</h1>

<p align="center">
<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;
<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="ddosify 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="ddosify discord server" /></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="ddosify discord server" /></a>
<a href="https://hub.docker.com/r/ddosify/ddosify" target="_blank"><img src="https://img.shields.io/docker/v/ddosify/ddosify?style=for-the-badge&logo=docker&label=docker&sort=semver" alt="ddosify docker image" /></a>
</p>


<p align="center">
<img src="../assets/ddosify-quick-start.gif" alt="Ddosify - High-performance load testing tool quick start" />
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/ddosify-quick-start.gif" alt="Ddosify - High-performance load testing tool quick start" />
</p>


Expand Down Expand Up @@ -78,11 +77,6 @@ dpkg -i ddosify_amd64.deb
wget https://github.com/ddosify/ddosify/releases/download/v1.0.6/ddosify_amd64.apk
apk add --allow-untrusted ddosify_amd64.apk

# For Arch Linux
git clone https://aur.archlinux.org/ddosify.git
cd ddosify
makepkg -sri

# For FreeBSD
pkg install ddosify
```
Expand Down Expand Up @@ -769,7 +763,7 @@ Ddosify enables you to capture variables from steps using **json_path**, **xpath
> **:warning: Points to keep in mind**
> - You must specify **'header_key'** when capturing from header.
> - For json_path syntax, please take a look at [gjson syntax](https://github.com/tidwall/gjson/blob/master/SYNTAX.md) doc.
> - Regular expression are expected in **'Golang'** style regex. For converting your existing regular expressions, you can use [regex101](https://regex101.com/).
> - Regular expression are expected in **'Golang'** style regex. For converting your existing regular expressions, you can use [regex101](https://regex101.com).
> - You can extract values from **headers**, **body**, and **cookies**.

You can use **debug** parameter to validate your config.
Expand Down Expand Up @@ -1086,7 +1080,7 @@ echo "ulimit -n 50000" >> ~/.zshrc

## Communication

You can join our [Discord Server](https://discord.gg/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.

## More

Expand Down
8 changes: 4 additions & 4 deletions selfhosted/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<div align="center">
<img src="../assets/anteon-logo-db.svg#gh-dark-mode-only" alt="Anteon logo dark" width="336px" /><br />
<img src="../assets/anteon-logo-wb.svg#gh-light-mode-only" alt="Anteon logo light" width="336px" /><br />
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon-logo-db.svg#gh-dark-mode-only" alt="Anteon logo dark" width="336px" /><br />
<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">Anteon Self Hosted (formerly Ddosify): Effortless Kubernetes Monitoring and Performance Testing</h1>

<p align="center">
<img src="../assets/anteon_service_map_filtered.png" alt="Anteon Kubernetes Monitoring Service Map" />
<img src="https://raw.githubusercontent.com/getanteon/anteon/master/assets/anteon_service_map_filtered.png" alt="Anteon Kubernetes Monitoring Service Map" />
<i>Anteon (formerly Ddosify) detects high latency service calls on your K8s cluster. So you can easily find the root service causing the problem.</i>
</p>

Expand All @@ -30,7 +30,7 @@ This README provides instructions for installing and an overview of the system r

## 🛠 Prerequisites

- [Git](https://git-scm.com/)
- [Git](https://git-scm.com)
- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/) (`docker-compose` or `docker compose`)

Expand Down
Loading