Skip to content

Commit 2ce6eef

Browse files
committed
Note on memory footprint
1 parent ff81caf commit 2ce6eef

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

synapse/README.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,10 @@ An example configuration setting these and a custom prefix would like::
5151

5252
experimental_features:
5353
msc3886_endpoint: /rendezvous # this should match above
54+
55+
^^^^^^^^^^^^
56+
Memory usage
57+
^^^^^^^^^^^^
58+
59+
`max_entries` and `max_bytes` allow to tune how much memory the module may take.
60+
There is a constant overhead of approximately 1KiB per entry, so with the default config (`max_bytes = 4KiB, max_entries = 10000`), the maximum theorical memory footprint of the moduel is `(4KiB + 1KiB) * 10000 = 50MiB`.

0 commit comments

Comments
 (0)