appsignal 2.1.2 → 2.2.0.beta.1

data/lib/appsignal/hooks.rb

@@ -1,4 +1,5 @@
 module Appsignal
+  # @api private
   class Hooks
     class << self
       def register(name, hook)

data/lib/appsignal/hooks/active_support_notifications.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class Hooks
+    # @api private
     class ActiveSupportNotificationsHook < Appsignal::Hooks::Hook
       register :active_support_notifications
 

data/lib/appsignal/hooks/celluloid.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class Hooks
+    # @api private
     class CelluloidHook < Appsignal::Hooks::Hook
       register :celluloid
 

data/lib/appsignal/hooks/data_mapper.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class Hooks
+    # @api private
     class DataMapperHook < Appsignal::Hooks::Hook
       register :data_mapper
 

data/lib/appsignal/hooks/delayed_job.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class Hooks
+    # @api private
     class DelayedJobHook < Appsignal::Hooks::Hook
       register :delayed_job
 

data/lib/appsignal/hooks/mongo_ruby_driver.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class Hooks
+    # @api private
     class MongoRubyDriverHook < Appsignal::Hooks::Hook
       register :mongo_ruby_driver
 

data/lib/appsignal/hooks/net_http.rb

@@ -2,6 +2,7 @@ require "net/http"
 
 module Appsignal
   class Hooks
+    # @api private
     class NetHttpHook < Appsignal::Hooks::Hook
       register :net_http
 

data/lib/appsignal/hooks/passenger.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class Hooks
+    # @api private
     class PassengerHook < Appsignal::Hooks::Hook
       register :passenger
 

data/lib/appsignal/hooks/puma.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class Hooks
+    # @api private
     class PumaHook < Appsignal::Hooks::Hook
       register :puma
 

data/lib/appsignal/hooks/rake.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class Hooks
+    # @api private
     class RakeHook < Appsignal::Hooks::Hook
       register :rake
 

data/lib/appsignal/hooks/redis.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class Hooks
+    # @api private
     class RedisHook < Appsignal::Hooks::Hook
       register :redis
 

data/lib/appsignal/hooks/sequel.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class Hooks
+    # @api private
     module SequelLogExtension
       # Add query instrumentation
       def log_yield(sql, args = nil)

data/lib/appsignal/hooks/shoryuken.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class Hooks
+    # @api private
     class ShoryukenMiddleware
       def call(_worker_instance, queue, sqs_msg, body)
         metadata = {

data/lib/appsignal/hooks/sidekiq.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class Hooks
+    # @api private
     class SidekiqPlugin
       include Appsignal::Hooks::Helpers
 

data/lib/appsignal/hooks/unicorn.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class Hooks
+    # @api private
     class UnicornHook < Appsignal::Hooks::Hook
       register :unicorn
 

data/lib/appsignal/hooks/webmachine.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class Hooks
+    # @api private
     class WebmachineHook < Appsignal::Hooks::Hook
       register :webmachine
 

data/lib/appsignal/integrations/capistrano/appsignal.cap

@@ -1,11 +1,11 @@
 namespace :appsignal do
   task :deploy do
-    env = fetch(:appsignal_env, fetch(:stage, fetch(:rails_env, fetch(:rack_env, 'production'))))
-    user = ENV['USER'] || ENV['USERNAME']
+    env = fetch(:appsignal_env, fetch(:stage, fetch(:rails_env, fetch(:rack_env, "production"))))
+    user = ENV["USER"] || ENV["USERNAME"]
     revision = fetch(:appsignal_revision, fetch(:current_revision))
 
     appsignal_config = Appsignal::Config.new(
-      ENV['PWD'],
+      ENV["PWD"],
       env,
       fetch(:appsignal_config, {}),
       Logger.new(StringIO.new)
@@ -25,4 +25,4 @@ namespace :appsignal do
   end
 end
 
-after 'deploy:finished', 'appsignal:deploy'
+after "deploy:finished", "appsignal:deploy"

data/lib/appsignal/integrations/capistrano/capistrano_2_tasks.rb

@@ -1,4 +1,6 @@
 module Appsignal
+  # @todo Move to sub-namespace
+  # @api private
   class Capistrano
     def self.tasks(config)
       config.load do

data/lib/appsignal/integrations/data_mapper.rb

@@ -6,7 +6,7 @@ module Appsignal
         "DataObjects::Sqlite3::Connection",
         "DataObjects::Mysql::Connection",
         "DataObjects::Postgres::Connection"
-      ]
+      ].freeze
 
       def log(message)
         # If scheme is SQL-like, try to sanitize it, otherwise clear the body

