yipit/cron-sentry

Crontab sentry error reporter

Cron-Sentry: error reporting to Sentry of commands run via cron

Cron-Sentry is a python command-line wrapper that reports errors to Sentry (using raven) if the called script exits with a status other than zero.

Install

pip install cron-sentry

Usage

$ cron-sentry --help
usage: cron-sentry [-h] [--dsn SENTRY_DSN] [-M STRING_MAX_LENGTH] [--quiet] [--report-all] [--version] cmd [arg ...]

Wraps commands and reports those that fail to Sentry.

positional arguments:
  cmd                   The command to run

optional arguments:
  -h, --help            show this help message and exit
  --dsn SENTRY_DSN      Sentry server address
  -M STRING_MAX_LENGTH, --string-max-length STRING_MAX_LENGTH, --max-message-length STRING_MAX_LENGTH
                        The maximum characters of a string that should be sent
                        to Sentry (defaults to 4096)
  -q, --quiet           Suppress all command output
  --version             show program's version number and exit
  --report-all          Report to Sentry even if the task has succeeded

The Sentry server address can also be specified through the SENTRY_DSN
environment variable (and the --dsn option can be omitted).

It's possible to send extra information to Sentry via environment variables (prefix them with CRON_SENTRY_EXTRA_), such as:

$ export CRON_SENTRY_EXTRA_env=production
$ cron-sentry my-program

Example

$ crontab -e

SENTRY_DSN=https://<your_key>:<your_secret>@app.getsentry.com/<your_project_id>
0 4 * * * cron-sentry my-process --arg arg2

Notes

• If your command outputs Unicode, you may need to signal to python that stdin/stdout/stderr are UTF-8 encoded:

PYTHONIOENCODING=utf-8
SENTRY_DSN=https://<your_key>:<your_secret>@app.getsentry.com/<your_project_id>
0 4 * * * cron-sentry my-process --arg arg2

License

This project started life as raven-cron by MediaCore Technologies.

Original copyright 2013 to MediaCore Technologies (MIT license). Copyright 2015 to Yipit Inc. (MIT license).

cron-sentry's Issues

Catch invalid commands (OSError)

Option to not crop messages written to stdout and stderr with max string max length

There would be reasons to send a limited message to sentry (limited by sting max length option) but still pass stdout and stderr without limiting the length.

Make the `cmd` parameter required

Unfortunately it's not possible to use argparse and force a positional argument to be specified. We should check if the cmd parameter was passed and decide if we exit successfuly or not.

Right now the exception it raises isn't helpful:

$ cron-sentry
Traceback (most recent call last):
  File "/Users/hugo/.virtualenvs/cron-sentry/bin/cron-sentry", line 9, in <module>
    load_entry_point('cron-sentry==0.4.2', 'console_scripts', 'cron-sentry')()
  File "/Users/hugo/projects/cron-sentry/cron_sentry/runner.py", line 72, in run
    if opts.cmd[0] == '--':
IndexError: list index out of range

Option to write logs to syslog

I'd really like to see an option that would cause gathered data to also be written to syslog. In our case, we write everything to syslog and then forward syslog to a log aggregator. So this would be a great way to get success messages into a place that they can be reviewed if needed while also getting Sentry alerts for known errors.

Bonus points for an option to log as JSON:

cron-sentry --syslog ...
# same as the above
cron-sentry --syslog=plain
# log as json
cron-sentry --syslog=json

If you are interested in this option, I could most likely submit a PR that does the heavy lifting.

Change README to be reStructuredText instead of Markdown

This would make it look nice on PyPI.

Add proper exit status

Add command-line parameters `string-max-length` and `max-list-length`

Based on raven.Client arguments string_max_length (default is 200) and max_list_length (default is 50): https://raven.readthedocs.org/en/latest/advanced.html#client-arguments

support for sending additional data?

hi,
thanks for keep maintaining cron-sentry!
I'd find useful to add job-specific data when using cron-sentry, is it something you'd consider adding? happy to try it too and submit a PR but wanted to know what you think first

thanks!
filippo

No handlers could be found for logger "sentry.errors"

When raven gives errors, they are not printed at all. You only get "No handlers could be found for logger "sentry.errors"". There is a PR to fix this.

`sys.argv` and `command` are sent to sentry without the last character of each item

Each list element is a string. For some reason, each string is missing the last character.

It's not possible to use pipes with cron-sentry

Currently it's not possible to use have commands that use the shell capabilities. For example, it's not possible to wrap completely the following command with cron-sentry:

ls /dir | mycommand

With cron-sentry it would be possible to wrap the ls /dir part, but not the whole thing (unless cron-sentry is executed twice). So, if the ls command works, but mycommand fails, cron-sentry wouldn't catch it.

The above is true for |, ||, &&, >, >>, etc.

Rename the project

The original project is not being maintained. This fork should be renamed, add a new executable (keep raven-cron too for backwards compatibility purposess), and push to PyPI.