appsignal 2.2.1 → 2.3.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 705384b1874c28d97c9686459bcbfc6a99fb2314
-  data.tar.gz: d191875adb5dadac78d8148828a346e9165964a4
+  metadata.gz: 5785ecc19ccd3550a6a654429274f796d462b6b4
+  data.tar.gz: ec699ff6da87026d7b003c1343d77c0ed3513914
 SHA512:
-  metadata.gz: fd0dc31ae1795897907da34b6ce862777829e81b6e98013830caa4818bf17f77f683e4a6beb176d6664213f5e64bd602df410aedab8ac798b58432dc0417daa5
-  data.tar.gz: 7a448280ea51c4426e6a9322f8a264fe99f94c25312dd663cdd489d8d9f9ac58d81e5f21e154fb309a9fcc035fc23fbcfc7ea98394597305ae49ad021356f167
+  metadata.gz: f533af191e8b214188d676db0d834d117e3c0ed4bad7d52cacb83b2a5ed78285e640a738a1fde78f9a29f0cabab97277034ec74a242b833f63236d1fe2d1bf8b
+  data.tar.gz: 71dac0fc78a0964425672356ac88ca2518f16c47a340408c2fafd7d15991f99df7907c34790c91dc093b2c30f1199b7705c7e9eef16004df133e36ef31e2f78a

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 2.3.0 (unreleased)
+* Fix Shoryuken instrumentation when body is a string. PR #266
+* Enable ActiveSupport instrumentation at all times. PR #274
+* Add parameter filtering for background jobs. Automatically uses the AppSignal
+  parameter filtering. PR #280
+* Improve log messages for transactions. PR #293
+* Remove thread_safe dependency. PR #294
+* Add `Transaction#params` attribute for custom parameters. PR #295
+* Add ActionCable support. PR #309
+* Finish ActiveSupport notifications events when they would encounter a `raise`
+  or a `throw`. PR #310
+* Add `ignore_namespaces` option. PR #312
+* Truncate lengthy parameter values to 2000 characters.
+  Commit 65de1382f5f453b624781cde6e0544c89fdf89ef
+
 # 2.2.1
 * Fix support for Rails 5.1. PR #286
 * Fix instrumentation that would report a duration of `0ms` for all DataMapper

data/appsignal.gemspec

@@ -24,10 +24,9 @@ Gem::Specification.new do |gem|
   gem.extensions = %w(ext/extconf.rb)
 
   gem.add_dependency "rack"
-  gem.add_dependency "thread_safe"
 
   gem.add_development_dependency "rake", "~> 11"
-  gem.add_development_dependency "rspec", "~> 3.5"
+  gem.add_development_dependency "rspec", "~> 3.6"
   gem.add_development_dependency "pry"
   gem.add_development_dependency "timecop"
   gem.add_development_dependency "webmock"

data/ext/agent.yml

@@ -1,18 +1,18 @@
 ---
-version: d54a76a
+version: d5b0750
 triples:
   x86_64-linux:
-    checksum: 281d91b060365e05fc2df94eb88b0b8d7f6fde06c439829bdd170f202f5aa5b1
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d54a76a/appsignal-x86_64-linux-all-static.tar.gz
+    checksum: 1ff68355e089d855927dfd5058e635bf1ad3196f8f9c6f4577ac6854bca133bf
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d5b0750/appsignal-x86_64-linux-all-static.tar.gz
   i686-linux:
-    checksum: 91e9d317a45d0a5e1a03b5a12480c221182b8f460638532181b58b362941d3d5
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d54a76a/appsignal-i686-linux-all-static.tar.gz
+    checksum: fcfa0d7a0ebd628d24ba799e0c765210ee2c93d1eff6930b94fd9ca4383cb278
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d5b0750/appsignal-i686-linux-all-static.tar.gz
   x86-linux:
-    checksum: 91e9d317a45d0a5e1a03b5a12480c221182b8f460638532181b58b362941d3d5
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d54a76a/appsignal-i686-linux-all-static.tar.gz
+    checksum: fcfa0d7a0ebd628d24ba799e0c765210ee2c93d1eff6930b94fd9ca4383cb278
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d5b0750/appsignal-i686-linux-all-static.tar.gz
   x86_64-darwin:
