From a47282fe9f9c51d88a3e1be6118b3d672d483fe0 Mon Sep 17 00:00:00 2001 From: Giuliano Mega Date: Sun, 3 Mar 2024 11:46:19 -0300 Subject: [PATCH] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ae064c4..0b9b0ef 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ chroprof - Profiling for [Chronos](https://github.com/status-im/nim-chronos) ============================================================================ -This repo contains a usable profiler for [Chronos](https://github.com/status-im/nim-chronos). For the time being, it requires [a modified version of Chronos V4](https://github.com/codex-storage/nim-chronos/tree/feature/profiler-v4) which has profiling hooks enabled. Some of the rationale for the design and implementation of the profiler [can be found here](https://hackmd.io/eQ_ouNV4QZe0TG334_gkFg). +This repo contains a usable profiler for [Chronos](https://github.com/status-im/nim-chronos). For the time being, it requires [a modified version of Chronos V4](https://github.com/codex-storage/nim-chronos/tree/feature/profiler-v4) which has profiling hooks enabled. Before attempting to use this, make sure you [understand the limitations](#limitations). Some of the rationale for the design and implementation of the profiler [can be found here](https://hackmd.io/eQ_ouNV4QZe0TG334_gkFg). 1. [Enabling profiling](#enabling-profiling) 2. [Looking at metrics](#looking-at-metrics) @@ -57,7 +57,7 @@ which, in the context of a bug, may help identify the cause. ## Limitations -* Nested `waitFor` calls are not supported; +* Nested `waitFor` calls are not supported (as in, it'll crash your app); * Prometheus metrics only work with `refc` because nim-metrics only works with `refc`; * the Prometheus metrics collector can only be enabled for one event loop; i.e., you cannot have multiple loops in different threads publishing metrics to Prometheus.