airbrake-ruby 4.2.5 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f420d742ab241277d8364835c8b293782cc4ae1c
-  data.tar.gz: 474ca3f382cb72e68fc4b6096c495345770385d2
+  metadata.gz: 6225e22d263a35ca8bc1e40a9b8d9a688738f37e
+  data.tar.gz: d8d9046a0acee6834eb604769ed39d696c2c2325
 SHA512:
-  metadata.gz: c96369b971def3c5bb39bbf1957c8230c14de547a1c1b0a0846690b173ad168334a76792dc6c61cba19f3e7f0feefe2d5c0bd8e5479dce0cf52d2934f5edb874
-  data.tar.gz: cba06f1d4f42606b1a473ae52c81109a52ee8b21a3006b00fe9db97bde047966879dc011c99a0fe318650931f6d1477c7a30b0aa6bfa7a7f9329420ee9cfcb42
+  metadata.gz: 35a1011b7fcf9380a20b934a04dccfaec4acd83a171060ff6457370e8da90fac83b6ba48d8d60e50b2ed0e21611aa5d0dda3cf210a5d7d6710115cdc0cfcfaeb
+  data.tar.gz: '098415b654116fce90700b9e4f7d540637c98d5712b321eb808c20c386a3100a3e63ba68ab6d514029831e84dab9585e66dc17cafcf271c916dc81ab3ebf6089'

data/lib/airbrake-ruby.rb

@@ -49,6 +49,7 @@ require 'airbrake-ruby/request'
 require 'airbrake-ruby/performance_breakdown'
 require 'airbrake-ruby/benchmark'
 require 'airbrake-ruby/monotonic_time'
+require 'airbrake-ruby/timed_trace'
 
 # Airbrake is a thin wrapper around instances of the notifier classes (such as
 # notice, performance & deploy notifiers). It creates a way to access them via a
@@ -77,9 +78,6 @@ module Airbrake
   #  special cases where we need to work around older implementations
   JRUBY = (RUBY_ENGINE == 'jruby')
 
-  # @!macro see_public_api_method
-  #   @see Airbrake.$0
-
   class << self
     # @since v4.2.3
     # @api private

data/lib/airbrake-ruby/benchmark.rb

@@ -1,14 +1,39 @@
 module Airbrake
   # Benchmark benchmarks Ruby code.
   #
-  # @since v4.3.0
+  # @since v4.2.4
   # @api private
-  module Benchmark
+  class Benchmark
     # Measures monotonic time for the given operation.
+    #
+    # @yieldreturn [void]
     def self.measure
-      start = MonotonicTime.time_in_ms
+      benchmark = new
+
       yield
-      MonotonicTime.time_in_ms - start
+
+      benchmark.stop
+      benchmark.duration
+    end
+
+    # @return [Float]
+    attr_reader :duration
+
+    # @since v4.3.0
+    def initialize
+      @start = MonotonicTime.time_in_ms
+      @duration = 0.0
+    end
+
+    # Stops the benchmark and stores `duration`.
+    #
+    # @since v4.3.0
+    # @return [Boolean] true for the first invocation, false in all other cases
+    def stop
+      return false if @duration > 0.0
+
+      @duration = MonotonicTime.time_in_ms - @start
+      true
     end
   end
 end

data/lib/airbrake-ruby/config.rb

@@ -96,7 +96,7 @@ module Airbrake
     attr_accessor :performance_stats_flush_period
 
     class << self
-      # @param [Config] new_instance
+      # @return [Config]
       attr_writer :instance
 
       # @return [Config]

data/lib/airbrake-ruby/loggable.rb

@@ -17,7 +17,7 @@ module Airbrake
   # @api private
   module Loggable
     class << self
-      # @param [Logger] logger
+      # @return [Logger]
       attr_writer :instance
 
       # @return [Logger]

data/lib/airbrake-ruby/monotonic_time.rb

@@ -7,7 +7,7 @@ module Airbrake
   #   MonotonicTime.time_in_ms #=> 287138801.144576
   #
   # @see http://pubs.opengroup.org/onlinepubs/9699919799/functions/clock_getres.html
-  # @since v4.3.0
+  # @since v4.2.4
   # @api private
   module MonotonicTime
     class << self

data/lib/airbrake-ruby/notice_notifier.rb

@@ -31,27 +31,27 @@ module Airbrake
       add_filter(Airbrake::Filters::ExceptionAttributesFilter.new)
     end
 
-    # @macro see_public_api_method
+    # @see Airbrake.notify
     def notify(exception, params = {}, &block)
       send_notice(exception, params, default_sender, &block)
     end
 
