appsignal 3.0.5 → 3.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f73ddc957c9f0fd0fd13008f5ef1caea0a9248b70fc6b21a929e607b815dedb1
-  data.tar.gz: 7df48cb0e05e402266198605774661d3ab62dd3952e8770ec7ab4295ab9bed5a
+  metadata.gz: e7497a8e24e7219e936d3056dfa2c835b35b40faec1f8e9502dcc93e7ec7b7b5
+  data.tar.gz: 4e74a0eaac0b0e6330ecfcbd63762d80359ff880395e66644d39db4879c823a8
 SHA512:
-  metadata.gz: 69dafc14fccd8c5c1ed793563ea0e2c19ce4f58404a1b1dd9d185f83ae1c5996105102e13619612d210c86742ac437c217a66f623f1bb138389df4c8483d9f9d
-  data.tar.gz: 2e3c70b487c91c73d61e5d876cf053d4c6477505ec1d47f3766b7dd4afd9196b78f817def8440c3668609f16d09e468ef1fb7f8712a923bf6034def75dd5c0a2
+  metadata.gz: 5c4ee25807db79abac6b10cf247deaef410c2108cd05500dc2bf1d78f5c2989c6e7fd2f249f4bc5016a542a41a467cb078bea7565ae5485fa5d997d62c44f06b
+  data.tar.gz: 1b728a26ade2bbcdedea7d454e9bb7ad548c1931a2503b79a5ed265e6d768e9f403b268f7e4984a62c5d9f6c679c08fbf6fa23d0365592b6dd2c34b68013a0dd

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.0.6
+
+- [d354d79b](https://github.com/appsignal/appsignal-ruby/commit/d354d79b293fd549e66cae60d805d1b1e9e9d2d8) patch - Add Excon integration. Track requests and responses from the Excon gem.
+- [4c32e818](https://github.com/appsignal/appsignal-ruby/commit/4c32e8180b797d7987c67b68720c6a5d22935333) patch - Support Redis eval statements better by showing the actual script that was performed. Instead of showing `eval ? ? ?` (for a script with 2 arguments), show `<script> ? ?`, where `<script>` is whatever script was sent to `Redis.new.eval("<script>")`.
+
 ## 3.0.5
 
 - [4bddac36](https://github.com/appsignal/appsignal-ruby/commit/4bddac3618ccea03c165eec53cee90e222b68cd6) patch - Skip empty HTTP proxy config. When any of the HTTP proxy config returns an

data/lib/appsignal/hooks.rb

@@ -108,3 +108,4 @@ require "appsignal/hooks/mongo_ruby_driver"
 require "appsignal/hooks/webmachine"
 require "appsignal/hooks/data_mapper"
 require "appsignal/hooks/que"
+require "appsignal/hooks/excon"

data/lib/appsignal/hooks/excon.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Appsignal
+  class Hooks
+    # @api private
+    class ExconHook < Appsignal::Hooks::Hook
+      register :excon
+
+      def dependencies_present?
+        Appsignal.config && defined?(::Excon)
+      end
+
+      def install
+        require "appsignal/integrations/excon"
+        ::Excon.defaults[:instrumentor] = Appsignal::Integrations::ExconIntegration
+      end
+    end
+  end
+end

data/lib/appsignal/integrations/excon.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Appsignal
+  module Integrations
+    module ExconIntegration
+      def self.instrument(name, data, &block)
+        namespace, *event = name.split(".")
+        rails_name = [event, namespace].flatten.join(".")
+
+        title =
+          if rails_name == "response.excon"
+            data[:host]
+          else
+            "#{data[:method].to_s.upcase} #{data[:scheme]}://#{data[:host]}"
+          end
+        Appsignal.instrument(rails_name, title, &block)
+      end
+    end
+  end
+end

data/lib/appsignal/integrations/redis.rb

@@ -3,12 +3,15 @@
 module Appsignal
   module Integrations
     module RedisIntegration
-      def process(commands, &block)
-        sanitized_commands = commands.map do |command, *args|
-          "#{command}#{" ?" * args.size}"
-        end.join("\n")
+      def write(command)
+        sanitized_command =
+          if command[0] == :eval
+            "#{command[1]}#{" ?" * (command.size - 3)}"
+          else
+            "#{command[0]}#{" ?" * (command.size - 1)}"
+          end
 
-        Appsignal.instrument "query.redis", id, sanitized_commands do
+        Appsignal.instrument "query.redis", id, sanitized_command do
           super
         end
       end

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.0.5".freeze
+  VERSION = "3.0.6".freeze
 end

data/spec/lib/appsignal/hooks/excon_spec.rb

@@ -0,0 +1,74 @@
+describe Appsignal::Hooks::ExconHook do
+  before :context do
+    start_agent
+  end
+
+  context "with Excon" do
+    before(:context) do
+      class Excon
+        def self.defaults
+          @defaults ||= {}
+        end
+      end
+      Appsignal::Hooks::ExconHook.new.install
+    end
+    after(:context) { Object.send(:remove_const, :Excon) }
+
+    describe "#dependencies_present?" do
+      subject { described_class.new.dependencies_present? }
+
+      it { is_expected.to be_truthy }
+    end
+
+    describe "#install" do
+      it "adds the AppSignal instrumentor to Excon" do
+        expect(Excon.defaults[:instrumentor]).to eql(Appsignal::Integrations::ExconIntegration)
+      end
+    end
+
+    describe "instrumentation" do
+      let!(:transaction) do
+        Appsignal::Transaction.create("uuid", Appsignal::Transaction::HTTP_REQUEST, "test")
+      end
+      around { |example| keep_transactions { example.run } }
+
+      it "instruments a http request" do
+        data = {
+          :host => "www.google.com",
+          :method => :get,
+          :scheme => "http"
+        }
+        Excon.defaults[:instrumentor].instrument("excon.request", data) {}
+
+        expect(transaction.to_h["events"]).to include(
+          hash_including(
+            "name" => "request.excon",
+            "title" => "GET http://www.google.com",
+            "body" => ""
+          )
+        )
+      end
+
+      it "instruments a http response" do
+        data = { :host => "www.google.com" }
+        Excon.defaults[:instrumentor].instrument("excon.response", data) {}
+
+        expect(transaction.to_h["events"]).to include(
+          hash_including(
+            "name" => "response.excon",
+            "title" => "www.google.com",
+            "body" => ""
+          )
+        )
+      end
+    end
+  end
+
+  context "without Excon" do
+    describe "#dependencies_present?" do
+      subject { described_class.new.dependencies_present? }
+
+      it { is_expected.to be_falsy }
+    end
+  end
+end

data/spec/lib/appsignal/hooks/redis_spec.rb

@@ -33,16 +33,17 @@ describe Appsignal::Hooks::RedisHook do
 
           context "instrumentation" do
             before do
+              start_agent
               # Stub Redis::Client class so that it doesn't perform an actual
               # Redis query. This class will be included (prepended) with the
               # AppSignal Redis integration.
               stub_const("Redis::Client", Class.new do
                 def id
-                  :stub_id
+                  "stub_id"
                 end
 
-                def process(_commands)
-                  :stub_process
+                def write(_commands)
+                  "stub_write"
                 end
               end)
               # Load the integration again for the stubbed Redis::Client class.
@@ -50,17 +51,40 @@ describe Appsignal::Hooks::RedisHook do
               # track if it was installed already or not.
               Appsignal::Hooks::RedisHook.new.install
             end
+            let!(:transaction) do
+              Appsignal::Transaction.create("uuid", Appsignal::Transaction::HTTP_REQUEST, "test")
+            end
+            around { |example| keep_transactions { example.run } }
 
             it "instrument a redis call" do
-              Appsignal::Transaction.create("uuid", Appsignal::Transaction::HTTP_REQUEST, "test")
-              expect(Appsignal::Transaction.current).to receive(:start_event)
-                .at_least(:once)
-              expect(Appsignal::Transaction.current).to receive(:finish_event)
-                .at_least(:once)
-                .with("query.redis", :stub_id, "get ?", 0)
+              client = Redis::Client.new
+              expect(client.write([:get, "key"])).to eql("stub_write")
 
+              transaction_hash = transaction.to_h
+              expect(transaction_hash["events"]).to include(
+                hash_including(
+                  "name" => "query.redis",
+                  "body" => "get ?",
+                  "title" => "stub_id"
+                )
+              )
+            end
+
+            it "instrument a redis script call" do
               client = Redis::Client.new
-              expect(client.process([[:get, "key"]])).to eql(:stub_process)
+              script = "return redis.call('set',KEYS[1],ARGV[1])"
+              keys = ["foo"]
+              argv = ["bar"]
+              expect(client.write([:eval, script, keys.size, keys, argv])).to eql("stub_write")
+
+              transaction_hash = transaction.to_h
+              expect(transaction_hash["events"]).to include(
+                hash_including(
+                  "name" => "query.redis",
+                  "body" => "#{script} ? ?",
+                  "title" => "stub_id"
+                )
+              )
             end
           end
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.0.6
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2021-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -210,6 +210,7 @@ files:
 - lib/appsignal/hooks/celluloid.rb
 - lib/appsignal/hooks/data_mapper.rb
 - lib/appsignal/hooks/delayed_job.rb
+- lib/appsignal/hooks/excon.rb
 - lib/appsignal/hooks/mongo_ruby_driver.rb
 - lib/appsignal/hooks/net_http.rb
 - lib/appsignal/hooks/passenger.rb
@@ -229,6 +230,7 @@ files:
 - lib/appsignal/integrations/capistrano/capistrano_2_tasks.rb
 - lib/appsignal/integrations/data_mapper.rb
 - lib/appsignal/integrations/delayed_job_plugin.rb
+- lib/appsignal/integrations/excon.rb
 - lib/appsignal/integrations/grape.rb
 - lib/appsignal/integrations/mongo_ruby_driver.rb
 - lib/appsignal/integrations/net_http.rb
@@ -305,6 +307,7 @@ files:
 - spec/lib/appsignal/hooks/celluloid_spec.rb
 - spec/lib/appsignal/hooks/data_mapper_spec.rb
 - spec/lib/appsignal/hooks/delayed_job_spec.rb
+- spec/lib/appsignal/hooks/excon_spec.rb
 - spec/lib/appsignal/hooks/mongo_ruby_driver_spec.rb
 - spec/lib/appsignal/hooks/net_http_spec.rb
 - spec/lib/appsignal/hooks/passenger_spec.rb
@@ -453,6 +456,7 @@ test_files:
 - spec/lib/appsignal/hooks/celluloid_spec.rb
 - spec/lib/appsignal/hooks/data_mapper_spec.rb
 - spec/lib/appsignal/hooks/delayed_job_spec.rb
+- spec/lib/appsignal/hooks/excon_spec.rb
 - spec/lib/appsignal/hooks/mongo_ruby_driver_spec.rb
 - spec/lib/appsignal/hooks/net_http_spec.rb
 - spec/lib/appsignal/hooks/passenger_spec.rb