data/lib/appsignal/integrations/delayed_job_plugin.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class Hooks
+    # @api private
     class DelayedJobPlugin < ::Delayed::Plugin
       extend Appsignal::Hooks::Helpers
 

data/lib/appsignal/integrations/grape.rb

@@ -1,4 +1,6 @@
 module Appsignal
+  # @todo Move to sub-namespace
+  # @api private
   module Grape
     class Middleware < ::Grape::Middleware::Base
       def call(env)
@@ -37,7 +39,7 @@ module Appsignal
             path = "/#{path}" if path[0] != "/"
             path = "#{namespace}#{path}"
 
-            transaction.set_action("#{request_method}::#{klass}##{path}")
+            transaction.set_action_if_nil("#{request_method}::#{klass}##{path}")
           end
 
           transaction.set_http_or_background_queue_start

data/lib/appsignal/integrations/mongo_ruby_driver.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class Hooks
+    # @api private
     class MongoMonitorSubscriber
       # Called by Mongo::Monitor when query starts
       def started(event)

data/lib/appsignal/integrations/padrino.rb

@@ -1,19 +1,18 @@
 require "appsignal"
 
-module Appsignal::Integrations
-  module PadrinoPlugin
-    def self.init
-      Appsignal.logger.info("Loading Padrino (#{Padrino::VERSION}) integration")
+module Appsignal
+  module Integrations
+    # @api private
+    module PadrinoPlugin
+      def self.init
+        Appsignal.logger.info("Loading Padrino (#{Padrino::VERSION}) integration")
 
-      root             = Padrino.mounted_root
-      Appsignal.config = Appsignal::Config.new(
-        root,
-        Padrino.env,
-        :log_path => File.join(root, "log")
-      )
+        root = Padrino.mounted_root
+        Appsignal.config = Appsignal::Config.new(root, Padrino.env)
 
-      Appsignal.start_logger
-      Appsignal.start
+        Appsignal.start_logger
+        Appsignal.start
+      end
     end
   end
 end
@@ -23,8 +22,7 @@ module Padrino::Routing::InstanceMethods
 
   def route!(base = settings, pass_block = nil)
     if !Appsignal.active? || env["sinatra.static_file"]
