Aller au contenu

Installation

Installez le bundle dans l'application Symfony à surveiller (et non sur le serveur Quiet Guard).

Prérequis

  • PHP 8.2 ou supérieur
  • Symfony 6.4 (LTS), 7.x ou 8.x
  • ext-curl (le transport par défaut) et ext-sodium (tirée par le cœur)

Installer le package

Le package est publié sur Packagist : un simple composer require l'installe.

bash
composer require quiet-guard/monitor-symfony-bundle

Cela tire automatiquement le cœur agnostique quiet-guard/monitor-php.

Enregistrer le bundle

Symfony Flex enregistre un bundle à partir d'une recette publiée dans son propre index. Aucune recette n'existe pour ce bundle : ajoutez-le à la main dans config/bundles.php :

php
// config/bundles.php
return [
    // ...
    QuietGuard\Monitor\Symfony\MonitorBundle::class => ['all' => true],
];

La classe du bundle est QuietGuard\Monitor\Symfony\MonitorBundle, et l'alias de son extension de conteneur est monitor : toute la configuration vit donc sous une clé monitor.

Créer le fichier de configuration

Le bundle lit ses options dans une arborescence de configuration monitor. Créez config/packages/monitor.yaml :

yaml
# config/packages/monitor.yaml
monitor:
    url: '%env(default::MONITOR_URL)%'
    key: '%env(MONITOR_KEY)%'

Puis renseignez les variables correspondantes dans .env / .env.local :

dotenv
MONITOR_KEY=votre-jeton-de-projet

# Uniquement pour une instance auto-hébergée : le service hébergé est le défaut
MONITOR_URL=https://monitor.example.com

key est la seule valeur à fournir pour démarrer la remontée. url ne se renseigne que pour une instance auto-hébergée : vide ou absente, elle vaut le service hébergé https://quietguard.dev, et la forme %env(default::MONITOR_URL)% la laisse vide quand la variable n'est pas définie. Consultez la Configuration pour chaque option et sa valeur par défaut.

Vérifier le câblage

Une fois enregistré, le bundle définit ses services dans le conteneur. Vous pouvez confirmer leur présence :

bash
php bin/console debug:container monitor.reporter
php bin/console debug:event-dispatcher kernel.exception

L'écouteur monitor.exception_subscriber doit apparaître sur kernel.exception. Poursuivez avec la Configuration.

Vous lisez la documentation Symfony Bundle v1.0.