airbrake-ruby 6.0.1 → 6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f89d6e09b27f36f4d4450eeb9dd6fb9dff228ffe095769f8b9bcc24a02413842
-  data.tar.gz: a2b4daefe2139f002a42754b6df05c6c11dca9d80b0ecf440cd0620336a2d87e
+  metadata.gz: f0310134480c9c13f2e8ab87a4c616768c213b590f98edd38e9c9abbd539a7ba
+  data.tar.gz: 6f5e8d2411eee4e18ff97ef7d89b3c4a1c8ebb3ba5ec14fafe24c25e850672b1
 SHA512:
-  metadata.gz: 423f95e5781de19de642d880106b38feca43c98f9223956e4208b616929d6a63c56e1ca223d449115f232e60f0a84f9f0c52c140df708d2deaf20aa2dfca4a3e
-  data.tar.gz: e09266840dd038be725ad564d6db02696e5c6a0f188eae5206da30cbd2cf454eccbe56cbcf027b454821e6ef1bee29cb8fb2db7c7c61f81ffa6e0ecb1566c133
+  metadata.gz: d6e19e37eca3e38af441560c044ac1472ab06a282c4d8b4873a4c8529b9fb9e9a70634a42b4d0d5fe668ba866649ee115942678e5bbfffa1f60373ccd66e964b
+  data.tar.gz: f8b22c23d2534b1f4dc12dd1b5d8bf970504b297a61421cda6d496ec2f1143ac9eb031e2c1b033e8d8a24b94b634c2a17ea475f9ef13d482be08a419a54b1d98

data/lib/airbrake-ruby/config.rb

@@ -248,14 +248,14 @@ module Airbrake
 
     # @return [Promise] resolved promise if neither of the performance options
     #   reject it, false otherwise
-    def check_performance_options(resource)
+    def check_performance_options(metric)
       promise = Airbrake::Promise.new
 
       if !performance_stats
         promise.reject("The Performance Stats feature is disabled")
-      elsif resource.is_a?(Airbrake::Query) && !query_stats
+      elsif metric.is_a?(Airbrake::Query) && !query_stats
         promise.reject("The Query Stats feature is disabled")
-      elsif resource.is_a?(Airbrake::Queue) && !job_stats
+      elsif metric.is_a?(Airbrake::Queue) && !job_stats
         promise.reject("The Job Stats feature is disabled")
       else
         promise

data/lib/airbrake-ruby/filters/sql_filter.rb

@@ -108,20 +108,20 @@ module Airbrake
         @regexp = Regexp.union(features)
       end
 
-      # @param [Airbrake::Query] resource
-      def call(resource)
-        return unless resource.respond_to?(:query)
+      # @param [Airbrake::Query] metric
+      def call(metric)
+        return unless metric.respond_to?(:query)
 
-        query = resource.query
+        query = metric.query
         if IGNORED_QUERIES.any? { |q| q =~ query }
-          resource.ignore!
+          metric.ignore!
           return
         end
 
         q = query.gsub(@regexp, FILTERED)
         q.gsub!(POST_FILTER, FILTERED) if q =~ POST_FILTER
         q = ERROR_MSG if UNMATCHED_PAIR[@dialect] =~ q
-        resource.query = q
+        metric.query = q
       end
     end
   end

data/lib/airbrake-ruby/performance_notifier.rb

@@ -1,6 +1,6 @@
 module Airbrake
-  # QueryNotifier aggregates information about SQL queries and periodically sends
-  # collected data to Airbrake.
+  # PerformanceNotifier aggregates performance data and periodically sends it to
+  # Airbrake.
   #
   # @api public
   # @since v3.2.0
@@ -21,20 +21,20 @@ module Airbrake
       @has_payload = @payload.new_cond
     end
 
-    # @param [Hash] resource
+    # @param [Hash] metric
     # @see Airbrake.notify_query
     # @see Airbrake.notify_request
-    def notify(resource)
+    def notify(metric)
       @payload.synchronize do
-        send_resource(resource, sync: false)
+        send_metric(metric, sync: false)
       end
     end
 
-    # @param [Hash] resource
+    # @param [Hash] metric
     # @since v4.10.0
     # @see Airbrake.notify_queue_sync
-    def notify_sync(resource)
-      send_resource(resource, sync: true).value
+    def notify_sync(metric)
+      send_metric(metric, sync: true).value
     end
 
     # @see Airbrake.add_performance_filter
@@ -78,16 +78,16 @@ module Airbrake
       end
     end
 