-      route_without_appsignal(base, pass_block)
-      return
+      return route_without_appsignal(base, pass_block)
     end
 
     transaction = Appsignal::Transaction.create(
@@ -40,7 +38,7 @@ module Padrino::Routing::InstanceMethods
       transaction.set_error(error)
       raise error
     ensure
-      transaction.set_action(get_payload_action(request))
+      transaction.set_action_if_nil(get_payload_action(request))
       transaction.set_metadata("path", request.path)
       transaction.set_metadata("method", request.request_method)
       transaction.set_http_or_background_queue_start
@@ -48,19 +46,36 @@ module Padrino::Routing::InstanceMethods
     end
   end
 
+  private
+
   def get_payload_action(request)
     # Short-circut is there's no request object to obtain information from
-    return settings.name.to_s if request.nil?
+    return settings.name.to_s unless request
+
+    # Newer versions expose the action / controller on the request class.
+    # Newer versions also still expose a route_obj so we must prioritize the
+    # action/fullpath methods.
+    # The `request.action` and `request.controller` values are `nil` when a
+    # endpoint is not found, `""` if not specified by the user.
+    controller_name = request.controller if request.respond_to?(:controller)
+    action_name = request.action if request.respond_to?(:action)
+    action_name ||= ""
+    if action_name.empty? && request.respond_to?(:fullpath)
+      action_name = request.fullpath
+    end
+
+    unless action_name.empty?
+      return "#{settings.name}:#{controller_name}##{action_name}"
+    end
 
     # Older versions of Padrino work with a route object
-    route_obj = defined?(request.route_obj) && request.route_obj
-    if route_obj && route_obj.respond_to?(:original_path)
+    if request.respond_to?(:route_obj) && request.route_obj
       return "#{settings.name}:#{request.route_obj.original_path}"
     end
 
-    # Newer versions expose the action / controller on the request class
-    request_data = request.respond_to?(:action) ? request.action : request.fullpath
-    "#{settings.name}:#{request.controller}##{request_data}"
+    # Fall back to the application name if we haven't found an action name in
+    # any previous methods.
+    settings.name.to_s
   end
 end
 

data/lib/appsignal/integrations/railtie.rb

@@ -4,6 +4,7 @@ require "appsignal/rack/rails_instrumentation"
 
 module Appsignal
   module Integrations
+    # @api private
     class Railtie < ::Rails::Railtie
       initializer "appsignal.configure_rails_initialization" do |app|
         Appsignal::Integrations::Railtie.initialize_appsignal(app)
@@ -26,8 +27,7 @@ module Appsignal
           Appsignal::Rack::RailsInstrumentation
         )
 
