Tracer des applications PHP
Rapport de recherche Datadog : Bilan sur l'adoption de l'informatique sans serveur Rapport : Bilan sur l'adoption de l'informatique sans serveur

Tracer des applications PHP

Installation et démarrage

Si vous avez déjà un compte Datadog, vous trouverez des instructions détaillées dans nos guides intégrés à l’application pour les configurations basées sur un host et les configurations basées sur un conteneur.

Pour connaître la définition des termes utilisés dans l’APM, consultez la documentation officielle.

Pour découvrir comment effectuer des contributions open source au traceur PHP, consultez le guide relatif aux contributions.

Configurer l’Agent Datadog

Le traceur de l’APM PHP envoie les données de trace par l’intermédiaire de l’Agent Datadog.

Installez et configurez l’Agent Datadog. Consultez la documentation supplémentaire relative au tracing d’applications Docker ou au tracing d’applications Kubernetes.

Pour les versions 7.18.0 et ultérieures de l’Agent, l’APM est activé par défaut pour tous les environnements. Si vous exécutez une version plus ancienne de l’Agent, vérifiez que vous avez activé l’APM pour l’Agent.

Installer l’extension

Installez l’extension PHP à l’aide de l’un des paquets pré-compilés pour les distributions prises en charge.

Une fois le paquet téléchargé, installez-le avec l’une des commandes ci-dessous.

# avec le paquet RPM (RHEL/Centos 6+, Fedora 20+)
rpm -ivh datadog-php-tracer.rpm

# avec le paquet DEB (Debian Jessie ou ultérieur, Ubuntu 14.04+ sur les versions de PHP prises en charge)
dpkg -i datadog-php-tracer.deb

# avec le paquet APK (Alpine)
apk add datadog-php-tracer.apk --allow-untrusted

L’extension sera installée pour la version de PHP par défaut. Si vous souhaitez installer l’extension pour une version spécifique de PHP, utilisez la variable d’environnement DD_TRACE_PHP_BIN pour définir l’emplacement du binaire PHP cible avant de lancer l’installation.

export DD_TRACE_PHP_BIN=$(which php-fpm7)

Redémarrez PHP (PHP-FPM ou le SAPI Apache), puis consultez un endpoint de votre application pour lequel le tracing est activé. Affichez l’interface de l’APM pour visualiser les traces.

Remarque : quelques minutes peuvent s’écouler avant que les traces soient visibles dans l’UI. Si elles n’apparaissent toujours pas une fois ce délai passé, exécutez le script de diagnostic dd-doctor.php depuis la machine du host afin d’identifier les éventuels problèmes.

Si vous ne trouvez pas votre distribution, vous pouvez installer manuellement l’extension PHP.

Instrumentation automatique

Par défaut, le tracing est automatiquement activé. Une fois l’extension installée, ddtrace trace votre application et envoie les traces à l’Agent.

Par défaut, Datadog prend en charge tous les frameworks Web. L’instrumentation automatique fonctionne en modifiant l’exécution de PHP pour wrapper certaines fonctions et méthodes afin de les tracer. Le traceur PHP prend en charge l’instrumentation automatique pour plusieurs bibliothèques.

L’instrumentation automatique capture :

  • Le temps d’exécution de la méthode
  • Les données de trace pertinentes, telles que l’URL et les codes de réponse de statut pour les requêtes Web ou les requêtes SQL pour l’accès à la base de données
  • Les exceptions non traitées, y compris les traces de pile le cas échéant
  • Le nombre total de traces (p. ex. les requêtes Web) transmises via le système

Remarque : si votre application n’utilise pas Composer ni un chargeur automatique enregistré avec spl_autoload_register(), définissez la variable d’environnement DD_TRACE_NO_AUTOLOADER=true pour activer l’instrumentation automatique.

Modifier le hostname de l’Agent

Configurez vos traceurs d’applications de façon à envoyer des traces à un hostname d’Agent personnalisé :

