chore: Add changelog entry

getsentry · Dec 12, 2024 · 07d259e · 07d259e
1 parent 276a762
commit 07d259e
Showing 1 changed file with 92 additions and 75 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@
 - Fix latency related nil error for Sidekiq Queues Module span data [#2486](https://github.com/getsentry/sentry-ruby/pull/2486)
   - Fixes [#2485](https://github.com/getsentry/sentry-ruby/issues/2485)
 
+### Internal
+
+- Remove usage of user segment from baggage and dynamic sampling context propagation logic [#2493](https://github.com/getsentry/sentry-ruby/pull/2493)
+
 ## 5.22.0
 
 ### Features
@@ -17,7 +21,7 @@
 - Reset `trace_id` and add root transaction for sidekiq-cron [#2446](https://github.com/getsentry/sentry-ruby/pull/2446)
 - Add support for Excon HTTP client instrumentation ([#2383](https://github.com/getsentry/sentry-ruby/pull/2383))
 
-    Note: MemoryStore and FileStore require Rails 8.0+
+  Note: MemoryStore and FileStore require Rails 8.0+
 
 ### Bug Fixes
 
@@ -90,6 +94,7 @@
 - Use `Concurrent.available_processor_count` instead of `Concurrent.usable_processor_count` ([#2358](https://github.com/getsentry/sentry-ruby/pull/2358))
 
 - 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>
 
@@ -112,6 +117,7 @@
   ```
 
 - Transaction data are now included in the context ([#2365](https://github.com/getsentry/sentry-ruby/pull/2365))
+
   - Closes [#2363](https://github.com/getsentry/sentry-ruby/issues/2363)
 
 - Inject Sentry meta tags in the Rails application layout automatically in the generator ([#2369](https://github.com/getsentry/sentry-ruby/pull/2369))
@@ -157,19 +163,20 @@
 - Notify users when their custom options are discarded ([#2303](https://github.com/getsentry/sentry-ruby/pull/2303))
 - Add a new `:graphql` patch to automatically enable instrumenting GraphQL spans ([#2308](https://github.com/getsentry/sentry-ruby/pull/2308))
 
-    Usage:
+  Usage:
 
-    ```rb
-    Sentry.init do |config|
-      # ...
-      config.enabled_patches += [:graphql]
-    end
-    ```
+  ```rb
+  Sentry.init do |config|
+    # ...
+    config.enabled_patches += [:graphql]
+  end
+  ```
 
 - Add `Sentry.get_trace_propagation_meta` helper for injecting meta tags into views ([#2314](https://github.com/getsentry/sentry-ruby/pull/2314))
 - Add query source support to `sentry-rails` ([#2313](https://github.com/getsentry/sentry-ruby/pull/2313))
 
   The feature is only activated in apps that use Ruby 3.2+ and Rails 7.1+. By default only queries that take longer than 100ms will have source recorded, which can be adjusted by updating the value of `config.rails.db_query_source_threshold_ms`.
+
 - Log envelope delivery message with debug instead of info ([#2320](https://github.com/getsentry/sentry-ruby/pull/2320))
 
 ### Bug Fixes
@@ -224,6 +231,7 @@
 - Fix warning about default gems on Ruby 3.3.0 ([#2225](https://github.com/getsentry/sentry-ruby/pull/2225))
 - Add `hint:` support to `Sentry::Rails::ErrorSubscriber` [#2235](https://github.com/getsentry/sentry-ruby/pull/2235)
 - Add [Metrics](https://docs.sentry.io/product/metrics/) support
+
   - Add main APIs and `Aggregator` thread [#2247](https://github.com/getsentry/sentry-ruby/pull/2247)
   - Add `Sentry::Metrics.timing` API for measuring block duration [#2254](https://github.com/getsentry/sentry-ruby/pull/2254)
   - Add metric summaries on spans [#2255](https://github.com/getsentry/sentry-ruby/pull/2255)
@@ -297,7 +305,7 @@
 - Only instantiate SessionFlusher when the SDK is enabled under the current env [#2245](https://github.com/getsentry/sentry-ruby/pull/2245)
   - Fixes [#2234](https://github.com/getsentry/sentry-ruby/issues/2234)
 - Update backtrace parsing regexp to support Ruby 3.4 ([#2252](https://github.com/getsentry/sentry-ruby/pull/2252))
-- Make sure ``sending_allowed?`` is respected irrespective of spotlight configuration ([#2231](https://github.com/getsentry/sentry-ruby/pull/2231))
+- Make sure `sending_allowed?` is respected irrespective of spotlight configuration ([#2231](https://github.com/getsentry/sentry-ruby/pull/2231))
   - Fixes [#2226](https://github.com/getsentry/sentry-ruby/issues/2226)
 
 ## 5.16.1
@@ -312,36 +320,36 @@
 
 - Add backpressure handling for transactions [#2185](https://github.com/getsentry/sentry-ruby/pull/2185)
 
-    The SDK can now dynamically downsample transactions to reduce backpressure in high
-    throughput systems. It starts a new `BackpressureMonitor` thread to perform some health checks
-    which decide to downsample (halved each time) in 10 second intervals till the system
-    is healthy again.
+  The SDK can now dynamically downsample transactions to reduce backpressure in high
+  throughput systems. It starts a new `BackpressureMonitor` thread to perform some health checks
+  which decide to downsample (halved each time) in 10 second intervals till the system
+  is healthy again.
 
-    To enable this behavior, use:
+  To enable this behavior, use:
 
-    ```ruby
-    Sentry.init do |config|
-      # ...
-      config.traces_sample_rate = 1.0
-      config.enable_backpressure_handling = true
-    end
-    ```
+  ```ruby
+  Sentry.init do |config|
+    # ...
+    config.traces_sample_rate = 1.0
+    config.enable_backpressure_handling = true
+  end
+  ```
 
-    If your system serves heavy load, please let us know how this feature works for you!
+  If your system serves heavy load, please let us know how this feature works for you!
 
-- Implement proper flushing logic on ``close`` for Client Reports and Sessions [#2206](https://github.com/getsentry/sentry-ruby/pull/2206)
+- Implement proper flushing logic on `close` for Client Reports and Sessions [#2206](https://github.com/getsentry/sentry-ruby/pull/2206)
 - Support cron with timezone for `sidekiq-scheduler` patch [#2209](https://github.com/getsentry/sentry-ruby/pull/2209)
   - Fixes [#2187](https://github.com/getsentry/sentry-ruby/issues/2187)
-- Add `Cron::Configuration` object that holds defaults for all ``MonitorConfig`` objects [#2211](https://github.com/getsentry/sentry-ruby/pull/2211)
+- Add `Cron::Configuration` object that holds defaults for all `MonitorConfig` objects [#2211](https://github.com/getsentry/sentry-ruby/pull/2211)
 
-    ```ruby
-    Sentry.init do |config|
-      # ...
-      config.cron.default_checkin_margin = 1
-      config.cron.default_max_runtime = 30
-      config.cron.default_timezone = 'America/New_York'
-    end
-    ```
+  ```ruby
+  Sentry.init do |config|
+    # ...
+    config.cron.default_checkin_margin = 1
+    config.cron.default_max_runtime = 30
+    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)
@@ -383,6 +391,7 @@
 - Improve default slug generation for Crons [#2168](https://github.com/getsentry/sentry-ruby/pull/2168)
 - Change release name generator to use full SHA commit hash and align with `sentry-cli` and other Sentry SDKs [#2174](https://github.com/getsentry/sentry-ruby/pull/2174)
 - Automatic Crons support for scheduling gems
+
   - Add support for [`sidekiq-cron`](https://github.com/sidekiq-cron/sidekiq-cron) [#2170](https://github.com/getsentry/sentry-ruby/pull/2170)
 
     You can opt in to the `sidekiq-cron` patch and we will automatically monitor check-ins for all jobs listed in your `config/schedule.yml` file.
@@ -438,6 +447,7 @@
 - Adopt Rails 7.1's new BroadcastLogger [#2120](https://github.com/getsentry/sentry-ruby/pull/2120)
 - Support sending events after all retries were performed (sentry-resque) [#2087](https://github.com/getsentry/sentry-ruby/pull/2087)
 - Add [Cron Monitoring](https://docs.sentry.io/product/crons/) support
+
   - Add `Sentry.capture_check_in` API for Cron Monitoring [#2117](https://github.com/getsentry/sentry-ruby/pull/2117)
 
     You can now track progress of long running scheduled jobs.
@@ -509,7 +519,7 @@
 
 - Make `:value` in `SingleExceptionInterface` writable, so that it can be modified in `before_send` under `event.exception.values[n].value` [#2072](https://github.com/getsentry/sentry-ruby/pull/2072)
 - Add `sampled` field to `dynamic_sampling_context` [#2092](https://github.com/getsentry/sentry-ruby/pull/2092)
-- Consolidate HTTP span data conventions with OpenTelemetry with `Sentry::Span::DataConventions`  [#2093](https://github.com/getsentry/sentry-ruby/pull/2093)
+- Consolidate HTTP span data conventions with OpenTelemetry with `Sentry::Span::DataConventions` [#2093](https://github.com/getsentry/sentry-ruby/pull/2093)
 - Consolidate database span data conventions with OpenTelemetry for ActiveRecord and Redis [#2100](https://github.com/getsentry/sentry-ruby/pull/2100)
 - Add new `config.trace_propagation_targets` option to set targets for which headers are propagated in outgoing HTTP requests [#2079](https://github.com/getsentry/sentry-ruby/pull/2079)
 
@@ -520,6 +530,7 @@
   ```
 
 - 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)
 
@@ -606,6 +617,7 @@
   ```
 
   Some implementation caveats:
+
   - Profiles are sampled **relative** to traces, so if both rates are 0.5, we will capture 0.25 of all requests.
   - Profiles are only captured for code running within a transaction.
   - Profiles for multi-threaded servers like `puma` might not capture frames correctly when async I/O is happening. This is a `stackprof` limitation.
@@ -629,46 +641,46 @@
 - Pass a `cached: true` tag for SQL query spans that utilized the ActiveRecord QueryCache when using ActiveRecordSubscriber in `sentry-rails` [#1968](https://github.com/getsentry/sentry-ruby/pull/1968)
 - Add `Sentry.add_global_event_processor` API [#1976](https://github.com/getsentry/sentry-ruby/pull/1976)
 
-    Users can now configure global event processors without configuring scope as well.
+  Users can now configure global event processors without configuring scope as well.
 
-    ```rb
-    Sentry.add_global_event_processor do |event, hint|
-      event.tags = { foo: 42 }
-      event
-    end
-    ```
+  ```rb
+  Sentry.add_global_event_processor do |event, hint|
+    event.tags = { foo: 42 }
+    event
+  end
+  ```
 
 - Add global event processor in OpenTelemetry `SpanProcessor` to link errors with transactions [#1983](https://github.com/getsentry/sentry-ruby/pull/1983)
 - Fix some inconsistencies in setting name/op/status in OpenTelemetry `SpanProcessor` [#1987](https://github.com/getsentry/sentry-ruby/pull/1987)
 - Add `config.before_send_transaction` hook [#1989](https://github.com/getsentry/sentry-ruby/pull/1989)
 
-    Users can now configure a `before_send_transaction` callback that runs similar to `before_send` but for transaction events.
+  Users can now configure a `before_send_transaction` callback that runs similar to `before_send` but for transaction events.
 
-    ```rb
-    config.before_send_transaction = lambda do |event, hint|
-      # skip unimportant transactions or strip sensitive data
-      if event.transaction == "/healthcheck/route"
-        nil
-      else
-        event
-      end
+  ```rb
+  config.before_send_transaction = lambda do |event, hint|
+    # skip unimportant transactions or strip sensitive data
+    if event.transaction == "/healthcheck/route"
+      nil
+    else
+      event
     end
-    ```
+  end
+  ```
 
 - Support `Sentry::Transaction#set_measurement` [#1838](https://github.com/getsentry/sentry-ruby/pull/1838)
 
-    Usage:
+  Usage:
 
-    ```rb
-    transaction = Sentry.get_current_scope.get_transaction
-    transaction.set_measurement("metrics.foo", 0.5, "millisecond")
-    ```
+  ```rb
+  transaction = Sentry.get_current_scope.get_transaction
+  transaction.set_measurement("metrics.foo", 0.5, "millisecond")
+  ```
 
 ### Bug Fixes
 
 - Support redis-rb 5.0+ [#1963](https://github.com/getsentry/sentry-ruby/pull/1963)
   - Fixes [#1932](https://github.com/getsentry/sentry-ruby/pull/1932)
-- Skip private _config context in Sidekiq 7+ [#1967](https://github.com/getsentry/sentry-ruby/pull/1967)
+- Skip private \_config context in Sidekiq 7+ [#1967](https://github.com/getsentry/sentry-ruby/pull/1967)
   - Fixes [#1956](https://github.com/getsentry/sentry-ruby/issues/1956)
 - Return value from `perform_action` in ActionCable::Channel instances when initialized [#1966](https://github.com/getsentry/sentry-ruby/pull/1966)
 - `Span#with_child_span` should finish the span even with exception raised [#1982](https://github.com/getsentry/sentry-ruby/pull/1982)
@@ -690,6 +702,7 @@
 - Expose `end_timestamp` in `Span#finish` and `Transaction#finish` [#1946](https://github.com/getsentry/sentry-ruby/pull/1946)
 - Add `Transaction#set_context` api [#1947](https://github.com/getsentry/sentry-ruby/pull/1947)
 - Add OpenTelemetry support with new `sentry-opentelemetry` gem
+
   - Add `config.instrumenter` to switch between `:sentry` and `:otel` instrumentation [#1944](https://github.com/getsentry/sentry-ruby/pull/1944)
 
     The new `sentry-opentelemetry` gem adds support to automatically integrate OpenTelemetry performance tracing with Sentry. [Give it a try](https://github.com/getsentry/sentry-ruby/tree/master/sentry-opentelemetry#getting-started) and let us know if you have any feedback or problems with using it.
@@ -700,15 +713,16 @@
 
 - Allow users to configure their asset-skipping pattern [#1915](https://github.com/getsentry/sentry-ruby/pull/1915)
 
-    Users can now configure their own pattern to skip asset requests' transactions
+  Users can now configure their own pattern to skip asset requests' transactions
 
-    ```rb
-    Sentry.init do |config|
-      config.rails.assets_regexp = /my_regexp/
-    end
-    ```
+  ```rb
+  Sentry.init do |config|
+    config.rails.assets_regexp = /my_regexp/
+  end
+  ```
 
 - 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)
 
@@ -724,9 +738,9 @@
   - 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.
-    **If you rely on Span op names for fine-grained event filtering, this may affect the data your app sends to Sentry.**
-    **Also make sure to update your [`traces_sampler`](https://docs.sentry.io/platforms/ruby/configuration/sampling/#setting-a-sampling-function) if you rely on the `op` for filtering some requests.**
+  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.
+  **If you rely on Span op names for fine-grained event filtering, this may affect the data your app sends to Sentry.**
+  **Also make sure to update your [`traces_sampler`](https://docs.sentry.io/platforms/ruby/configuration/sampling/#setting-a-sampling-function) if you rely on the `op` for filtering some requests.**
 
 ### Refactoring
 
@@ -737,6 +751,7 @@
 ### Features
 
 - Support rack 3 [#1884](https://github.com/getsentry/sentry-ruby/pull/1884)
+
   - We no longer need the `HTTP_VERSION` check for ignoring the header
 
 - Add [Dynamic Sampling](https://docs.sentry.io/product/sentry-basics/sampling/) support
@@ -779,6 +794,7 @@
 - Expose `:values` in `ExceptionInterface`, so that it can be accessed in `before_send` under `event.exception.values` [#1843](https://github.com/getsentry/sentry-ruby/pull/1843)
 
 - Add top level `Sentry.close` API [#1844](https://github.com/getsentry/sentry-ruby/pull/1844)
+
   - Cleans up SDK state and sets it to uninitialized
   - No-ops all SDK APIs and also disables the transport layer, so nothing will be sent to Sentry after closing the SDK
 
@@ -787,17 +803,17 @@
 
 - Add `Sentry.with_exception_captured` helper [#1814](https://github.com/getsentry/sentry-ruby/pull/1814)
 
-    Usage:
+  Usage:
 
-    ```rb
-    Sentry.with_exception_captured do
-     1/1 #=> 1 will be returned
-    end
+  ```rb
+  Sentry.with_exception_captured do
+   1/1 #=> 1 will be returned
+  end
 
-    Sentry.with_exception_captured do
-     1/0 #=> ZeroDivisionError will be reported and re-raised
-    end
-    ```
+  Sentry.with_exception_captured do
+   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)
@@ -1020,7 +1036,7 @@ end
 
 ### Bug Fixes
 
-- Avoid causing NoMethodError for Sentry.* calls when the SDK is not inited [#1713](https://github.com/getsentry/sentry-ruby/pull/1713)
+- Avoid causing NoMethodError for Sentry.\* calls when the SDK is not inited [#1713](https://github.com/getsentry/sentry-ruby/pull/1713)
   - Fixes [#1706](https://github.com/getsentry/sentry-ruby/issues/1706)
 - Transaction#finish should ignore the parent's sampling decision [#1716](https://github.com/getsentry/sentry-ruby/pull/1716)
   - Fixes [#1712](https://github.com/getsentry/sentry-ruby/issues/1712)
@@ -1259,6 +1275,7 @@ When `config.send_default_pii` is set as `true`, `:http_logger` will include que
 ### Features
 
 - Support exception frame's local variable capturing
+
   - [#1580](https://github.com/getsentry/sentry-ruby/pull/1580)
   - [#1589](https://github.com/getsentry/sentry-ruby/pull/1589)