Skip to content

Commit

Permalink
docs: add installation section
Browse files Browse the repository at this point in the history
Signed-off-by: Alessio Greggi <[email protected]>
  • Loading branch information
alegrey91 committed Sep 23, 2023
1 parent 8e06349 commit 8c24b95
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## Introduction

This tool is designed to provide fine-grained visibility into the syscalls made by specific functions within a program. Unlike traditional system call tracing tools like `strace`, which capture all syscalls made during the entire program's execution, this project leverages the power of eBPF to pinpoint and monitor system calls exclusively within targeted functions.
This tool is designed to provide fine-grained visibility into the syscalls made by specific functions within a program. Unlike traditional system call tracing tools like `strace`, which capture all syscalls made during the entire program's execution, this project leverages the power of **eBPF** to pinpoint and monitor system calls exclusively within targeted functions.

## Getting Started

Expand Down Expand Up @@ -44,6 +44,24 @@ getrlimit

These are the syscalls that have been executed by the traced function!

## Installation

`harpoon` uses the [**bcc**](https://github.com/iovisor/bcc/blob/master/) project under the hood to run **eBPF**. In order to make it works, you'll have to install the **bcc** build dependencies, since it compiles **eBPF** code at runtime. To do so, please refer to this [page](https://github.com/iovisor/bcc/blob/master/INSTALL.md) looking at your own distribution.

### Build

Once you have all the needed tools to run `harpoon`, you can build it locally with:

```sh
make build
```

After the build is completed, you can find the executable under the `bin/` directory.

### Download

Alternatively, you can easily download the latest release from the dedicated [page](https://github.com/alegrey91/harpoon/releases/latest).

## References

I would like to point out that without the references mentioned below this project would never have come to life.
Expand Down

0 comments on commit 8c24b95

Please sign in to comment.