Skip to content

Commit

Permalink
docs: add a short paragraph on how to get started with pyroscope
Browse files Browse the repository at this point in the history
  • Loading branch information
evan-forbes committed Sep 28, 2023
1 parent 5ca865b commit bde38a2
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/core/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,12 @@ Percentage of missing + byzantine validators:
```md
((consensus\_byzantine\_validators\_power + consensus\_missing\_validators\_power) / consensus\_validators\_power) * 100
```

## Profiling with Pyroscope

Flamegraphs for metrics such as execution time and allocations can be generated
using [Pyroscope](https://pyroscope.io/docs/). To enable pyroscope profiling,
set `pyroscope_trace` to `true` and add the url of the pyroscope server being
used to `pyroscope_url` in the config file (`config.toml`). The types of
profiling can be refined by removing or adding profile types to the
`pyroscope_profile_types` string list in the same config.

0 comments on commit bde38a2

Please sign in to comment.