Starter Spring Boot : @Scheduled et Quartz
Le starter Spring Boot de SilenceWatch surveille les tâches planifiées de votre application sans que vous déclariez quoi que ce soit : il découvre chaque @Scheduled et chaque job Quartz, les déclare avec leur vraie planification, et envoie un signal autour de chaque exécution. Il est sous licence Apache 2.0, volontairement, pour pouvoir être embarqué dans n’importe quelle application.
Démarrage rapide
Section intitulée « Démarrage rapide »-
Obtenez un SilenceWatch. Créez un compte sur app.silencewatch.com, ou auto-hébergez-le.
-
Créez une clé d’API dans Réglages › Clés API › Nouvelle clé. Elle n’est affichée qu’une fois : copiez-la.
-
Ajoutez le starter et la clé (l’installation ci-dessous), puis démarrez votre application avec
SILENCEWATCH_API_KEYdéfinie. -
Regardez le journal :
SilenceWatch is watching 2 job(s). Chaque job est désormais dans Checks, marquéauto, avec sa vraie planification et un signal à chaque exécution. -
Essayez. Arrêtez l’application : les checks passent en retard, puis en panne. Ajoutez un canal d’alerte dans Alertes › Nouveau canal et utilisez Envoyer un test pour être prévenu.
Il faut Java 17 ou plus et la planification activée (@EnableScheduling, dont vos méthodes @Scheduled ont déjà besoin pour s’exécuter). Il a été exécuté avec Spring Boot 3.5 et 4.1.
Installation
Section intitulée « Installation »<dependency> <groupId>com.silencewatch</groupId> <artifactId>silencewatch-spring-boot-starter</artifactId> <version>0.2.0</version></dependency>implementation 'com.silencewatch:silencewatch-spring-boot-starter:0.2.0'silencewatch: api-key: ${SILENCEWATCH_API_KEY}Créez la clé d’API dans Réglages › Clés API de votre projet. C’est toute la configuration.
Ce qu’il fait au démarrage
Section intitulée « Ce qu’il fait au démarrage »À l’événement ApplicationReadyEvent, en un seul appel HTTP :
- Spring : il lit les tâches que Spring a lui-même planifiées, donc les planifications résolues :
@Scheduled(cron = "${backup.cron}")est déclaré avec l’expression que la propriété contenait réellement. - Quartz : si Quartz est présent, il parcourt les jobs et lit leurs déclencheurs. Un job avec plusieurs déclencheurs est déclaré d’après celui qui se déclenche le plus souvent, puisque c’est l’échéance qu’une exécution manquée dépasse en premier.
- Il déclare le tout à
POST /api/v1/checks/syncet garde en mémoire les clés de ping.
Chaque job reçoit une identité stable qui le relie à son historique à travers les redémarrages, les redéploiements et les renommages : com.acme.jobs.BackupJob#run pour Spring, groupe.nomDuJob pour Quartz. Un job qui disparaît du code est marqué orphelin, jamais supprimé.
Ce qu’il fait à chaque exécution
Section intitulée « Ce qu’il fait à chaque exécution »Un advisor Spring AOP (de l’AOP Spring ordinaire, sans AspectJ) entoure chaque méthode @Scheduled ; un JobListener fait de même pour Quartz :
POST /p/<clé>/start au début de l’exécutionPOST /p/<clé>/0?duration_ms=1234 quand elle se terminePOST /p/<clé>/fail?duration_ms=1234 quand elle lève une exceptionConfiguration
Section intitulée « Configuration »silencewatch: enabled: true # false supprime tout, voir plus bas api-key: ${SILENCEWATCH_API_KEY} base-url: https://app.silencewatch.com # votre instance si vous auto-hébergez environment: production # fait partie de l’identité d’un check default-grace: 5m # pour les jobs qui n’en déclarent pas auto-register: true # false pour gérer les checks à la main report-start: true # false pour n’envoyer que le résultat timeout: 2s # par appel, volontairement court queue-capacity: 1000 # bornée, les plus anciens sont abandonnés timezone: Europe/Paris # pour les cron sans fuseau dans le déclencheur discover-spring-tasks: true discover-quartz-jobs: true per-instance-jobs: com.acme.cache.LocalCache#evict # voir « Plusieurs instances » (0.2.0) instance-id: ${HOSTNAME} # avec per-instance-jobs seulement, et stablePlusieurs instances
Section intitulée « Plusieurs instances »Quand une application tourne en plusieurs instances (répliques, pods, serveurs), toutes déclarent les mêmes jobs dans le même environnement : chaque job est donc un seul check pour toutes, en bonne santé tant qu’une instance au moins le signale. C’est ce qu’on attend de la plupart des jobs :
- un job Quartz en cluster, ou une méthode
@Scheduledprotégée par un verrou (ShedLock), tourne sur une instance à la fois, et le check l’entend quelle qu’elle soit. Avec ShedLock, seule l’instance qui a obtenu le verrou signale l’exécution (depuis le starter 0.2.1 : les versions précédentes signalaient aussi les exécutions sautées par les autres instances, ce qui pouvait masquer un job bloqué). Laissez l’orderde@EnableSchedulerLockà sa valeur par défaut ; le starter prévient s’il ne peut pas se placer dans le verrou ; - une méthode
@Scheduledsans verrou tourne sur chaque instance. Le check reste en bonne santé tant que l’une d’elles l’exécute : une instance dont le planificateur est bloqué passe inaperçue pendant qu’une autre travaille. Si le job doit tourner une seule fois, mettez-le derrière un verrou ; s’il doit tourner partout, lisez la suite.
Les jobs qui doivent tourner sur chaque instance (vider un cache local, supprimer des fichiers temporaires) peuvent être surveillés sur chacune, à partir du starter 0.2.0 :
silencewatch: per-instance-jobs: - com.acme.cache.LocalCache#evict - com.acme.tmp.* # un * final désigne un préfixe instance-id: ${HOSTNAME}Ces jobs sont déclarés dans un environnement propre à l’instance, production.app-0 : chaque
instance a son check, et celle qui se tait est vue pendant que les autres signalent. Les autres
jobs restent partagés.
instance-id n’a pas de valeur par défaut, et doit rester le même d’un redémarrage et d’un
déploiement à l’autre : le nom d’un pod de StatefulSet, le nom d’hôte d’un serveur. Les noms
des pods d’un Deployment changent à chaque déploiement, ce qui laisserait derrière lui, à chaque
fois, des checks que plus rien ne signale, et qui tomberaient en panne. Sans instance-id, les
jobs listés sont surveillés comme partagés, avec un avertissement. Quand vous retirez une instance
pour de bon (réduction d’un StatefulSet), supprimez ses checks.
Les règles qu’il ne transgresse pas
Section intitulée « Les règles qu’il ne transgresse pas »C’est ce qui permet de le mettre en production sans crainte :
- Il ne fait jamais échouer votre job. Toute erreur réseau ou HTTP est avalée et journalisée en
WARN. L’intercepteur appelle votre méthode exactement une fois, renvoie son résultat tel quel et relance son exception inchangée. - Il ne bloque jamais votre job. L’envoi d’un signal est un dépôt dans une file traitée par un thread daemon de basse priorité. Un SilenceWatch injoignable ne coûte rien à votre job.
- Il est borné. La file contient au plus
queue-capacitysignaux ; au-delà, les plus anciens sont abandonnés, parce que l’état le plus récent est celui qui compte. Les avertissements sont limités à un par minute. - Il se dégrade en silence. Pas de clé d’API, pas de réseau, pas de serveur : l’application démarre et tourne exactement comme sans la dépendance.
silencewatch.enabled: falsesupprime tout le mécanisme : pas de découverte, pas de proxy, pas de thread, pas de bean.- Aucune dépendance lourde.
spring-boot-starteret le client HTTP du JDK. Pas de bibliothèque JSON, donc pas de version de Jackson imposée à votre application.
- Les jobs de moins de 30 secondes sont déclarés avec une période de 30 secondes, la plus courte acceptée, et un avertissement les nomme.
- Le
Wde Quartz ne peut pas être évalué par le serveur : ces jobs sont ignorés avec un avertissement plutôt que de faire échouer toute la déclaration. - Les tâches planifiées par programme (
SchedulingConfigurer, lambdas) n’ont pas d’identité stable et sont ignorées. Déclarez ces checks à la main ou donnez-leur une méthode@Scheduled. spring.aop.auto=falsedésactive le proxy que Spring Boot fournit normalement : les jobs sont déclarés mais aucun signal ne peut partir. Le starter le dit au démarrage.