-
Notifications
You must be signed in to change notification settings - Fork 164
Expand file tree
/
Copy pathdtrace.xml
More file actions
753 lines (701 loc) · 26.5 KB
/
Copy pathdtrace.xml
File metadata and controls
753 lines (701 loc) · 26.5 KB
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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 7c966c94fde8a9bb4e52975b559dc0bb0cb2ef72 Maintainer: lacatoire Status: ready -->
<!-- Reviewed: no -->
<chapter xml:id="features.dtrace" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>DTrace Traçage dynamique</title>
<sect1 xml:id="features.dtrace.introduction">
<title>Introduction à PHP et DTrace</title>
<para>
DTrace est un framework de traçage toujours disponible, à faible surcoût,
disponible sur plusieurs plateformes, incluant Solaris, macOS,
Oracle Linux et BSD. DTrace peut tracer le comportement du système d'exploitation
et l'exécution des programmes utilisateurs. Il peut afficher les valeurs des arguments et être
utilisé pour déduire des statistiques de performance. Les sondes sont contrôlées par des scripts
créés par l'utilisateur et écrits dans le langage de script DTrace D. Cela
permet une analyse efficace des points de données.
</para>
<para>
Les sondes PHP qui ne sont pas activement surveillées par le script DTrace
D de l'utilisateur ne contiennent pas de code instrumenté, il n'y a donc
pas de dégradation des performances lors de l'exécution normale de l'application.
Les sondes qui sont surveillées ont un coût de fonctionnement assez faible pour
généralement permettre la surveillance de DTrace sur les systèmes de production.
</para>
<para>
PHP incorpore des sondes de "Traçage Statique Défini par l'Utilisateur" (USDT)
qui sont déclenchées au moment de l'exécution. Par exemple, lorsqu'un script D
surveille la sonde <literal>function-entry</literal> de PHP, alors,
chaque fois qu'une fonction du script PHP est appelée, cette sonde est déclenchée et
le code d'action du script D associé est exécuté. Ce code d'action
pourrait, par exemple, imprimer les arguments de la sonde tels que l'emplacement du fichier
source de la fonction PHP. L'action peut également regrouper des données
comme le nombre de fois où chaque fonction est appelée.
</para>
<para>
Seules les sondes PHP USDT sont décrites ici. Se référer à la documentation externe
générale et spécifique au système d'exploitation pour voir comment
DTrace peut être utilisé pour tracer des fonctions arbitraires, et comment il peut être utilisé
pour tracer le comportement du système d'exploitation. Il est à noter que toutes les fonctionnalités
de DTrace ne sont pas disponibles dans toutes les implémentations de DTrace.
</para>
<para>
Les sondes DTrace statiques dans PHP peuvent alternativement être utilisées avec la fonction
SystemTap sur certaines distributions Linux.
</para>
</sect1>
<sect1 xml:id="features.dtrace.dtrace">
<title>Utiliser PHP et DTrace</title>
<para>
PHP peut être configuré avec les sondes statiques DTrace sur les plateformes
qui supportent le traçage dynamique DTrace.
</para>
<sect2 xml:id="features.dtrace.install">
<title>Configurer PHP pour les sondes statiques de DTrace</title>
<para>
Se référer à la documentation spécifique de la plateforme externe pour activer
le support DTrace du système d'exploitation. Par exemple, sur Oracle Linux
démarrez un noyau UEK3 et faites :
<informalexample>
<programlisting role="php">
<![CDATA[
# modprobe fasttrap
# chmod 666 /dev/dtrace/helper
]]>
</programlisting>
</informalexample>
</para>
<para>
Au lieu d'utiliser <literal>chmod</literal>, il est possible d'utiliser une règle de paquetage
ACL pour limiter l'accès au périphérique à un utilisateur spécifique.
</para>
<para>
Construire PHP avec le paramètre de configuration <literal>--enable-dtrace</literal>:
<informalexample>
<programlisting role="php">
<![CDATA[
# ./configure --enable-dtrace ...
# make
# make install
]]>
</programlisting>
</informalexample>
</para>
<para>
Cela rend les sondes statiques disponibles dans le cœur de PHP. Toutes les extensions PHP
qui fournissent leurs propres sondes doivent être construites séparément en tant qu'extensions
partagées.
</para>
<para>
Pour activer les sondes, définissez la variable d'environnement <option>USE_ZEND_DTRACE=1</option> pour les processus PHP ciblés.
</para>
</sect2>
<sect2 xml:id="features.dtrace.static-probes">
<title>Sondes statiques DTrace dans le cœur de PHP</title>
<table>
<title>Les sondes statiques suivantes sont disponibles dans PHP</title>
<tgroup cols="2">
<thead>
<row>
<entry>Nom de la sonde</entry>
<entry>Description de la sonde</entry>
<entry>Arguments de la sonde</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>request-startup</literal></entry>
<entry>Se déclenche lorsqu'une requête démarre.</entry>
<entry>char *<varname>file</varname>, char *<varname>request_uri</varname>, char *<varname>request_method</varname></entry>
</row>
<row>
<entry><literal>request-shutdown</literal></entry>
<entry>Se déclenche lorsqu'une requête s'arrête.</entry>
<entry>char *<varname>file</varname>, char *<varname>request_uri</varname>, char *<varname>request_method</varname></entry>
</row>
<row>
<entry><literal>compile-file-entry</literal></entry>
<entry>Se déclenche lorsque la compilation d'un script commence.</entry>
<entry>char *<varname>compile_file</varname>, char *<varname>compile_file_translated</varname></entry>
</row>
<row>
<entry><literal>compile-file-return</literal></entry>
<entry>Se déclenche lorsque la compilation d'un script se termine.</entry>
<entry>char *<varname>compile_file</varname>, char *<varname>compile_file_translated</varname></entry>
</row>
<row>
<entry><literal>execute-entry</literal></entry>
<entry>Se déclenche lorsqu'un tableau d'opcodes doit être exécuté.
Par exemple, il se déclenche lors d'appels de fonction, d'inclusions et de reprises de
générateur.</entry>
<entry>char *<varname>request_file</varname>, int <varname>lineno</varname></entry>
</row>
<row>
<entry><literal>execute-return</literal></entry>
<entry>Se déclenche après l'exécution d'un tableau d'opcodes.</entry>
<entry>char *<varname>request_file</varname>, int <varname>lineno</varname></entry>
</row>
<row>
<entry><literal>function-entry</literal></entry>
<entry>Se déclenche lorsque le moteur de PHP entre dans une fonction PHP ou un appel de méthode.</entry>
<entry>char *<varname>function_name</varname>, char *<varname>request_file</varname>, int <varname>lineno</varname>, char *<varname>classname</varname>, char *<varname>scope</varname></entry>
</row>
<row>
<entry><literal>function-return</literal></entry>
<entry>Se déclenche lorsque le moteur PHP revient d'une fonction PHP ou d'un appel de méthode.</entry>
<entry>char *<varname>function_name</varname>, char *<varname>request_file</varname>, int <varname>lineno</varname>, char *<varname>classname</varname>, char *<varname>scope</varname></entry>
</row>
<row>
<entry><literal>exception-thrown</literal></entry>
<entry>Se déclenche lorsqu'une exception est émise.</entry>
<entry>char *<varname>classname</varname></entry>
</row>
<row>
<entry><literal>exception-caught</literal></entry>
<entry>Se déclenche lorsqu'une exception est attrapée.</entry>
<entry>char *<varname>classname</varname></entry>
</row>
<row>
<entry><literal>error</literal></entry>
<entry>Se déclenche lorsqu'une erreur survient, quel que soit le niveau de <link linkend="ini.error-reporting">error_reporting</link>.</entry>
<entry>char *<varname>errormsg</varname>, char *<varname>request_file</varname>, int <varname>lineno</varname></entry>
</row>
</tbody>
</tgroup>
</table>
<para>
Les extensions PHP peuvent également disposer de sondes statiques supplémentaires.
</para>
</sect2>
<sect2 xml:id="features.dtrace.list-probes">
<title>Liste des sondes statiques DTrace de PHP</title>
<para>
Pour lister les sondes disponibles, démarrez un processus PHP puis exécutez :
<informalexample>
<programlisting>
<![CDATA[
# dtrace -l
]]>
</programlisting>
</informalexample>
</para>
<para>
Le résultat sera similaire à celui qui suit :
<informalexample>
<programlisting>
<![CDATA[
ID PROVIDER MODULE FUNCTION NAME
[ . . . ]
4 php15271 php dtrace_compile_file compile-file-entry
5 php15271 php dtrace_compile_file compile-file-return
6 php15271 php zend_error error
7 php15271 php ZEND_CATCH_SPEC_CONST_CV_HANDLER exception-caught
8 php15271 php zend_throw_exception_internal exception-thrown
9 php15271 php dtrace_execute_ex execute-entry
10 php15271 php dtrace_execute_internal execute-entry
11 php15271 php dtrace_execute_ex execute-return
12 php15271 php dtrace_execute_internal execute-return
13 php15271 php dtrace_execute_ex function-entry
14 php15271 php dtrace_execute_ex function-return
15 php15271 php php_request_shutdown request-shutdown
16 php15271 php php_request_startup request-startup
]]>
</programlisting>
</informalexample>
</para>
<para>
Les valeurs de la colonne Provider sont <literal>php</literal> et
l'identifiant du processus PHP en cours d'exécution.
</para>
<para>
Si le serveur web Apache est en cours d'exécution, le nom du module peut être,
par exemple, <filename>libphp5.so</filename>, et il y aurait
plusieurs blocs de listes, un par processus Apache en cours d'exécution.
</para>
<para>
La colonne Fonction fait référence à l'implémentation interne en C
de PHP, où chaque fournisseur est situé.
</para>
<para>
Si un processus PHP n'est pas en cours d'exécution, aucune sonde PHP ne sera affichée.
</para>
</sect2>
<sect2 xml:id="features.dtrace.examples">
<title>DTrace avec un exemple PHP</title>
<para>
Cet exemple montre les bases du langage de script DTrace D.
<example>
<title><filename>all_probes.d</filename> pour tracer toutes les sondes statiques PHP avec DTrace</title>
<programlisting>
<![CDATA[
#!/usr/sbin/dtrace -Zs
#pragma D option quiet
php*:::compile-file-entry
{
printf("PHP compile-file-entry\n");
printf(" compile_file %s\n", copyinstr(arg0));
printf(" compile_file_translated %s\n", copyinstr(arg1));
}
php*:::compile-file-return
{
printf("PHP compile-file-return\n");
printf(" compile_file %s\n", copyinstr(arg0));
printf(" compile_file_translated %s\n", copyinstr(arg1));
}
php*:::error
{
printf("PHP error\n");
printf(" errormsg %s\n", copyinstr(arg0));
printf(" request_file %s\n", copyinstr(arg1));
printf(" lineno %d\n", (int)arg2);
}
php*:::exception-caught
{
printf("PHP exception-caught\n");
printf(" classname %s\n", copyinstr(arg0));
}
php*:::exception-thrown
{
printf("PHP exception-thrown\n");
printf(" classname %s\n", copyinstr(arg0));
}
php*:::execute-entry
{
printf("PHP execute-entry\n");
printf(" request_file %s\n", copyinstr(arg0));
printf(" lineno %d\n", (int)arg1);
}
php*:::execute-return
{
printf("PHP execute-return\n");
printf(" request_file %s\n", copyinstr(arg0));
printf(" lineno %d\n", (int)arg1);
}
php*:::function-entry
{
printf("PHP function-entry\n");
printf(" function_name %s\n", copyinstr(arg0));
printf(" request_file %s\n", copyinstr(arg1));
printf(" lineno %d\n", (int)arg2);
printf(" classname %s\n", copyinstr(arg3));
printf(" scope %s\n", copyinstr(arg4));
}
php*:::function-return
{
printf("PHP function-return\n");
printf(" function_name %s\n", copyinstr(arg0));
printf(" request_file %s\n", copyinstr(arg1));
printf(" lineno %d\n", (int)arg2);
printf(" classname %s\n", copyinstr(arg3));
printf(" scope %s\n", copyinstr(arg4));
}
php*:::request-shutdown
{
printf("PHP request-shutdown\n");
printf(" file %s\n", copyinstr(arg0));
printf(" request_uri %s\n", copyinstr(arg1));
printf(" request_method %s\n", copyinstr(arg2));
}
php*:::request-startup
{
printf("PHP request-startup\n");
printf(" file %s\n", copyinstr(arg0));
printf(" request_uri %s\n", copyinstr(arg1));
printf(" request_method %s\n", copyinstr(arg2));
}
]]>
</programlisting>
</example>
</para>
<para>
Ce script utilise l'option <literal>-Z</literal> de
<filename>dtrace</filename>, ce qui lui permet d'être exécuté lorsqu'il n'y a
aucun processus PHP en cours d'exécution. Si cette option était omise, le script
se terminerait immédiatement parce qu'il sait qu'aucune des sondes à
surveiller n'existe.
</para>
<para>
Le script trace tous les points de sonde statiques de PHP pendant la
durée d'un script PHP en cours d'exécution. Exécutez le script D :
<informalexample>
<programlisting>
<![CDATA[
# ./all_probes.d
]]>
</programlisting>
</informalexample>
</para>
<para>
Exécutez un script ou une application PHP. Le script D de surveillance
affichera les arguments de chaque sonde au fur et à mesure qu'elle se déclenche.
</para>
<para>
Lorsque la surveillance est terminée, le script D peut être interrompu par une commande
<keycombo action='simul'><keycap>CTRL</keycap><keycap>C</keycap></keycombo>
</para>
<para>
Sur les machines multi-CPU, l'ordre des sondes peut ne pas être séquentiel.
Cela dépend du CPU qui a traité les sondes,
et de la façon dont les threads migrent d'un CPU à l'autre. L'affichage des horodatages des sondes
permet de réduire la confusion, par exemple :
<informalexample>
<programlisting>
<![CDATA[
php*:::function-entry
{
printf("%lld: PHP function-entry ", walltimestamp);
[ . . .]
}
]]>
</programlisting>
</informalexample>
</para>
</sect2>
<sect2 xml:id="features.dtrace.references">
&reftitle.seealso;
<simplelist>
<member><link linkend="oci8.dtrace">OCI8 et le traçage dynamique DTrace</link></member>
</simplelist>
</sect2>
</sect1>
<sect1 xml:id="features.dtrace.systemtap">
<title>Utiliser SystemTap avec les sondes statiques DTrace de PHP</title>
<para>
Sur certaines distributions Linux, l'utilitaire de traçage SystemTap peut
être utilisé pour tracer les sondes statiques DTrace de PHP. Ceci est disponible avec
PHP 5.4.20 et PHP 5.5.
</para>
<sect2 xml:id="features.dtrace.systemtap-install">
<title>Installer PHP avec SystemTap</title>
<para>
Installez le paquet de développement SDT de SystemTap :
<informalexample>
<programlisting role="shell">
<![CDATA[
# yum install systemtap-sdt-devel
]]>
</programlisting>
</informalexample>
</para>
<para>
Installer PHP avec les sondes DTrace activées :
<informalexample>
<programlisting role="shell">
<![CDATA[
# ./configure --enable-dtrace ...
# make
]]>
</programlisting>
</informalexample>
</para>
</sect2>
<sect2 xml:id="features.dtrace.systemtap-list-probes">
<title>Liste des sondes statiques avec SystemTap</title>
<para>
Les sondes statiques dans PHP peuvent être listées en utilisant <filename>stap</filename>:
<informalexample>
<programlisting>
<![CDATA[
# stap -l 'process.provider("php").mark("*")' -c 'sapi/cli/php -i'
]]>
</programlisting>
</informalexample>
</para>
<para>
Cela produit :
<informalexample>
<programlisting>
<![CDATA[
process("sapi/cli/php").provider("php").mark("compile__file__entry")
process("sapi/cli/php").provider("php").mark("compile__file__return")
process("sapi/cli/php").provider("php").mark("error")
process("sapi/cli/php").provider("php").mark("exception__caught")
process("sapi/cli/php").provider("php").mark("exception__thrown")
process("sapi/cli/php").provider("php").mark("execute__entry")
process("sapi/cli/php").provider("php").mark("execute__return")
process("sapi/cli/php").provider("php").mark("function__entry")
process("sapi/cli/php").provider("php").mark("function__return")
process("sapi/cli/php").provider("php").mark("request__shutdown")
process("sapi/cli/php").provider("php").mark("request__startup")
]]>
</programlisting>
</informalexample>
</para>
</sect2>
<sect2 xml:id="features.dtrace.systemtap-examples">
<title>SystemTap avec un exemple PHP</title>
<para>
<example>
<title><filename>all_probes.stp</filename> pour tracer toutes les sondes statiques PHP avec SystemTap</title>
<programlisting role="shell">
<![CDATA[
probe process("sapi/cli/php").provider("php").mark("compile__file__entry") {
printf("Probe compile__file__entry\n");
printf(" compile_file %s\n", user_string($arg1));
printf(" compile_file_translated %s\n", user_string($arg2));
}
probe process("sapi/cli/php").provider("php").mark("compile__file__return") {
printf("Probe compile__file__return\n");
printf(" compile_file %s\n", user_string($arg1));
printf(" compile_file_translated %s\n", user_string($arg2));
}
probe process("sapi/cli/php").provider("php").mark("error") {
printf("Probe error\n");
printf(" errormsg %s\n", user_string($arg1));
printf(" request_file %s\n", user_string($arg2));
printf(" lineno %d\n", $arg3);
}
probe process("sapi/cli/php").provider("php").mark("exception__caught") {
printf("Probe exception__caught\n");
printf(" classname %s\n", user_string($arg1));
}
probe process("sapi/cli/php").provider("php").mark("exception__thrown") {
printf("Probe exception__thrown\n");
printf(" classname %s\n", user_string($arg1));
}
probe process("sapi/cli/php").provider("php").mark("execute__entry") {
printf("Probe execute__entry\n");
printf(" request_file %s\n", user_string($arg1));
printf(" lineno %d\n", $arg2);
}
probe process("sapi/cli/php").provider("php").mark("execute__return") {
printf("Probe execute__return\n");
printf(" request_file %s\n", user_string($arg1));
printf(" lineno %d\n", $arg2);
}
probe process("sapi/cli/php").provider("php").mark("function__entry") {
printf("Probe function__entry\n");
printf(" function_name %s\n", user_string($arg1));
printf(" request_file %s\n", user_string($arg2));
printf(" lineno %d\n", $arg3);
printf(" classname %s\n", user_string($arg4));
printf(" scope %s\n", user_string($arg5));
}
probe process("sapi/cli/php").provider("php").mark("function__return") {
printf("Probe function__return: %s\n", user_string($arg1));
printf(" function_name %s\n", user_string($arg1));
printf(" request_file %s\n", user_string($arg2));
printf(" lineno %d\n", $arg3);
printf(" classname %s\n", user_string($arg4));
printf(" scope %s\n", user_string($arg5));
}
probe process("sapi/cli/php").provider("php").mark("request__shutdown") {
printf("Probe request__shutdown\n");
printf(" file %s\n", user_string($arg1));
printf(" request_uri %s\n", user_string($arg2));
printf(" request_method %s\n", user_string($arg3));
}
probe process("sapi/cli/php").provider("php").mark("request__startup") {
printf("Probe request__startup\n");
printf(" file %s\n", user_string($arg1));
printf(" request_uri %s\n", user_string($arg2));
printf(" request_method %s\n", user_string($arg3));
}
]]>
</programlisting>
</example>
</para>
<para>
Le script ci-dessus va tracer tous les points de sonde statique de PHP
pendant toute la durée de l'exécution d'un script PHP :
<informalexample>
<programlisting>
<![CDATA[
# stap -c 'sapi/cli/php test.php' all_probes.stp
]]>
</programlisting>
</informalexample>
</para>
</sect2>
</sect1>
<sect1 xml:id="features.dtrace.bpftrace">
<title>Utilisation de bpftrace avec les sondes statiques DTrace de PHP</title>
<simpara>
Sur les distributions Linux dont le noyau supporte eBPF, l'utilitaire
bpftrace peut s'attacher directement aux sondes USDT DTrace de PHP,
sans nécessiter SystemTap.
</simpara>
<sect2 xml:id="features.dtrace.bpftrace-install">
<title>Installation de bpftrace</title>
<para>
Il faut installer bpftrace avec le gestionnaire de paquets de la
distribution. Par exemple, sur Oracle Linux, RHEL ou Fedora :
<informalexample>
<programlisting role="shell">
<![CDATA[
# dnf install bpftrace
]]>
</programlisting>
</informalexample>
Ou, sur Debian ou Ubuntu :
<informalexample>
<programlisting role="shell">
<![CDATA[
# apt install bpftrace
]]>
</programlisting>
</informalexample>
</para>
<simpara>
Les exemples ci-dessous supposent que le binaire PHP cible est installé dans
<filename>/usr/bin/php</filename>.
</simpara>
<simpara>
Les mêmes sondes USDT sont également exposées par les autres SAPI compilées à partir du même
arbre de sources, donc la cible de la sonde peut aussi être le module Apache
(<filename>libphp.so</filename>) ou le binaire du gestionnaire de processus FastCGI
(<filename>php-fpm</filename>) ; il faut substituer le chemin approprié ou s'attacher
par PID avec <literal>-p</literal> si nécessaire.
</simpara>
<simpara>
Il faut s'assurer que le binaire cible est compilé avec DTrace et que la variable d'environnement est correctement configurée.
Voir <link linkend="features.dtrace.install">Configurer PHP pour les sondes statiques DTrace</link> pour les détails.
</simpara>
<para>
Les sondes statiques de PHP peuvent être listées en utilisant
<command>bpftrace</command> :
<informalexample>
<programlisting>
<![CDATA[
# bpftrace -l 'usdt:/usr/bin/php:php:*'
]]>
</programlisting>
</informalexample>
</para>
<para>
Ce qui affiche :
<informalexample>
<programlisting>
<![CDATA[
usdt:/usr/bin/php:php:compile__file__entry
usdt:/usr/bin/php:php:compile__file__return
usdt:/usr/bin/php:php:error
usdt:/usr/bin/php:php:exception__caught
usdt:/usr/bin/php:php:exception__thrown
usdt:/usr/bin/php:php:execute__entry
usdt:/usr/bin/php:php:execute__return
usdt:/usr/bin/php:php:function__entry
usdt:/usr/bin/php:php:function__return
usdt:/usr/bin/php:php:request__shutdown
usdt:/usr/bin/php:php:request__startup
]]>
</programlisting>
</informalexample>
</para>
<para>
<example>
<title><filename>all_probes.bt</filename> pour tracer toutes les sondes statiques de PHP avec bpftrace</title>
<programlisting role="shell">
<![CDATA[
#!/usr/bin/env bpftrace
usdt:/usr/bin/php:php:compile__file__entry
{
printf("Probe compile__file__entry\n");
printf(" compile_file %s\n", str(arg0));
printf(" compile_file_translated %s\n", str(arg1));
}
usdt:/usr/bin/php:php:compile__file__return
{
printf("Probe compile__file__return\n");
printf(" compile_file %s\n", str(arg0));
printf(" compile_file_translated %s\n", str(arg1));
}
usdt:/usr/bin/php:php:error
{
printf("Probe error\n");
printf(" errormsg %s\n", str(arg0));
printf(" request_file %s\n", str(arg1));
printf(" lineno %d\n", (int32)arg2);
}
usdt:/usr/bin/php:php:exception__caught
{
printf("Probe exception__caught\n");
printf(" classname %s\n", str(arg0));
}
usdt:/usr/bin/php:php:exception__thrown
{
printf("Probe exception__thrown\n");
printf(" classname %s\n", str(arg0));
}
usdt:/usr/bin/php:php:execute__entry
{
printf("Probe execute__entry\n");
printf(" request_file %s\n", str(arg0));
printf(" lineno %d\n", (int32)arg1);
}
usdt:/usr/bin/php:php:execute__return
{
printf("Probe execute__return\n");
printf(" request_file %s\n", str(arg0));
printf(" lineno %d\n", (int32)arg1);
}
usdt:/usr/bin/php:php:function__entry
{
printf("Probe function__entry\n");
printf(" function_name %s\n", str(arg0));
printf(" request_file %s\n", str(arg1));
printf(" lineno %d\n", (int32)arg2);
printf(" classname %s\n", str(arg3));
printf(" scope %s\n", str(arg4));
}
usdt:/usr/bin/php:php:function__return
{
printf("Probe function__return\n");
printf(" function_name %s\n", str(arg0));
printf(" request_file %s\n", str(arg1));
printf(" lineno %d\n", (int32)arg2);
printf(" classname %s\n", str(arg3));
printf(" scope %s\n", str(arg4));
}
usdt:/usr/bin/php:php:request__shutdown
{
printf("Probe request__shutdown\n");
printf(" file %s\n", str(arg0));
printf(" request_uri %s\n", str(arg1));
printf(" request_method %s\n", str(arg2));
}
usdt:/usr/bin/php:php:request__startup
{
printf("Probe request__startup\n");
printf(" file %s\n", str(arg0));
printf(" request_uri %s\n", str(arg1));
printf(" request_method %s\n", str(arg2));
}
]]>
</programlisting>
</example>
</para>
<para>
Le script ci-dessus tracera tous les points de sonde statiques du cœur de PHP
pendant toute la durée d'exécution d'un script PHP. bpftrace nécessite
les privilèges root :
<informalexample>
<programlisting>
<![CDATA[
# USE_ZEND_DTRACE=1 bpftrace -c '/usr/bin/php test.php' all_probes.bt
]]>
</programlisting>
</informalexample>
</para>
<para>
Pour tracer un processus PHP déjà en cours d'exécution (par exemple, un
worker <filename>php-fpm</filename> ou un processus Apache chargeant
<filename>libphp.so</filename>), il faut s'attacher par PID :
<informalexample>
<programlisting>
<![CDATA[
# bpftrace -p $PID all_probes.bt
]]>
</programlisting>
</informalexample>
Le chemin cible <literal>usdt:</literal> dans le script doit correspondre au binaire
du processus en cours ; il faut ajuster <literal>usdt:/usr/bin/php</literal> au
binaire <filename>php-fpm</filename> ou à <filename>libphp.so</filename> selon le cas.
</para>
</sect2>
</sect1>
</chapter>
<!-- Keep this comment at the end of the file
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->