Centre d'aide / Vérifications

Tâches planifiées (heartbeats)

Des URL de ping pour les sauvegardes et les tâches planifiées, avec des exemples pour cron, shell, Rails, Laravel, Node et Python.

Comment fonctionnent les heartbeats

Dans Pingerer, on les appelle Tâches planifiées (les développeurs parlent souvent de heartbeats, ou signaux de vie). Ouvrez Tâches planifiées et choisissez Surveiller une tâche pour en ajouter une.

Un heartbeat surveille quelque chose qui doit se produire selon un horaire. Au lieu que Pingerer vérifie votre tâche, c'est votre tâche qui se signale à Pingerer : quand elle se termine, elle appelle l'URL de ping du heartbeat. Si un ping n'arrive pas avant l'échéance, le heartbeat est hors ligne et vous êtes alerté. Le ping suivant règle l'incident.

  • Période : la fréquence de la tâche (de toutes les 5 minutes à une fois par semaine).
  • Délai de grâce : le retard accepté pour un ping avant qu'il soit considéré comme manqué, pour les tâches qui prennent du temps.
  • L'échéance correspond au dernier ping (ou à la création du heartbeat), plus la période, plus le délai de grâce.

URL de ping

Chaque heartbeat a sa propre URL avec un jeton secret, affichée sur la page Tâches planifiées (cliquez sur l'adresse, ou sur son icône de copie, pour la copier) :

https://pingerer.com/hb/YOUR-TOKEN        # réussite
https://pingerer.com/hb/YOUR-TOKEN/fail   # la tâche a échoué : alerter tout de suite

GET, POST et HEAD fonctionnent tous (envoyez /fail en GET ou en POST). Les aperçus de liens, comme celui de Slack quand vous collez l'URL, ne sont pas comptés. Toute personne qui a l'URL peut l'appeler, alors traitez-la comme un mot de passe. Les pings sont limités à 30 requêtes par minute et par heartbeat.

Si Pingerer lui-même est en panne ou redémarre, votre tâche reçoit quand même un « OK » immédiatement. Le ping est conservé (jusqu'à un jour) et compté à l'heure où il a été envoyé dès notre retour, et un heartbeat dont des pings sont encore en attente n'est pas considéré comme manqué : vous ne recevez donc pas de fausse alerte.

cron

# chaque nuit à 3 h ; ping seulement si la tâche a réussi
0 3 * * * /usr/local/bin/backup.sh && curl -fsS -m 10 --retry 3 https://pingerer.com/hb/YOUR-TOKEN > /dev/null

Script shell

#!/bin/sh
if /usr/local/bin/backup.sh; then
  curl -fsS -m 10 --retry 3 https://pingerer.com/hb/YOUR-TOKEN
else
  curl -fsS -m 10 --retry 3 https://pingerer.com/hb/YOUR-TOKEN/fail
fi

Ruby on Rails

# app/jobs/nightly_backup_job.rb
require "net/http"

class NightlyBackupJob < ApplicationJob
  PING = "https://pingerer.com/hb/YOUR-TOKEN"

  def perform
    Backup.run!
    Net::HTTP.get(URI(PING))
  rescue => error
    Net::HTTP.get(URI("#{PING}/fail"))
    raise
  end
end

Laravel

// routes/console.php (ou app/Console/Kernel.php)
Schedule::command('backup:run')
    ->daily()
    ->pingOnSuccess('https://pingerer.com/hb/YOUR-TOKEN')
    ->pingOnFailure('https://pingerer.com/hb/YOUR-TOKEN/fail');

Node.js

const PING = "https://pingerer.com/hb/YOUR-TOKEN";

async function main() {
  try {
    await runBackup();
    await fetch(PING);
  } catch (error) {
    await fetch(`${PING}/fail`);
    throw error;
  }
}

main();

Python

import urllib.request

PING = "https://pingerer.com/hb/YOUR-TOKEN"

try:
    run_backup()
    urllib.request.urlopen(PING, timeout=10)
except Exception:
    urllib.request.urlopen(PING + "/fail", timeout=10)
    raise

Depuis la ligne de commande

pingerer heartbeats ping "Nightly backup"
pingerer heartbeats ping YOUR-TOKEN --fail   # par jeton, sans connexion

Conseils

  • Envoyez le ping à la fin de la tâche, une fois qu'elle a vraiment réussi, pas au début.
  • Utilisez curl -m 10 --retry 3 pour qu'un réseau lent ne bloque pas votre tâche, et qu'un petit incident ne provoque pas de fausse alerte.
  • Réglez le délai de grâce un peu au-dessus de la durée normale la plus longue de la tâche.
  • Les heartbeats ne sont pas mis en pause par les fenêtres de maintenance ; mettez le heartbeat lui-même en pause si une tâche est volontairement arrêtée.

Toujours bloqué ? Écrivez-nous, une vraie personne vous répondra.