Le traceur PHP recherche automatiquement les variables ENV DD_AGENT_HOST et DD_TRACE_AGENT_PORT puis s’initialise avec celles-ci.

Consultez la configuration du traceur pour découvrir comment définir ces variables.

Compatibilité

L’APM PHP prend en charge les versions suivantes de PHP :

VersionType de prise en charge
7.4.xPrise en charge complète
7.3.xPrise en charge complète
7.2.xPrise en charge complète
7.1.xPrise en charge complète
7.0.xPrise en charge complète
5.6.xPrise en charge complète
5.4.xPrise en charge complète

L’APM PHP prend en charge les SAPI suivants :

SAPIType de prise en charge
apache2handlerPrise en charge complète
cliPrise en charge complète
fpm-fcgiPrise en charge complète
cgi-fcgiPrise en charge complète

Intégrations

Compatibilité des frameworks Web

Par défaut, Datadog prend en charge tous les frameworks Web PHP. Vous pouvez ainsi visualiser les traces des spans des bibliothèques prises en charge, par exemple pour des clients de base de données et HTTP.

Le tableau suivant énumère plusieurs frameworks et versions pour lesquels Datadog peut surveiller des traces.

Fraweworks Web :

ModuleVersionsType de prise en charge
CakePHP2.xToutes les versions PHP
CodeIgniter2.x, 3.xPHP 7+
Laravel4.2, 5.x, 6.xToutes les versions PHP
Lumen5.2+Toutes les versions PHP
Slim3.xToutes les versions PHP
Symfony3.3, 3.4, 4.xToutes les versions PHP
WordPress4.x, 5.xPHP 7+
Zend Framework1.12Toutes les versions PHP
Yii1.1, 2.0Toutes les versions PHP
DrupalToutes les versions PHP
Magento2Toutes les versions PHP
Phalcon1.3, 3.4Toutes les versions PHP
Slim2.xToutes les versions PHP
Neos Flow1.1Toutes les versions PHP
FuelPHP1.1PHP 7+

Attention : même si votre framework Web n’est pas répertorié, il est par défaut pris en charge avec la dernière version du traceur.

Vous souhaitez utiliser davantage de métadonnées de span et de fonctionnalités internes des frameworks ? Datadog élargit continuellement la prise en charge du tracing avancé pour les frameworks Web PHP. Contactez l’équipe Datadog pour obtenir de l’aide.

Compatibilité des bibliothèques CLI

Le tracing depuis le CLI SAPI est désactivé par défaut. Pour activer le tracing des scripts CLI PHP, définissez DD_TRACE_CLI_ENABLED=true.

ModuleVersionsType de prise en charge
Console CakePHP2.xPrise en charge complète
Laravel Artisan5.xPrise en charge complète
Console SymfonyDisponible prochainement

Votre bibliothèque CLI préférée n’est pas disponible ? Datadog élargit continuellement la liste des bibliothèques prises en charge. Contactez l’équipe Datadog pour obtenir de l’aide.

Compatibilité des datastores

ModuleVersionsType de prise en charge
Amazon RDS (avec PDO ou MySQLi)(Toute version de PHP prise en charge)Prise en charge complète
Elasticsearch1.xPrise en charge complète
EloquentVersions prises en charge par LaravelPrise en charge complète
Memcached(Toute version de PHP prise en charge)Prise en charge complète
MongoDB1.4.xPrise en charge complète
MySQLi(Toute version de PHP prise en charge)Prise en charge complète
PDO (MySQL, PostgreSQL, MariaDB)(Toute version de PHP prise en charge)Prise en charge complète
Predis1.1Prise en charge complète
AWS CouchbaseAWS PHP SDK 3Disponible prochainement
AWS DynamoDBAWS PHP SDK 3Disponible prochainement
AWS ElastiCacheAWS PHP SDK 3Disponible prochainement
Doctrine ORM2Disponible prochainement
ODBC(Toute version de PHP prise en charge)Disponible prochainement
PHPredis4Disponible prochainement
Solarium4.2Disponible prochainement

