Manage memory

Manage Teku's Java Virtual Machine (JVM) memory usage by setting a maximum heap size using the JAVA_OPTS environment variable.

We recommend setting the maximum heap size to 5GB or more.

Set the heap size using the environment variable, or using the command line when starting Teku.

Environment variable

export JAVA_OPTS=-Xmx5g

Command line

JAVA_OPTS=-Xmx5g ./teku [options]

note

The node uses more RAM to perform better if it’s available, especially during periods of non-finalization.

Manage the heap dump

If an out of memory error occurs, the heap dump file is placed in the directory that Teku runs from. The heap dump file is potentially large (1-2GB), to specify the directory to place the file, set the -XX:HeapDumpPath Java option to the required path.

Environment variable

export TEKU_OPTS="-XX:HeapDumpPath=/home/me/me_node/dumps"

Command line

TEKU_OPTS="-XX:HeapDumpPath=/home/me/me_node/dumps" ./teku [options]

To disable the heap dump file generation, set the -XX:-HeapDumpOnOutOfMemoryError Java option.

Environment variable

export TEKU_OPTS="-XX:-HeapDumpOnOutOfMemoryError"

Command line

TEKU_OPTS="-XX:-HeapDumpOnOutOfMemoryError" ./teku [options]