Skip to content

Commit 0a93d3f

Browse files
committed
Move snapper pod into Telemetry
1 parent 023ac49 commit 0a93d3f

File tree

2 files changed

+14
-23
lines changed

2 files changed

+14
-23
lines changed

doc/Type/Telemetry.pod6

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,20 @@ If that is not set either, defaults to True.
324324
If there are C<snap>s available in the internal array at the end of the
325325
program, then C<report> will be automatically generated and printed on C<STDERR>.
326326
327+
=head 2 module snapper
328+
329+
Start a thread taking repeated system state snapshots.
330+
331+
This module contains no subroutines or methods or anything. It is intended
332+
as a shortcut for starting the L<snapper> subroutine of the C<Telemetry> module,
333+
allowing taking snapshots of the execution of a program without needing to change
334+
the program. Simple loading the module with C<-Msnapper> will do all that is
335+
needed to start the snapper, and have a report printed on STDERR upon completion
336+
of the program.
337+
338+
The C<RAKUDO_SNAPPER> environment variable can be set to indicate the time
339+
between snapshots. If not specified, it will default to B<0.1> seconds.
340+
327341
=end pod
328342

329343
# vim: expandtab softtabstop=4 shiftwidth=4 ft=perl6

doc/Type/Telemetry/snapper.pod6

Lines changed: 0 additions & 23 deletions
This file was deleted.

0 commit comments

Comments
 (0)