package mem_usage

All checked builds pass
  1. Overview
  2. Docs
Cross-platform stats about memory usage

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (9)

Authors

  1. R
    Romain Beauxis <toots@rastageeks.org>

Maintainers

  1. T
    The Savonet Team <contact@liquidsoap.info>

Sources

v0.2.0.tar.gz
md5=6c5036811ec7240f659dcd8f764cf382
sha512=98062df94ad6df4c6d6925b26105d83064af658498545fc39d573e9b6441be03c29731bad55ab5aeeab26924520a7378803685f590d2cab359e1a72c282d1193

Description

Added to opam-repository:

README

ocaml-mem_usage

GitHub GitHub Workflow Status GitHub release (latest by date)

A cross-platform OCaml module for reporting memory usage, with a focus on distinguishing private memory (allocated by the process itself) from shared memory (e.g., shared libraries, memory-mapped files).

Overview

The module reports both system-wide and per-process memory statistics:

Field

Description

total_physical_memory

Total RAM installed on the system

total_virtual_memory

Total virtual memory (RAM + swap)

total_used_physical_memory

RAM currently in use system-wide

total_used_virtual_memory

Virtual memory in use system-wide

process_virtual_memory

Virtual address space of the process

process_physical_memory

Resident set size (RSS) - pages in RAM

process_private_memory

Private pages unique to this process (USS)

process_swapped_memory

Process pages swapped to disk

The key metric is process_private_memory which represents memory that would be freed if this process terminates, excluding shared libraries and other shared mappings.

Supported Platforms

  • Linux
  • macOS
  • Windows
  • FreeBSD

Example

let () =
  let info = Mem_usage.info () in
  Printf.printf "Process private memory: %s\n"
    (Mem_usage.prettify_bytes ~binary:true info.process_private_memory)

Output:

Process private memory: 1.25 MiB

Installation

opam install mem_usage

To install from source:

git clone https://github.com/savonet/ocaml-mem_usage.git
cd ocaml-mem_usage
opam install .

Documentation

API documentation

License

MIT

Dependencies (3)

  1. dune >= "3.23"
  2. ocaml >= "4.08"
  3. conf-sysinfo os = "freebsd"

Dev Dependencies (1)

  1. odoc with-doc

Optional Dependencies

None

Used by (2)

  1. liquidsoap >= "2.3.3"
  2. liquidsoap-core >= "2.3.0"

Conflicts

None

Build status

Results of building mem_usage with each compiler on check.ci.ocaml.org, run of against opam-repository 8a77e58. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.2.0 (this version) good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure