appsignal 0.6.7 → 0.7.0.alpha.1

data/lib/appsignal/config.rb

@@ -1,7 +1,6 @@
 require 'erb'
 require 'yaml'
-require 'appsignal/careful_logger'
-require 'erb'
+require 'appsignal/integrations/capistrano/careful_logger'
 
 module Appsignal
   class Config
@@ -13,85 +12,71 @@ module Appsignal
       :slow_request_threshold => 200
     }.freeze
 
-    attr_reader :configurations, :project_path, :env
+    attr_reader :root_path, :env, :config_hash
 
-    def initialize(project_path, env, logger=Appsignal.logger)
-      @project_path = project_path || ENV['PWD']
-      @env = env.to_sym
+    def initialize(root_path, env, logger=Appsignal.logger)
+      @root_path = root_path
+      @env = env
       @logger = logger
-      @configurations = {}
-    end
 
-    def load
-      return unless load_configurations
-      return unless current_environment_present
-      warn_if_duplicate_api_keys
-
-      if Appsignal.respond_to?(:logger) && @logger == Appsignal.logger
-        @logger.level = Logger::DEBUG if configurations[env][:debug]
+      if File.exists?(config_file)
+        load_config_from_disk
+      elsif ENV['APPSIGNAL_PUSH_API_KEY']
+        load_default_config_with_push_api_key(
+          ENV['APPSIGNAL_PUSH_API_KEY']
+        )
+      elsif ENV['APPSIGNAL_API_KEY']
+        load_default_config_with_push_api_key(
+          ENV['APPSIGNAL_API_KEY']
+        )
+      else
+        carefully_log_error(
+          "Not loading: No config file found at '#{config_file}' " \
+          "and no APPSIGNAL_PUSH_API_KEY env var present"
+        )
       end
-      DEFAULT_CONFIG.merge(configurations[env])
     end
 
-    def load_all
-      return unless load_configurations
-      warn_if_duplicate_api_keys
+    def loaded?
+      !! config_hash
+    end
 
-      {}.tap do |result|
-        configurations.each do |env, config|
-          result[env] = DEFAULT_CONFIG.merge(config)
-        end
-      end
+    def [](key)
+      return unless loaded?
+      config_hash[key]
     end
 
     protected
 
     def config_file
-      File.join(project_path, 'config', 'appsignal.yml')
+      @config_file ||= File.join(root_path, 'config', 'appsignal.yml')
     end
 
-    def load_configurations
-      unless load_configurations_from_disk || load_configurations_from_env
-        carefully_log_error "no config file found at '#{config_file}'
-          and no APPSIGNAL_API_KEY found in ENV"
-        return false
-      end
-      true
-    end
+    def load_config_from_disk
+      configurations = YAML.load(ERB.new(IO.read(config_file)).result)
+      config_for_this_env = configurations[env]
+      if config_for_this_env
+        config_for_this_env = Hash[config_for_this_env.map do |key, value|
+          [key.to_sym, value]
+        end] # convert keys to symbols
 
-    def load_configurations_from_disk
-      file = config_file
-      unless File.exists?(file)
-        return false
-      end
-      @configurations = YAML.load(ERB.new(IO.read(file)).result)
-      configurations.each { |k,v| v.symbolize_keys! }
-      configurations.symbolize_keys!
-      true
-    end
+        # Backwards compatibility with config files generated by earlier
+        # versions of the gem
+        if !config_for_this_env[:push_api_key] && config_for_this_env[:api_key]
+          config_for_this_env[:push_api_key] = config_for_this_env[:api_key]
+        end
 
-    def load_configurations_from_env
-      api_key = ENV['APPSIGNAL_API_KEY']
-      env = ENV['RAILS_ENV'] || :production
-      if api_key.present?
-        @configurations = {env.to_sym => {:api_key => api_key, :active => true}}
-        true
+        @config_hash = DEFAULT_CONFIG.merge(config_for_this_env)
       else
-        false
-      end
-    end
-
-    def warn_if_duplicate_api_keys
-      keys = configurations.each_value.map { |config| config[:api_key] }.compact
-      if keys.uniq.count < keys.count
-        carefully_log_error('Warning: Duplicate API keys found in appsignal.yml')
+        carefully_log_error("Not loading: config for '#{env}' not found")
       end
     end
 
-    def current_environment_present
-      return true if configurations[env].present?
-      carefully_log_error "config for '#{env}' not found"
-      false
+    def load_default_config_with_push_api_key(key)
+      @config_hash = DEFAULT_CONFIG.merge(
+        :push_api_key => key,
+        :active => true
+      )
     end
   end
 end

data/lib/appsignal/integrations/capistrano.rb

