sentry
Version information
This version is compatible with:
- Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 3.0.0 < 5.0.0
- ,
Start using this module
Add this module to your Puppetfile:
mod 'venmo-sentry', '1.0.0'
Learn more about managing modules with a PuppetfileDocumentation
Table of Contents
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 DBpostgres
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 tosentry
)user
Database userpassword
Database passwordhost
Database host (defaults tolocalhost
)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 tolocalhost
)port
SMTP port (defaults to25
)user
SMTP user (defaults to none)password
SMTP password (defaults to none)use_tls
Whether to enable SMTP TLS (defaults tofalse
)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 tolocalhost
)port
Redis port (defaults to6379
)
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.
2015-09-10 Release 1.0.0
This release introduces several backward incompatible changes:
- The
password_hash
class parameter has been replaced withpassword
which takes plain text instead of a hash - The
user
class parameter was removed, the superuser's username is now the same as their email
Other changes include:
-
A specific Sentry version (currently
7.7.0
) is installed by default if a version isn't specifiedPreviously, the most recent PyPI version was installed. Versions older than
7.7.0
are no longer officially supported. -
Ubuntu 12.04 (Precise) is no longer officially supported, due to Sentry >=
7.5.0
requiring a newer Redis version than shipped -
Upgrades are no longer done automatically, but must be done as documented at Upgrading
2015-03-17 Release 0.4.0
- Support for Sentry 7.4.0+
- Support for beacon added in 7.3.0
2015-03-05 Release 0.3.0
- Support for Sentry 7.3.0+
- Support for Sentry plugins
2015-01-16 Release 0.2.0
- Support for Debian 7
- Documentation fixes
2015-01-14 Release 0.1.0
- Initial release
Dependencies
- ajcrowe/supervisord (>= 0.5.1 < 1.0.0)
- puppetlabs/git (>= 0.3.0 < 1.0.0)
- puppetlabs/nodejs (>= 0.6.1 < 1.0.0)
- puppetlabs/stdlib (>= 4.4.0 < 5.0.0)
- stankevich/python (>= 1.8.2 < 2.0.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2015 Venmo Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.