Skip to content
This repository has been archived by the owner on Aug 7, 2020. It is now read-only.
/ autocronitor Public archive
forked from jonlives/autocronitor

A tool to automatically pass a standard-format crontab file and add jobs to cronitor.io for monitoring

License

Notifications You must be signed in to change notification settings

cronitorio/autocronitor

 
 

Repository files navigation

autocronitor

Gem Version

A CLI tool to parse a standard format crontab file, create monitors in cronitor.io for each job, and automatically add the necessary curl commands to the original crontab.

It assumes that you are using cronitor's "template" feature to configure notifications for your monitors, and that you have created templates which will then be passed to autocronitor.

Please note, cronitor.io (and therefore autocronitor) do not support "informal" cron expressions such as @hourly or @daily.

GEM INSTALL

autocronitor is available on rubygems.org - if you have that source in your gemrc, you can simply use:

gem install autocronitor

Autocronitor Usage

You can run autocronitor by running the autocronitor command.

Usage

Usage: autocronitor [-aft]

Specific options:
    -a, --api-key APIKEY             Your cronitor.io API key
    -f, --filename FILENAME          The cron files to read

Email Options: 
    -t, --templace *TEMPLATES        The Cronitor.io templates to send alerts for this monitor to

Text to exclude: 
    -c, --common-text *COMMONTEXT    A space separated list of common text to exclude from cron names
    -i, --common-include-text *COMMONINCLUDETEXT
                                     A space separated list of common text to exclude from cron names (includes strings which contain each phrase)
  • Mandatory Parameters (you must specify one or the other)

    • -a, --api-key APIKEY Your cronitor.io API key
    • -f, --filename FILENAME The crontab files to read
  • Optional Parameters

    • -t, --templace *TEMPLATES The Cronitor.io template(s) to use for notifications. If not provided Cronitor will default to using the email address of your account to send notifications.
    • -c, --common-text *COMMONTEXT A space separated list of common text to exclude from cron names
    • -i, --common-include-text *COMMONINCLUDETEXT A space separated list of common text to exclude from cron names (includes strings which contain each phrase)

Example)

$> autocronitor -a abcdef123456 -f test.conf -t mydefault-template

Processing file test.conf

Cron expression: 10 * * * *
Cron name: testcron
Creating monitor testcron...
Monitor 'testcron' created with ID abc123

Writing new test.conf with added Cronitor URLs...

About

A tool to automatically pass a standard-format crontab file and add jobs to cronitor.io for monitoring

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 100.0%