Configuration
Le plugin se configure depuis un unique écran dans wp-admin. Après activation, rendez-vous dans Réglages → Quiet Guard (un utilisateur disposant de la capacité manage_options est requis).
Toutes les valeurs sont stockées ensemble dans une seule option WordPress nommée laravel_monitor_options, au sein du groupe de réglages laravel_monitor. Le formulaire est une page standard de l'API Settings de WordPress, intitulée Quiet Guard, avec une unique section Connection.
Champs
L'écran de réglages expose les champs suivants :
| Libellé du champ | Clé d'option | Exemple | Remarques |
|---|---|---|---|
| Enabled (1/0) | enabled | 1 | Interrupteur principal. Toute valeur non vide est enregistrée comme 1 ; une valeur vide devient 0. La capture ne démarre que si ce champ est actif et que l'URL et la clé sont renseignées. |
| Server URL | url | https://monitor.example.com | URL de base de votre serveur Quiet Guard. Assainie avec esc_url_raw. N'ajoutez pas de chemin, le plugin ajoute lui-même /api/v1/ingest. |
| Project key | key | lm_xxxxxxxx | La clé d'API propre au projet, issue de votre tableau de bord Quiet Guard. Envoyée comme jeton HTTP Authorization: Bearer. Assainie avec sanitize_text_field. |
| Environments (comma-separated, empty = all) | environments | production,staging | Liste optionnelle de noms d'environnements. Voir la note ci-dessous sur son comportement actuel. |
| Release (optional) | release | 2024.05.1 ou un SHA git | Identifiant de la version déployée. Joint à chaque événement remonté afin que le serveur puisse rattacher les problèmes à un déploiement. |
Les cinq champs s'affichent sous forme de simples champs texte. Cliquez sur Enregistrer les modifications pour les sauvegarder.
Configuration minimale
Pour commencer à remonter des erreurs, trois éléments suffisent :
- Enabled réglé sur
1. - Server URL, l'URL de base de votre serveur (sans chemin final).
- Project key, créée lorsque vous ajoutez le projet dans le tableau de bord Quiet Guard. Consultez la documentation du serveur pour savoir comment les projets et les clés sont créés.
Si le plugin est activé mais que l'URL ou la clé est vide, rien n'est envoyé et aucune erreur n'est levée, le plugin reste simplement silencieux.
Comment la clé est envoyée
Les rapports sont envoyés via une requête HTTPS POST vers {Server URL}/api/v1/ingest, avec la clé de projet dans l'en-tête Authorization: Bearer … et un corps JSON. La requête est bornée par un court délai d'expiration afin qu'un serveur lent ou injoignable ne bloque jamais la page.
Release
Renseigner une Release permet au serveur de regrouper les problèmes par déploiement. Un SHA git hexadécimal est idéal, car le serveur peut alors rattacher la release d'un problème au commit correspondant qu'il a synchronisé pour le projet. Mettez cette valeur à jour à chaque déploiement.
À propos du champ Environments
Le champ Environments est stocké et transmis à la configuration du cœur sous-jacent, où il est conçu comme une liste blanche d'environnements depuis lesquels remonter les erreurs (vide signifiant « remonter depuis partout »).
Dans la version actuelle, l'adaptateur WordPress ne calcule pas d'« environnement courant » à comparer : cette liste n'a donc encore aucun effet de filtrage, toute erreur capturée est remontée quelle que soit la valeur saisie. Le champ est câblé par anticipation ; le filtrage par environnement pour WordPress est prévu. Pour cesser de remonter les erreurs d'un site aujourd'hui, désactivez Enabled.
Options avancées (absentes de l'interface)
Deux clés supplémentaires sont lues depuis la même option laravel_monitor_options mais ne sont pas exposées sur l'écran de réglages : elles utilisent donc leurs valeurs par défaut, sauf si elles sont définies par programme (par exemple via update_option) :
| Clé d'option | Défaut | Rôle |
|---|---|---|
timeout | 3 | Délai d'expiration HTTP, en secondes, pour chaque rapport. |
trace_limit | 0 | Frames de pile envoyées par exception. 0 (la valeur par défaut) envoie la trace de pile complète ; une valeur positive tronque la trace à ce nombre de frames. |
Vous pouvez définir ces valeurs par programme sans risque : l'assainisseur de réglages conserve timeout et trace_limit lors des enregistrements depuis l'écran de réglages, une valeur écrite via update_option() survit donc aux sauvegardes ultérieures depuis wp-admin.
Étape suivante
Continuez avec l'Utilisation pour voir ce que le plugin capture et comment confirmer qu'il fonctionne.
Vous lisez la documentation WordPress Plugin v1.0.