-        if Appsignal.config.active? &&
-            Appsignal.config[:enable_frontend_error_catching] == true
+        if Appsignal.config[:enable_frontend_error_catching]
           app.middleware.insert_before(
             Appsignal::Rack::RailsInstrumentation,
             Appsignal::Rack::JSExceptionCatcher

data/lib/appsignal/integrations/resque.rb

@@ -1,5 +1,6 @@
 module Appsignal
   module Integrations
+    # @api private
     module ResquePlugin
       # Do not use this file as a template for your own background processor
       # Resque is an exception to the rule and the code below causes the

data/lib/appsignal/integrations/resque_active_job.rb

@@ -1,5 +1,6 @@
 module Appsignal
   module Integrations
+    # @api private
     module ResqueActiveJobPlugin
       include Appsignal::Hooks::Helpers
 

data/lib/appsignal/integrations/webmachine.rb

@@ -1,32 +1,35 @@
-module Appsignal::Integrations
-  module WebmachinePlugin
-    module FSM
-      def run_with_appsignal
-        transaction = Appsignal::Transaction.create(
-          SecureRandom.uuid,
-          Appsignal::Transaction::HTTP_REQUEST,
-          request,
-          :params_method => :query
-        )
+module Appsignal
+  module Integrations
+    # @api private
+    module WebmachinePlugin
+      module FSM
+        def run_with_appsignal
+          transaction = Appsignal::Transaction.create(
+            SecureRandom.uuid,
+            Appsignal::Transaction::HTTP_REQUEST,
+            request,
+            :params_method => :query
+          )
 
-        transaction.set_action("#{resource.class.name}##{request.method}")
+          transaction.set_action_if_nil("#{resource.class.name}##{request.method}")
 
-        Appsignal.instrument("process_action.webmachine") do
-          run_without_appsignal
-        end
+          Appsignal.instrument("process_action.webmachine") do
+            run_without_appsignal
+          end
 
-        Appsignal::Transaction.complete_current!
-      end
+          Appsignal::Transaction.complete_current!
+        end
 
-      private
+        private
 
-      def handle_exceptions_with_appsignal
-        handle_exceptions_without_appsignal do
-          begin
-            yield
-          rescue => e
-            Appsignal.set_error(e)
-            raise e
+        def handle_exceptions_with_appsignal
+          handle_exceptions_without_appsignal do
+            begin
+              yield
+            rescue => e
+              Appsignal.set_error(e)
+              raise e
+            end
           end
         end
       end

data/lib/appsignal/js_exception_transaction.rb

@@ -14,17 +14,17 @@ module Appsignal
     end
 
     def set_action
-      @ext.set_action(@data["action"]) if @data["action"]
+      return unless @data["action"]
+      ext.set_action(@data["action"])
     end
 
     def set_metadata
-      @ext.set_metadata(
-        "path", @data["path"]
-      ) if @data["path"]
+      return unless @data["path"]
+      ext.set_metadata("path", @data["path"])
     end
 
     def set_error
-      @ext.set_error(
+      ext.set_error(
         @data["name"],
         @data["message"] || "",
         Appsignal::Utils.data_generate(@data["backtrace"] || [])
@@ -39,7 +39,7 @@ module Appsignal
         :tags         => @data["tags"]
       }.each do |key, data|
         next unless data.is_a?(Array) || data.is_a?(Hash)
-        @ext.set_sample_data(
+        ext.set_sample_data(
           key.to_s,
           Appsignal::Utils.data_generate(data)
         )
@@ -47,8 +47,8 @@ module Appsignal
     end
 
     def complete!
-      @ext.finish(0)
-      @ext.complete
+      ext.finish(0)
+      ext.complete
     end
   end
 end

data/lib/appsignal/marker.rb

@@ -1,23 +1,60 @@
 module Appsignal
+  # Deploy markers are used on AppSignal.com to indicate changes in an
+  # application, "Deploy markers" indicate a deploy of an application.
+  #
+  # Incidents for exceptions and performance issues will be closed and
+  # reopened if they occur again in the new deploy.
+  #
+  # This class will help send a request to the AppSignal Push API to create a
+  # Deploy marker for the application on AppSignal.com.
+  #
+  # @!attribute [r] marker_data
+  #   @return [Hash] marker data to send.
+  #
+  # @!attribute [r] config
+  #   @return [Appsignal::Config] config to use in the authentication request.
+  #     Set config does not override data set in {#marker_data}.
+  #
+  # @see Appsignal::CLI::NotifyOfDeploy
+  # @see http://docs.appsignal.com/appsignal/terminology.html#markers
+  #   Terminology: Deploy marker
+  # @api private
   class Marker
+    # Path used on the AppSignal Push API
+    # https://push.appsignal.com/1/markers
+    ACTION = "markers".freeze
+
     attr_reader :marker_data, :config
-    ACTION = "markers"
 
+    # @param marker_data [Hash] see {#marker_data}
+    # @option marker_data :environment [String] environment to load
+    #   configuration for.
+    # @option marker_data :name [String] name of the application.
+    # @option marker_data :user [String] name of the user that is creating the
+    #   marker.
+    # @option marker_data :revision [String] the revision that has been
+    #   deployed. E.g. a git commit SHA.
+    # @param config [Appsignal::Config]
     def initialize(marker_data, config)
       @marker_data = marker_data
       @config = config
     end
 
+    # Send a request to create the marker.
+    #
+    # Prints output to STDOUT.
+    #
+    # @return [void]
     def transmit
       transmitter = Transmitter.new(ACTION, config)
       puts "Notifying AppSignal of deploy with: "\
         "revision: #{marker_data[:revision]}, user: #{marker_data[:user]}"
 
-      result = transmitter.transmit(marker_data)
-      if result == "200"
+      response = transmitter.transmit(marker_data)
+      if response.code == "200"
         puts "AppSignal has been notified of this deploy!"
       else
-        raise "#{result} at #{transmitter.uri}"
+        raise "#{response.code} at #{transmitter.uri}"
       end
     rescue => e
       puts "Something went wrong while trying to notify AppSignal: #{e}"