mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 01:43:36 +01:00
Code Issues Projects Releases Wiki Activity

cln-tracer: readme usage clarifications

Browse Source
This commit is contained in:
Jesse de Wit 2024-08-15 16:06:38 +02:00 committed by ShahanaFarooqui
parent 1a71e15cf3
commit 15eb1e6ff5
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
contrib/cln-tracer/README.md
View File

@ -6,12 +6,23 @@ This directory contains the following utilities:
- `cln_tracer/trace.py` instruments and exports traces from a single binary. - `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 ## Installation
Since the `bcc` library depends heavily on its binary extension Since the `bcc` library depends heavily on its binary extension
matching the version of the kernel `systemtap-sdt-dev` version, it is 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. package manager and _not_ use a virtualenv to run these tracers.
The tracers also require kernel access, and will most likely have to The tracers also require kernel access, and will most likely have to
be run by `root` 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`
```