appsignal 0.6.7 → 0.7.0.alpha.1

data/lib/appsignal/transaction/formatter.rb

@@ -0,0 +1,96 @@
+require 'delegate'
+
+module Appsignal
+  class Transaction
+    class Formatter < SimpleDelegator
+      def initialize(transaction)
+        super(transaction)
+      end
+
+      def hash
+        @hash ||= default_hash
+      end
+
+      def to_hash
+        merge_process_action_event_with_log_entry! if process_action_event
+        add_http_queue_duration_to_hash!
+        if exception?
+          add_exception_to_hash!
+          add_tags_to_hash!
+        end
+        add_events_to_hash! if slow_request?
+        hash
+      end
+
+      protected
+
+      def default_hash
+        {
+          :request_id => request_id,
+          :log_entry => {
+            :path => fullpath,
+            :kind => 'http_request',
+            :time => time,
+            :environment => sanitized_environment,
+            :session_data => sanitized_session_data
+          },
+          :failed => exception?
+        }
+      end
+
+      def merge_process_action_event_with_log_entry!
+        hash[:log_entry].merge!(event_to_hash(process_action_event))
+        hash[:log_entry].tap do |o|
+          o.merge!(o.delete(:payload))
+          o.delete(:action)
+          o.delete(:controller)
+          o.delete(:name)
+          o[:action] = action
+        end
+      end
+
+      def add_http_queue_duration_to_hash!
+        start = http_queue_start
+        if start
+          hash[:log_entry][:queue_duration] = hash[:log_entry][:time] - start
+        end
+      end
+
+      def add_tags_to_hash!
+        hash[:log_entry][:tags] = tags
+      end
+
+      def add_exception_to_hash!
+        hash[:exception] = {
+          :exception => exception.class.name,
+          :message => exception.message,
+          :backtrace => clean_backtrace(exception)
+        }
+      end
+
+      def clean_backtrace(exception)
+        if defined?(::Rails)
+          ::Rails.backtrace_cleaner.clean(exception.backtrace, nil)
+        else
+          exception.backtrace
+        end
+      end
+
+      def add_events_to_hash!
+        hash[:events] = events.map do |event|
+          event_to_hash(event)
+        end
+      end
+
+      def event_to_hash(event)
+        {
+          :name => event.name,
+          :duration => event.duration,
+          :time => event.time.to_f,
+          :end => event.end.to_f,
+          :payload => event.payload
+        }
+      end
+    end
+  end
+end

data/lib/appsignal/transaction/params_sanitizer.rb

@@ -1,113 +1,115 @@
 module Appsignal
-  class ParamsSanitizer
-    class << self
-      def sanitize(params)
-        ParamsSanitizerCopy.sanitize_value(params)
-      end
-
-      def sanitize!(params)
-        ParamsSanitizerDestructive.sanitize_value(params)
-      end
+  class Transaction
+    class ParamsSanitizer
+      class << self
+        def sanitize(params)
+          ParamsSanitizerCopy.sanitize_value(params)
+        end
 
-      def scrub(params)
-        ParamsSanitizerCopyScrub.sanitize_value(params)
-      end
+        def sanitize!(params)
+          ParamsSanitizerDestructive.sanitize_value(params)
+        end
 
-      def scrub!(params)
-        ParamsSanitizerDestructiveScrub.sanitize_value(params)
-      end
+        def scrub(params)
+          ParamsSanitizerCopyScrub.sanitize_value(params)
+        end
 
-      protected
+        def scrub!(params)
+          ParamsSanitizerDestructiveScrub.sanitize_value(params)
+        end
 
-      def sanitize_value(value)
-        case value
-        when Hash
-          sanitize_hash(value)
-        when Array
-          sanitize_array(value)
-        when Fixnum, String, Symbol
-          unmodified(value)
-        else
-          inspected(value)
+        protected
+
+        def sanitize_value(value)
+          case value
+          when Hash
+            sanitize_hash(value)
+          when Array
+            sanitize_array(value)
+          when Fixnum, String, Symbol
+            unmodified(value)
+          else
+            inspected(value)
+          end
         end
-      end
 
-      def sanitize_hash_with_target(source_hash, target_hash)
-        source_hash.each_pair do |key, value|
-          target_hash[key] = sanitize_value(value)
+        def sanitize_hash_with_target(source_hash, target_hash)
+          source_hash.each_pair do |key, value|
+            target_hash[key] = sanitize_value(value)
+          end
+          target_hash
         end
-        target_hash
-      end
 