-    # @macro see_public_api_method
+    # @see Airbrake.notify_sync
     def notify_sync(exception, params = {}, &block)
       send_notice(exception, params, @sync_sender, &block).value
     end
 
-    # @macro see_public_api_method
+    # @see Airbrake.add_filte
     def add_filter(filter = nil, &block)
       @filter_chain.add_filter(block_given? ? block : filter)
     end
 
-    # @macro see_public_api_method
+    # @see Airbrake.delete_filter
     def delete_filter(filter_class)
       @filter_chain.delete_filter(filter_class)
     end
 
-    # @macro see_public_api_method
+    # @see Airbrake.build_notice
     def build_notice(exception, params = {})
       if @async_sender.closed?
         raise Airbrake::Error,
@@ -66,17 +66,17 @@ module Airbrake
       end
     end
 
-    # @macro see_public_api_method
+    # @see Airbrake.close
     def close
       @async_sender.close
     end
 
-    # @macro see_public_api_method
+    # @see Airbrake.configured?
     def configured?
       @config.valid?
     end
 
-    # @macro see_public_api_method
+    # @see Airbrake.merge_context
     def merge_context(context)
       @context.merge!(context)
     end

data/lib/airbrake-ruby/performance_breakdown.rb

@@ -1,10 +1,10 @@
 module Airbrake
   # PerformanceBreakdown holds data that shows how much time a request spent
-  # doing certaing subtasks such as (DB querying, view rendering, etc).  request
+  # doing certaing subtasks such as (DB querying, view rendering, etc).
   #
   # @see Airbrake.notify_breakdown
   # @api public
