-spec get_check_interval() -> Milliseconds :: integer().

get_check_interval() -> MS

Returns the time interval, in milliseconds, for the periodic memory check.

-spec get_helper_timeout() -> Seconds :: integer().

get_helper_timeout() -> Seconds

Returns the timeout value, in seconds, for memory checks.

-spec get_memory_data() -> {Total, Allocated, Worst}
                   when
                       Total :: integer(),
                       Allocated :: integer(),
                       Worst :: {Pid, PidAllocated} | undefined,
                       Pid :: pid(),
                       PidAllocated :: integer().

get_memory_data() -> {Total,Allocated,Worst}

Returns the result of the latest memory check, where Total is the total memory size and Allocated the allocated memory size, in bytes.

Worst is the pid and number of allocated bytes of the largest Erlang process on the node. If memsup should not collect process data, that is if the configuration parameter memsup_system_only was set to true, Worst is undefined.

The function is normally asynchronous in the sense that it does not invoke a memory check, but returns the latest available value. The one exception if is the function is called before a first memory check is finished, in which case it does not return a value until the memory check is finished.

Returns {0,0,{pid(),0}} or {0,0,undefined} if memsup is not available, or if all memory checks so far have timed out.

-spec get_os_wordsize() -> Wordsize when Wordsize :: 32 | 64 | unsupported_os.

get_os_wordsize() -> Wordsize

Returns the wordsize of the current running operating system.

-spec get_procmem_high_watermark() -> integer().

get_procmem_high_watermark() -> int()

Returns the threshold, in percent, for process memory allocation.

-spec get_sysmem_high_watermark() -> integer().

get_sysmem_high_watermark() -> int()

Returns the threshold, in percent, for system memory allocation.

-spec get_system_memory_data() -> MemDataList
                          when MemDataList :: [{Tag, Size}], Tag :: atom(), Size :: integer().

get_system_memory_data() -> MemDataList

Invokes a memory check and returns the resulting, system dependent, data as a list of tagged tuples, where Tag currently can be one of the following:

• total_memory - The total amount of memory available to the Erlang emulator, allocated and free. May or may not be equal to the amount of memory configured in the system.

• available_memory - Informs about the amount memory that is available for increased usage if there is an increased memory need. This value is not based on a calculation of the other provided values and should give a better value of the amount of memory that actually is available than calculating a value based on the other values reported. This value is currently only present on newer Linux kernels. If this value is not available on Linux, you can use the sum of cached_memory, buffered_memory, and free_memory as an approximation.

• free_memory - The amount of free memory available to the Erlang emulator for allocation.

• system_total_memory - The amount of memory available to the whole operating system. This may well be equal to total_memory but not necessarily.

• buffered_memory - The amount of memory the system uses for temporary storing raw disk blocks.

• cached_memory - The amount of memory the system uses for cached files read from disk. On Linux, also memory marked as reclaimable in the kernel slab allocator will be added to this value.

• total_swap - The amount of total amount of memory the system has available for disk swap.

• free_swap - The amount of memory the system has available for disk swap.

Note

Note that new tagged tuples may be introduced in the result at any time without prior notice

Note that the order of the tuples in the resulting list is undefined and may change at any time.

All memory sizes are presented as number of bytes.

Returns the empty list [] if memsup is not available, or if the memory check times out.

-spec set_check_interval(Minutes :: non_neg_integer()) -> ok.

set_check_interval(Minutes) -> ok

Changes the time interval, given in minutes, for the periodic memory check.

The change will take effect after the next memory check and is non-persistent. That is, in case of a process restart, this value is forgotten and the default value will be used. See Configuration above.

-spec set_helper_timeout(Seconds :: non_neg_integer()) -> ok.

set_helper_timeout(Seconds) -> ok

Changes the timeout value, given in seconds, for memory checks.

The change will take effect for the next memory check and is non-persistent. That is, in the case of a process restart, this value is forgotten and the default value will be used. See Configuration above.

-spec set_procmem_high_watermark(Float :: term()) -> ok.

set_procmem_high_watermark(Float) -> ok

Changes the threshold, given as a float, for process memory allocation.

The change will take effect during the next periodic memory check and is non-persistent. That is, in case of a process restart, this value is forgotten and the default value will be used. See Configuration above.

-spec set_sysmem_high_watermark(Float :: term()) -> ok.

set_sysmem_high_watermark(Float) -> ok

Changes the threshold, given as a float, for system memory allocation.

The change will take effect during the next periodic memory check and is non-persistent. That is, in case of a process restart, this value is forgotten and the default value will be used. See Configuration above.