diagnostics: Diagnostics API

diagnosticsR Documentation

Diagnostics API

Description

Comprehensive diagnostics for shard parallel execution, providing insights into memory usage, worker status, task execution, and shared memory segments.

Details

The diagnostics API provides multiple views into shard's runtime behavior:

  • report(): Primary entry point with configurable detail levels

  • mem_report(): Memory usage across workers

  • cow_report(): Copy-on-write policy tracking

  • copy_report(): Data transfer statistics

  • task_report(): Task/chunk execution statistics

  • segment_report(): Shared memory segment information

All functions return S3 shard_report objects with appropriate print methods for human-readable output.


shard documentation built on April 3, 2026, 9:08 a.m.