aboutsummaryrefslogtreecommitdiff
path: root/docs/PROFILING.md
diff options
context:
space:
mode:
authorNeil Alexander <neilalexander@users.noreply.github.com>2022-05-11 15:39:36 +0100
committerNeil Alexander <neilalexander@users.noreply.github.com>2022-05-11 15:39:36 +0100
commit19a9166eb0de86b643c17a3b96c770635468b4f5 (patch)
treea931bad229b70aaf708a09a0f9ffa0b0e548c5ea /docs/PROFILING.md
parent9599b3686e02356e48a537a820b075523252ac64 (diff)
New documentation: https://matrix-org.github.io/dendrite/
Diffstat (limited to 'docs/PROFILING.md')
-rw-r--r--docs/PROFILING.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/PROFILING.md b/docs/PROFILING.md
index b026a8ae..f3b57347 100644
--- a/docs/PROFILING.md
+++ b/docs/PROFILING.md
@@ -1,8 +1,14 @@
+---
+title: Profiling
+parent: Development
+permalink: /development/profiling
+---
+
# Profiling Dendrite
If you are running into problems with Dendrite using excessive resources (e.g. CPU or RAM) then you can use the profiler to work out what is happening.
-Dendrite contains an embedded profiler called `pprof`, which is a part of the standard Go toolchain.
+Dendrite contains an embedded profiler called `pprof`, which is a part of the standard Go toolchain.
## Enable the profiler
@@ -16,7 +22,7 @@ If pprof has been enabled successfully, a log line at startup will show that ppr
```
WARN[2020-12-03T13:32:33.669405000Z] [/Users/neilalexander/Desktop/dendrite/internal/log.go:87] SetupPprof
- Starting pprof on localhost:65432
+ Starting pprof on localhost:65432
```
All examples from this point forward assume `PPROFLISTEN=localhost:65432` but you may need to adjust as necessary for your setup.