-    checksum: f9732af3f4913341d0ec70474d893472fd1bf9720c5cea098a24be92379872aa
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d54a76a/appsignal-x86_64-darwin-all-static.tar.gz
+    checksum: 9e394fa5f473f81ef4f322b3802aeee2b08854ea43a75f9c22c6185b4ffd960a
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d5b0750/appsignal-x86_64-darwin-all-static.tar.gz
   universal-darwin:
-    checksum: f9732af3f4913341d0ec70474d893472fd1bf9720c5cea098a24be92379872aa
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d54a76a/appsignal-x86_64-darwin-all-static.tar.gz
+    checksum: 9e394fa5f473f81ef4f322b3802aeee2b08854ea43a75f9c22c6185b4ffd960a
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d5b0750/appsignal-x86_64-darwin-all-static.tar.gz

data/ext/appsignal_extension.c

@@ -281,6 +281,21 @@ static VALUE complete_transaction(VALUE self) {
   return Qnil;
 }
 
+static VALUE transaction_to_json(VALUE self) {
+  appsignal_transaction_t* transaction;
+  appsignal_string_t json;
+
+  Data_Get_Struct(self, appsignal_transaction_t, transaction);
+
+  json = appsignal_transaction_to_json(transaction);
+
+  if (json.len == 0) {
+    return Qnil;
+  } else {
+    return make_ruby_string(json);
+  }
+}
+
 static VALUE data_map_new(VALUE self) {
   appsignal_data_t* data;
 
@@ -636,6 +651,7 @@ void Init_appsignal_extension(void) {
   rb_define_method(Transaction, "set_metadata",    set_transaction_metadata,    2);
   rb_define_method(Transaction, "finish",          finish_transaction,          1);
   rb_define_method(Transaction, "complete",        complete_transaction,        0);
+  rb_define_method(Transaction, "to_json",         transaction_to_json,         0);
 
   // Create a data map or array
   rb_define_singleton_method(Extension, "data_map_new", data_map_new, 0);
@@ -660,7 +676,7 @@ void Init_appsignal_extension(void) {
   // Data equality
   rb_define_method(Data, "==", data_equal, 1);
 
-  // Get Json content of a data
+  // Get JSON content of a data
   rb_define_method(Data, "to_s", data_to_s, 0);
 
   // Event hook installation

data/lib/appsignal/config.rb

@@ -9,8 +9,9 @@ module Appsignal
     DEFAULT_CONFIG = {
       :debug                          => false,
       :log                            => "file",
-      :ignore_errors                  => [],
       :ignore_actions                 => [],
+      :ignore_errors                  => [],
+      :ignore_namespaces              => [],
       :filter_parameters              => [],
       :send_params                    => true,
       :endpoint                       => "https://push.appsignal.com",
@@ -43,8 +44,9 @@ module Appsignal
       "APPSIGNAL_INSTRUMENT_SEQUEL"              => :instrument_sequel,
       "APPSIGNAL_SKIP_SESSION_DATA"              => :skip_session_data,
       "APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING" => :enable_frontend_error_catching,
-      "APPSIGNAL_IGNORE_ERRORS"                  => :ignore_errors,
       "APPSIGNAL_IGNORE_ACTIONS"                 => :ignore_actions,
+      "APPSIGNAL_IGNORE_ERRORS"                  => :ignore_errors,
+      "APPSIGNAL_IGNORE_NAMESPACES"              => :ignore_namespaces,
       "APPSIGNAL_FILTER_PARAMETERS"              => :filter_parameters,
       "APPSIGNAL_SEND_PARAMS"                    => :send_params,
       "APPSIGNAL_HTTP_PROXY"                     => :http_proxy,
@@ -132,6 +134,7 @@ module Appsignal
       ENV["_APPSIGNAL_HTTP_PROXY"]                   = config_hash[:http_proxy]
       ENV["_APPSIGNAL_IGNORE_ACTIONS"]               = config_hash[:ignore_actions].join(",")
       ENV["_APPSIGNAL_IGNORE_ERRORS"]                = config_hash[:ignore_errors].join(",")
+      ENV["_APPSIGNAL_IGNORE_NAMESPACES"]            = config_hash[:ignore_namespaces].join(",")
       ENV["_APPSIGNAL_FILTER_PARAMETERS"]            = config_hash[:filter_parameters].join(",")
       ENV["_APPSIGNAL_SEND_PARAMS"]                  = config_hash[:send_params].to_s
       ENV["_APPSIGNAL_RUNNING_IN_CONTAINER"]         = config_hash[:running_in_container].to_s
@@ -209,8 +212,8 @@ module Appsignal
       end
 
       # Configuration with array of strings type
-      %w(APPSIGNAL_IGNORE_ERRORS APPSIGNAL_IGNORE_ACTIONS
-         APPSIGNAL_FILTER_PARAMETERS).each do |var|
+      %w(APPSIGNAL_IGNORE_ACTIONS APPSIGNAL_IGNORE_ERRORS
+         APPSIGNAL_IGNORE_NAMESPACES APPSIGNAL_FILTER_PARAMETERS).each do |var|
         env_var = ENV[var]
         next unless env_var
         config[ENV_TO_KEY_MAPPING[var]] = env_var.split(",")

data/lib/appsignal/hooks.rb

@@ -82,16 +82,11 @@ module Appsignal
           value
         end
       end
-
-      def format_args(args)
-        args.map do |arg|
-          truncate(string_or_inspect(arg))
-        end
-      end
     end
   end
 end
 
+require "appsignal/hooks/action_cable"
 require "appsignal/hooks/active_support_notifications"
 require "appsignal/hooks/celluloid"
 require "appsignal/hooks/delayed_job"

data/lib/appsignal/hooks/action_cable.rb

@@ -0,0 +1,113 @@
+module Appsignal
+  class Hooks
+    # @api private
+    class ActionCableHook < Appsignal::Hooks::Hook
+      register :action_cable
+
+      REQUEST_ID = "_appsignal_action_cable.request_id".freeze
+
+      def dependencies_present?
+        defined?(::ActiveSupport::Notifications::Instrumenter) &&
+          defined?(::ActionCable)
+      end
+
+      def install
+        patch_perform_action
+        install_callbacks
+      end
+
+      private
+
+      def patch_perform_action
+        ActionCable::Channel::Base.class_eval do
+          alias_method :original_perform_action, :perform_action
+
+          def perform_action(*args, &block)
+            # The request is only the original websocket request
+            env = connection.env
+            request = ActionDispatch::Request.new(env)
+            env[Appsignal::Hooks::ActionCableHook::REQUEST_ID] ||=
+              request.request_id || SecureRandom.uuid
+
+            transaction = Appsignal::Transaction.create(
+              env[Appsignal::Hooks::ActionCableHook::REQUEST_ID],
+              Appsignal::Transaction::ACTION_CABLE,
+              request
+            )
+
+            begin
+              original_perform_action(*args, &block)
+            rescue => exception
+              transaction.set_error(exception)
+              raise exception
+            ensure
+              transaction.params = args.first
+              transaction.set_action_if_nil("#{self.class}##{args.first["action"]}")
+              transaction.set_metadata("path", request.path)
+              transaction.set_metadata("method", "websocket")
+              Appsignal::Transaction.complete_current!
+            end
+          end
+        end
+      end
+
+      def install_callbacks
+        ActionCable::Channel::Base.set_callback :subscribe, :around, :prepend => true do |channel, inner|
+          # The request is only the original websocket request
+          env = channel.connection.env
+          request = ActionDispatch::Request.new(env)
+          env[Appsignal::Hooks::ActionCableHook::REQUEST_ID] ||=
+            request.request_id || SecureRandom.uuid
+
+          transaction = Appsignal::Transaction.create(
+            env[Appsignal::Hooks::ActionCableHook::REQUEST_ID],
+            Appsignal::Transaction::ACTION_CABLE,
+            request
+          )
+
+          begin
+            Appsignal.instrument "subscribed.action_cable" do
+              inner.call
+            end
+          rescue => exception
+            transaction.set_error(exception)
+            raise exception
+          ensure
+            transaction.set_action_if_nil("#{channel.class}#subscribed")
+            transaction.set_metadata("path", request.path)
+            transaction.set_metadata("method", "websocket")
+            Appsignal::Transaction.complete_current!
+          end
+        end
+
+        ActionCable::Channel::Base.set_callback :unsubscribe, :around, :prepend => true do |channel, inner|
+          # The request is only the original websocket request
+          env = channel.connection.env
+          request = ActionDispatch::Request.new(env)
+          env[Appsignal::Hooks::ActionCableHook::REQUEST_ID] ||=
+            request.request_id || SecureRandom.uuid
+
+          transaction = Appsignal::Transaction.create(
+            env[Appsignal::Hooks::ActionCableHook::REQUEST_ID],
+            Appsignal::Transaction::ACTION_CABLE,
+            request
+          )
+
+          begin
+            Appsignal.instrument "unsubscribed.action_cable" do
+              inner.call
+            end
+          rescue => exception
+            transaction.set_error(exception)
+            raise exception
+          ensure
+            transaction.set_action_if_nil("#{channel.class}#unsubscribed")
+            transaction.set_metadata("path", request.path)
+            transaction.set_metadata("method", "websocket")
+            Appsignal::Transaction.complete_current!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/hooks/active_support_notifications.rb

@@ -11,6 +11,16 @@ module Appsignal
       end
 
       def install
+        ::ActiveSupport::Notifications.class_eval do
+          def self.instrument(name, payload = {})
+            # Don't check the notifier if any subscriber is listening:
+            # AppSignal is listening
+            instrumenter.instrument(name, payload) do
+              yield payload if block_given?
+            end
+          end
+        end
+
         ::ActiveSupport::Notifications::Instrumenter.class_eval do
           alias instrument_without_appsignal instrument
 
@@ -23,8 +33,8 @@ module Appsignal
               transaction.start_event
             end
 
-            return_value = instrument_without_appsignal(name, payload, &block)
-
+            instrument_without_appsignal(name, payload, &block)
+          ensure
             if instrument_this
               title, body, body_format = Appsignal::EventFormatter.format(name, payload)
               transaction.finish_event(
@@ -34,8 +44,6 @@ module Appsignal
                 body_format
               )
             end
-
-            return_value
           end
         end
       end

data/lib/appsignal/hooks/shoryuken.rb

@@ -2,21 +2,21 @@ module Appsignal
   class Hooks
     # @api private
     class ShoryukenMiddleware
-      def call(_worker_instance, queue, sqs_msg, body)
-        metadata = {
-          :queue => queue
-        }
-        exclude_keys = [:job_class, :queue_name, :arguments]
-        metadata.merge!(body.reject { |key| exclude_keys.member?(key.to_sym) })
-        metadata.merge!(sqs_msg.attributes)
-
+      def call(worker_instance, queue, sqs_msg, body)
+        metadata = { :queue => queue }.merge(sqs_msg.attributes)
         options = {
-          :class => body["job_class"],
+          :class => worker_instance.class.name,
           :method => "perform",
           :metadata => metadata
         }
-        options[:params] = body["arguments"] if body.key?("arguments")
-        options[:queue_start] = Time.at(sqs_msg.attributes["SentTimestamp"].to_i / 1000) if sqs_msg.attributes.key?("SentTimestamp")
+
+        args = body.is_a?(Hash) ? body : { :params => body }
+        options[:params] = Appsignal::Utils::ParamsSanitizer.sanitize args,
+          :filter_parameters => Appsignal.config[:filter_parameters]
+
+        if sqs_msg.attributes.key?("SentTimestamp")
+          options[:queue_start] = Time.at(sqs_msg.attributes["SentTimestamp"].to_i / 1000)
+        end
 
         Appsignal.monitor_transaction("perform_job.shoryuken", options) do
           yield

data/lib/appsignal/hooks/sidekiq.rb

@@ -14,12 +14,14 @@ module Appsignal
       end
 
       def call(_worker, item, _queue)
-        params =
+        args =
           if item["class"] == "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"
-            format_args(item["args"].first["arguments"])
+            item["args"].first["arguments"]
           else
-            format_args(item["args"])
+            item["args"]
           end
+        params = Appsignal::Utils::ParamsSanitizer.sanitize args,
+          :filter_parameters => Appsignal.config[:filter_parameters]
 
         Appsignal.monitor_transaction(
           "perform_job.sidekiq",

data/lib/appsignal/integrations/delayed_job_plugin.rb

@@ -26,7 +26,11 @@ module Appsignal
           class_name, method_name = job.job_data[:name].split("#")
           args = job.job_data[:args] || {}
           job_data = job.job_data
+        else
+          args = {}
         end
+        params = Appsignal::Utils::ParamsSanitizer.sanitize args,
+          :filter_parameters => Appsignal.config[:filter_parameters]
 
         Appsignal.monitor_transaction(
           "perform_job.delayed_job",
@@ -38,7 +42,7 @@ module Appsignal
             :priority => extract_value(job_data, :priority, 0),
             :attempts => extract_value(job_data, :attempts, 0)
           },
-          :params      => format_args(args),
+          :params      => params,
           :queue_start => extract_value(job_data, :created_at)
         ) do
           block.call(job)

data/lib/appsignal/integrations/resque_active_job.rb

@@ -7,11 +7,14 @@ module Appsignal
       def self.included(base)
         base.class_eval do
           around_perform do |job, block|
+            params = Appsignal::Utils::ParamsSanitizer.sanitize job.arguments,
+              :filter_parameters => Appsignal.config[:filter_parameters]
+
             Appsignal.monitor_single_transaction(
               "perform_job.resque",
               :class    => job.class.to_s,
               :method   => "perform",
-              :params   => job.format_args(job.arguments),
+              :params   => params,
               :metadata => {
                 :id       => job.job_id,
                 :queue    => job.queue_name

data/lib/appsignal/transaction.rb

@@ -4,6 +4,7 @@ module Appsignal
   class Transaction
     HTTP_REQUEST   = "http_request".freeze
     BACKGROUND_JOB = "background_job".freeze
+    ACTION_CABLE   = "action_cable".freeze
     FRONTEND       = "frontend".freeze
     BLANK          = "".freeze
 
@@ -32,7 +33,9 @@ module Appsignal
         # Check if we already have a running transaction
         if Thread.current[:appsignal_transaction] != nil
           # Log the issue and return the current transaction
-          Appsignal.logger.debug("Trying to start new transaction #{id} but #{current.transaction_id} is already running. Using #{current.transaction_id}")
+          Appsignal.logger.debug "Trying to start new transaction with id " \
+            "'#{id}', but a transaction with id '#{current.transaction_id}' " \
+            "is already running. Using transaction '#{current.transaction_id}'."
 
           # Return the current (running) transaction
           current
@@ -61,6 +64,18 @@ module Appsignal
 
     attr_reader :ext, :transaction_id, :action, :namespace, :request, :paused, :tags, :options, :discarded
 
+    # @!attribute params
+    #   Attribute for parameters of the transaction.
+    #
+    #   When no parameters are set with {#params=} the parameters it will look
+    #   for parameters on the {#request} environment.
+    #
+    #   The parameters set using {#params=} are leading over those extracted
+    #   from a request's environment.
+    #
+    #   @return [Hash]
+    attr_writer :params
+
     def initialize(transaction_id, namespace, request, options = {})
       @transaction_id = transaction_id
       @action = nil
@@ -86,7 +101,8 @@ module Appsignal
 
     def complete
       if discarded?
-        Appsignal.logger.debug("Skipping transaction because it was manually discarded.".freeze)
+        Appsignal.logger.debug "Skipping transaction '#{transaction_id}' " \
+          "because it was manually discarded."
         return
       end
       if @ext.finish(self.class.garbage_collection_profiler.total_time)
@@ -123,6 +139,11 @@ module Appsignal
       @store[key]
     end
 
+    def params
+      return @params if defined?(@params)
+      request_params
+    end
+
     # Set tags on the transaction.
     #
     # @param given_tags [Hash] Collection of tags.
@@ -291,6 +312,11 @@ module Appsignal
       finish_event(name, title, body, body_format)
     end
 
+    def to_h
+      JSON.parse(@ext.to_json)
+    end
+    alias_method :to_hash, :to_h
+
     class GenericRequest
       attr_reader :env
 
@@ -348,17 +374,6 @@ module Appsignal
 
     def sanitized_params
       return unless Appsignal.config[:send_params]
-      return unless request.respond_to?(options[:params_method])
-
-      params =
-        begin
-          request.send options[:params_method]
-        rescue => e
-          # Getting params from the request has been know to fail.
-          Appsignal.logger.debug "Exception while getting params: #{e}"
-          nil
-        end
-      return unless params
 
       options = {}
       if Appsignal.config[:filter_parameters]
@@ -367,6 +382,18 @@ module Appsignal
       Appsignal::Utils::ParamsSanitizer.sanitize params, options
     end
 
+    def request_params
+      return unless request.respond_to?(options[:params_method])
+
+      begin
+        request.send options[:params_method]
+      rescue => e
+        # Getting params from the request has been know to fail.
+        Appsignal.logger.debug "Exception while getting params: #{e}"
+        nil
+      end
+    end
+
     # Returns sanitized environment for a transaction.
     #
     # The environment of a transaction can contain a lot of information, not