Votre datastore préféré n’est pas disponible ? Datadog élargit continuellement la liste des datastores pris en charge. Contactez l’équipe Datadog pour obtenir de l’aide.

Compatibilité des bibliothèques

ModuleVersionsType de prise en charge
Curl(Toute version de PHP prise en charge)Prise en charge complète
Guzzle5.xPrise en charge complète
Guzzle6.xPrise en charge complète
BeanstalkdDisponible prochainement
ReactPHPDisponible prochainement

Vos bibliothèques préférées ne sont pas disponibles ? Datadog élargit continuellement la liste des bibliothèques prises en charge. Contactez l’équipe Datadog pour obtenir de l’aide.

Configuration

Le traceur PHP peut être configuré à l’aide de variables d’environnement.

Remarque : si vous utilisez l’instrumentation automatique du code (la méthode conseillée), rappelez-vous que le code instrumenté s’exécute avant le code utilisateur. Par conséquent, les variables d’environnement ci-dessous doivent être définies au niveau du serveur et mises à disposition de l’environnement d’exécution PHP avant l’exécution de tout code utilisateur. Par exemple, putenv() et les fichiers .env ne fonctionneraient pas.

Apache

Pour Apache avec php-fpm, utilisez le répertoire env de votre fichier de configuration www.conf pour configurer le traceur PHP. Exemple :

env[DD_AGENT_HOST] = $FROM_HOST_ENV
env[DD_TRACE_DEBUG] = true

Vous pouvez également utiliser SetEnv depuis la configuration du serveur, le host virtuel, le répertoire ou le fichier .htaccess.

SetEnv DD_TRACE_DEBUG true

NGINX

Pour NGINX, utilisez le répertoire env dans le fichier www.conf de php-fpm. Exemple :

env[DD_AGENT_HOST] = $FROM_HOST_ENV
env[DD_TRACE_DEBUG] = true

Serveur CLI PHP

Défini depuis la ligne de commande pour démarrer le serveur.

DD_TRACE_DEBUG=true php -S localhost:8888

Configuration des variables d’environnement

