You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

26 lines
1.1 KiB

  1. <h1>SITE_NAME Documentation</h1>
  2. <p>SITE_NAME is a service for monitoring cron jobs and similar periodic processes:</p>
  3. <ul>
  4. <li>SITE_NAME <strong>listens for HTTP requests ("pings")</strong> from your cron jobs and scheduled
  5. tasks.</li>
  6. <li>It <strong>keeps silent</strong> as long as pings arrive on time.</li>
  7. <li>It <strong>raises an alert</strong> as soon as a ping does not arrive on time.</li>
  8. </ul>
  9. <p>SITE_NAME works as a <a href="https://en.wikipedia.org/wiki/Dead_man%27s_switch">dead man's switch</a> for processes that need to
  10. run continuously or on a regular, known schedule. For example:</p>
  11. <ul>
  12. <li>filesystem backups, database backups</li>
  13. <li>task queues</li>
  14. <li>database replication status</li>
  15. <li>report generation scripts</li>
  16. <li>periodic data import and sync jobs</li>
  17. <li>periodic antivirus scans</li>
  18. <li>DDNS updater scripts</li>
  19. <li>SSL renewal scripts</li>
  20. </ul>
  21. <p>SITE_NAME is <em>not</em> the right tool for:</p>
  22. <ul>
  23. <li>monitoring website uptime by probing it with HTTP requests</li>
  24. <li>collecting application performance metrics</li>
  25. <li>error tracking</li>
  26. <li>log aggregation</li>
  27. </ul>