Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pdf/crononag
super-simple wrapper for commands running from cron
https://github.com/pdf/crononag
cron go golang
Last synced: about 2 months ago
JSON representation
super-simple wrapper for commands running from cron
- Host: GitHub
- URL: https://github.com/pdf/crononag
- Owner: pdf
- License: mit
- Created: 2015-07-03T23:05:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-24T02:10:43.000Z (over 7 years ago)
- Last Synced: 2024-06-21T03:16:53.705Z (7 months ago)
- Topics: cron, go, golang
- Language: Go
- Homepage:
- Size: 9.77 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# crononag
**crononag** is a **super-simple wrapper for commands running from cron** to
limit nagging emails.
## Motivation
There are a couple of existing cron wrappers around, but I needed to be able to
customize the suppressed exit codes, and optionally always suppress stdout. I
also wanted a simple deploy story. Existing solutions didn't meet these
criteria, so I wrote this.
Since its inception, it has grown some additional useful features, including:
- Suppressing output based on matching regexp, regardless of exit code
- Forcing output based on matching regexp, regardless of exit code
- Ability to sleep for a random duration (up to a specified maximum), e.g. to
spread load over a time window for jobs that run on multiple hosts
## Usage
```
crononag [global options] command [command options] [arguments...]
```
Simply [download](https://github.com/pdf/crononag/releases/latest)
`crononag` and either install the package, or put it on your path, then add
`crononag` in front of the executable in your cron definition and enjoy the
silence. You can remove any output redirections, eg:
```diff
diff a/cronjob b/cronjob
--- a/cronjob
+++ b/cronjob
@@ -1,3 +1,3 @@
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
-*/10 * * * * root noisycronjob --with args > /dev/null
+*/10 * * * * root crononag noisycronjob --with args
```
Now, your job will only produce output in the event of a non-zero exit code.
Suppressed exit codes may be set using the option below.
### Options
Currently, `crononag` supports only very simple options:
```
-E, --suppress-exit-code [-E option -E option] suppress output for specified exit code(s), may specify multiple times, defaults to 0
-R, --suppress-regexp [-R option -R option] suppress output on matching regexp, may specify multiple times
-O, --omit-stdout omit stdout, even on error, defaults to false
-f, --force-regexp [-f option -f option] force output on matching regexp, may specify multiple times, overrides suppression
-s, --splay "0" sleep for a random duration, up to the specified maximum, format is , eg: "5s", "2h45m", "12h", defaults to 0
```
## Alternatives
Here are some alternative implementations, in no particular order:
- [shush](http://web.taranis.org/shush/)
- [cronic](http://habilis.net/cronic/)
- [cronwrap](https://www.uow.edu.au/~sah/cronwrap.html)
## License
This project rocks and uses the MIT-LICENSE