Skip to content

Add a note about memtx.memory estimation #5674

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xuniq wants to merge 1 commit into
base: latest
Choose a base branch
from
Open

Add a note about memtx.memory estimation #5674

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/platform/storage/memtx.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,20 @@ This topic describes how to define basic settings related to in-memory storage i
For the specific settings related to allocator or sorting threads,
check the corresponding ``memtx`` options in the :ref:`Configuration reference <configuration_reference_memtx>`.

.. note_memtx_memory_estimation_start

.. NOTE::

By default, the memory size (``memtx.memory``) parameter is set to 256 MB.
Before deploying a cluster, calculate the necessary amount of memory with a reserve and specify it in the
``memtx.memory`` option.
Starting a cluster with the default memory size value may lead to memory exhaustion and make further writes
to the replica instance impossible.
To estimate the required amount of memory, you can use the
`sizing calculator <https://www.tarantool.io/en/sizing_calculator/>`_.

.. note_memtx_memory_estimation_end

.. _configuration_memtx-memory:

Memory size
Expand Down
4 changes: 4 additions & 0 deletions doc/reference/configuration/configuration_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3323,6 +3323,10 @@ The ``memtx`` section is used to configure parameters related to the :ref:`memtx
The server does not go beyond the ``memtx.memory`` limit to allocate tuples, but there is additional memory
used to store indexes and connection information.

.. include:: /platform/storage/memtx.rst
:start-after: note_memtx_memory_estimation_start
:end-before: note_memtx_memory_estimation_end

**Example**

In the example below, the memory size is set to 1 GB (1073741824 bytes).
Expand Down
Loading