Allow current_environment to be set via an env variable
#736
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit allows developers to set a `SENTRY_CURRENT_ENV` variable to configure the `current_environment` setting. It serves as a fix for this scenario: We run our production/staging/integration environments with Rails env "production". To differentiate errors from the environments we set `config.current_environment` with an environment variable (https://github.com/alphagov/content-tagger/blob/bac2e1903aaf6ac12b3a103 490517355673648dd/config/initializers/sentry.rb#L2). However, this doesn't work in all situations. For example, when you run a rake task that doesn't exist, an error will be reported to Sentry. Because the initialiser that sets the `current_environment` hasn't run (yet) Sentry will use the `RAILS_ENV` to determine the current env. This causes all errors to be reported as production instead of production/staging/integration.
|
Couldn't you also fix this by requiring the initializer at the top of your Rakefile? |
|
Yep, that would also work in this case. However, we're migrating over 50 applications to Sentry, so for us this would be a not insignificant amount of work. Additionally this option would probably allow us to configure everything via the environment and skip the initialiser entirely, which makes adoption a lot easier for us. |
tijmenb
added a commit
to alphagov/govuk-puppet
that referenced
this pull request
Aug 11, 2017
This sets the current environment for Sentry to the value currently used for errbit, so either integration/staging/production (getsentry/sentry-ruby#736).
tijmenb
added a commit
to alphagov/govuk-puppet
that referenced
this pull request
Aug 15, 2017
This sets the current environment for Sentry to the value currently used for errbit, so either integration/staging/production (getsentry/sentry-ruby#736).
tijmenb
added a commit
to alphagov/govuk-puppet
that referenced
this pull request
Aug 17, 2017
This sets the current environment for Sentry to the value currently used for errbit, so either integration/staging/production (getsentry/sentry-ruby#736).
tijmenb
added a commit
to alphagov/govuk-puppet
that referenced
this pull request
Aug 21, 2017
This sets the current environment for Sentry to the value currently used for errbit, so either integration/staging/production (getsentry/sentry-ruby#736).
tijmenb
added a commit
to alphagov/govuk-puppet
that referenced
this pull request
Aug 21, 2017
This sets the current environment for Sentry to the value currently used for errbit, so either integration/staging/production (getsentry/sentry-ruby#736).
tijmenb
added a commit
to alphagov/govuk_app_config
that referenced
this pull request
Oct 11, 2017
Release commit: getsentry/sentry-ruby@ef623824cb0a8a2f60be5fb7e 12f80454da54fd7 This release includes the PR to set the Sentry environment with `SENTRY_CURRENT_ENV`, which means that Sentry will report the correct env even when the configuration hasn't loaded yet (getsentry/sentry-ruby#736). It simplifies our local config.
tijmenb
added a commit
to alphagov/govuk_app_config
that referenced
this pull request
Oct 11, 2017
Release commit: getsentry/sentry-ruby@ef623824cb0a8a2f60be5fb7e 12f80454da54fd7 This release includes the PR to set the Sentry environment with `SENTRY_CURRENT_ENV`, which means that Sentry will report the correct env even when the configuration hasn't loaded yet (getsentry/sentry-ruby#736). It simplifies our local config.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit allows developers to set a
SENTRY_CURRENT_ENVvariable to configure thecurrent_environmentsetting.It serves as a fix for this scenario:
We run our production/staging/integration environments with Rails env "production". To differentiate errors from the environments we set
config.current_environmentwith an environment variable:https://github.com/alphagov/content-tagger/blob/bac2e1903aaf6ac12b3a103490517355673648dd/config/initializers/sentry.rb#L1-L3
However, this doesn't work in all situations. For example, when you run a rake task that doesn't exist, an error will be reported to Sentry. Because the initialiser that sets the
current_environmenthasn't run (yet) Sentry will use theRAILS_ENVto determine the current env. This causes all errors to be reported as "production" instead of production/staging/integration.