-    def send_resource(resource, sync:)
-      promise = check_configuration(resource)
+    def send_metric(metric, sync:)
+      promise = check_configuration(metric)
       return promise if promise.rejected?
 
-      @filter_chain.refine(resource)
-      if resource.ignored?
-        return Promise.new.reject("#{resource.class} was ignored by a filter")
+      @filter_chain.refine(metric)
+      if metric.ignored?
+        return Promise.new.reject("#{metric.class} was ignored by a filter")
       end
 
-      update_payload(resource)
+      update_payload(metric)
       if sync || @flush_period == 0
         send(@sync_sender, @payload, promise)
       else
@@ -96,29 +96,29 @@ module Airbrake
       end
     end
 
-    def update_payload(resource)
-      if (total_stat = @payload[resource])
-        @payload.key(total_stat).merge(resource)
+    def update_payload(metric)
+      if (total_stat = @payload[metric])
+        @payload.key(total_stat).merge(metric)
       else
-        @payload[resource] = { total: Airbrake::Stat.new }
+        @payload[metric] = { total: Airbrake::Stat.new }
       end
 
-      @payload[resource][:total].increment_ms(resource.timing)
+      @payload[metric][:total].increment_ms(metric.timing)
 
-      resource.groups.each do |name, ms|
-        @payload[resource][name] ||= Airbrake::Stat.new
-        @payload[resource][name].increment_ms(ms)
+      metric.groups.each do |name, ms|
+        @payload[metric][name] ||= Airbrake::Stat.new
+        @payload[metric][name].increment_ms(ms)
       end
     end
 
-    def check_configuration(resource)
+    def check_configuration(metric)
       promise = @config.check_configuration
       return promise if promise.rejected?
 
-      promise = @config.check_performance_options(resource)
+      promise = @config.check_performance_options(metric)
       return promise if promise.rejected?
 
-      if resource.timing && resource.timing == 0
+      if metric.timing && metric.timing == 0
         return Promise.new.reject(':timing cannot be zero')
       end
 
@@ -128,47 +128,47 @@ module Airbrake
     def send(sender, payload, promise)
       raise "payload cannot be empty. Race?" if payload.none?
 
-      with_grouped_payload(payload) do |resource_hash, destination|
+      with_grouped_payload(payload) do |metric_hash, destination|
         url = URI.join(
           @config.apm_host,
           "api/v5/projects/#{@config.project_id}/#{destination}",
         )
 
         logger.debug do
-          "#{LOG_LABEL} #{self.class.name}##{__method__}: #{resource_hash}"
+          "#{LOG_LABEL} #{self.class.name}##{__method__}: #{metric_hash}"
         end
-        sender.send(resource_hash, promise, url)
+        sender.send(metric_hash, promise, url)
       end
 
       promise
     end
 
     def with_grouped_payload(raw_payload)
-      grouped_payload = raw_payload.group_by do |resource, _stats|
-        [resource.cargo, resource.destination]
+      grouped_payload = raw_payload.group_by do |metric, _stats|
+        [metric.cargo, metric.destination]
       end
 
-      grouped_payload.each do |(cargo, destination), resources|
+      grouped_payload.each do |(cargo, destination), metrics|
         payload = {}
-        payload[cargo] = serialize_resources(resources)
+        payload[cargo] = serialize_metrics(metrics)
         payload['environment'] = @config.environment if @config.environment
 
         yield(payload, destination)
       end
     end
 
-    def serialize_resources(resources)
-      resources.map do |resource, stats|
-        resource_hash = resource.to_h.merge!(stats[:total].to_h)
+    def serialize_metrics(metrics)
+      metrics.map do |metric, stats|
+        metric_hash = metric.to_h.merge!(stats[:total].to_h)
 
-        if resource.groups.any?
+        if metric.groups.any?
           group_stats = stats.reject { |name, _stat| name == :total }
-          resource_hash['groups'] = group_stats.merge(group_stats) do |_name, stat|
+          metric_hash['groups'] = group_stats.merge(group_stats) do |_name, stat|
             stat.to_h
           end
         end
 
-        resource_hash
+        metric_hash
       end
     end
   end

data/lib/airbrake-ruby/stat.rb

@@ -4,7 +4,7 @@ module Airbrake
   # Stat is a data structure that allows accumulating performance data (route
   # performance, SQL query performance and such). It's powered by TDigests.
   #
-  # Usually, one Stat corresponds to one resource (route or query,
+  # Usually, one Stat corresponds to one metric (route or query,
   # etc.). Incrementing a stat means pushing new performance statistics.
   #
   # @example

data/lib/airbrake-ruby/time_truncate.rb

