airbrake-ruby 3.2.4 → 3.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0151a765b95213dc4a221547aa4afd2cf7da6c0
-  data.tar.gz: b13483675acade75535356f679099873ed234888
+  metadata.gz: d82d2c4088a9f12a7b9f79f06bbd627e467ca41a
+  data.tar.gz: 2d5a844aee8b9566bb707a6ba5b89f6b0534d770
 SHA512:
-  metadata.gz: fe9e46d9281e883be340f1648160989c4e8683c52e7dfec8652ba0403d625d70d2d23874134c2fc6000b0a3d8730dfeb01778832e1cd763999278883ad13c115
-  data.tar.gz: 39a05948f1e8176e7862cda8a02d669a9f2f46e078f1aca1901167814192e1ea1ad62f6b0b81df802f8a2b5686fc6ac6f0295b52daa2a121ddaf8d48eb79fc42
+  metadata.gz: c0bda142c168eeca50d9f73d6897c031d20bec58f2c1c9dbc1bbc4778fa3252025bfd56c8f0c1f7593b86fc632ac3f26a7a73d2edd5b84171c2701b4d7a0a94c
+  data.tar.gz: 871e4d592b46053d231d5ef6611e7f0736cffd0d4b40dc1ac586c1f3fee86e06bb937b4df0ee6c27a34d1c343d59d161b34b3b76b358683dbfdaad3a7013e1a3

data/lib/airbrake-ruby.rb

@@ -42,6 +42,8 @@ require 'airbrake-ruby/deploy_notifier'
 require 'airbrake-ruby/stat'
 require 'airbrake-ruby/time_truncate'
 require 'airbrake-ruby/tdigest'
+require 'airbrake-ruby/query'
+require 'airbrake-ruby/request'
 
 # This module defines the Airbrake API. The user is meant to interact with
 # Airbrake via its public class methods. Before using the library, you must to
@@ -450,6 +452,9 @@ module Airbrake
     #     method: 'POST',
     #     route: '/thing/:id/create',
     #     status_code: 200,
+    #     func: 'do_stuff',
+    #     file: 'app/models/foo.rb',
+    #     line: 452,
     #     start_time: timestamp,
     #     end_time: Time.now
     #   )
@@ -457,7 +462,14 @@ module Airbrake
     # @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 route returned
+    # @option request_info [Integer] :status_code The respose 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 [Date] :start_time When the request started
     # @option request_info [Time] :end_time When the request ended (optional)
     # @return [void]
@@ -484,6 +496,7 @@ module Airbrake
     #   )
     #
     # @param [Hash{Symbol=>Object}] query_info
+    # @option request_info [String] :environment (optional)
     # @option request_info [String] :method The HTTP method that triggered this
     #   SQL query (optional)
     # @option request_info [String] :route The route that triggered this SQL

data/lib/airbrake-ruby/performance_notifier.rb

@@ -103,59 +103,4 @@ module Airbrake
       end
     end
   end
-
-  # Request holds request data that powers route stats.
-  #
-  # @see Airbrake.notify_request
-  # @api public
-  # @since v3.2.0
-  Request = Struct.new(:method, :route, :status_code, :start_time, :end_time) do
-    include HashKeyable
-    include Ignorable
-
-    def initialize(method:, route:, status_code:, start_time:, end_time: Time.now)
-      @ignored = false
-      super(method, route, status_code, start_time, end_time)
-    end
-
-    def name
-      'routes'
-    end
-
-    def to_h
-      {
-        'method' => method,
-        'route' => route,
-        'statusCode' => status_code,
-        'time' => TimeTruncate.utc_truncate_minutes(start_time)
-      }
-    end
-  end
-
-  # Query holds SQL query data that powers SQL query collection.
-  #
-  # @see Airbrake.notify_query
-  # @api public
-  # @since v3.2.0
-  Query = Struct.new(:method, :route, :query, :start_time, :end_time) do
-    include HashKeyable
-    include Ignorable
-
-    def initialize(method:, route:, query:, start_time:, end_time: Time.now)
-      super(method, route, query, start_time, end_time)
-    end
-
-    def name
-      'queries'
-    end
-
-    def to_h
-      {
-        'method' => method,
-        'route' => route,
-        'query' => query,
-        'time' => TimeTruncate.utc_truncate_minutes(start_time)
-      }
-    end
-  end
 end

data/lib/airbrake-ruby/query.rb

