cookbook 'sentry', '= 0.4.0'
sentry (5) Versions 0.4.0 Follow2
Installs/Configures Sentry realtime error logging and aggregation platform
cookbook 'sentry', '= 0.4.0', :supermarket
knife supermarket install sentry
knife supermarket download sentry
sentry Cookbook
Installs and configure Sentry realtime error logging and aggregation platform. This cookbook supports sentry 7.7.1 and above.
Requirements
platforms
-
ubuntu
- sentry has only been tested on ubuntu
cookbooks
-
poise-python
- forpython
,virtualenv
andpip
installation and LWRP.
Attributes
sentry::default
Key | Type | Description | Default |
---|---|---|---|
['sentry']['version'] |
String | which version to install | "8.6.0" ** |
['sentry']['pipname'] |
String | which package to install | "sentry[postgres]" |
['sentry']['plugins'] |
Array | list of plugins to install: [ "sentry-irc", # No version specified ["sentry-github", "0.1.2"], # With explicit version specified ]
|
[["django-secure", "1.0.1"], ["django-bcrypt", "0.9.2"], ["django-sendmail-backend", "0.1.2"]] |
["dependency"]["packages"] |
Array | list of packages to install | ["libxml2-dev", "libxslt1-dev", "libffi-dev",] |
['sentry']['user'] |
String | system user to run sentry | "sentry" |
['sentry']['group'] |
String | system group to run sentry | "sentry" |
['sentry']['install_dir'] |
String | full path to the sentry install directory | "/opt/sentry/" |
['sentry']['filestore_dir'] |
String | full path to the sentry filestore directory | "/opt/sentry/data" |
['sentry']['config_dir'] |
String | path to sentry config directory | "/opt/sentry/etc" |
['sentry']['config_file_path'] |
String | path to sentry config file for Sentry < 8.0 | "/opt/sentry/etc/config.py" |
['sentry']['config_python_path'] |
String | path to sentry config file for Sentry >= 8.0 | "/opt/sentry/etc/sentry.conf.py" |
['sentry']['config_yaml_path'] |
String | path to sentry yaml config file for Sentry >= 8.0 | "/opt/sentry/etc/config.yml" |
['sentry']['env_d_path'] |
String | path to the daemontool's env.d path for sentry configurations | "/etc/sentry.d" |
['sentry']['env_path'] |
String | path to the daemontool's env path for sentry configurations | "/etc/sentry.d/env" |
['sentry']['config']['url_prefix'] |
String | URL where sentry will be accessible | "http://localhost" |
['sentry']['config']['db_engine'] |
String | Django class to use to connect to database | "django.db.backends.postgresql_psycopg2" |
['sentry']['config']['db_options'] |
Hash | OPTIONS passed to database config | {autocommit: true} |
['sentry']['config']['web_host'] |
String | IP to which sentry is listening | "127.0.0.1" |
['sentry']['config']['web_port'] |
String | Port to which sentry is listening | 9000 |
['sentry']['config']['web_options'] |
Hash | additional options used in SENTRY_WEB_OPTIONS | {"workers": 3, secure_scheme_headers: {"X-FORWARDED-PROTO": 'https'}} |
['sentry']['config']['additional_apps'] |
Array | additional apps to append to INSTALLED_APPS | ["djangosecure", "django_bcrypt"] |
['sentry']['config']['prepend_middleware_classes'] |
Array | additional middlewares classes to prepend to MIDDLEWARE_CLASSES | ["djangosecure.middleware.SecurityMiddleware"] |
['sentry']['config']['append_middleware_classes'] |
Array | additional middlewares classes to append to MIDDLEWARE_CLASSES | [] |
['sentry']['config']['email_default_from'] |
String | email address used in from of sent emails | "#{node["sentry"]["user"]}@#{node[:fqdn]}" |
['sentry']['config']['email_backend'] |
String | EMAIL_BACKEND class to use by django | "django.core.mail.backends.smtp.EmailBackend" |
['sentry']['config']['email_host'] |
String | SMTP host to use | "localhost" |
['sentry']['config']['email_port'] |
String | SMTP port to use | 25 |
['sentry']['config']['email_use_tls'] |
Boolean | Set wether to use tls for auth | false |
['sentry']['config']['email_subject_prefix'] |
String | Prefix for sent emails | nil |
['sentry']['data_bag'] |
String | name of the data_bag holding the sentry configuration | "sentry" |
['sentry']['data_bag_item'] |
String | name of the data_bag's item holding the credentials | "credentials" |
['sentry']['use_encrypted_data_bag'] |
Boolean | if the data_bag is expected to be encrypted or not | false |
['sentry']['data_bag_secret'] |
String | Path to the databag secret file when using an encrypted databag, if nil the value from Chef::Config[:encrypted_data_bag_secret] is used. |
nil |
***NOTE* Versions prior to 7.7.x are having trouble running sentry upgrade command. It throws below error:
STDERR: FATAL ERROR - The following SQL query failed: ALTER TABLE "sentry_authprovider" ALTER COLUMN "config" TYPE jsonb, ALTER COLUMN "config" DROP NOT NULL, ALTER COLUMN "config" DROP DEFAULT; The error was: column "config" cannot be cast automatically to type jsonb HINT: You might need to specify "USING config::jsonb".
Usage
Sentry credentials
Store the default admin account informations as well as the database connection
information.
Here's the expected content of such a data_bag item
:
{ "id": "credentials", "admin_username": "xxxxxxx", "admin_password": "xxxxxxx", "admin_first_name": "Chef", "admin_last_name": "Admin", "admin_email": "xxxxxxx", "database_name": "sentry", "database_user": "sentry", "database_password": "xxxxxx", "database_host": "", "database_port": "", "signing_token": "xxxxxxx", "email_host_user": "xxxxxxx", "email_host_password": "xxxxxxx", "additional_env_vars": {} }
To install and configure sentry
Include sentry
or more explictly sentry::default
in your node's run_list
:
{ "name":"my_node", "run_list": [ "recipe[sentry::default]" ] }
Upgrade info
If you come from older version < 6.4.x then you need to run the following SQL query on the database, before upgrading:
UPDATE sentry_project SET team_id=(SELECT id FROM sentry_team LIMIT 1) WHERE team_id IS null;
If you used bcrypt
for passwords, then you run the following SQL query on the database:
UPDATE auth_user SET password=CONCAT('bcrypt', SUBSTR(password, 3)) WHERE password LIKE 'bc$%';
Contributing
- Fork the repository on Github
- Create a named feature branch (like
add_component_x
) - Write you change
- Write tests for your change (if applicable)
- Run the tests, ensuring they all pass
- Submit a Pull Request using Github
License and Authors
Primary authors:
- Jonathan Tron (@JonathanTron)
Contributors:
- Nilanjan Roy (@nilroy)
- Matt Leick (@mattlock12)
- Luka Lüdicke (@klyonrad)
Copyright 2013, Openhood S.E.N.C.
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.
Dependent cookbooks
poise-python >= 0.0.0 |
runit >= 1.1.6 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
CHANGELOG for sentry
This file is used to list changes made in each version of sentry.
0.4.0 (2017-09-28)
- Update Sentry to 8.20.0
0.3.2 (2017-05-26)
- Construct
default["sentry"]["config"]["celerybeat_schedule_filename"]
anddefault["sentry"]["config"]["filestore_options"]["location"]
fromnode["sentry"]["filestore_dir"]
(Luka Lüdicke) #21 - Update File storage setting for Sentry 8.10 compatibility (Luka Lüdicke) #20 #17
0.3.1 (2017-01-02)
- Ensure parent install directory is created too (Nilanjan Roy) #14
- Depends on
poise-python
cookbook instead ofpython
(Nilanjan Roy) #15
0.3.0 (2016-08-14)
- Default to Sentry 8.6.0
- Add Sentry 8.6 support (Matt Leick) #9
0.2.2 (2016-02-17)
- Add support for Sentry 8.x
- Bump default version to 7.7.1
0.2.1 (2015-05-09)
- Update
default["sentry"]["config"]["redis_enabled"]
to true
0.2.0 (2015-05-09)
- Upgrade Sentry to 7.4.3
- Add a lot more configuration to allow buffers, queues, rate limits, quotas and TSDB.
0.1.2 (2014-06-30)
- Ensure
runit_service[sentry]
is not restarted during each Chef run:- Don't use
sentry[postgres]
meta-package as it leavespython_pip
LWRP unable to detect it's already installed. - Add
default['sentry']['database']['pipdeps']
with a default to installpsycopg2==2.4.6
. - Add versions to
default['sentry']['plugins']
to ensure no re-install when not needed:django-secure==1.0
,django-bcrypt==0.9.2
,django-sendmail-backend==0.1.2
- Don't use
0.1.1 (2014-06-06)
- Upgrade Sentry to 5.4.6
0.1.0 (2013-07-09)
- Initial release of sentry
Collaborator Number Metric
0.4.0 failed this metric
Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
0.4.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.4.0 passed this metric
No Binaries Metric
0.4.0 passed this metric
Testing File Metric
0.4.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.4.0 passed this metric
0.4.0 failed this metric
0.4.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.4.0 passed this metric
No Binaries Metric
0.4.0 passed this metric
Testing File Metric
0.4.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.4.0 passed this metric
0.4.0 passed this metric
0.4.0 passed this metric
Testing File Metric
0.4.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.4.0 passed this metric
0.4.0 failed this metric
0.4.0 passed this metric