Skip to contents

Generate Shard Runtime Report

Source: R/diagnostics.R
report.Rd

Primary entry point for shard diagnostics. Generates a comprehensive report of the current runtime state including pool status, memory usage, and execution statistics.

Usage

report(level = c("summary", "workers", "tasks", "segments"), result = NULL)

Arguments

level

Character. Detail level for the report:

  • "summary": High-level overview (default)

  • "workers": Include per-worker details

  • "tasks": Include task execution history

  • "segments": Include shared memory segment details

result

Optional. A shard_result object from shard_map to include execution diagnostics from.

Value

An S3 object of class shard_report containing:

  • level: The requested detail level

  • timestamp: When the report was generated

  • pool: Pool status information (if pool exists)

  • memory: Memory usage summary

  • workers: Per-worker details (if level includes workers)

  • tasks: Task execution details (if level includes tasks)

  • segments: Segment details (if level includes segments)

  • result_diagnostics: Diagnostics from shard_result (if provided)

Examples

# \donttest{
res <- shard_map(shards(100, workers = 2), function(s) sum(s$idx), workers = 2)
pool_stop()
report(result = res)
#> shard_report (summary)
#> Generated: 2026-03-30 20:47:43 
#> 
#> Pool: (not active)
#> 
#> Memory:
#>   (no pool active)
# }