@@ -6,10 +6,10 @@ module Airbrake
   module TimeTruncate
     # Truncate +time+ to floor minute and turn it into an RFC3339 timestamp.
     #
-    # @param [Time] time
+    # @param [Time, Integer, Float] time
     # @return [String]
     def self.utc_truncate_minutes(time)
-      tm = time.getutc
+      tm = Time.at(time).getutc
 
       Time.utc(tm.year, tm.month, tm.day, tm.hour, tm.min).to_datetime.rfc3339
     end

data/lib/airbrake-ruby/version.rb

@@ -3,7 +3,7 @@
 module Airbrake
   # @return [String] the library version
   # @api public
-  AIRBRAKE_RUBY_VERSION = '6.0.1'.freeze
+  AIRBRAKE_RUBY_VERSION = '6.0.2'.freeze
 
   # @return [Hash{Symbol=>String}] the information about the notifier library
   # @since v5.0.0

data/lib/airbrake-ruby.rb

@@ -364,23 +364,14 @@ module Airbrake
     #     method: 'POST',
     #     route: '/thing/:id/create',
     #     status_code: 200,
-    #     func: 'do_stuff',
-    #     file: 'app/models/foo.rb',
-    #     line: 452,
     #     timing: 123.45 # ms
     #   )
     #
     # @param [Hash{Symbol=>Object}] request_info
     # @option request_info [String] :method The HTTP method that was invoked
     # @option request_info [String] :route The route that was invoked
-    # @option request_info [Integer] :status_code The respose code that the
+    # @option request_info [Integer] :status_code The response code that the
     #   route returned
-    # @option request_info [String] :func The function that called the query
-    #   (optional)
-    # @option request_info [String] :file The file that has the function that
-    #   called the query (optional)
-    # @option request_info [Integer] :line The line that executes the query
-    #   (optional)
     # @option request_info [Float] :timing  How much time it took to process the
     #   request (in ms)
     # @param [Hash] stash What needs to be appeneded to the stash, so it's
@@ -415,6 +406,9 @@ module Airbrake
     #     method: 'GET',
     #     route: '/things',
     #     query: 'SELECT * FROM things',
+    #     func: 'do_stuff',
+    #     file: 'app/models/foo.rb',
+    #     line: 452,
     #     timing: 123.45 # ms
     #   )
     #
@@ -424,6 +418,12 @@ module Airbrake
     # @option query_info [String] :route The route that triggered this SQL
     #    query (optional)
     # @option query_info [String] :query The query that was executed
+    # @option request_info [String] :func The function that called the query
+    #   (optional)
+    # @option request_info [String] :file The file that has the function that
+    #   called the query (optional)
+    # @option request_info [Integer] :line The line that executes the query
+    #   (optional)
     # @option query_info [Float] :timing How much time it took to process the
     #   query (in ms)
     # @param [Hash] stash What needs to be appeneded to the stash, so it's
@@ -451,7 +451,7 @@ module Airbrake
     # Increments performance breakdown statistics of a certain route.
     #
     # @example
-    #   Airbrake.notify_request(
+    #   Airbrake.notify_performance_breakdown(
     #     method: 'POST',
     #     route: '/thing/:id/create',
     #     response_type: 'json',
@@ -523,24 +523,24 @@ module Airbrake
       performance_notifier.notify_sync(queue)
     end
 
-    # Runs a callback before {.notify_request} or {.notify_query} kicks in. This
-    # is useful if you want to ignore specific resources or filter the data the
-    # resource contains.
+    # Runs a callback before {.notify_request}, {.notify_query}, {.notify_queue}
+    # or {.notify_performance_breakdown} kicks in. This is useful if you want to
+    # ignore specific metrics or filter the data the metric contains.
     #
-    # @example Ignore all resources
+    # @example Ignore all metrics
     #   Airbrake.add_performance_filter(&:ignore!)
     # @example Filter sensitive data
-    #   Airbrake.add_performance_filter do |resource|
-    #     case resource
+    #   Airbrake.add_performance_filter do |metric|
+    #     case metric
     #     when Airbrake::Query
-    #       resource.route = '[Filtered]'
+    #       metric.route = '[Filtered]'
     #     when Airbrake::Request
-    #       resource.query = '[Filtered]'
+    #       metric.query = '[Filtered]'
     #     end
     #   end
     # @example Filter with help of a class
     #   class MyFilter
-    #     def call(resource)
+    #     def call(metric)
     #       # ...
     #     end
     #   end
@@ -548,7 +548,7 @@ module Airbrake
     #   Airbrake.add_performance_filter(MyFilter.new)
     #
     # @param [#call] filter The filter object
