Skip to main content

Forward exceptions raised by a setuptools entrypoint to sentry

Project description

DESCRIPTION
===========

sentry-wrapper calls a setuptools entrypoint and sends exceptions to sentry. It
is useful to log the exceptions of a correctly packaged but not sentry-capable
program.


Usage::

usage: sentry-wrapper [options] [-- entrypoint options]

positional arguments:
name Entry point name (eg. my-entrypoint)
dist Distribution name (eg. my-project==1.2.4, default:
same value than name)
group Entry point group (default: console_scripts)

optional arguments:
-h, --help show this help message and exit
--dsn SENTRY_DSN Sentry DSN
-t timeout, --timeout timeout
Timeout. After this value, TimeoutError is raised to
Sentry.


For example, if the `setup.py` file of the package `mypackage` contains::

...
name='my-package',
entry_points={
'console_scripts': [
'my-entrypoint = mypackage:main',
],
},
...

Call `my-entrypoint` with::

sentry-wrapper --dsn SENTRY_DSN my-entrypoint my-package console_scripts


INSTALLATION
============

To install in a virtualenv::

$> virtualenv myenv
$> source myenv/bin/activate
$> pip install sentry-wrapper
$> pip install path/to/your/project
$> sentry-wrapper -h


DEVELOP
=======

To start hacking on sentry-wrapper using Docker::

$> make

Then:

- Visit http://localhost:9000 with the credentials test/test
- Create a project and copy the DSN
- Test sentry-wrapper against the test project of this repository::

sentry-wrapper --dsn [...] whatever_ok whatever console_scripts
sentry-wrapper --dsn [...] whatever_exception whatever console_scripts

CONTRIBUTORS
============

* `Bastien Chatelard <https://github.com/bchatelard/>`_
* `Julien Castets <https://github.com/brmzkw/>`_

sentry-wrapper Changelog
========================

2.1.0 (2018-05-23)
------------------

* Add flag `-t` or `--timeout`. After the specified amount of time,
sentry-wrapper exits and raises an error to Sentry.
This is implemented by raising SIGALARM. If the wrapped application catches
the signal, timeout won't work.

2.0.0 (2015-08-20)
------------------

* Accept extra arguments that are given to the wrapped command, like::

sentry-wrapper entrypoint -- arg1 arg2 arg3

1.0.0 (2015-04-20)
------------------

* Initial version.

Project details


Release history Release notifications

This version
History Node

2.1.0

History Node

2.0.0

History Node

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sentry_wrapper-2.1.0-py2.7.egg (5.3 kB) Copy SHA256 hash SHA256 Egg 2.7 May 23, 2018
sentry_wrapper-2.1.0-py2-none-any.whl (5.9 kB) Copy SHA256 hash SHA256 Wheel 2.7 May 23, 2018
sentry-wrapper-2.1.0.tar.gz (3.9 kB) Copy SHA256 hash SHA256 Source None May 23, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page