Developer Guide

This guide helps you get started to develop Kindling.

# Before you start to contribute code

Please check out [An Introduction to the Kindling Architecture](https://mp.weixin.qq.com/s/ND56KTm10WOswUipQsAZ3w)  and read the  [Contributor Guide](https://github.com/CloudDectective-Harmonycloud/kindling/blob/main/CONTRIBUTING.md) first to get some basic knowledge.

# Fetch the code and build

Clone the source code to your development machine.

## Get the source code of the kindling drivers

### Step 1: Fork the agent-libs repository

Visit https://github.com/Kindling-project/agent-libs and click `Fork` to create a fork to your GitHub account.

### Step 2: Clone source code to your local environment

`git clone https://github.com/$user/agent-libs.git`

## Get the kindling probe's and collector's source code

### Step 1: Fork the kindling repository

Visit https://github.com/CloudDectective-Harmonycloud/kindling and click `Fork` to create a fork to your GitHub account.

### Step 2: Clone the source code to your local environment

`git clone https://github.com/$user/kindling.git`

## Build the kindling source code

Please read [Build the kindling container image from the source code](http://www.kindling.space:33215/project-1/doc-13/).

# Understand the data processing flow

Several docs are provided for all developers to get familiar with the project quickly.

- [How to add new eBPF hooks](http://www.kindling.space:33215/project-1/doc-63/)
- [Kindling probe 核心流程](http://www.kindling.space:33215/project-1/doc-64/)
- [Kindling collector 流水线数据传递流程](http://www.kindling.space:33215/project-1/doc-62/)
- [Kindling agent-libs用户态空间数据流](http://www.kindling.space:33215/project-1/doc-60/)
- [Kindling agent-libs内核态空间数据流](http://www.kindling.space:33215/project-1/doc-61/)