Variable d’environnementValeur par défautRemarque
DD_AGENT_HOSTlocalhostNom du host de l’Agent
DD_AUTOFINISH_SPANSfalseDéfinit si les spans doivent être automatiquement finalisées ou non lorsque le traceur est vidé
DD_DISTRIBUTED_TRACINGtrueDéfinit si le tracing distribué doit être activé ou non
DD_INTEGRATIONS_DISABLEDnullListe au format CSV des intégrations à désactiver, p. ex. : curl,mysqli (voir la section Noms des intégrations).
DD_PRIORITY_SAMPLINGtrueActive ou désactive l’échantillonnage prioritaire
DD_SERVICE_NAMEnullNom par défaut de l’application
DD_SERVICE_MAPPINGnullModifie le nom par défaut d’une intégration APM. Vous pouvez remplacer le nom de plusieurs intégrations à la fois. Utilisez par exemple DD_SERVICE_MAPPING=pdo:payments-db,mysqli:orders-db (voir la section Noms des intégrations).
DD_TRACE_AGENT_ATTEMPT_RETRY_TIME_MSEC5000Délai de nouvelle tentative du disjoncteur configurable basé sur IPC (en millisecondes)
DD_TRACE_AGENT_CONNECT_TIMEOUT100Délai maximum autorisé pour la configuration de la connexion de l’Agent (en millisecondes)
DD_TRACE_AGENT_CONNECT_TIMEOUT100Délai d’expiration de la connexion de l’Agent (en millisecondes)
DD_TRACE_AGENT_MAX_CONSECUTIVE_FAILURES3Nombre maximal de tentatives du disjoncteur configurable basé sur IPC (en millisecondes)
DD_TRACE_AGENT_PORT8126Port de l’Agent
DD_TRACE_AGENT_TIMEOUT500Délai d’expiration du transfert de la requête de l’Agent (en millisecondes)
DD_TRACE_ANALYTICS_ENABLEDfalseFlag pour activer la fonction App Analytics pour les spans pertinentes dans les intégrations Web
DD_TRACE_AUTO_FLUSH_ENABLEDfalseVider automatiquement le traceur lorsque toutes les spans sont finalisées ; définir sur true conjointement à DD_TRACE_GENERATE_ROOT_SPAN=0 pour tracer les processus à exécution longue
DD_TRACE_CLI_ENABLEDfalseActive le tracing de scripts PHP depuis le CLI
DD_TRACE_DEBUGfalseActive le mode debugging pour le traceur
DD_TRACE_ENABLEDtrueActive le traceur partout
DD_TRACE_GENERATE_ROOT_SPANtrueGénérer automatiquement une span de premier niveau ; définir sur false conjointement à DD_TRACE_AUTO_FLUSH_ENABLED=1 pour tracer les processus à exécution longue
DD_TRACE_GLOBAL_TAGSnullTags à appliquer à toutes les spans, p. ex. : key1:value1,key2:value2.
DD_TRACE_HTTP_CLIENT_SPLIT_BY_DOMAINfalseDéfinir le nom de service des requêtes HTTP sur host-<hostname>. Par exemple, un appel curl_exec() vers https://datadoghq.com prendra le nom de service host-datadoghq.com au lieu du nom de service par défaut curl.
DD_TRACE_MEASURE_COMPILE_TIMEtrueEnregistre la durée de compilation de la requête (en millisecondes) dans la span de premier niveau
DD_TRACE_NO_AUTOLOADERfalseDéfinissez cette variable d’environnement sur true afin d’activer l’instrumentation automatique pour les applications qui n’utilisent pas de chargeur automatique
DD_TRACE_REPORT_HOSTNAMEfalseActive la transmission du hostname sur la span racine
DD_TRACE_RESOURCE_URI_MAPPINGnullRègles de mappage de l’URL au nom de la ressource au format CSV, par exemple : /foo/*,/bar/$*/baz (voir la section Mappage personnalisé de l’URL à la ressource)
DD_TRACE_SAMPLE_RATE1.0Taux d’échantillonnage des traces (entre 0.0 et 1.0 par défaut). Pour les versions inférieures à 0.36.0, ce paramètre est DD_SAMPLING_RATE.
DD_TRACE_SAMPLING_RULESnullChaîne encodée au format JSON pour configurer le taux d’échantillonnage. Exemples : définir le taux d’échantillonnage sur 20 % : [{"sample_rate": 0.2}]. Définir le taux d’échantillonnage sur 10 % pour les services commençant par « a » et pour les noms de span commençant par « b » et définir le taux d’échantillonnage sur 20 % pour tous les autres services : [{"service": "a.*", "name": "b", "sample_rate": 0.1}, {"sample_rate": 0.2}] (voir la section Noms des intégrations).
DD_TRACE_URL_AS_RESOURCE_NAMES_ENABLEDtrueActiver les URL en tant que noms de ressources (voir la section Mapper les noms de ressources à une URL normalisée).
DD_<INTÉGRATION>_ANALYTICS_ENABLEDfalseFlag pour activer App Analytics pour les spans pertinentes dans une intégration spécifique (voir la section Noms des intégrations).
DD_<INTÉGRATION>_ANALYTICS_SAMPLE_RATE1.0Définir le taux d’échantillonnage App Analytics pour les spans pertinentes dans une intégration spécifique (voir la section Noms des intégrations).

Noms des intégrations

Le tableau ci-dessous répertorie les noms de service par défaut pour chaque intégration. Modifiez les noms de service avec DD_SERVICE_MAPPING.

Utilisez ces noms lorsque vous définissez un paramètre pour une intégration spécifique, tel que DD_<INTÉGRATION>_ANALYTICS_ENABLED. Exemple pour Laravel : DD_LARAVEL_ANALYTICS_ENABLED.

