Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/getanteon/alaz
Alaz: Advanced eBPF Agent for Kubernetes Observability – Effortlessly monitor K8s service interactions and performance metrics in your K8s environment. Gain in-depth insights with service maps, metrics, and more, while staying alert to crucial system anomalies 🐝
https://github.com/getanteon/alaz
bpf ddosify distributed-tracing ebpf ebpf-programs kubernetes logs metrics monitoring observability prometheus tracing
Last synced: about 1 month ago
JSON representation
Alaz: Advanced eBPF Agent for Kubernetes Observability – Effortlessly monitor K8s service interactions and performance metrics in your K8s environment. Gain in-depth insights with service maps, metrics, and more, while staying alert to crucial system anomalies 🐝
- Host: GitHub
- URL: https://github.com/getanteon/alaz
- Owner: getanteon
- License: agpl-3.0
- Created: 2023-05-18T16:36:02.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-08-16T12:26:43.000Z (about 1 month ago)
- Last Synced: 2024-08-16T12:56:21.040Z (about 1 month ago)
- Topics: bpf, ddosify, distributed-tracing, ebpf, ebpf-programs, kubernetes, logs, metrics, monitoring, observability, prometheus, tracing
- Language: C
- Homepage: https://getanteon.com
- Size: 7.15 MB
- Stars: 617
- Watchers: 8
- Forks: 28
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Alaz - Anteon eBPF Agent for Kubernetes Monitoring
Anteon (formerly Ddosify) automatically generates Service Map of your K8s cluster without code instrumentation or sidecars with eBPF Agent Alaz. So you can easily find the bottlenecks in your system. Red lines indicate the high latency between services.
Live Demo •
Documentation •
Deployment •
Discord
Table of Contents
- [What is Alaz?](#what-is-alaz)
- [Features](#features)
- [🚀 Getting Started](#-getting-started)
- [☁️ For Anteon Cloud](#-for-anteon-cloud)
- [Using the kubectl](#using-the-kubectl)
- [Using the Helm](#using-the-helm)
- [🏠 For Anteon Self-Hosted](#-for-anteon-self-hosted)
- [Using the kubectl](#using-the-kubectl-1)
- [Using the Helm](#using-the-helm-1)
- [🧹 Cleanup](#-cleanup)
- [Supported Protocols](#supported-protocols)
- [Limitations](#limitations)
- [Encryption Libraries](#encryption-libraries)
- [Contributing](#contributing)
- [Communication](#communication)
- [License](#license)
## What is 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. This is possible due to its use of eBPF technology.
Alaz can create a **Service Map** that helps identify golden signals and problems like:
- High latencies between K8s services
- Detect 5xx HTTP status codes
- Detect Idle / Zombie services
- Detect slow SQL queries
Additionally, Anteon tracks and displays live data on your cluster instances CPU, memory, disk, and network usage. All of the dashboards are generated out-of-box and you can create alerts based on these metrics values. Check out the [documentation](https://getanteon.com/docs/) for more.
Anteon tracks and displays live data on your cluster instances CPU, memory, disk, and network usage.
➡️ See [Anteon repository](https://github.com/getanteon/anteon) for more information.
## Features
✅ **Low-Overhead**
Inspect and collect K8s service traffic without the need for code instrumentation, sidecars, or service restarts.
✅ **Effortless**
Anteon will create the Service Map & Metrics Dashboard that helps identify golden signals and issues such as high latencies, 5xx errors, zombie services.
✅ **Prometheus Compatible**
Gather system information and resources via the Prometheus Node Exporter, which is readily available on the agent.
✅ **Cloud or On-premise**
Export metrics to [Anteon Cloud](https://getanteon.com), or install the [Anteon Self-Hosted](https://getanteon.com/docs/self-hosted/) in your infrastructure and manage everything according to your needs.
✅ **Test & Observe**
Anteon Performance Testing and Alaz can work collaboratively. You can start a load test and monitor your system simultaneously. This will help you spot performance issues instantly. Check out the [Anteon documentation](https://getanteon.com/docs) for more information about Anteon Stack.
✅ **Alerts for Anomalies**
If something unusual, like a sudden increase in CPU usage, happens in your Kubernetes (K8s) cluster, Anteon immediately sends alerts to your Slack.
✅ **Platform Support**
Works on both Arm64 and x86_64 architectures.
## 🚀 Getting Started
To use Alaz, you need to have a [Anteon Cloud](https://app.getanteon.com/register) account or [Anteon Self-Hosted](https://github.com/getanteon/anteon) installed.
### ☁️ For Anteon Cloud
1. Register for a [Anteon Cloud account](https://app.getanteon.com/register).
2. Add a cluster on the [Observability page](https://app.getanteon.com/clusters). You will receive a Monitoring ID and instructions.
3. Run the agent on your Kubernetes cluster using the instructions you received. There are two options for Kubernetes deployment:
#### Using the kubectl
```bash
# Replace with your monitoring ID from the Anteon Cloud. Change XXXXX with your monitoring ID.
MONITORING_ID=XXXXX
curl -sSL https://raw.githubusercontent.com/getanteon/alaz/master/resources/alaz.yaml -o alaz.yaml
sed -i"" -e "s//$MONITORING_ID/g" alaz.yaml
kubectl create namespace anteon
kubectl apply -f alaz.yaml
```
#### Using the Helm
```bash
# Replace with your monitoring ID from the Anteon Cloud. Change XXXXX with your monitoring ID.
MONITORING_ID=XXXXX
helm repo add anteon https://getanteon.github.io/anteon-helm-charts/
helm repo update
kubectl create namespace anteon
helm upgrade --install --namespace anteon alaz anteon/alaz --set monitoringID=$MONITORING_ID
```
Then you can view the metrics and Kubernetes Service Map on the [Anteon Observability dashboard](https://app.getanteon.com/clusters). For more information, see [Anteon Kubernetes Monitoring](https://getanteon.com/docs/kubernetes-monitoring/).
### 🏠 For Anteon Self-Hosted
1. Install [Anteon Self-Hosted](https://getanteon.com/docs/self-hosted)
2. Add a cluster on the Observability page of your Self-Hosted frontend. You will receive a Monitoring ID and instructions.
3. Run the agent on your Kubernetes cluster using the instructions you received.
Note: After you install Anteon Self-Hosted, you will have a Anteon Self-Hosted endpoint of Nginx reverse proxy. The base URL of the Anteon Self-Hosted endpoint forwards traffic to the frontend. The base URL of the Anteon Self-Hosted endpoint with `/api` suffix forwards traffic to the backend. So you need to set the backend host variable as `http:///api`.
There are two options for Kubernetes deployment:
#### Using the kubectl
```bash
# Replace with your monitoring ID from the Anteon Cloud. Change XXXXX with your monitoring ID.
MONITORING_ID=XXXXX
# Set BACKEND_HOST with your Anteon Self Hosted Endpoint. If your Anteon Self Hosted endpoint is http://localhost:8014, then BACKEND_HOST=localhost:8014
BACKEND_HOST=XXXXX
curl -sSL https://raw.githubusercontent.com/getanteon/alaz/master/resources/alaz.yaml -o alaz.yaml
sed -i"" -e "s//$MONITORING_ID/g" alaz.yaml
sed -i"" -e "s/https:\/\/api-alaz.getanteon.com:443/http:\/\/$BACKEND_HOST\/api/g" alaz.yaml
kubectl create namespace anteon
kubectl apply -f alaz.yaml
```
#### Using the Helm
```bash
# Replace with your monitoring ID from the Anteon Cloud. Change XXXXX with your monitoring ID.
MONITORING_ID=XXXXX
# Set BACKEND_HOST with your Anteon Self Hosted Endpoint. If your Anteon Self Hosted endpoint is http://localhost:8014, then BACKEND_HOST=http://localhost:8014/api
BACKEND_HOST=XXXXX
helm repo add anteon https://getanteon.github.io/anteon-helm-charts/
helm repo update
kubectl create namespace anteon
helm upgrade --install --namespace anteon alaz anteon/alaz --set monitoringID=$MONITORING_ID --set backendHost=$BACKEND_HOST
```
Then you can view the metrics and Kubernetes Service Map on the Anteon Self-Hosted Observability dashboard. For more information, see [Anteon Monitoring Docs](https://getanteon.com/docs/kubernetes-monitoring/).
Alaz runs as a DaemonSet on your Kubernetes cluster. It collects metrics and sends them to Anteon Cloud or Anteon Self-Hosted. You can view the metrics on the Anteon Observability dashboard. For the detailed Alaz architecture, see [Alaz Architecture](https://github.com/getanteon/alaz/blob/master/ARCHITECTURE.md).
## 🧹 Cleanup
To remove Alaz from your Kubernetes cluster, run the following command:
- For Kubectl:
```bash
kubectl delete -f https://raw.githubusercontent.com/getanteon/alaz/master/resources/alaz.yaml
```
- For Helm:
```bash
helm delete alaz --namespace anteon
```
## Supported Protocols
Alaz supports the following protocols:
- HTTP
- HTTPS (OpenSSL and Go TLS)
- HTTP2
- Postgres
- RabbitMQ
- gRPC
- Redis (RESP)
- Kafka
- MySQL
- MongoDB
Other protocols will be supported soon. If you have a specific protocol you would like to see supported, please [open an issue](https://github.com/getanteon/alaz/issues/new).
## Limitations
Alaz runs on Linux Kubernetes clusters. Windows or MacOS are not supported.
In the future, we plan to support Docker containers.
Alaz is an eBPF application that uses [CO-RE](https://github.com/libbpf/libbpf#bpf-co-re-compile-once--run-everywhere).
Most of the latest linux distributions support CO-RE. In order to CO-RE to work, the kernel has to be built with BTF(bpf type format) information.
You can check your kernel version with `uname -r`
command and whether btf is enabled by default or not at the [btfhub](https://github.com/aquasecurity/btfhub/blob/main/docs/supported-distros.md).
For the time being, we expect that btf information is readily available on your system. We will support all kernels in the upcoming weeks leveraging [btfhub](https://github.com/aquasecurity/btfhub).
### Encryption Libraries
These are the libraries that alaz hooks into for capturing encrypted traffic.
- [crypto/tls](https://pkg.go.dev/crypto/tls):
In order to Alaz to capture tls requests in your Go applications, your go version must be **1.17+** and your executable must include debug info.
- [OpenSSL](https://www.openssl.org/):
OpenSSL shared objects that is dynamically linked into your executable is supported.
Supported versions : **1.0.2**, **1.1.1** and **3.\***
## Contributing
Contributions to Alaz are welcome! To contribute, please follow these steps:
1. Fork the repository
2. Create a new branch: `git checkout -b my-branch`
3. Make your changes and commit them: `git commit -am "Add some feature"`
4. Push to the branch: `git push origin my-branch`
5. Submit a pull request.
## Communication
You can join our [Discord Server](https://discord.com/invite/9KdnrSUZQg) for issues, feature requests, feedbacks or anything else.
## License
Alaz is licensed under the [AGPLv3](LICENSE)