Skip to content

Commit

Permalink
cln-tracer: readme usage clarifications
Browse files Browse the repository at this point in the history
  • Loading branch information
JssDWt authored and ShahanaFarooqui committed Sep 5, 2024
1 parent 1a71e15 commit 15eb1e6
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion contrib/cln-tracer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,23 @@ This directory contains the following utilities:

- `cln_tracer/trace.py` instruments and exports traces from a single binary.

## Prerequisites

`trace.py` sends traces to [zipkin](https://zipkin.io/), so zipkin needs to be
installed.

## Installation

Since the `bcc` library depends heavily on its binary extension
matching the version of the kernel `systemtap-sdt-dev` version, it is
strongly suggested to install the `libpbfcc` dependency via your
strongly suggested to install the `libbpfcc` dependency via your
package manager and _not_ use a virtualenv to run these tracers.

The tracers also require kernel access, and will most likely have to
be run by `root`

## Usage
To use with a default zipkin installation:
```bash
sudo python3 ./cln_tracer/trace.py http://127.0.0.1:9411/api/v2/spans /path/to/lightningd`
```

0 comments on commit 15eb1e6

Please sign in to comment.