htwkmooc/codeocean
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Introduce new config option for JS-based Sentry

Browse Source 
* Also update environment_variables.md
This commit is contained in:
Sebastian Serth
2021-07-08 20:06:06 +02:00
parent ab7ce316ab
commit 4926b33a5f
3 changed files with 35 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
app/views/layouts/application.html.slim
View File

@ -20,12 +20,12 @@ html lang="#{I18n.locale || I18n.default_locale}"
script type="text/javascript"
| I18n.defaultLocale = "#{I18n.default_locale}";
| I18n.locale = "#{I18n.locale}";
- unless Sentry.configuration.environment == "development"
- if SentryJavascript.active?
| Sentry.init({
| dsn: 'https://2616b10855e04ce1b748775203ff0f7c@o257002.ingest.sentry.io/5667283',
| attachStacktrace: true,
| release: "#{Sentry.configuration.release}",
| environment: "#{Sentry.configuration.environment}",
| release: "#{SentryJavascript.release}",
| environment: "#{SentryJavascript.environment}",
| });
- if @current_user
| Sentry.configureScope(function(scope) {

19
config/initializers/sentry_javascript.rb Normal file
View File

@ -0,0 +1,19 @@
# frozen_string_literal: true
class SentryJavascript
def self.active?
dsn.present? && %w[development test].exclude?(environment)
end
def self.dsn
ENV['SENTRY_JAVASCRIPT_DSN']
end
def self.release
Sentry.configuration.release
end
def self.environment
Sentry.configuration.environment
end
end

24
docs/environment_variables.md
View File

@ -2,14 +2,16 @@
The following environment variables are specifically support in CodeOcean and are used to configure the application in addition to the setting files under `config/`.
| Environment Variable | Default | Description |
|- |- |- |
| `RAILS_ENV` | `development` | Specifies the Rails environment which can be configured using the files in `config/environments` |
| `RAILS_RELATIVE_URL_ROOT` | `/` | Specifies the subpath of the application, used for links and assets |
| `SENTRY_DSN` | `` | Specifies the Sentry error reporting endpoint for the Rails server |
| `RAILS_LOG_TO_STDOUT` | `false` in `production` | Enables the server to print log output to the command line |
| `RAILS_SERVE_STATIC_FILES` | `true` in `development` and `test`<br>`false` in `production` and `staging` | Specifies whether the Rails server should be able to handle requests for non-dynamic resources (e.g., assets) |
| `BACKTRACE` | `false` | Enables more verbose log output from framework code during debugging |
| `TRUSTED_IP` | ` ` in `development` | Enables `BetterErrors` for the given IP addresses during development |
| `LISTEN_ADDRESS` | `127.0.0.1` in `development` | Specifies the IP address the server should attach to during development |
| `HEADLESS_TEST` | `false` | Enables the test environment to work without a window manager for feature tests (e.g., using Vagrant) |
| Environment Variable | Default | Description |
|- |- |- |
| `RAILS_ENV` | `development` | Specifies the Rails environment which can be configured using the files in `config/environments` |
| `RAILS_RELATIVE_URL_ROOT` | `/` | Specifies the subpath of the application, used for links and assets |
| `SENTRY_DSN` | ` ` | Specifies the [Sentry error reporting](https://sentry.io) endpoint for the Rails server |
| `SENTRY_JAVASCRIPT_DSN` | ` ` | Specifies the [Sentry error reporting](https://sentry.io) endpoint for the frontend used by browsers |
| `SENTRY_CURRENT_ENV` | ` ` | Specifies the [Sentry](https://sentry.io) environment used for error reporting |
| `RAILS_LOG_TO_STDOUT` | `false` in `production` | Enables the server to print log output to the command line |
| `RAILS_SERVE_STATIC_FILES` | `true` in `development` and `test`<br>`false` in `production` and `staging` | Specifies whether the Rails server should be able to handle requests for non-dynamic resources (e.g., assets) |
| `BACKTRACE` | `false` | Enables more verbose log output from framework code during debugging |
| `TRUSTED_IP` | ` ` in `development` | Enables `BetterErrors` for the given IP addresses during development |
| `LISTEN_ADDRESS` | `127.0.0.1` in `development` | Specifies the IP address the Vagrant VM server should attach to during development |
| `HEADLESS_TEST` | `false` | Enables the test environment to work without a window manager for feature tests (e.g., using Vagrant) |