@@ -0,0 +1,50 @@
+module Airbrake
+  # Query holds SQL query data that powers SQL query collection.
+  #
+  # @see Airbrake.notify_query
+  # @api public
+  # @since v3.2.0
+  # rubocop:disable Metrics/ParameterLists, Metrics/BlockLength
+  Query = Struct.new(
+    :environment, :method, :route, :query, :func, :file, :line, :start_time,
+    :end_time
+  ) do
+    include HashKeyable
+    include Ignorable
+
+    def initialize(
+      environment: nil,
+      method:,
+      route:,
+      query:,
+      func: nil,
+      file: nil,
+      line: nil,
+      start_time:,
+      end_time: Time.now
+    )
+      super(
+        environment, method, route, query, func, file, line, start_time,
+        end_time
+      )
+    end
+
+    def name
+      'queries'
+    end
+
+    def to_h
+      {
+        'environment' => environment,
+        'method' => method,
+        'route' => route,
+        'query' => query,
+        'time' => TimeTruncate.utc_truncate_minutes(start_time),
+        'function' => func,
+        'file' => file,
+        'line' => line
+      }.delete_if { |_key, val| val.nil? }
+    end
+    # rubocop:enable Metrics/ParameterLists, Metrics/BlockLength
+  end
+end

data/lib/airbrake-ruby/request.rb

@@ -0,0 +1,40 @@
+module Airbrake
+  # Request holds request data that powers route stats.
+  #
+  # @see Airbrake.notify_request
+  # @api public
+  # @since v3.2.0
+  # rubocop:disable Metrics/ParameterLists
+  Request = Struct.new(
+    :environment, :method, :route, :status_code, :start_time, :end_time
+  ) do
+    include HashKeyable
+    include Ignorable
+
+    def initialize(
+      environment: nil,
+      method:,
+      route:,
+      status_code:,
+      start_time:,
+      end_time: Time.now
+    )
+      super(environment, method, route, status_code, start_time, end_time)
+    end
+
+    def name
+      'routes'
+    end
+
+    def to_h
+      {
+        'environment' => environment,
+        'method' => method,
+        'route' => route,
+        'statusCode' => status_code,
+        'time' => TimeTruncate.utc_truncate_minutes(start_time)
+      }.delete_if { |_key, val| val.nil? }
+    end
+  end
+  # rubocop:enable Metrics/ParameterLists
+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 = '3.2.4'.freeze
+  AIRBRAKE_RUBY_VERSION = '3.2.5'.freeze
 end

data/spec/performance_notifier_spec.rb

@@ -19,6 +19,68 @@ RSpec.describe Airbrake::PerformanceNotifier do
   end
 
   describe "#notify" do
+    it "sends full query" do
+      subject.notify(
+        Airbrake::Query.new(
+          environment: 'development',
+          method: 'POST',
+          route: '/foo',
+          query: 'SELECT * FROM things',
+          func: 'foo',
+          file: 'foo.rb',
+          line: 123,
+          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+          end_time: Time.new(2018, 1, 1, 0, 50, 0, 0)
+        )
+      )
+
+      expect(
+        a_request(:put, queries).with(body: %r|
+          \A{"queries":\[{
+            "environment":"development",
+            "method":"POST",
+            "route":"/foo",
+            "query":"SELECT\s\*\sFROM\sthings",
+            "time":"2018-01-01T00:49:00\+00:00",
+            "function":"foo",
+            "file":"foo.rb",
+            "line":123,
+            "count":1,
+            "sum":60000.0,
+            "sumsq":3600000000.0,
+            "tdigest":"AAAAAkA0AAAAAAAAAAAAAUdqYAAB"
+          }\]}\z|x)
+      ).to have_been_made
+    end
+
+    it "sends full request" do
+      subject.notify(
+        Airbrake::Request.new(
+          environment: 'development',
+          method: 'POST',
+          route: '/foo',
+          status_code: 200,
+          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+          end_time: Time.new(2018, 1, 1, 0, 50, 0, 0)
+        )
+      )
+
+      expect(
+        a_request(:put, routes).with(body: %r|
+          \A{"routes":\[{
+            "environment":"development",
+            "method":"POST",
+            "route":"/foo",
+            "statusCode":200,
+            "time":"2018-01-01T00:49:00\+00:00",
+            "count":1,
+            "sum":60000.0,
+            "sumsq":3600000000.0,
+            "tdigest":"AAAAAkA0AAAAAAAAAAAAAUdqYAAB"
+          }\]}\z|x)
+      ).to have_been_made
+    end
+
     it "rounds time to the floor minute" do
       subject.notify(
         Airbrake::Request.new(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 3.2.4
+  version: 3.2.5
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-15 00:00:00.000000000 Z
+date: 2019-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3
@@ -68,6 +68,8 @@ files:
 - lib/airbrake-ruby/notice_notifier.rb
 - lib/airbrake-ruby/performance_notifier.rb
 - lib/airbrake-ruby/promise.rb
+- lib/airbrake-ruby/query.rb
+- lib/airbrake-ruby/request.rb
 - lib/airbrake-ruby/response.rb
 - lib/airbrake-ruby/stat.rb
 - lib/airbrake-ruby/sync_sender.rb