@@ -0,0 +1,44 @@
+require 'capistrano'
+
+module Appsignal
+  module Integrations
+    class Capistrano
+      def self.tasks(config)
+        config.load do
+          after 'deploy', 'appsignal:deploy'
+          after 'deploy:migrations', 'appsignal:deploy'
+
+          namespace :appsignal do
+            task :deploy do
+              env = fetch(:rails_env, fetch(:rack_env, 'production'))
+              user = ENV['USER'] || ENV['USERNAME']
+
+              appsignal_config = Appsignal::Config.new(
+                ENV['PWD'],
+                env,
+                logger
+              )
+
+              marker_data = {
+                :revision => current_revision,
+                :repository => repository,
+                :user => user
+              }
+
+              marker = Marker.new(marker_data, appsignal_config, logger)
+              if config.dry_run
+                logger.info('Dry run: Deploy marker not actually sent.')
+              else
+                marker.transmit
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+if ::Capistrano::Configuration.instance
+  Appsignal::Integrations::Capistrano.tasks(::Capistrano::Configuration.instance)
+end

data/lib/appsignal/{careful_logger.rb → integrations/capistrano/careful_logger.rb}

@@ -1,5 +1,7 @@
 module Appsignal
   module CarefulLogger
+    # Because Capistrano's logger uses the term important
+    # instead of error.
     def carefully_log_error(message)
       if @logger.respond_to?(:important)
         @logger.important(message)

data/lib/appsignal/integrations/passenger.rb

@@ -1,13 +1,13 @@
-if defined?(PhusionPassenger)
-  Appsignal.logger.info("Using Passenger")
+if defined?(::PhusionPassenger)
+  Appsignal.logger.info('Using Passenger')
 
-  PhusionPassenger.on_event(:starting_worker_process) do |forked|
-    Appsignal.logger.debug("starting worker process")
+  ::PhusionPassenger.on_event(:starting_worker_process) do |forked|
+    Appsignal.logger.debug('starting worker process')
     Appsignal.agent.forked!
   end
 
-  PhusionPassenger.on_event(:stopping_worker_process) do
-    Appsignal.logger.debug("stopping worker process")
+  ::PhusionPassenger.on_event(:stopping_worker_process) do
+    Appsignal.logger.debug('stopping worker process')
     Appsignal.agent.shutdown(true)
   end
 end

data/lib/appsignal/integrations/rails.rb

@@ -0,0 +1,33 @@
+if defined?(::Rails)
+  module Appsignal
+    module Integrations
+      class Railtie < ::Rails::Railtie
+        initializer 'appsignal.configure_rails_initialization' do |app|
+          app.middleware.insert_before(
+            ActionDispatch::RemoteIp,
+            Appsignal::Rack::Listener
+          )
+        end
+
+        config.after_initialize do
+          # Setup logging
+          if File.writable?(Rails.root.join('log'))
+            output = Rails.root.join('log/appsignal.log')
+          else
+            output = STDOUT
+          end
+          Appsignal.logger = Logger.new(output).tap do |l|
+            l.level = Logger::INFO
+          end
+          Appsignal.flush_in_memory_log
+
+          # Load config
+          Appsignal.config = Appsignal::Config.new(Rails.root, Rails.env)
+
+          # Start agent if config for this env is present
+          Appsignal.start if Appsignal.active?
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/integrations/sinatra.rb

@@ -0,0 +1,20 @@
+require 'appsignal'
+
+Appsignal.logger.info('Loading Sinatra integration')
+
+app_settings = ::Sinatra::Application.settings
+Appsignal.config = Appsignal::Config.new(
+  app_settings.root,
+  app_settings.environment.to_s
+)
+
+Appsignal.logger = Logger.new(File.join(app_settings.root, 'appsignal.log')).tap do |l|
+  l.level = Logger::DEBUG
+end
+Appsignal.flush_in_memory_log
+
+if Appsignal.active?
+  Appsignal.start
+  ::Sinatra::Application.use(Appsignal::Rack::Listener)
+  ::Sinatra::Application.use(Appsignal::Rack::Instrumentation)
+end

data/lib/appsignal/marker.rb

@@ -1,4 +1,4 @@
-require 'appsignal/careful_logger'
+require 'appsignal/integrations/capistrano/careful_logger'
 
 module Appsignal
   class Marker
@@ -7,27 +7,26 @@ module Appsignal
     attr_reader :marker_data, :config, :logger
     ACTION = 'markers'
 
-    def initialize(marker_data, root_path, rails_env, logger)
+    def initialize(marker_data, config, logger)
       @marker_data = marker_data
-      @config = Appsignal::Config.new(root_path, rails_env, logger).load
+      @config = config
       @logger = logger
     end
 
     def transmit
       begin
-        transmitter = Transmitter.new(
-          @config[:endpoint], ACTION, @config[:api_key]
-        )
-        @logger.info("Notifying Appsignal of deploy...")
+        transmitter = Transmitter.new(ACTION, config)
+        logger.info('Notifying Appsignal of deploy...')
         result = transmitter.transmit(marker_data)
         if result == '200'
