From cd5181e932425ff14ac3304593a4c3f726d175fb Mon Sep 17 00:00:00 2001 From: Slawek Figiel Date: Wed, 26 Jun 2024 17:56:31 +0200 Subject: [PATCH] [#1389] Move the section to user doc --- doc/dev/devel.rst | 25 ------------------------- doc/user/troubleshooting.rst | 26 ++++++++++++++++++++++++++ 2 files changed, 26 insertions(+), 25 deletions(-) diff --git a/doc/dev/devel.rst b/doc/dev/devel.rst index 88bf12e74..debabf8f0 100644 --- a/doc/dev/devel.rst +++ b/doc/dev/devel.rst @@ -1331,31 +1331,6 @@ packages distributed by their maintainers. See `the documentation `_ for details. -High Virtual Memory Usage -------------------------- - -Stork processes allocate large amount of virtual memory. It is a common situation in -applications written in Golang. The Go runtime uses the virtual memory to manage the memory -efficiently. The virtual memory is not the same as the physical memory. The -size of the reserved virtual memory depends on the internal implementation -details of the Go memory allocator. The high value of virtual memory usage -is not alarming as long as the real memory usage is low. - -You can examine the virtual memory usage using the ``ps aux`` command. The -virtual memory usage is displayed in the ``VSZ`` column. There is also the -``RSS`` column that shows the physical memory usage. - -The usual virtual memory usage of the Stork agent on machine with 16GB RAM, -Go 1.22.4, and Ubuntu 22.04 is about 2.5-3GB. -The real memory usage is relatively low, about 10-40MB for Kea deployments with -dozen of subnets and host reservations and 40-80MB for the deployments with -thousands of subnets and host reservations. - -References: - -- `Official Golang FAQ - Why does my Go process use so much virtual memory? `_ -- `Go memory management `_ - Generated Code for DHCP Option Definitions ========================================== diff --git a/doc/user/troubleshooting.rst b/doc/user/troubleshooting.rst index f999b0fe4..aa52a336d 100644 --- a/doc/user/troubleshooting.rst +++ b/doc/user/troubleshooting.rst @@ -360,3 +360,29 @@ This section describes the solutions for some common issues with the Stork serve ``Cannot start the Stork Server: readdirent [HOOK DIRECTORY]/[FILENAME]: not a directory cannot list hook directory`` :Solution: Change the hook directory path. :Explanation: File was found instead of directory under given hook directory path. + + +High Virtual Memory Usage +========================= + +Stork processes allocate large amount of virtual memory. It is a common +situation in applications written in Golang. The Go runtime uses the virtual +memory to manage the memory efficiently. The virtual memory is not the same as +the physical memory. The size of the reserved virtual memory depends on the +internal implementation details of the Go memory allocator. The high value of +virtual memory usage is not alarming as long as the real memory usage is low. + +You can examine the virtual memory usage using the ``ps aux`` command. The +virtual memory usage is displayed in the ``VSZ`` column. There is also the +``RSS`` column that shows the physical memory usage. + +The usual virtual memory usage of the Stork agent on machine with 16GB RAM, +Go 1.22.4, and Ubuntu 22.04 is about 2.5-3GB. +The real memory usage is relatively low, about 10-40MB for Kea deployments with +dozen of subnets and host reservations and 40-80MB for the deployments with +thousands of subnets and host reservations. + +References: + +- `Official Golang FAQ - Why does my Go process use so much virtual memory? `_ +- `Go memory management `_