-  # @since v4.3.0
+  # @since v4.2.0
   # rubocop:disable Metrics/BlockLength, Metrics/ParameterLists
   PerformanceBreakdown = Struct.new(
     :method, :route, :response_type, :groups, :start_time, :end_time

data/lib/airbrake-ruby/timed_trace.rb

@@ -0,0 +1,58 @@
+module Airbrake
+  # TimedTrace represents a chunk of code performance of which was measured and
+  # stored under a label. The chunk is called a "span".
+  #
+  # @example
+  #   timed_trace = TimedTrace.new
+  #   timed_trace.span('http request') do
+  #     http.get('example.com')
+  #   end
+  #   timed_trace.spans #=> { 'http request' => 0.123 }
+  #
+  # @api public
+  # @since v4.3.0
+  class TimedTrace
+    # @param [String] label
+    # @return [Airbrake::TimedTrace]
+    def self.span(label, &block)
+      new.tap { |timed_trace| timed_trace.span(label, &block) }
+    end
+
+    def initialize
+      @spans = {}
+    end
+
+    # @param [String] label
+    # @return [Boolean]
+    def span(label)
+      start_span(label)
+      yield
+      stop_span(label)
+    end
+
+    # @param [String] label
+    # @return [Boolean]
+    def start_span(label)
+      return false if @spans.key?(label)
+
+      @spans[label] = Airbrake::Benchmark.new
+      true
+    end
+
+    # @param [String] label
+    # @return [Boolean]
+    def stop_span(label)
+      return false unless @spans.key?(label)
+
+      @spans[label].stop
+      true
+    end
+
+    # @return [Hash<String=>Float>]
+    def spans
+      @spans.each_with_object({}) do |(label, benchmark), new_spans|
+        new_spans[label] = benchmark.duration
+      end
+    end
+  end
+end

data/lib/airbrake-ruby/version.rb

@@ -2,5 +2,5 @@
 # More information: http://semver.org/
 module Airbrake
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '4.2.5'.freeze
+  AIRBRAKE_RUBY_VERSION = '4.3.0'.freeze
 end

data/spec/benchmark_spec.rb

@@ -1,7 +1,33 @@
 RSpec.describe Airbrake::Benchmark do
   describe ".measure" do
     it "returns measured performance time" do
-      expect(subject.measure { '10' * 10 }).to be_kind_of(Numeric)
+      expect(described_class.measure { '10' * 10 }).to be_kind_of(Numeric)
+    end
+  end
+
+  describe "#stop" do
+    before { subject }
+
+    context "when called one time" do
+      its(:stop) { is_expected.to eq(true) }
+    end
+
+    context "when called twice or more" do
+      before { subject.stop }
+
+      its(:stop) { is_expected.to eq(false) }
+    end
+  end
+
+  describe "#duration" do
+    context "when #stop wasn't called yet" do
+      its(:duration) { is_expected.to be_zero }
+    end
+
+    context "when #stop was called" do
+      before { subject.stop }
+
+      its(:duration) { is_expected.to be > 0 }
     end
   end
 end

data/spec/timed_trace_spec.rb

@@ -0,0 +1,125 @@
+RSpec.describe Airbrake::TimedTrace do
+  describe ".span" do
+    it "returns a timed trace" do
+      expect(described_class.span('operation') {}).to be_a(described_class)
+    end
+
+    it "returns a timed trace with a stopped span" do
+      timed_trace = described_class.span('operation') {}
+      expect(timed_trace.spans).to match('operation' => be > 0)
+    end
+  end
+
+  describe "#span" do
+    it "captures a span" do
+      subject.span('operation') {}
+      expect(subject.spans).to match('operation' => be > 0)
+    end
+  end
+
+  describe "#start_span" do
+    context "when called once" do
+      it "returns true" do
+        expect(subject.start_span('operation')).to eq(true)
+      end
+    end
+
+    context "when called multiple times" do
+      before { subject.start_span('operation') }
+
+      it "returns false" do
+        expect(subject.start_span('operation')).to eq(false)
+      end
+    end
+
+    context "when another span was started" do
+      before { subject.start_span('operation') }
+
+      it "returns true" do
+        expect(subject.start_span('another operation')).to eq(true)
+      end
+    end
+
+    context "when #spans was called" do
+      before { subject.start_span('operation') }
+
+      it "returns spans with zero values" do
+        expect(subject.spans).to eq('operation' => 0.0)
+      end
+    end
+  end
+
+  describe "#stop_span" do
+    context "when #start_span wasn't invoked" do
+      it "returns false" do
+        expect(subject.stop_span('operation')).to eq(false)
+      end
+    end
+
+    context "when #start_span was invoked" do
+      before { subject.start_span('operation') }
+
+      it "returns true" do
+        expect(subject.stop_span('operation')).to eq(true)
+      end
+    end
+
+    context "when multiple spans were started" do
+      before do
+        subject.start_span('operation')
+        subject.start_span('another operation')
+      end
+
+      context "and when stopping in LIFO order" do
+        it "returns true for all spans" do
+          expect(subject.stop_span('another operation')).to eq(true)
+          expect(subject.stop_span('operation')).to eq(true)
+        end
+      end
+
+      context "and when stopping in FIFO order" do
+        it "returns true for all spans" do
+          expect(subject.stop_span('operation')).to eq(true)
+          expect(subject.stop_span('another operation')).to eq(true)
+        end
+      end
+    end
+  end
+
+  describe "#spans" do
+    context "when no spans were captured" do
+      it "returns an empty hash" do
+        expect(subject.spans).to eq({})
+      end
+    end
+
+    context "when a span was captured" do
+      before do
+        subject.start_span('operation')
+        subject.stop_span('operation')
+      end
+
+      it "returns a Hash with the corresponding span" do
+        subject.stop_span('operation')
+        expect(subject.spans).to match('operation' => be > 0)
+      end
+    end
+
+    context "when multiple spans were captured" do
+      before do
+        subject.start_span('operation')
+        subject.stop_span('operation')
+
+        subject.start_span('another operation')
+        subject.stop_span('another operation')
+      end
+
+      it "returns a Hash with all spans" do
+        expect(subject.spans).to match(
+          'operation' => be > 0,
+          'another operation' => be > 0
+        )
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 4.2.5
+  version: 4.3.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-11 00:00:00.000000000 Z
+date: 2019-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3
@@ -80,6 +80,7 @@ files:
 - lib/airbrake-ruby/sync_sender.rb
 - lib/airbrake-ruby/tdigest.rb
 - lib/airbrake-ruby/time_truncate.rb
+- lib/airbrake-ruby/timed_trace.rb
 - lib/airbrake-ruby/truncator.rb
 - lib/airbrake-ruby/version.rb
 - spec/airbrake_spec.rb
@@ -127,6 +128,7 @@ files:
 - spec/sync_sender_spec.rb
 - spec/tdigest_spec.rb
 - spec/time_truncate_spec.rb
+- spec/timed_trace_spec.rb
 - spec/truncator_spec.rb
 homepage: https://airbrake.io
 licenses:
@@ -186,6 +188,7 @@ test_files:
 - spec/performance_notifier_spec.rb
 - spec/airbrake_spec.rb
 - spec/nested_exception_spec.rb
+- spec/timed_trace_spec.rb
 - spec/filter_chain_spec.rb
 - spec/response_spec.rb
 - spec/file_cache.rb