-          @logger.info("Appsignal has been notified of this deploy!")
+          logger.info('Appsignal has been notified of this deploy!')
         else
           raise "#{result} at #{transmitter.uri}"
         end
       rescue Exception => e
-        message = "Something went wrong while trying to notify Appsignal: #{e}"
-        carefully_log_error message
+        carefully_log_error(
+          "Something went wrong while trying to notify Appsignal: #{e}"
+        )
       end
     end
   end

data/lib/appsignal/rack/instrumentation.rb

@@ -0,0 +1,28 @@
+module Appsignal
+  module Rack
+    class Instrumentation
+      def initialize(app, options = {})
+        @app, @options = app, options
+      end
+
+      def call(env)
+        ActiveSupport::Notifications.instrument(
+          'process_action.rack',
+          raw_payload(env)
+        ) do |payload|
+          @app.call(env)
+        end
+      end
+
+      def raw_payload(env)
+        request = ::Rack::Request.new(env)
+        {
+          :action => "#{request.request_method}:#{request.path}",
+          :params => request.params,
+          :method => request.request_method,
+          :path   => request.path
+        }
+      end
+    end
+  end
+end

data/lib/appsignal/rack/listener.rb

@@ -0,0 +1,33 @@
+module Appsignal
+  module Rack
+    class Listener
+      def initialize(app, options = {})
+        @app, @options = app, options
+      end
+
+      def call(env)
+        if Appsignal.active?
+          call_with_appsignal_monitoring(env)
+        else
+          @app.call(env)
+        end
+      end
+
+      def call_with_appsignal_monitoring(env)
+        Appsignal::Transaction.create(request_id(env), env)
+        @app.call(env)
+      rescue Exception => exception
+        unless Appsignal.is_ignored_exception?(exception)
+          Appsignal::Transaction.current.add_exception(exception)
+        end
+        raise exception
+      ensure
+        Appsignal::Transaction.current.complete!
+      end
+
+      def request_id(env)
+        env['action_dispatch.request_id'] || SecureRandom.uuid
+      end
+    end
+  end
+end

data/lib/appsignal/transaction.rb

@@ -1,7 +1,3 @@
-require 'socket'
-require 'appsignal/transaction/transaction_formatter'
-require 'appsignal/transaction/params_sanitizer'
-
 module Appsignal
   class Transaction
     # Based on what Rails uses + some variables we'd like to show
@@ -26,7 +22,7 @@ module Appsignal
     end
 
     attr_reader :request_id, :events, :process_action_event, :action, :exception,
-      :env, :fullpath, :time, :tags
+                :env, :fullpath, :time, :tags
 
     def initialize(request_id, env)
       @request_id = request_id
@@ -46,7 +42,7 @@ module Appsignal
     end
 
     def request
-      ActionDispatch::Request.new(@env)
+      ::Rack::Request.new(@env)
     end
 
     def set_tags(given_tags={})
@@ -75,8 +71,7 @@ module Appsignal
 
     def slow_request?
       return false unless process_action_event && process_action_event.payload
-      Appsignal.config[:slow_request_threshold] <=
-        process_action_event.duration
+      Appsignal.config[:slow_request_threshold] <= process_action_event.duration
     end
 
     def slower?(transaction)
@@ -93,8 +88,8 @@ module Appsignal
     end
 
     def convert_values_to_primitives!
-      Appsignal::ParamsSanitizer.sanitize!(@process_action_event.payload) if @process_action_event
-      @events.each { |o| Appsignal::ParamsSanitizer.sanitize!(o.payload) }
+      Appsignal::Transaction::ParamsSanitizer.sanitize!(@process_action_event.payload) if @process_action_event
+      @events.each { |o| Appsignal::Transaction::ParamsSanitizer.sanitize!(o.payload) }
       add_sanitized_context!
     end
 
@@ -105,7 +100,7 @@ module Appsignal
     end
 
     def to_hash
-      TransactionFormatter.new(self).to_hash
+      Formatter.new(self).to_hash
     end
 
     def complete!
@@ -121,6 +116,17 @@ module Appsignal
 
     protected
 
+    def http_queue_start
+      return unless env
+      env_var = env['HTTP_X_QUEUE_START'] || env['HTTP_X_REQUEST_START']
+      if env_var
+        value = env_var.tr('^0-9', '')
+        unless value.empty?
+          value.to_f / 1_000_000
+        end
+      end
+    end
+
     def add_sanitized_context!
       sanitize_environment!
       sanitize_session_data!
@@ -147,7 +153,7 @@ module Appsignal
 
     def sanitize_session_data!
       @sanitized_session_data =
-        Appsignal::ParamsSanitizer.sanitize(request.session.to_hash)
+        Appsignal::Transaction::ParamsSanitizer.sanitize(request.session.to_hash)
       @fullpath = request.fullpath
     end
   end