-    # @yield [resource] The resource to filter
+    # @yield [metric] The metric to filter
     # @yieldparam [Airbrake::Query, Airbrake::Request]
     # @yieldreturn [void]
     # @return [void]

data/spec/config_spec.rb

@@ -127,22 +127,22 @@ RSpec.describe Airbrake::Config do
 
   describe "#check_performance_options" do
     it "returns a promise" do
-      resource = Airbrake::Query.new(method: '', route: '', query: '', timing: 1)
-      expect(config.check_performance_options(resource))
+      metric = Airbrake::Query.new(method: '', route: '', query: '', timing: 1)
+      expect(config.check_performance_options(metric))
         .to be_an(Airbrake::Promise)
     end
 
     context "when performance stats are disabled" do
       before { config.performance_stats = false }
 
-      let(:resource) do
+      let(:metric) do
         Airbrake::Request.new(
           method: 'GET', route: '/foo', status_code: 200, timing: 1,
         )
       end
 
       it "returns a rejected promise" do
-        promise = config.check_performance_options(resource)
+        promise = config.check_performance_options(metric)
         expect(promise.value).to eq(
           'error' => "The Performance Stats feature is disabled",
         )
@@ -152,12 +152,12 @@ RSpec.describe Airbrake::Config do
     context "when query stats are disabled" do
       before { config.query_stats = false }
 
-      let(:resource) do
+      let(:metric) do
         Airbrake::Query.new(method: 'GET', route: '/foo', query: '', timing: 1)
       end
 
       it "returns a rejected promise" do
-        promise = config.check_performance_options(resource)
+        promise = config.check_performance_options(metric)
         expect(promise.value).to eq(
           'error' => "The Query Stats feature is disabled",
         )
@@ -167,12 +167,12 @@ RSpec.describe Airbrake::Config do
     context "when job stats are disabled" do
       before { config.job_stats = false }
 
-      let(:resource) do
+      let(:metric) do
         Airbrake::Queue.new(queue: 'foo_queue', error_count: 0, timing: 1)
       end
 
       it "returns a rejected promise" do
-        promise = config.check_performance_options(resource)
+        promise = config.check_performance_options(metric)
         expect(promise.value).to eq(
           'error' => "The Job Stats feature is disabled",
         )

data/spec/performance_notifier_spec.rb

@@ -522,8 +522,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
 
     context "when a filter that modifies payload was defined" do
       before do
-        perf_notifier.add_filter do |resource|
-          resource.route = '[Filtered]'
+        perf_notifier.add_filter do |metric|
+          metric.route = '[Filtered]'
         end
       end
 
@@ -621,7 +621,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
   describe "#delete_filter" do
     let(:filter) do
       Class.new do
-        def call(resource); end
+        def call(metric); end
       end
     end
 

data/spec/time_truncate_spec.rb

@@ -1,15 +1,30 @@
 RSpec.describe Airbrake::TimeTruncate do
+  time = Time.new(2018, 1, 1, 0, 0, 20, 0)
+  time_with_zone = Time.new(2018, 1, 1, 0, 0, 20, '-05:00')
+
   describe "#utc_truncate_minutes" do
-    it "truncates time to the floor minute and returns an RFC3339 timestamp" do
-      time = Time.new(2018, 1, 1, 0, 0, 20, 0)
-      expect(described_class.utc_truncate_minutes(time))
-        .to eq('2018-01-01T00:00:00+00:00')
+    shared_examples 'time conversion' do |t|
+      it "truncates the time to the floor minute and returns an RFC3339 timestamp" do
+        expect(described_class.utc_truncate_minutes(t))
+          .to eq('2018-01-01T00:00:00+00:00')
+      end
+
+      it "converts time with zone to UTC" do
+        expect(described_class.utc_truncate_minutes(time_with_zone))
+          .to eq('2018-01-01T05:00:00+00:00')
+      end
+    end
+
+    context "when the time argument is a Time object" do
+      include_examples 'time conversion', time
+    end
+
+    context "when the time argument is a Float" do
+      include_examples 'time conversion', time.to_f
     end
 
-    it "converts time with zone to UTC" do
-      time = Time.new(2018, 1, 1, 0, 0, 20, '-05:00')
-      expect(described_class.utc_truncate_minutes(time))
-        .to eq('2018-01-01T05:00:00+00:00')
+    context "when the time argument is an Integer" do
+      include_examples 'time conversion', time.to_i
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.0.2
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-07 00:00:00.000000000 Z
+date: 2022-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3
@@ -155,7 +155,8 @@ files:
 homepage: https://airbrake.io
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: