Skip to main content

Send logs from Nginx and other applications to Sentry.

Project description

Build status Code health Python versions Software license

Sentry Logs allows you to send logs to Sentry. Only Nginx error log is currently supported, but extending the library to support more log files is planned.

How It Works

To install sentrylogs you can use pip or easy_install:

$ pip install sentrylogs
$ easy_install sentrylogs

This will install the module and will provide a new console command:

$ sentrylogs -h

usage: sentrylogs [-h] [--sentryconfig SENTRYCONFIG] [--sentrydsn SENTRYDSN]
                  [--daemonize] [--follow FOLLOW]
                  [--nginxerrorpath NGINXERRORPATH]

Send logs to Django Sentry.

optional arguments:
  -h, --help            show this help message and exit
                        A configuration file (.ini, .yaml) of some Sentry
                        integration to extract the Sentry DSN from
  --sentrydsn SENTRYDSN, -s SENTRYDSN
                        The Sentry DSN string (overrides -c)
  --daemonize, -d       Run this script in background
  --follow FOLLOW, -f FOLLOW
                        Which logs to follow, default ALL
                        Nginx error log path

Sentry DSN

We need to provide a Sentry DSN to send messages to the Sentry server. There are 3 options to do this:

  1. Use the --sentryconfig command line argument to read the configuration file of your Sentry integration, or
  2. Use the --sentrydsn command line argument to specify the DSN directly, or
  3. Provide an environment variable.
$ sentrylogs --sentryconfig /opt/myapp/config/pyramid.ini
$ sentrylogs --sentrydsn 'protocol://'
$ export SENTRY_DSN='protocol://' && sentrylogs

Log File Location

By default sentrylogs will assume the nginx log at /var/log/nginx/error.log. You can change this using the --nginxerrorpath argument.

Run as Daemon

If you use --daemonize the command will daemonize itself and run in background.

How to Contribute

Please open an issue to discuss your plans for a pull request. After writing code make sure your changes pass our quality gate before you push.

$ tox
$ python clean

Please write tests! Test coverage is still low and the code quality needs to improve. Please help by adding tests with each contribution you make!

Project details

Download files

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

Files for SentryLogs, version 0.5.0
Filename, size File type Python version Upload date Hashes
Filename, size SentryLogs-0.5.0-py3-none-any.whl (13.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size SentryLogs-0.5.0.tar.gz (11.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page