/
Telemetry.pm6
924 lines (793 loc) Β· 29.5 KB
/
Telemetry.pm6
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
# Provide an API for keeping track of a lot of system lifesigns
use nqp;
# the place where the default snaps are stored
my $snaps := nqp::create(IterationBuffer);
# Role for building instruments --------------------------
role Telemetry::Instrument is export {
# Should return instantiated snap object
method snap() is raw { ... } # Typically just Snap.new
# Should return a list of lists with:
# [0] name of the column, also used in headers and legends
# [1] printf format of the column, *without* '%' prefix
# [2] one line explanation of the column to be used in legend
method formats() { ... }
# Should a return a list of column names to be used by default
method columns() { ... }
}
# Role for creating an instrument snap -------------
role Telemetry::Instrument::Snap does Associative is export {
has Mu $!data;
method data() is raw { $!data }
multi method new(::?CLASS:) {
nqp::p6bindattrinvres(nqp::create(self),self,'$!data',self!snap)
}
multi method new(::?CLASS:D: Mu \data) { # needed for creating a difference
nqp::p6bindattrinvres(
nqp::clone(self),::?CLASS,'$!data',nqp::decont(data))
}
multi method new(::?CLASS: *@data) { # provided for .perl roundtripping
my $data := nqp::list_i;
nqp::push_i($data,$_) for @data;
nqp::p6bindattrinvres(nqp::create(self),self,'$!data',$data)
}
multi method perl(::?CLASS:D:) {
my $text := nqp::list_s;
my int $elems = nqp::elems($!data);
my int $i = -1;
nqp::while(
++$i < $elems,
nqp::push_s($text,nqp::atpos_i($!data,$i))
);
self.^name ~ '.new(' ~ nqp::join(',',$text) ~ ')'
}
# Should return a native-int like list with a sample
method !snap() is raw { ... }
# Needed for associative access: given a column name, return the value
method AT-KEY($column) { ... }
# Needed for associative access: given a column name, return whether exists
method EXISTS-KEY($column) { ... }
}
# Telemetry data from wallclock and nqp::getrusage -----------------------------
class Telemetry::Instrument::Usage does Telemetry::Instrument {
method formats() is raw {
<< cpu 8d
'The total amount of CPU used (in microseconds)'
>>,<< cpu-user 8d
'The amount of CPU used in user code (in microseconds)'
>>,<< cpu-sys 8d
'The amount of CPU used in system overhead (in microseconds)'
>>,<< id-rss 8d
'Integral unshared data size (in Kbytes)'
>>,<< inb 3d
'Number of block input operations'
>>,<< invcsw 8d
'Number of involuntary context switches'
>>,<< is-rss 8d
'Integral unshared stack size (in Kbytes)'
>>,<< ix-rss 8d
'Integral shared text memory size (in Kbytes)'
>>,<< aft 3d
'Number of page reclaims (ru_majflt)'
>>,<< max-rss 8d
'Maximum resident set size (in Kbytes)'
>>,<< ift 3d
'Number of page reclaims (ru_minflt)'
>>,<< mrc 3d
'Number of messages received'
>>,<< msd 3d
'Number of messages sent'
>>,<< ngs 3d
'Number of signals received'
>>,<< nsw 3d
'Number of swaps'
>>,<< vcs 4d
'Number of voluntary context switches'
>>,<< oub 3d
'Number of block output operations'
>>,<< util% 6.2f
'Percentage of CPU utilization (0..100%)'
>>,<< wallclock 9d
'Number of microseconds elapsed'
>>
}
method columns() { < wallclock util% max-rss > }
method preamble($first, $last, $total, @snaps --> Str:D) {
qq:to/HEADER/.chomp;
Initial/Final Size: { $first<max-rss> } / { $last<max-rss> } Kbytes
Total Time: { ($total<wallclock> / 1000000).fmt('%9.2f') } seconds
Total CPU Usage: { ($total<cpu> / 1000000).fmt('%9.2f') } seconds
HEADER
}
# actual snapping logic
class Snap does Telemetry::Instrument::Snap {
# Helper stuff
my int $start =
nqp::fromnum_I(Rakudo::Internals.INITTIME * 1000000,Int);
my int $cores = Kernel.cpu-cores;
my $utilize = 100 / $cores;
my int $b2kb =
nqp::atkey(nqp::backendconfig,'osname') eq 'darwin' ?? 10 !! 0;
# Constants indexing into the data array
my constant UTIME_SEC = 0;
my constant UTIME_MSEC = 1;
my constant STIME_SEC = 2;
my constant STIME_MSEC = 3;
my constant MAX_RSS = 4;
my constant IX_RSS = 5;
my constant ID_RSS = 6;
my constant IS_RSS = 8;
my constant MIN_FLT = 9;
my constant MAJ_FLT = 10;
my constant NSWAP = 11;
my constant INBLOCK = 12;
my constant OUTBLOCK = 13;
my constant MSGSND = 14;
my constant MSGRCV = 14;
my constant NSIGNALS = 15;
my constant NVCSW = 16;
my constant INVCSW = 17;
my constant WALLCLOCK = 18; # not actually part of nqp::getrusage
# Initialize the dispatch hash using HLL features, as we only need to
# do this on module load time. First handle the usable names of
# attributes that are part of getrusage struct.
my %dispatch = << "" "" "" "" # first 4 are special
max-rss ix-rss id-rss is-rss min-flt maj-flt nswap inblock
outblock msgsnd msgrcv nsignals nvcsw invcsw wallclock
>>.kv.map: -> int $index, $name {
if $name {
$name => $name.ends-with('rss') && $b2kb
?? -> Mu \data {
nqp::bitshiftr_i(nqp::atpos_i(data,$index),$b2kb)
}
!! -> Mu \data {
nqp::atpos_i(data,$index)
}
}
}
# Allow for low-level dispatch hash access for speed
my $dispatch := nqp::getattr(%dispatch,Map,'$!storage');
# Add the special cases to the dispatch
%dispatch<cpu> = -> Mu \data {
nqp::atpos_i(data,UTIME_SEC) * 1000000
+ nqp::atpos_i(data,UTIME_MSEC)
+ nqp::atpos_i(data,STIME_SEC) * 1000000
+ nqp::atpos_i(data,STIME_MSEC)
}
%dispatch<cpu-user> = -> Mu \data {
nqp::atpos_i(data,UTIME_SEC) * 1000000
+ nqp::atpos_i(data,UTIME_MSEC)
}
%dispatch<cpu-sys> = -> Mu \data {
nqp::atpos_i(data,STIME_SEC) * 1000000
+ nqp::atpos_i(data,STIME_MSEC)
}
%dispatch<cpus> = -> Mu \data {
(my int $wallclock = nqp::atkey($dispatch,'wallclock')(data))
?? nqp::atkey($dispatch,'cpu')(data) / $wallclock
!! $cores
}
%dispatch<util%> = -> Mu \data {
$utilize * nqp::atkey($dispatch,'cpus')(data)
}
method AT-KEY(Str:D $key) {
nqp::ifnull(
nqp::atkey($dispatch,$key),
-> Mu \data { Nil }
)($!data)
}
method EXISTS-KEY(Str:D $key) { nqp::existskey($dispatch,$key) }
method !snap() is raw {
nqp::stmts(
nqp::bindpos_i(
(my $data := nqp::getrusage),
WALLCLOCK,
nqp::sub_i(nqp::fromnum_I(nqp::time_n() * 1000000,Int),$start)
),
$data
)
}
}
method snap(--> Snap:D) { Snap.new }
}
# Telemetry data from the ThreadPoolScheduler ----------------------------------
class Telemetry::Instrument::ThreadPool does Telemetry::Instrument {
method formats() is raw {
<< atc 8d
'The number of tasks completed in affinity threads'
>>,<< atq 3d
'The number of tasks queued for execution in affinity threads'
>>,<< aw 3d
'The number of affinity threads'
>>,<< gtc 8d
'The number of tasks completed in general worker threads'
>>,<< gtq 3d
'The number of tasks queued for execution in general worker threads'
>>,<< gw 3d
'The number of general worker threads'
>>,<< s 1d
'The number of supervisors'
>>,<< ttc 8d
'The number of tasks completed in timer threads'
>>,<< ttq 3d
'The number of tasks queued for execution in timer threads'
>>,<< tw 3d
'The number of timer threads'
>>
}
method columns() { < gw gtc tw ttc aw atc > }
method preamble($first, $last, $total, @snaps --> Str:D) {
my $text := nqp::list_s;
if $first<s> {
nqp::push_s($text,"Supervisor thread ran the whole time");
}
elsif !$last<s> {
nqp::push_s($text,"No supervisor thread has been running");
}
else {
my $started = @snaps.first: *.<s>;
nqp::push_s($text,"Supervisor thread ran for {
(100 * ($last<wallclock> - $started<wallclock>)
/ $total<wallclock>).fmt("%5.2f")
}% of the time");
}
nqp::join("\n",$text)
}
# actual snapping logic
class Snap does Telemetry::Instrument::Snap {
# Constants indexing into the data array
my constant SUPERVISOR = 0;
my constant GW = 1;
my constant GTQ = 2;
my constant GTC = 3;
my constant TW = 4;
my constant TTQ = 5;
my constant TTC = 6;
my constant AW = 7;
my constant ATQ = 8;
my constant ATC = 9;
my constant COLUMNS = 10;
# Initialize the dispatch hash using HLL features, as we only need to
# do this on module load time. First handle the usable names of
# attributes that are part of getrusage struct.
my %dispatch = <<
s gw gtq gtc tw ttq ttc aw atq atc
>>.kv.map: -> int $index, $name {
$name => -> Mu \data { nqp::atpos_i(data,$index) }
}
# Allow for low-level dispatch hash access for speed
my $dispatch := nqp::getattr(%dispatch,Map,'$!storage');
# calculate number of tasks completed for a worker list
sub completed(\workers) is raw {
my int $elems = nqp::elems(workers);
my int $completed;
my int $i = -1;
nqp::while(
nqp::islt_i(($i = nqp::add_i($i,1)),$elems),
nqp::stmts(
(my $w := nqp::atpos(workers,$i)),
($completed = nqp::add_i(
$completed,
nqp::getattr_i($w,$w.WHAT,'$!total')
))
)
);
$completed
}
method AT-KEY(Str:D $key) {
nqp::ifnull(
nqp::atkey($dispatch,$key),
-> Mu \data { Nil }
)($!data)
}
method EXISTS-KEY(Str:D $key) { nqp::existskey($dispatch,$key) }
method !snap() is raw {
my $data := nqp::setelems(nqp::list_i,COLUMNS);
if $*SCHEDULER -> \scheduler {
my $sched := nqp::decont(scheduler);
nqp::bindpos_i($data,SUPERVISOR,1)
if nqp::getattr($sched,ThreadPoolScheduler,'$!supervisor');
if nqp::getattr($sched,ThreadPoolScheduler,'$!general-workers')
-> \workers {
nqp::bindpos_i($data,GW,nqp::elems(workers));
if nqp::getattr($sched,ThreadPoolScheduler,'$!general-queue')
-> \queue {
nqp::bindpos_i($data,GTQ,nqp::elems(queue));
}
nqp::bindpos_i($data,GTC,completed(workers));
}
if nqp::getattr($sched,ThreadPoolScheduler,'$!timer-workers')
-> \workers {
nqp::bindpos_i($data,TW,nqp::elems(workers));
if nqp::getattr($sched,ThreadPoolScheduler,'$!timer-queue')
-> \queue {
nqp::bindpos_i($data,TTQ,nqp::elems(queue));
}
nqp::bindpos_i($data,TTC,completed(workers));
}
if nqp::getattr($sched,ThreadPoolScheduler,'$!affinity-workers')
-> \workers {
my int $elems =
nqp::bindpos_i($data,AW,nqp::elems(workers));
my int $completed;
my int $queued;
my int $i = -1;
nqp::while(
nqp::islt_i(($i = nqp::add_i($i,1)),$elems),
nqp::stmts(
(my $w := nqp::atpos(workers,$i)),
($completed = nqp::add_i(
$completed,
nqp::getattr_i($w,$w.WHAT,'$!total')
)),
($queued = nqp::add_i(
$queued,
nqp::elems(nqp::getattr($w,$w.WHAT,'$!queue'))
))
)
);
nqp::bindpos_i($data,ATQ,$queued);
nqp::bindpos_i($data,ATC,$completed);
}
}
# the final thing
$data
}
}
method snap(--> Snap:D) { Snap.new }
}
# Telemetry::Instrument::Adhoc -------------------------------------------------
class Telemetry::Instrument::AdHoc does Telemetry::Instrument {
has @!formats;
has @!columns;
has Mu $!containers;
has Mu $!dispatch;
multi method new(::?CLASS: *@vars is raw, *%vars is raw) {
nqp::create(self)!SET-SELF(@vars, %vars)
}
method !SET-SELF(\array, \hash) {
$!containers := nqp::create(IterationBuffer);
$!dispatch := nqp::create(Rakudo::Internals::IterationSet);
for array {
my int $index = nqp::elems($!containers);
if nqp::istype($_,Pair) {
my $variable := .value;
die "Must specify a container" unless nqp::iscont($variable);
my str $name = $variable.VAR.name.substr(1);
@!formats.push([$name,"{4 max nqp::chars($name)}d",.key]);
@!columns.push($name);
nqp::bindpos($!containers,$index,$variable.VAR);
nqp::bindkey($!dispatch,$name,
-> Mu \data { nqp::atpos_i(data,$index) });
}
else {
die "Must specify a container" unless nqp::iscont($_);
my str $name = .VAR.name;
@!formats.push([$name,"{4 max nqp::chars($name)}d",""]);
@!columns.push($name);
nqp::bindpos($!containers,$index,$_);
nqp::bindkey($!dispatch,$name,
-> Mu \data { nqp::atpos_i(data,$index) });
}
}
self
}
method preamble($first, $, $, @ --> Str:D) {
my $text := nqp::list_s;
for @!columns -> $name {
nqp::push_s($text,
"Initial $name.tc(): ".fmt('%-17s') ~ $first{$name}.fmt('%9d')
);
}
nqp::join("\n",$text)
}
# actual snapping logic
class Snap does Telemetry::Instrument::Snap {
has Mu $!instrument;
multi method new(::?CLASS: Telemetry::Instrument::AdHoc:D \instrument) {
my $self := nqp::create(self);
nqp::bindattr($self,::?CLASS,'$!instrument',instrument);
nqp::p6bindattrinvres($self,::?CLASS,'$!data',$self!snap)
}
method AT-KEY(Str:D $key) {
my $i := $!instrument;
nqp::ifnull(
nqp::atkey(
nqp::getattr(
$i,Telemetry::Instrument::AdHoc,'$!dispatch'),
$key
),
-> Mu \data { Nil }
)($!data)
}
method EXISTS-KEY(Str:D $key) {
nqp::existskey(
nqp::getattr(
$!instrument,Telemetry::Instrument::AdHoc,'$!dispatch'),
$key
)
}
method !snap() {
my $containers := nqp::getattr(
$!instrument,Telemetry::Instrument::AdHoc,'$!containers');
my int $i = -1;
my int $elems = nqp::elems($containers);
my $data := nqp::setelems(nqp::list_i,$elems);
nqp::while(
nqp::islt_i(($i = nqp::add_i($i,1)),$elems),
nqp::bindpos_i($data,$i,nqp::decont(nqp::atpos($containers,$i)))
);
$data
}
}
method formats() { @!formats }
method columns() { @!columns }
method snap(--> Snap:D) { Snap.new(self) }
}
# Telemetry::Sampler -----------------------------------------------------------
class Telemetry::Sampler {
has $!instruments;
has $!dispatcher;
has $!formats;
# helper sub for handling instruments specified with a Str
sub Str-instrument($name) {
(my $class := nqp::decont(Telemetry::Instrument::{$name})) =:= Any
?? die "Could not find Telemetry::Instrument::$name class"
!! $class
}
method !set-up-instrument($instrument is copy --> Nil) {
my $class = nqp::istype($instrument,Str)
?? Str-instrument($instrument)
!! $instrument;
my int $index = nqp::elems($!instruments);
$!instruments.push($class);
my constant KEY = 0;
my constant FORMAT = 1;
my constant LEGEND = 2;
for $class.formats -> @info {
my str $key = @info[KEY];
nqp::bindkey($!dispatcher,$key, -> Mu \samples {
nqp::atpos(samples,$index).AT-KEY($key)
});
nqp::bindkey($!formats,$key,@info);
}
}
multi method new(Telemetry::Sampler:) { self.new([]) }
multi method new(Telemetry::Sampler: Mu \instrument) {
self.new(List.new(instrument))
}
multi method new(Telemetry::Sampler: @spec) {
my $self := nqp::create(self);
nqp::bindattr($self,self,'$!instruments',
nqp::create(IterationBuffer));
nqp::bindattr($self,self,'$!dispatcher',
nqp::create(Rakudo::Internals::IterationSet));
nqp::bindattr($self,self,'$!formats',
nqp::create(Rakudo::Internals::IterationSet));
# handle instrument specification
if @spec {
$self!set-up-instrument($_) for @spec;
}
# none specified, but we do have a default in the environment
elsif %*ENV<RAKUDO_TELEMETRY_INSTRUMENTS> -> $rri {
$self!set-up-instrument(Str-instrument($_))
for $rri.comb( /<[\w-]>+/ );
}
# no instruments to be found anywhere, use the default default
else {
$self!set-up-instrument($_) for
Telemetry::Instrument::Usage,
Telemetry::Instrument::ThreadPool,
;
}
$self
}
method set-instruments(Telemetry::Sampler:D: *@instruments --> Nil) {
nqp::bindattr(self,Telemetry::Sampler,'$!instruments',
nqp::create(IterationBuffer));
nqp::bindattr(self,Telemetry::Sampler,'$!dispatcher',
nqp::create(Rakudo::Internals::IterationSet));
nqp::bindattr(self,Telemetry::Sampler,'$!formats',
nqp::create(Rakudo::Internals::IterationSet));
self!set-up-instrument($_) for @instruments;
$snaps := nqp::create(IterationBuffer);
}
multi method perl(Telemetry::Sampler:D: --> Str:D) {
self.^name
~ '.new('
~ self.instruments.map(*.^name).join(",")
~ ')'
}
method instruments(Telemetry::Sampler:D:) {
nqp::p6bindattrinvres(nqp::create(List),List,'$!reified',$!instruments)
}
method formats(Telemetry::Sampler:D:) {
nqp::p6bindattrinvres(nqp::create(Map),Map,'$!storage',$!formats)
}
}
# Make sure we alwas have a Sampler
INIT without $*SAMPLER {
PROCESS::<$SAMPLER> := Telemetry::Sampler.new;
}
# Telemetry --------------------------------------------------------------------
class Telemetry does Associative {
has $!sampler;
has $!samples;
multi method new(Telemetry:) {
my $self := nqp::create(self);
nqp::bindattr($self,self,'$!sampler',
my $sampler := nqp::decont($*SAMPLER));
my $instruments :=
nqp::getattr($sampler,Telemetry::Sampler,'$!instruments');
my int $elems = nqp::elems($instruments);
nqp::bindattr($self,self,'$!samples',
my $samples := nqp::setelems(nqp::create(IterationBuffer),$elems));
my int $i = -1;
nqp::while(
++$i < $elems,
nqp::bindpos($samples,$i,nqp::atpos($instruments,$i).snap)
);
$self
}
multi method new(Telemetry: *@samples) { # needed for .perl roundtripping
my $self := nqp::create(self);
nqp::bindattr($self,Telemetry,'$!sampler',
my $sampler := nqp::decont($*SAMPLER));
nqp::bindattr($self,Telemetry,'$!samples',
my $samples := nqp::create(IterationBuffer));
$samples.push($_) for @samples;
$self
}
multi method perl(Telemetry:D: --> Str:D) {
self.^name ~ ".new$!samples.perl()"
}
method sampler() { $!sampler }
method samples() {
nqp::p6bindattrinvres(nqp::create(List),List,'$!reified',$!samples)
}
method AT-KEY($key) is raw {
nqp::ifnull(
nqp::atkey(
nqp::getattr($!sampler,Telemetry::Sampler,'$!dispatcher'),
$key
),
-> Mu \samples { Nil }
)($!samples)
}
method FALLBACK(Telemetry:D: $method) is raw {
self.AT-KEY($method)
// X::Method::NotFound.new(:$method,:typename(self.^name)).throw
}
}
# Telemetry::Period ------------------------------------------------------------
class Telemetry::Period is Telemetry {
# Same as Telemetry, but contains differences instead of absolute values
}
# Creating Telemetry::Period objects -------------------------------------------
multi sub infix:<->(Telemetry:U \a, Telemetry:U \b) is export {
die "Cannot subtract Telemetry type objects";
}
multi sub infix:<->(
Telemetry:D \a, Telemetry:U \b --> Telemetry::Period:D) is export {
a - b.new
}
multi sub infix:<->(
Telemetry:U \a, Telemetry:D \b --> Telemetry::Period:D) is export {
a.new - b
}
multi sub infix:<->(
Telemetry:D \a, Telemetry:D \b --> Telemetry::Period) is export {
my $a := nqp::decont(a);
my $b := nqp::decont(b);
my $period := nqp::create(Telemetry::Period);
nqp::bindattr($period,Telemetry,'$!sampler',
nqp::getattr($a,Telemetry,'$!sampler'));
my \samples-a := nqp::getattr($a,Telemetry,'$!samples');
my \samples-b := nqp::getattr($b,Telemetry,'$!samples');
my int $elems = nqp::elems(samples-a);
die "Different number of samples" if $elems != nqp::elems(samples-b);
# create diff of rusage structs
sub diff($a, $b) is raw {
my Mu \data-a = nqp::decont($a.data);
my Mu \data-b = nqp::decont($b.data);
my Mu \data = nqp::clone(data-a); # make sure correct type
my int $i = -1;
my int $elems = nqp::elems(data);
nqp::while(
++$i < $elems,
nqp::bindpos_i(data,$i,
nqp::sub_i(nqp::atpos_i(data-a,$i),nqp::atpos_i(data-b,$i))
)
);
$a.new(data)
}
nqp::bindattr($period,Telemetry,'$!samples',
my \samples := nqp::setelems(nqp::create(IterationBuffer),$elems));
my int $i = -1;
nqp::while(
++$i < $elems,
nqp::bindpos(samples,$i,diff(
nqp::atpos(samples-a,$i),
nqp::atpos(samples-b,$i)
))
);
$period
}
# Making a Telemetry object procedurally ---------------------------------------
proto sub snap(|) is export {*}
multi sub snap(--> Nil) { $snaps.push(Telemetry.new) }
multi sub snap(@s --> Nil) { @s.push(Telemetry.new) }
# Starting the snapper / changing the period size
my int $snapper-running;
my $snapper-wait;
sub snapper($sleep = 0.1, :$stop, :$reset --> Nil) is export {
$snapper-wait = $sleep;
$snaps := nqp::create(IterationBuffer) if $reset;
if $snapper-running {
$snapper-running = 0 if $stop;
}
elsif !$stop {
$snapper-running = 1;
Thread.start(:app_lifetime, :name<Snapper>, {
snap;
while $snapper-running {
sleep $snapper-wait;
snap if $snapper-running;
}
});
}
}
# Telemetry::Period objects from a list of Telemetry objects -------------------
proto sub periods(|) is export {*}
multi sub periods() {
my $new := $snaps;
$snaps := nqp::create(IterationBuffer);
$new.push(Telemetry.new) if $new.elems == 1;
periods(nqp::p6bindattrinvres(nqp::create(List),List,'$!reified',$new));
}
multi sub periods(@s) { (1..^@s).map: { @s[$_] - @s[$_ - 1] } }
# Telemetry reporting features -------------------------------------------------
proto sub report(|) is export {*}
multi sub report(*%_ --> Str:D) {
report(nqp::p6bindattrinvres(nqp::create(List),List,'$!reified',$snaps),|%_)
}
# some constants for the %format list
constant NAME = 0; # short name
constant FORMAT = 1; # format (without % prefixed)
constant LEGEND = 2; # legend
constant HEADER = 3; # generated: column header
constant FOOTER = 4; # generated: column footer
constant DISPLAY = 5; # generated: code to execute to display
sub prepare-format(@raw, %format --> Nil) is raw {
for @raw -> @info is copy {
my str $name = @info[NAME];
my str $format = @info[FORMAT];
my int $width = $format; # natives have p5 semantics
my str $empty = nqp::x(" ",$width);
@info[HEADER] = $name.fmt("%{$width}s");
@info[FOOTER] = nqp::x("-",$width);
@info[DISPLAY] = -> \value { value ?? value.fmt("%$format") !! $empty }
%format{$name} = @info;
}
}
multi sub report(
@s,
:@columns is copy,
:$header-repeat is copy,
:$legend is copy,
:$csv is copy,
:@format,
--> Str:D
) {
# set up basic header
my $text := nqp::list_s(qq:to/HEADER/.chomp);
Telemetry Report of Process #$*PID ({Instant.from-posix(nqp::time_i).DateTime})
Number of Snapshots: {+@s}
HEADER
# return that if there's nothing to tell otherwise
return nqp::atpos_s($text,0) unless @s;
# get the sampler that was used
my $sampler := @s[0].sampler;
# determine columns to be displayed
unless @columns {
if %*ENV<RAKUDO_REPORT_COLUMNS> -> $rrc {
@columns = $rrc.comb( /<[\w%-]>+/ );
}
else {
@columns.append(.columns) for $sampler.instruments;
}
}
# set header repeat flag
without $header-repeat {
$header-repeat = $_.Int with %*ENV<RAKUDO_REPORT_HEADER_REPEAT> // 32;
}
# set legend flag
without $legend {
$legend = $_.Int with %*ENV<RAKUDO_REPORT_LEGEND> // 1;
}
# set csv flag
without $csv {
$csv = $_.Int with %*ENV<RAKUDO_REPORT_CSV> // 0;
}
# get / calculate the format info we need
my %format;
if @format {
prepare-format(@format, %format)
}
else {
prepare-format(.formats, %format) for @s[0].sampler.instruments;
}
# some initializations
my @periods = periods(@s);
# only want CSV ready output
if $csv {
my @formats = %format{@columns};
nqp::push_s($text,%format{@columns}>>.[NAME].join(' '));
for @periods -> $period {
nqp::push_s($text,
@formats.map( -> @info { $period{@info[NAME]} }).join(' ')
)
}
}
# standard text output
else {
my $first = @s[0];
my $last = @s[*-1];
my $total = $last - $first;
# remove the columns that don't have any values
@columns = @columns.grep: -> $column {
@periods.first: { .{%format{$column}[NAME]} }
};
my $header = "\n%format{@columns}>>.[HEADER].join(' ')";
my @formats = %format{@columns};
for $sampler.instruments -> \instrument {
nqp::push_s($text,$_)
with instrument.preamble: $first, $last, $total, @s;
}
sub push-period($period --> Nil) {
nqp::push_s($text,
@formats.map( -> @info {
@info[DISPLAY]($period{@info[NAME]})
}).join(' ').trim-trailing
)
}
nqp::push_s($text,$header) unless $header-repeat;
for @periods.kv -> $index, $period {
nqp::push_s($text,$header)
if $header-repeat && $index %% $header-repeat;
push-period($period)
}
nqp::push_s($text,%format{@columns}>>.[FOOTER].join(' '));
push-period($total);
if $legend {
nqp::push_s($text,'');
nqp::push_s($text,'Legend:');
for %format{@columns} -> $col {
nqp::push_s($text,"$col[NAME].fmt("%9s") $col[LEGEND]");
}
}
}
nqp::join("\n",$text)
}
# Allow for safe CTRL-c exit, always giving a report ---------------------------
my int $has-safe-ctrl-c;
sub safe-ctrl-c(--> Nil) is export {
unless $has-safe-ctrl-c {
signal(SIGINT).tap: &exit;
$has-safe-ctrl-c = 1;
}
}
# The special T<foo bar> functionality -----------------------------------------
sub T (--> Telemetry:D) is export { Telemetry.new }
# Provide limited export capability --------------------------------------------
sub EXPORT(*@args) {
(EXPORT::DEFAULT::{ @args.map: '&' ~ * }:p).Map
}
# Make sure we tell the world if we're implicitely told to do so ---------------
END {
$snapper-running = 0; # stop any snapper
if $snaps.elems {
snap;
note report;
}
}
# vim: ft=perl6 expandtab sw=4