Cron job monitoring

With Cronitor you can create and integrate a cron job monitor in minutes, no coding required. When you create a monitor using a cron schedule like */15 * * * 1-5 we will alert you if your job does not run successfully, including:

  • The job does not start on time
  • The job runs for longer than expected
  • The job exits with a failure code
  • The job runs outside the expected schedule

Monitoring traditional cron jobs

If you are monitoring jobs in a crontab file, using cronitor discover in CronitorCLI is the easiest way to automatically create monitors for each job and keep their schedule in sync with your server.

  1. If you haven't installed CronitorCLI on your server, download and follow installation instructions.
  2. Before using discover for the first time your API key is required. Use cronitor configure -k <API KEY> to save the key in the system-wide cronitor config file, or see the "Configuration" section of Using CronitorCLI for more configuration options.
  3. Run cronitor discover <CRONTAB PATH> to read the crontab file and automatically create monitors for each entry using the Cronitor API. Your crontab will be rewritten to include necessary cronitor exec calls when each job runs and the updated crontab will be written to stdout.
  4. Immediately after running cronitor discover you will see the newly discovered cron jobs on your dashboard. Monitor names are created from the command being run. Names can be updated manually from the dashboard or you can re-run cronitor discover with optional -e, --exclude-from-name argument(s) to remove path names and other boilerplate from the automatically generated name. Re-run cronitor discover as many times as needed until the names on your dashboard are acceptable. Note that name length is limited to 100 chars. See cronitor help discover for examples.
  5. When satisfied with how cronitor discover has imported your crontab, and after reviewing the stdout output for accuracy, complete the integration by updating your crontab file with the output from the discover command. Note: If you are not using crontab -e to update contents you may need to restart your cron daemon to pick up changes to the crontab file.

By default, cronitor discover adds itself as an entry to each crontab file. This feature, auto-discover, is used to push schedule changes to Cronitor and alert you to any new jobs that have been added without monitoring.

Manually creating a Not on Schedule monitor

If you are monitoring jobs that use cron-like scheduling without a crontab file, you can manually create and integrate a cron monitor with just a few steps.

  1. From your dashboard, click the button to create a new monitor and select Cron job
  2. Paste the schedule expression:
  3. If your server clock timezone is not set to UTC, select the appropriate timezone. A default timezone can be set from your Account Settings page.
  4. Optionally add notification methods across Email, SMS, Slack, Hipchat, PagerDuty, etc
  5. Give the monitor a descriptive name like Offsite Database Backup and add optional tags or notes
  6. Save the monitor and add the unique ping url provided to send pings to Cronitor when your job runs, completes or fails. See the integration guide for details.

Your new monitor is created in a paused state; monitoring will not begin until the first ping is received.

Expected duration alerts

It's great to know that your cron job started but it's really valuable to know that it completed successfully. To alert you as quickly as possible when that's not the case we've developed a duration prediction algorithm. The predictions grow more accurate as we learn more about your job performance but will not work perfectly for every job. If it's normal for job runtime to vary significantly, or if you are receiving has not completed alerts earlier than you would like, you can provide a fixed runtime duration:

  • With less data available on a new monitor we use wider grace periods and we will not send has not completed alerts until the job has completed successfully once.
  • API Users: Specify fixed runtime duration by adding a a custom ran_longer_than rule along with the not_on_schedule rule.

To send duration alerts, Cronitor must know when your job starts running and when it completes successfully. To report these events, you should ping your /run endpoint as your job starts and /complete as it exits successfully. For more details on ping URL endpoints and where you should integrate your ping requests, see:

Troubleshooting Not on Schedule Rules

  • If for any reason your jobs do not start immediately at the scheduled time, you can provide an expanded grace period using our API by setting the grace_seconds on your not_on_schedule rule.
  • If you receive unexpected alerts for a new monitor, review your ping history from the dashboard to ensure it matches your expectations. If there are missing pings, double check your integration. Verify that you are pinging the /run endpoint before your job and your /complete endpoint after. A missing or misplaced /run or /complete ping is the most common integration mistake.
  • By using the date command on your linux server or tzutil /g on windows you can verify that your server time matches the timezone set in your account settings.
  • If you've verified that you're pinging /run and /complete endpoints appropriately, try changing the logic in your commands from && "and" logic to ; "or" logic.

    Switch from only pinging /complete if your command finishes successfully:

    * */2 * * * curl -m 10 ; /path/to/ && curl -m 10

    To always pinging your /complete URL:

    * */2 * * * curl -m 10 ; /path/to/ ; curl -m 10

    By changing to ; you will ping your Cronitor URL even if your command exits with a non-zero exit code. If this works, you should investigate why your command is exiting with an error code.