aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorArnab Sen <arnabsen1729@gmail.com>2021-09-03 18:46:13 +0530
committerArnab Sen <arnabsen1729@gmail.com>2021-11-28 11:34:44 +0530
commita26e8eef43c5ff0f4a5cd44d1d331a7bd72564a5 (patch)
treec68d455a2072645ab0d6678e811a14afaa2aad4c /doc
parent4f8b1f8759301d2553183e14f72444a0f1d80725 (diff)
[tracing] tracepoint for utxocache flushes
Signed-off-by: Arnab Sen <arnabsen1729@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/tracing.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/tracing.md b/doc/tracing.md
index 57104c43a0..4c18179928 100644
--- a/doc/tracing.md
+++ b/doc/tracing.md
@@ -108,6 +108,22 @@ Arguments passed:
5. SigOps in the Block (excluding coinbase SigOps) `uint64`
6. Time it took to connect the Block in microseconds (µs) as `uint64`
+### Context `utxocache`
+
+#### Tracepoint `utxocache:flush`
+
+Is called *after* the caches and indexes are flushed depending on the mode
+`CChainState::FlushStateToDisk` is called with.
+
+Arguments passed:
+1. Duration in microseconds as `int64`
+2. Flush state mode as `uint32`. It's an enumerator class with values `0`
+ (`NONE`), `1` (`IF_NEEDED`), `2` (`PERIODIC`), `3` (`ALWAYS`)
+3. Number of coins flushed as `uint64`
+4. Memory usage in bytes as `uint64`
+5. If the flush was pruned as `bool`
+6. If it was full flush as `bool`
+
## Adding tracepoints to Bitcoin Core
To add a new tracepoint, `#include <util/trace.h>` in the compilation unit where