Skip to contents

Memory Usage Report

Source: R/diagnostics.R
mem_report.Rd

Generates a report of memory usage across all workers in the pool.

Usage

mem_report(pool = NULL)

Arguments

pool

Optional. A shard_pool object. If NULL, uses the current pool.

Value

An S3 object of class shard_report with type "memory" containing:

  • type: "memory"

  • timestamp: When the report was generated

  • pool_active: Whether a pool exists

  • n_workers: Number of workers

  • rss_limit: RSS limit per worker (bytes)

  • total_rss: Sum of RSS across all workers

  • peak_rss: Highest RSS among workers

  • mean_rss: Mean RSS across workers

  • workers: Per-worker RSS details

Examples

# \donttest{
p <- pool_create(2)
mem_report(p)
#> shard memory report
#> Generated: 2026-03-30 20:47:19 
#> 
#> Pool: 2 workers
#> RSS limit: 2.0 GB 
#> 
#> Aggregate:
#>   Total: 137.1 MB 
#>   Peak: 68.6 MB 
#>   Mean: 68.6 MB 
#> 
#> Per-worker:
#>   [+] 1: rss=68.5 MB, baseline=68.5 MB, drift=0.0%
#>   [+] 2: rss=68.6 MB, baseline=68.6 MB, drift=0.0%
pool_stop(p)
# }