From 48e1e2c6e7b5989ca21470440ad82697b9ce038e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Michael=20B=C3=B6ckli?= <michael.boeckli@gmail.com>
Date: Wed, 29 Nov 2023 21:19:49 +0100
Subject: [PATCH] Profiler documentation

---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index 0e0f518d6..512e2bed6 100644
--- a/README.md
+++ b/README.md
@@ -317,3 +317,10 @@ The tests can be executed like this:
 ```
 make clean_restart_e2e_test
 ```
+
+## Profiler
+Each service runs a http profiler server if it is configured in `config.yaml`. In order to access it, a connection can be created using the Go `pprof` [tool](https://pkg.go.dev/net/http/pprof). For example to investigate the memory usage
+```bash
+go tool pprof http://localhost:9999/debug/pprof/allocs
+```
+Then type `top` to see the functions which consume the most memory. Find more information [here](https://go.dev/blog/pprof).