Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kumkeehyun/perisco
eBPF based, L7 protocols monitoring solution in k8s
https://github.com/kumkeehyun/perisco
cilium-ebpf ebpf http kubernetes microservice observability
Last synced: about 1 month ago
JSON representation
eBPF based, L7 protocols monitoring solution in k8s
- Host: GitHub
- URL: https://github.com/kumkeehyun/perisco
- Owner: KumKeeHyun
- Created: 2022-04-23T10:07:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-24T11:27:49.000Z (about 1 year ago)
- Last Synced: 2024-11-09T08:02:07.386Z (about 1 month ago)
- Topics: cilium-ebpf, ebpf, http, kubernetes, microservice, observability
- Language: C
- Homepage:
- Size: 1.39 MB
- Stars: 14
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# perisco
eBPF based, L7 protocols monitoring solution in k8s.
Persico captures unencrypted L4 packets of host using eBPF. The packets are parsed into L7 protocol header and then served in various path(file, elasticsearch etc.).
Perisco use [cilium/ebpf](https://github.com/cilium/ebpf) to load [eBPF](https://ebpf.io/) program.
## Requires
- Ubuntu(kernel version > 5.15.0)
## Support Protocol
- HTTP/1.1
- MySQL
- ️HTTP/2 (⚠️unstable)
## Why Perisco?
### There is already awesome project(cilium) as a network monitoring solution in k8s
`cilium-hubble` 모니터링 솔루션은 k8s cni로 cilium-cni를 사용하는 것을 전제로 합니다. Perisco 프로젝트는 특정한 cni에 종속되지 않는 독립적인 모니터링 솔루션을 제공하는 것을 목표로 합니다.
### What is the difference from pixie?
같은 방식(eBPF 활용)으로 4계층 패킷을 읽어서 파싱하는 pixie 프로젝트가 이미 존재합니다. pixie는 암호화된 프로토콜인 http2, gRPC를 지원하기 위해 4계층이 아닌 7계층(uprobe)를 트레이싱하는 우회기법을 사용하고, 프로토콜의 바디도 파싱하기 위해 페이로드를 최대 30KiB 까지 복사합니다. Perisco 프로젝트는 암호화된 패킷은 깔끔하게 포기해서 간결한 구조를 유지하고, 프로토콜의 헤더만을 파싱하기 때문에 페이로드를 최대 4KiB만 복사하는 등의 차이가 있습니다.
Perisco는 ingress에만 암호화를 사용하고 클러스터 내부 파드간 통신은 암호화를 사용하지 않는 사용 사례를 전제로 합니다. 암호화 계층이 내장되어있는 HTTP/2(+gRPC)의 경우, http2는 h2c(HTTP2 Cleartext), gRPC는 `insecure.NewCredentials()` 옵션을 사용하는 서비스만 추적할 수 있습니다.
## Get Started
Currently, Perisco is tested for Minikube, Google Kubernetes Engine.
GKE requires `Standard Cluster` and `ubuntu-containerd` node image.
### Install Perisco with Elasticsearch and Grafana
```shell
$ cd ./install/perisco-helm
# config values.yaml(cidrs, protocols...)
$ helm install perisco . --create-namespace -n perisco-system
```
### Install Sample Microservice
[booksapp github repo](https://github.com/BuoyantIO/booksapp)
```shell
$ cd ./testing/k8s
$ kubectl apply -f mysql-booksapp.yml
```
### Enter Grafana Dashboard
https://github.com/KumKeeHyun/perisco/assets/44857109/3e6ee8c2-3bc9-4e70-b334-f95474e97ee2
## Architecture
Perisco-agent는 DaemonSet을 통해 클러스터에 배포된 후, bpf 프로그램을 커널에 로드해서 Pod CIDR 범위의 소켓 송수신 페이로드를 캡처합니다.
응용 프로그램은 캡처한 페이로드를 7계층 프로토콜로 파싱해서 네트워크 로그를 생성하는 작업을 수행합니다. 생성한 데이터는 저장을 위해 파일, 엘라스틱서치, 카프카(TODO) 등의 저장소로 전달합니다.
### eBPF
Pixie는 `write`, `read`, `send`, `recv` 등의 system call을 추적하는 반면, Perisco는 불필요한 Hook 실행을 최소화하기 위해`inet_accept`, `sock_sendmsg`, `sock_recvmsg` 커널 함수를 추적합니다.
소켓 송수신 이벤트는 Kubernetes의 NAT(service ip -> pod ip) 환경을 고려하여 Remote 소켓만 추적 대상으로 삼으며, `inet_accept` Hook을 통해 Remote 소켓 목록을 관리합니다.
### Parser
Parser는 캡처한 페이로드를 7계층 프로토콜로 파싱하는 역할을 담당하고, 동시에 아직 지원하지 않는 프로토콜이나 암호화된 프로토콜을 사용하는 소켓을 차단하는 역할도 담당합니다.
프로토콜 정보가 없는 페이로드의 경우에 unknown parser를 통해 모든 프로토콜로 파싱을 시도해보고
- 만약 성공한다면 이후에 수집된 데이터부터는 해당 프로토콜로 파싱
- 반대로 계속해서 파싱에 실패한다면 해당 서버의 송수신 이벤트는 차단
하는 구조입니다.
### Matcher
Matcher는 Parser에서 개별로 생성된 요청/응답 헤더를 하나의 네트워크 로그로 합쳐주는 역할을 담당합니다.