Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add support for $SENTRY_DEBUG and $SENTRY_SPOTLIGHT #2374

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 21 additions & 16 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## Unreleased

- Add support for $SENTRY_DEBUG and $SENTRY_SPOTLIGHT ([#2374](https://github.com/getsentry/sentry-ruby/pull/2374))

## 5.19.0

### Features
Expand All @@ -6,7 +10,7 @@

- Support for tracing Faraday requests ([#2345](https://github.com/getsentry/sentry-ruby/pull/2345))
- Closes [#1795](https://github.com/getsentry/sentry-ruby/issues/1795)
- Please note that the Faraday instrumentation has some limitations in case of async requests: https://github.com/lostisland/faraday/issues/1381
- Please note that the Faraday instrumentation has some limitations in case of async requests: <https://github.com/lostisland/faraday/issues/1381>

Usage:

Expand All @@ -32,6 +36,7 @@
- Inject Sentry meta tags in the Rails application layout automatically in the generator ([#2369](https://github.com/getsentry/sentry-ruby/pull/2369))

To turn this behavior off, use

```bash
bin/rails generate sentry --inject-meta false
```
Expand Down Expand Up @@ -256,6 +261,7 @@
config.cron.default_timezone = 'America/New_York'
end
```

- Clean up logging [#2216](https://github.com/getsentry/sentry-ruby/pull/2216)
- Pick up config.cron.default_timezone from Rails config [#2213](https://github.com/getsentry/sentry-ruby/pull/2213)
- Don't add most scope data (tags/extra/breadcrumbs) to `CheckInEvent` [#2217](https://github.com/getsentry/sentry-ruby/pull/2217)
Expand Down Expand Up @@ -303,6 +309,7 @@
```rb
config.enabled_patches += [:sidekiq_cron]
```

- Add support for [`sidekiq-scheduler`](https://github.com/sidekiq-scheduler/sidekiq-scheduler) [#2172](https://github.com/getsentry/sentry-ruby/pull/2172)

You can opt in to the `sidekiq-scheduler` patch and we will automatically monitor check-ins for all repeating jobs (i.e. `cron`, `every`, and `interval`) specified in the config.
Expand Down Expand Up @@ -331,6 +338,7 @@
config.rails.active_support_logger_subscription_items.delete("sql.active_record")
config.rails.active_support_logger_subscription_items["foo"] = :bar
```

- Enable opting out of patches [#2151](https://github.com/getsentry/sentry-ruby/pull/2151)

### Bug Fixes
Expand Down Expand Up @@ -358,6 +366,7 @@
# do job stuff
Sentry.capture_check_in('job_name', :ok, check_in_id: check_in_id)
```

- Add `Sentry::Cron::MonitorCheckIns` module for automatic monitoring of jobs [#2130](https://github.com/getsentry/sentry-ruby/pull/2130)

Standard job frameworks such as `ActiveJob` and `Sidekiq` can now use this module to automatically capture check ins.
Expand Down Expand Up @@ -388,6 +397,7 @@
```

You can pass in optional attributes to `sentry_monitor_check_ins` as follows.

```rb
# slug defaults to the job class name
sentry_monitor_check_ins slug: 'custom_slug'
Expand Down Expand Up @@ -427,6 +437,7 @@
config.trace_propagation_targets = [/.*/] # default is to all targets
config.trace_propagation_targets = [/example.com/, 'foobar.org/api/v2']
```

- Tracing without Performance
- Implement `PropagationContext` on `Scope` and add `Sentry.get_trace_propagation_headers` API [#2084](https://github.com/getsentry/sentry-ruby/pull/2084)
- Implement `Sentry.continue_trace` API [#2089](https://github.com/getsentry/sentry-ruby/pull/2089)
Expand Down Expand Up @@ -466,7 +477,6 @@
- Use allowlist to filter `ActiveSupport` breadcrumbs' data [#2048](https://github.com/getsentry/sentry-ruby/pull/2048)
- ErrorHandler should cleanup the scope ([#2059](https://github.com/getsentry/sentry-ruby/pull/2059))


## 5.9.0

### Features
Expand All @@ -484,6 +494,7 @@
Sentry.capture_exception(ignored_exception) # won't be sent to Sentry
Sentry.capture_exception(ignored_exception, hint: { ignore_exclusions: true }) # will be sent to Sentry
```

- Support capturing low-level errors propagated to Puma [#2026](https://github.com/getsentry/sentry-ruby/pull/2026)

- Add `spec` to `Backtrace::APP_DIRS_PATTERN` [#2029](https://github.com/getsentry/sentry-ruby/pull/2029)
Expand Down Expand Up @@ -522,7 +533,7 @@

> **Warning**
> Profiling is currently in beta. Beta features are still in-progress and may have bugs. We recognize the irony.
> If you have any questions or feedback, please email us at [email protected], reach out via Discord (#profiling), or open an issue.
> If you have any questions or feedback, please email us at <[email protected]>, reach out via Discord (#profiling), or open an issue.

### Bug Fixes

Expand Down Expand Up @@ -617,19 +628,19 @@
```

- Use `Sentry.with_child_span` in redis and net/http instead of `span.start_child` [#1920](https://github.com/getsentry/sentry-ruby/pull/1920)
- This might change the nesting of some spans and make it more accurate
- Followup fix to set the sentry-trace header in the correct place [#1922](https://github.com/getsentry/sentry-ruby/pull/1922)
- This might change the nesting of some spans and make it more accurate
- Followup fix to set the sentry-trace header in the correct place [#1922](https://github.com/getsentry/sentry-ruby/pull/1922)

- Use `Exception#detailed_message` when generating exception message if applicable [#1924](https://github.com/getsentry/sentry-ruby/pull/1924)
- Make `sentry-sidekiq` compatible with Sidekiq 7 [#1930](https://github.com/getsentry/sentry-ruby/pull/1930)

### Bug Fixes

- `Sentry::BackgroundWorker` will release `ActiveRecord` connection pool only when the `ActiveRecord` connection is established
- Remove bad encoding arguments in redis span descriptions [#1914](https://github.com/getsentry/sentry-ruby/pull/1914)
- Fixes [#1911](https://github.com/getsentry/sentry-ruby/issues/1911)
- Remove bad encoding arguments in redis span descriptions [#1914](https://github.com/getsentry/sentry-ruby/pull/1914)
- Fixes [#1911](https://github.com/getsentry/sentry-ruby/issues/1911)
- Add missing `initialized?` checks to `sentry-rails` [#1919](https://github.com/getsentry/sentry-ruby/pull/1919)
- Fixes [#1885](https://github.com/getsentry/sentry-ruby/issues/1885)
- Fixes [#1885](https://github.com/getsentry/sentry-ruby/issues/1885)
- Update Tracing Span's op names [#1923](https://github.com/getsentry/sentry-ruby/pull/1923)

Currently, Ruby integrations' Span op names aren't aligned with the core specification's convention, so we decided to update them altogether in this PR.
Expand Down Expand Up @@ -706,6 +717,7 @@
1/0 #=> ZeroDivisionError will be reported and re-raised
end
```

- Prepare for Rails 7.1's error reporter API change [#1834](https://github.com/getsentry/sentry-ruby/pull/1834)
- Set `sentry.error_event_id` in request env if the middleware captures errors [#1849](https://github.com/getsentry/sentry-ruby/pull/1849)

Expand Down Expand Up @@ -858,7 +870,6 @@ end

This will help users report size-related issues in the future.


- Automatic session tracking [#1715](https://github.com/getsentry/sentry-ruby/pull/1715)

**Example**:
Expand All @@ -877,7 +888,6 @@ end

To disable this feature, set `config.auto_session_tracking` to `false`.


### Bug Fixes

- Require set library [#1753](https://github.com/getsentry/sentry-ruby/pull/1753)
Expand All @@ -892,7 +902,6 @@ end
- Avoid duplicated capturing on the same exception object [#1738](https://github.com/getsentry/sentry-ruby/pull/1738)
- Fixes [#1731](https://github.com/getsentry/sentry-ruby/issues/1731)


### Refactoring

- Encapsulate extension helpers [#1725](https://github.com/getsentry/sentry-ruby/pull/1725)
Expand Down Expand Up @@ -957,7 +966,6 @@ end

This version removes the dependency of [faraday](https://github.com/lostisland/faraday) and replaces related implementation with the `Net::HTTP` standard library.


#### Why?

Since the old `sentry-raven` SDK, we've been using `faraday` as the HTTP client for years (see [HTTPTransport](https://github.com/getsentry/sentry-ruby/blob/4-9/sentry-ruby/lib/sentry/transport/http_transport.rb)). It's an amazing tool that saved us many work and allowed us to focus on SDK features.
Expand All @@ -972,10 +980,8 @@ And with the release of [faraday 2.0](https://github.com/lostisland/faraday/rele

So we think it's time to say goodbye to it with this release.


#### What's changed?


By default, the SDK used `faraday`'s `net_http` adapter, which is also built on top of `Net::HTTP`. So this change shouldn't impact most of the users.

The only noticeable changes are the removal of 2 faraday-specific transport configurations:
Expand Down Expand Up @@ -1076,7 +1082,6 @@ end

2. Set `config.transport.transport = FaradayTransport`


**Please keep in mind that this may not work in the future when the SDK changes its `HTTPTransport` implementation.**

## 4.9.2
Expand Down Expand Up @@ -1216,7 +1221,6 @@ When `config.send_default_pii` is set as `true`, `:http_logger` will include que

- Start Testing Against Rails 7.0 [#1581](https://github.com/getsentry/sentry-ruby/pull/1581)


## 4.7.3

- Avoid leaking tracing timestamp to breadcrumbs [#1575](https://github.com/getsentry/sentry-ruby/pull/1575)
Expand All @@ -1235,6 +1239,7 @@ When `config.send_default_pii` is set as `true`, `:http_logger` will include que
## 4.7.1

### Bug Fixes

- Send events when report_after_job_retries is true and a job is configured with retry: 0 [#1557](https://github.com/getsentry/sentry-ruby/pull/1557)
- Fixes [#1556](https://github.com/getsentry/sentry-ruby/issues/1556)

Expand Down
12 changes: 8 additions & 4 deletions sentry-ruby/lib/sentry/configuration.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
require "concurrent/utility/processor_counter"

require "sentry/utils/exception_cause_chain"
require "sentry/utils/custom_inspection"
require 'sentry/utils/custom_inspection'
require 'sentry/utils/env_helper'
require "sentry/dsn"
require "sentry/release_detector"
require "sentry/transport/configuration"
Expand Down Expand Up @@ -350,7 +351,7 @@ def add_post_initialization_callback(&block)

def initialize
self.app_dirs_pattern = nil
self.debug = false
self.debug = Sentry::Utils::EnvHelper.env_to_bool(ENV["SENTRY_DEBUG"])
self.background_worker_threads = (processor_count / 2.0).ceil
self.background_worker_max_queue = BackgroundWorker::DEFAULT_MAX_QUEUE
self.backtrace_cleanup_callback = nil
Expand All @@ -376,8 +377,11 @@ def initialize
self.auto_session_tracking = true
self.enable_backpressure_handling = false
self.trusted_proxies = []
self.dsn = ENV["SENTRY_DSN"]
self.spotlight = false
self.dsn = ENV['SENTRY_DSN']

spotlight_env = ENV['SENTRY_SPOTLIGHT']
spotlight_bool = Sentry::Utils::EnvHelper.env_to_bool(spotlight_env, strict: true)
self.spotlight = spotlight_bool.nil? ? (spotlight_env || false) : spotlight_bool
self.server_name = server_name_from_env
self.instrumenter = :sentry
self.trace_propagation_targets = [PROPAGATION_TARGETS_MATCH_ALL]
Expand Down
21 changes: 21 additions & 0 deletions sentry-ruby/lib/sentry/utils/env_helper.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# frozen_string_literal: true

module Sentry
module Utils
module EnvHelper
TRUTHY_ENV_VALUES = %w[t true yes y 1 on].freeze
FALSY_ENV_VALUES = %w[f false no n 0 off].freeze

def self.env_to_bool(value, strict: false)
value = value.to_s
normalized = value.downcase

return false if FALSY_ENV_VALUES.include?(normalized)

return true if TRUTHY_ENV_VALUES.include?(normalized)

strict ? nil : !(value.nil? || value.empty?)
end
end
end
end
58 changes: 58 additions & 0 deletions sentry-ruby/spec/sentry/configuration_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -278,9 +278,67 @@
end

describe "#spotlight" do
before do
ENV.delete('SENTRY_SPOTLIGHT')
end

after do
ENV.delete('SENTRY_SPOTLIGHT')
end

it "false by default" do
expect(subject.spotlight).to eq(false)
end

it 'uses `SENTRY_SPOTLIGHT` env variable for truthy' do
ENV['SENTRY_SPOTLIGHT'] = 'on'

expect(subject.spotlight).to eq(true)
end

it 'uses `SENTRY_SPOTLIGHT` env variable for falsy' do
ENV['SENTRY_SPOTLIGHT'] = '0'

expect(subject.spotlight).to eq(false)
end

it 'uses `SENTRY_SPOTLIGHT` env variable for custom value' do
ENV['SENTRY_SPOTLIGHT'] = 'https://my.remote.server:8080/stream'

expect(subject.spotlight).to eq('https://my.remote.server:8080/stream')
end
end

describe "#debug" do
before do
ENV.delete('SENTRY_DEBUG')
end

after do
ENV.delete('SENTRY_DEBUG')
end

it "false by default" do
expect(subject.debug).to eq(false)
end

it 'uses `SENTRY_DEBUG` env variable for truthy' do
ENV['SENTRY_DEBUG'] = 'on'

expect(subject.debug).to eq(true)
end

it 'uses `SENTRY_DEBUG` env variable for falsy' do
ENV['SENTRY_DEBUG'] = '0'

expect(subject.debug).to eq(false)
end

it 'uses `SENTRY_DEBUG` env variable to turn on random value' do
ENV['SENTRY_DEBUG'] = 'yabadabadoo'

expect(subject.debug).to eq(true)
end
end

describe "#sending_allowed?" do
Expand Down
Loading