honeybadger 5.27.4 → 5.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 792e12e3901c164ddd146d74d0c1db7dc1978f2ea4804c7e8c35ccee9e864906
-  data.tar.gz: 92cb3e3455e09a2a9f708f645f22b06599626b5e0fe5e858362969b31133f65a
+  metadata.gz: a8183362165e34fd5896b5936721badd08db0d24935a10a46c63120ac6e76066
+  data.tar.gz: 51c0d0aaf04df683e5f1ef05ba342d50d8cc7693566567ace67e52a22244191c
 SHA512:
-  metadata.gz: f26123e1ccd7cfc7ed146a4e31b99ec2b835cfd9825ad9dd8813941a0b781765e26007de5c38f4761628859d10d9d44f881f864c561648afe873e477e0b4cc10
-  data.tar.gz: bcd09b18473e8d4839c68e54d7862fdf27a3bce4b01fc05b638a76e500eb55fd04be3b9268334ffa27e4737b002b383709bf6dda077801203704527007b4d19c
+  metadata.gz: 730c1514c746b72bc460d392e4fd6e2c7bb423ddc95d6a8b085f0955ef3feccba775570a904c5385d0899899c5003b304e48d2e99b90ad1fd25edf7d3f611dc6
+  data.tar.gz: dd930b1ac2f63c9d201a0c4cd128041092f7d28649d363c65bf73bad64323d982b6a4a99fb90d1a782e17dbda411529bf794484b4ebfdcb46e7be09473be29d2

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Change Log
 
 
+## [5.28.0](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.27.4...v5.28.0) (2025-05-02)
+
+
+### Features
+
+* add sampling ([#689](https://github.com/honeybadger-io/honeybadger-ruby/issues/689)) ([0692ab0](https://github.com/honeybadger-io/honeybadger-ruby/commit/0692ab07d33843dc2612c36713b0f126ecba6b35))
+
+
 ## [5.27.4](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.27.3...v5.27.4) (2025-04-30)
 
 

data/lib/honeybadger/agent.rb

@@ -1,4 +1,5 @@
 require 'forwardable'
+require 'zlib'
 
 require 'honeybadger/version'
 require 'honeybadger/config'
@@ -434,6 +435,10 @@ module Honeybadger
 
       return if event.halted?
 
+      return unless sample_event?(event)
+
+      strip_metadata(event)
+
       events_worker.push(event.as_json)
     end
 
@@ -570,6 +575,26 @@ module Honeybadger
 
     private
 
+    def strip_metadata(event)
+      event.delete(:_hb)
+    end
+
+    def sample_event?(event)
+      # Always send metrics events
+      return true if event[:event_type] == "metric.hb"
+
+      sample_rate = config[:'events.sample_rate']
+      sample_rate = event.dig(:_hb, :sample_rate) if event.dig(:_hb, :sample_rate).is_a?(Numeric)
+
+      return true if sample_rate >= 100
+
+      if event[:request_id] # Send all events for a given request
+        Zlib.crc32(event[:request_id].to_s) % 100 < sample_rate
+      else # Otherwise just take a random sample
+        rand(100) < sample_rate
+      end
+    end
+
     def validate_notify_opts!(opts)
       return if opts.has_key?(:exception)
       return if opts.has_key?(:error_message)

data/lib/honeybadger/config/defaults.rb

@@ -129,6 +129,11 @@ module Honeybadger
         default: nil,
         type: Array
       },
+      :'events.sample_rate' => {
+        description: 'Percentage of events to send to the API (0-100). A value of 0 means no events are sent, 100 means all events are sent.',
+        default: 100,
+        type: Integer
+      },
       plugins: {
         description: 'An optional list of plugins to load. Default is to load all plugins.',
         default: nil,

data/lib/honeybadger/event.rb

@@ -15,7 +15,7 @@ module Honeybadger
     # The payload data of the event
     attr_reader :payload
 
-    def_delegators :payload, :dig, :[], :[]=
+    def_delegators :payload, :dig, :[], :[]=, :delete
 
     # @api private
     def initialize(event_type_or_payload, payload={})

data/lib/honeybadger/version.rb

@@ -1,4 +1,4 @@
 module Honeybadger
   # The current String Honeybadger version.
-  VERSION = '5.27.4'.freeze
+  VERSION = '5.28.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 5.27.4
+  version: 5.28.0
 platform: ruby
 authors:
 - Honeybadger Industries LLC