-      def sanitize_array_with_target(source_array, target_array)
-        source_array.each_with_index do |item, index|
-          target_array[index] = sanitize_value(item)
+        def sanitize_array_with_target(source_array, target_array)
+          source_array.each_with_index do |item, index|
+            target_array[index] = sanitize_value(item)
+          end
+          target_array
         end
-        target_array
-      end
 
-      def unmodified(value)
-        value
-      end
+        def unmodified(value)
+          value
+        end
 
-      def inspected(value)
-        value.inspect
+        def inspected(value)
+          value.inspect
+        end
       end
     end
-  end
 
-  class ParamsSanitizerCopy < ParamsSanitizer
-    class << self
-      protected
+    class ParamsSanitizerCopy < ParamsSanitizer
+      class << self
+        protected
 
-      def sanitize_hash(hash)
-        sanitize_hash_with_target(hash, {})
-      end
+        def sanitize_hash(hash)
+          sanitize_hash_with_target(hash, {})
+        end
 
-      def sanitize_array(array)
-        sanitize_array_with_target(array, [])
+        def sanitize_array(array)
+          sanitize_array_with_target(array, [])
+        end
       end
     end
-  end
 
-  class ParamsSanitizerDestructive < ParamsSanitizer
-    class << self
-      protected
+    class ParamsSanitizerDestructive < ParamsSanitizer
+      class << self
+        protected
 
-      def sanitize_hash(hash)
-        sanitize_hash_with_target(hash, hash)
-      end
+        def sanitize_hash(hash)
+          sanitize_hash_with_target(hash, hash)
+        end
 
-      def sanitize_array(array)
-        sanitize_array_with_target(array, array)
+        def sanitize_array(array)
+          sanitize_array_with_target(array, array)
+        end
       end
     end
-  end
 
-  class ParamsSanitizerCopyScrub < ParamsSanitizerCopy
-    class << self
-      protected
+    class ParamsSanitizerCopyScrub < ParamsSanitizerCopy
+      class << self
+        protected
 
-      def unmodified(value)
-        '?'
-      end
+        def unmodified(value)
+          '?'
+        end
 
-      def inspected(value)
-        '?'
+        def inspected(value)
+          '?'
+        end
       end
     end
-  end
 
-  class ParamsSanitizerDestructiveScrub < ParamsSanitizerDestructive
-    class << self
-      protected
+    class ParamsSanitizerDestructiveScrub < ParamsSanitizerDestructive
+      class << self
+        protected
 
-      def unmodified(value)
-        '?'
-      end
+        def unmodified(value)
+          '?'
+        end
 
-      def inspected(value)
-        '?'
+        def inspected(value)
+          '?'
+        end
       end
     end
   end

data/lib/appsignal/transmitter.rb

@@ -7,21 +7,21 @@ module Appsignal
   class Transmitter
     CONTENT_TYPE = 'application/json; charset=UTF-8'.freeze
     CONTENT_ENCODING = 'gzip'.freeze
-    CA_FILE_PATH = File.
-      expand_path(File.join(__FILE__, '../../../resources/cacert.pem'))
+    CA_FILE_PATH = File.expand_path(File.join(__FILE__, '../../../resources/cacert.pem'))
 
-    attr_reader :endpoint, :action, :api_key
+    attr_reader :config, :action
 
-    def initialize(endpoint, action, api_key, logger=nil)
-      @endpoint = endpoint
+    def initialize(action, config=Appsignal.config)
       @action = action
-      @api_key = api_key
+      @config = config
     end
 
     def uri
