Puppet Forge Build Status

Table of Contents

  1. Overview
  2. Module Description
  3. Setup
  4. Usage
  5. Reference
  6. Limitations
  7. Development

Overview

The sentry module installs, configures, and manages the Sentry realtime event logging and aggregation platform. It supports Sentry version >= 7.7.0, < 8.0.0 on the following platforms:

  • Debian 7 (Wheezy)
  • Ubuntu 14.04 (Trusty)

Module Description

Installation is via PyPI or Git, with support for arbitrary PyPI versions or Git revisions. Configuration supports optional database integration with MySQL/Postgres, caching/queueing with Redis, and a reverse SSL proxy, though these must be deployed separately (for which an example profile is provided). Service management is done with Supervisor.

Setup

What sentry affects

  • A Python virtualenv is created with Sentry and required dependencies.
  • A Sentry configuration is generated based on provided class parameters.
  • A SQLite database is created and its contents initialized.
  • Supervisor is deployed to manage the Sentry web and worker services.

Beginning with sentry

A basic deploy listening on http://localhost:9000 can be done with

include sentry

An admin user is also created for evaluation purposes with username admin@localhost and password password.

To specify a PyPI version instead, run

class { 'sentry':
  version => '7.x.x'
}

or for a specific Git revision (branch, tag, or commit sha1) on https://github.com/getsentry/sentry/

class { 'sentry':
  source_location => 'git',
  git_revision    => 'master',
}

Note that installing from Git will also install git and nodejs packages required for building from source.

Usage

To allow for more widespread evaluation (say over a VPN), pass extra parameters like the following (IMPORTANT: don't use these values for password and secret_key, see Security for how to generate your own)

class { 'sentry':
  password   => 'password',
  secret_key => 'bxXkluWCyi7vNDDALvCKOGCI2WEbohkpF9nVPnV6jWGB1grz5csT3g==',
  email      => 'sentry@example.com',
  url        => 'http://sentry.example.lan:9000',  # must not have a trailing slash
  host       => '0.0.0.0',
}

For a basic production-ready deploy with support for Postgres, Redis, and a reverse SSL proxy deployed separately on the same host, pass extra parameters like the following (IMPORTANT: don't use these values for password and secret_key, see Security for how to generate your own)

class { 'sentry':
  password        => 'password',  # this should come from an encrypted source like hiera-eyaml
  secret_key      => 'bxXkluWCyi7vNDDALvCKOGCI2WEbohkpF9nVPnV6jWGB1grz5csT3g==',
  email           => 'sentry@example.com',
  url             => 'https://sentry.example.com',  # must not have a trailing slash
  database        => 'postgres',
  database_config => {
    user     => 'sentry',
    password => 'randompassword',  # this should come from an encrypted source like hiera-eyaml
  },
  proxy_enabled   => true,
  redis_enabled   => true,
}

For further instructions on preparing a production-ready deploy, see the parameter list in Reference and the following Sentry documentation:

Security

The values for password and secret_key are the admin user's password and the django secret key respectively. It's important to use your own values for these as the defaults are insecure.

  • password can be randomly generated with a shell command like the following: openssl rand -hex 8
  • secret_key can be randomly generated with the following Python command: python -c "import os; from base64 import b64encode; print(b64encode(os.urandom(40)))"

Reference

Classes

Class: sentry

path

The absolute path under which to install Sentry, defaults to /srv/sentry.

owner

The owner for Sentry files, defaults to sentry.

group

The group for Sentry files, defaults to sentry.

source_location

The source location from which to install Sentry. Choose from:

  • pypi PyPI (Default)
  • git Git
version

The Sentry version to install if using PyPI, defaults to 7.7.0.

git_revision

The Sentry revision to install if using Git, defaults to master. Can be branch, tag, or commit sha1.

git_url

The URL to install Sentry from if using Git, defaults to git+https://github.com/getsentry/sentry.git.

timeout

The timeout for install commands, defaults to 1800 seconds.

manage_git

Whether to manage git if needed for install, defaults to true. If false, git is expected to be preinstalled.

manage_nodejs

Whether to manage nodejs if needed for compiling static assets during git install, defaults to true. If false, nodejs and npm are expected to be preinstalled.

manage_python

Whether to manage Python for running Sentry, defaults to true. If false, python (w/ dev package), pip, and virtualenv are expected to be preinstalled.

extra_python_reqs

Extra Python requirements to install, in addition to and/or instead of what's specified in setup.py.

password

The password for Sentry's admin user, defaults to password. Should be at least 8 characters long.

secret_key

The secret key to use, should be a randomly generated 40-160 byte string.

user

The username for the Sentry admin user, defaults to admin.

email

The email address for the Sentry admin user, defaults to admin@localhost.

url

The absolute URL to access Sentry, defaults to http://localhost:9000. Must not have a trailing slash.

host

The hostname which the webserver should bind to, defaults to localhost.

port

The port which the webserver should listen on, defaults to 9000.

workers

The number of gunicorn workers to start, default is calculated according to number of cores.

database

The database to use. Choose from:

  • sqlite SQLite DB (Default)
  • mysql MySQL DB
  • postgres Postgres DB
beacon_enabled

Whether to enable support for sending beacons to the Sentry team, defaults to true.

email_enabled

Whether to enable support for sending email notifications, defaults to false.

proxy_enabled

Whether to enable support for serving behind a reverse proxy, defaults to false.

redis_enabled

Whether to enable Redis support for caching and queueing worker jobs, defaults to false.

database_config

A hash with the database configuration, not needed for SQLite. Can include:

  • name Database name (defaults to sentry)
  • user Database user
  • password Database password
  • host Database host (defaults to localhost)
  • port Database port (defaults to IANA registered port)
email_config

A hash with the email configuration, only needed if enabled. Can include:

  • host SMTP host (defaults to localhost)
  • port SMTP port (defaults to 25)
  • user SMTP user (defaults to none)
  • password SMTP password (defaults to none)
  • use_tls Whether to enable SMTP TLS (defaults to false)
  • from_addr The from address (defaults to admin email)
redis_config

A hash with the Redis configuration, only needed if enabled. Can include:

  • host Redis host (defaults to localhost)
  • port Redis port (defaults to 6379)
extra_config

Extra configuration to append to Sentry config, can be array or string.

service_restart

Whether to restart Sentry on config change, defaults to true.

Defines

Define: sentry::command

Execute a sentry command as documented at Command Line Usage.

command

The command to execute including any arguments.

refreshonly

Whether to execute only when an event is received, defaults to false.

Define: sentry::plugin

Installs a sentry plugin as documented at Plugins.

plugin

The plugin to install, typically begins with sentry-.

version

The plugin version to install, defaults to latest.

Limitations

  • Upgrades are not handled automatically, but must be done as documented at Upgrading.
  • Multiple Redis servers are not currently supported.

Development

Pull requests are highly encouraged, please read the guidelines in CONTRIBUTING before submitting. Tests are run by Travis CI.