IntégrationService Name
CakePHPcakephp
CodeIgnitercodeigniter
cURLcurl
ElasticSearchelasticsearch
Eloquenteloquent
Guzzleguzzle
Laravellaravel
Lumenlumen
Memcachedmemcached
Mongomongo
Mysqlimysqli
PDOpdo
Predispredis
Slimslim
Symfonysymfony
WordPresswordpress
Yiiyii
ZendFrameworkzendframework

Mapper les noms de ressources à une URL normalisée

Par défaut, l’URL est utilisée afin de créer le nom de ressource de la trace, en suivant le format <MÉTHODE_REQUÊTE_HTTP> <URL_NORMALISÉE>. La chaîne de requête est supprimée de l’URL. Cela vous permet de gagner en visibilité sur les frameworks personnalisés qui ne sont pas instrumentés automatiquement en normalisant les URL et en regroupant les endpoints génériques sous une unique ressource.

Requête HTTPNom de la ressource
GET request to /foo?a=1&b=2GET /foo
POST request to /bar?foo=barPOST /bar

Les ID numériques, les UUID (avec et sans tiret) et les hachages hexadécimaux de 32 à 512 octets sont automatiquement remplacés par le caractère ?.

URL (requête GET)Nom de la ressource
/user/123/showGET /user/?/show
/widget/b7a992e0-3300-4030-8617-84553b11c993GET /widget/?
/api/v2/b7a992e033004030861784553b11c993/123GET /api/v2/?/?
/book/0dbf3596GET /book/?

Vous pouvez désactiver cette fonctionnalité avec DD_TRACE_URL_AS_RESOURCE_NAMES_ENABLED=false.

Mappage personnalisé de l’URL à la ressource

Lorsque les noms de ressources d’URL sont activés, le mappage d’URL personnalisé se configure via DD_TRACE_RESOURCE_URI_MAPPING. Ce paramètre accepte une liste CSV de règles de mappage. Les wildcards * et $* sont pris en charge. DD_TRACE_RESOURCE_URI_MAPPING=/foo/*,/bar/$*/baz est donc valide. Dans ce contexte, * est une correspondance gourmande avec un caractère de remplacement ?, et $* forme une correspondance gourmande sans remplacement.

Les règles sont appliquées dans leur ordre d’affichage dans DD_TRACE_RESOURCE_URI_MAPPING. Les règles moins gourmandes doivent figurer avant les règles gourmandes. Exemple : /foo/$*/bar,/foo/*.

Le wildcard * wildcard est remplacé par ?.

Règle de mappageURL (requête GET)Nom de la ressource
/foo/*/foo/barGET /foo/?
/foo/*/bar/foo/baz/faz/barGET /foo/?/bar
/foo-*-bar/foo-secret-barGET /foo-?-bar

Le wildcard $* est mis en correspondance sans être remplacé.

Règle de mappageURL (requête GET)Nom de la ressource
/state/$*/show/state/kentucky/showGET /state/kentucky/show
/widget/*/type/$*/widget/foo-id/type/greenGET /widget/?/type/green

Mise à niveau

Pour mettre à niveau le traceur PHP, téléchargez la dernière version et suivez les mêmes étapes que lors de l’installation de l’extension.

Remarque : si vous utilisez une mise en cache secondaire dans OPcache en définissant le paramètre opcache.file_cache, supprimez le dossier de cache.

Suppression

Pour supprimer le tracer PHP :

  1. Pour php-fpm, arrêtez le service php-fpm ou le serveur Web Apache.
  2. Dissociez les fichiers 98-ddtrace.ini and 99-ddtrace-custom.ini de votre dossier de configuration PHP.
  3. Pour php-fpm, redémarrez le service php-fpm ou le serveur Web Apache.

Remarque : si vous utilisez une mise en cache secondaire dans OPcache en définissant le paramètre opcache.file_cache, supprimez le dossier de cache.

Pour aller plus loin