-      @uri ||= URI("#{@endpoint}/#{@action}").tap do |uri|
-        uri.query = Rack::Utils.build_query({
-          :api_key => api_key,
+      @uri ||= URI("#{config[:endpoint]}/#{action}").tap do |uri|
+        uri.query = ::Rack::Utils.build_query({
+          :api_key => config[:push_api_key],
+          :name => config[:name],
+          :environment => config.env,
           :hostname => Socket.gethostname,
           :gem_version => Appsignal::VERSION
         })
@@ -29,6 +29,7 @@ module Appsignal
     end
 
     def transmit(payload)
+      Appsignal.logger.debug "Transmitting payload to #{uri}"
       http_client.request(http_post(payload)).code
     end
 

data/lib/appsignal/version.rb

@@ -1,3 +1,3 @@
 module Appsignal
-  VERSION = '0.6.7'
+  VERSION = '0.7.0.alpha.1'
 end

data/lib/generators/appsignal/appsignal_generator.rb

@@ -1,33 +1,27 @@
 require 'appsignal'
 
 class AppsignalGenerator < Rails::Generators::Base
-  EXCLUDED_ENVIRONMENTS = [:test].freeze
+  EXCLUDED_ENVIRONMENTS = ['test'].freeze
 
   source_root File.expand_path('../templates', __FILE__)
-  argument :environment, :type => :string
-  argument :push_key, :type => :string
-  desc "Install the config file for AppSignal with your PUSH_KEY."
+  argument :push_api_key, :type => :string
+  desc 'Generate a config file for AppSignal'
 
   def copy_config_file
     template_file = 'appsignal.yml'
-    appsignal_file = File.join('config', template_file)
-    if File.exists?(appsignal_file)
-      say_status(:error, "Looks like you already have a config file.", :red)
-      say_status(:error, "Add the following to config/appsignal.yml:\n\n", :red)
-      say_status(:error, "#{environment}:", :red)
-      say_status(:error, "  api_key: #{push_key}\n\n", :red)
-      say_status(:info, "Then run:\n\n", :red)
-      say_status(:info, "  appsignal api_check", :red)
+    destination_file = File.join('config', template_file)
+    if File.exists?(destination_file)
+      say_status(:error, 'Looks like you already have a config file', :red)
     else
-      template template_file, appsignal_file
-      capyistrano_install
-      check_key
+      template(template_file, destination_file)
+      add_appsignal_require_for_capistrano
+      check_push_api_key
     end
   end
 
   protected
 
-  def capyistrano_install
+  def add_appsignal_require_for_capistrano
     deploy_file = File.expand_path(File.join('config', 'deploy.rb'))
     cap_file = File.expand_path('Capfile')
     if [deploy_file, cap_file].all? { |file| File.exists?(file) }
@@ -43,8 +37,15 @@ class AppsignalGenerator < Rails::Generators::Base
     end
   end
 
-  def check_key
-    auth_check = ::Appsignal::AuthCheck.new(environment)
+  def config
+    Appsignal::Config.new(
+      Rails.root,
+      'development'
+    )
+  end
+
+  def check_push_api_key
+    auth_check = ::Appsignal::AuthCheck.new(config, Appsignal.logger)
     status, result = auth_check.perform_with_result
     if status == '200'
       say_status :success, result
@@ -55,11 +56,9 @@ class AppsignalGenerator < Rails::Generators::Base
 
   private
 
-  alias :selected_environment :environment
-
   def environments
     @environments ||= Dir.glob(
       File.join(%w(. config environments *.rb))
-    ).map { |o| File.basename(o, ".rb") } - EXCLUDED_ENVIRONMENTS
+    ).map { |o| File.basename(o, ".rb") }.sort - EXCLUDED_ENVIRONMENTS
   end
 end

data/lib/generators/appsignal/templates/appsignal.yml

@@ -1,25 +1,19 @@
----
-# Unlisted environments will not be visible on the AppSignal site,
-# Active environments count towards the account plan limit.
-<%- environments.each do |environment| -%>
-<%= environment %>:
-  <%- if selected_environment == environment -%>
-  # The API key used by the AppSignal gem to push this specific environment to
-  # AppSignal.  (required)
-  #
-  # It is possible to use ERB.
-  # api_key: "<%%= ENV['APPSIGNAL_API_KEY'] %>"
-  api_key: "<%= push_key %>"
+default: &defaults
+  # Your push api key, it is possible to set this dynamically using ERB:
+  # push_api_key: "<%%= ENV['APPSIGNAL_PUSH_API_KEY'] %>"
+  push_api_key: "<%= push_api_key %>"
+
+  # Your app's name
+  name: "<%= Rails.application.class.parent_name %>"
 
-  # The cuttoff point above which a request is considered slow. (default: 200)
+  # The cuttoff point in ms above which a request is considered slow, default is 200
   # slow_request_threshold: 200
 
-  # Change whether this environment should be monitored. (default: false)
+# Configuration per environment, leave out an environment or set active
+# to false to not push metrics for that environment.
+<% environments.each do |environment| -%>
+<%= environment %>:
+  <<: *defaults
   active: true
-  <%- else -%>
-  # Go to https://appsignal.com if you want to monitor your <%= environment %>
-  # environment to obtain an api key.
-  # api_key: <<%= environment.upcase %>-API-KEY>
-  active: false
-  <%- end -%>
-<%- end -%>
+<%= "\n" unless environment == environments.last -%>
+<% end -%>