Skip to content

Add lua memory option #4736

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.

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

Merged
merged 16 commits into from
Jan 22, 2025
37 changes: 37 additions & 0 deletions doc/reference/configuration/configuration_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3133,6 +3133,43 @@ log.syslog.*
| Default: box.NULL
| Environment variable: TT_LOG_SYSLOG_SERVER

.. _configuration_reference_lua:

lua
---

The ``lua`` section outlines the configuration parameters related to the Lua environment within Tarantool.

.. NOTE::

``lua`` can be defined in any :ref:`scope <configuration_scopes>`.

.. NOTE::

- :ref:`lua.memory <configuration_reference_lua>`


.. _configuration_reference_lua_memory:

.. confval:: lua.memory

Specifies the maximum memory amount available to Lua scripts, measured in bytes.

|
| Type: integer
| Default Value: 2147483648 (2GB)
| Environment variable: TT_LUA_MEMORY

When the specified value exceeds the current memory usage, the new limit takes effect immediately without a restart.
However, **when the specified value is lower than the current memory usage, a restart of the instance is required** for the change to take effect.

Example to set the Lua memory limit to 4 GB:

.. code-block:: yaml

lua:
memory: 4294967296

.. _configuration_reference_memtx:

memtx
Expand Down
Loading