appsignal 2.1.2 → 2.2.0.beta.1

data/lib/appsignal/cli/helpers.rb

@@ -37,6 +37,9 @@ module Appsignal
       def ask_for_input
         value = stdin.gets
         value ? value.chomp : ""
+      rescue Interrupt
+        puts "\nExiting..."
+        exit 1
       end
 
       def required_input(prompt)
@@ -47,13 +50,15 @@ module Appsignal
         end
       end
 
-      def yes_or_no(prompt)
+      def yes_or_no(prompt, options = {})
         loop do
           print prompt
-          case ask_for_input
-          when "y"
+          input = ask_for_input.strip
+          input = options[:default] if input.empty? && options[:default]
+          case input
+          when "y", "Y", "yes"
             return true
-          when "n"
+          when "n", "N", "no"
             return false
           end
         end

data/lib/appsignal/cli/install.rb

@@ -85,7 +85,7 @@ module Appsignal
           puts "Installing for Sinatra"
           config[:name] = required_input("  Enter application name: ")
           puts
-          configure(config, ["development", "production", "staging"], true)
+          configure(config, %w(development production staging), true)
 
           puts "Finish Sinatra configuration"
           puts "  Sinatra requires some manual configuration."
@@ -94,7 +94,7 @@ module Appsignal
           puts "  require 'appsignal/integrations/sinatra'"
           puts
           puts "  You can find more information in the documentation:"
-          puts "  http://docs.appsignal.com/getting-started/supported-frameworks.html#sinatra"
+          puts "  http://docs.appsignal.com/ruby/integrations/sinatra.html"
           press_any_key
           done_notice
         end
@@ -103,7 +103,7 @@ module Appsignal
           puts "Installing for Padrino"
           config[:name] = required_input("  Enter application name: ")
           puts
-          configure(config, ["development", "production", "staging"], true)
+          configure(config, %w(development production staging), true)
 
           puts "Finish Padrino installation"
           puts "  Padrino requires some manual configuration."
@@ -112,7 +112,7 @@ module Appsignal
           puts "  require 'appsignal/integrations/padrino"
           puts
           puts "  You can find more information in the documentation:"
-          puts "  http://docs.appsignal.com/getting-started/supported-frameworks.html#padrino"
+          puts "  http://docs.appsignal.com/ruby/integrations/padrino.html"
           press_any_key
           done_notice
         end
@@ -123,11 +123,11 @@ module Appsignal
           config[:name] = required_input("  Enter application name: ")
           puts
 
-          configure(config, ["development", "production", "staging"], true)
+          configure(config, %w(development production staging), true)
 
           puts "Manual Grape configuration needed"
           puts "  See the installation instructions at:"
-          puts "  http://docs.appsignal.com/getting-started/supported-frameworks.html#grape"
+          puts "  http://docs.appsignal.com/ruby/integrations/grape.html"
           press_any_key
           done_notice
         end

data/lib/appsignal/cli/notify_of_deploy.rb

@@ -1,7 +1,65 @@
 module Appsignal
   class CLI
+    # Command line tool to send a "Deploy Marker" for an application to
+    # 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.
+    #
+    # @note The same logic is used in the Capistrano integration. A deploy
+    #   marker is created on each deploy.
+    #
+    # ## Options
+    #
+    # - `--environment` required. The environment of the application being
+    #   deployed.
+    # - `--user` required. User that triggered the deploy.
+    # - `--revision` required. Git commit SHA or other identifiable revision id.
+    # - `--name` If no "name" config can be found in a `config/appsignal.yml`
+    #   file or based on the `APPSIGNAL_APP_NAME` environment variable, this
+    #   option is required.
+    #
+    # ## Exit codes
+    #
+    # - Exits with status code `0` if the deploy marker is sent.
+    # - Exits with status code `1` if the configuration is not valid and active.
+    # - Exits with status code `1` if the required options aren't present.
+    #
+    # @example basic example
+    #   appsignal notify_of_deploy \
+    #     --user=tom \
+    #     --environment=production \
+    #     --revision=abc1234
+    #
+    # @example using a custom app name
+    #   appsignal notify_of_deploy \
+    #     --user=tom \
+    #     --environment=production \
+    #     --revision=abc1234 \
+    #     --name="My app"
+    #
+    # @example help command
+    #   appsignal notify_of_deploy --help
+    #
+    # @since 0.2.5
+    # @see Appsignal::Marker Appsignal::Marker
+    # @see http://docs.appsignal.com/ruby/command-line/notify_of_deploy.html
+    #   AppSignal notify_of_deploy documentation
+    # @see http://docs.appsignal.com/appsignal/terminology.html#markers
+    #   Terminology: Deploy marker
     class NotifyOfDeploy
       class << self
+        # @param options [Hash]
+        # @option options :environment [String] environment to load
+        #   configuration for.
+        # @option options :name [String] custom name of the application.
+        # @option options :user [String] user who triggered the deploy.
+        # @option options :revision [String] the revision that has been
+        #   deployed. E.g. a git commit SHA.
+        # @return [void]
         def run(options)
           config = config_for(options[:environment])
           config[:name] = options[:name] if options[:name]

data/lib/appsignal/config.rb

@@ -22,11 +22,11 @@ module Appsignal
       :frontend_error_catching_path   => "/appsignal_error_catcher",
       :enable_allocation_tracking     => true,
       :enable_gc_instrumentation      => false,
-      :running_in_container           => false,
       :enable_host_metrics            => true,
       :enable_minutely_probes         => false,
       :hostname                       => ::Socket.gethostname,
-      :ca_file_path                   => File.expand_path(File.join("../../../resources/cacert.pem"), __FILE__)
+      :ca_file_path                   => File.expand_path(File.join("../../../resources/cacert.pem"), __FILE__),
+      :dns_servers                    => []
     }.freeze
 
     ENV_TO_KEY_MAPPING = {
@@ -55,7 +55,8 @@ module Appsignal
       "APPSIGNAL_ENABLE_HOST_METRICS"            => :enable_host_metrics,
       "APPSIGNAL_ENABLE_MINUTELY_PROBES"         => :enable_minutely_probes,
       "APPSIGNAL_HOSTNAME"                       => :hostname,
-      "APPSIGNAL_CA_FILE_PATH"                   => :ca_file_path
+      "APPSIGNAL_CA_FILE_PATH"                   => :ca_file_path,
+      "APPSIGNAL_DNS_SERVERS"                    => :dns_servers
     }.freeze
 
     attr_reader :root_path, :env, :initial_config, :config_hash
@@ -115,33 +116,35 @@ module Appsignal
       @valid && config_hash[:active]
     end
 
-    def write_to_environment
-      ENV["APPSIGNAL_ACTIVE"]                       = active?.to_s
-      ENV["APPSIGNAL_APP_PATH"]                     = root_path.to_s
-      ENV["APPSIGNAL_AGENT_PATH"]                   = File.expand_path("../../../ext", __FILE__).to_s
-      ENV["APPSIGNAL_ENVIRONMENT"]                  = env
-      ENV["APPSIGNAL_AGENT_VERSION"]                = Appsignal::Extension.agent_version
-      ENV["APPSIGNAL_LANGUAGE_INTEGRATION_VERSION"] = "ruby-#{Appsignal::VERSION}"
-      ENV["APPSIGNAL_DEBUG_LOGGING"]                = config_hash[:debug].to_s
-      ENV["APPSIGNAL_LOG_FILE_PATH"]                = log_file_path.to_s if log_file_path
-      ENV["APPSIGNAL_PUSH_API_ENDPOINT"]            = config_hash[:endpoint]
-      ENV["APPSIGNAL_PUSH_API_KEY"]                 = config_hash[:push_api_key]
-      ENV["APPSIGNAL_APP_NAME"]                     = config_hash[:name]
-      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_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
-      ENV["APPSIGNAL_WORKING_DIR_PATH"]             = config_hash[:working_dir_path] if config_hash[:working_dir_path]
-      ENV["APPSIGNAL_ENABLE_HOST_METRICS"]          = config_hash[:enable_host_metrics].to_s
-      ENV["APPSIGNAL_ENABLE_MINUTELY_PROBES"]       = config_hash[:enable_minutely_probes].to_s
-      ENV["APPSIGNAL_HOSTNAME"]                     = config_hash[:hostname].to_s
-      ENV["APPSIGNAL_PROCESS_NAME"]                 = $0
-      ENV["APPSIGNAL_CA_FILE_PATH"]                 = config_hash[:ca_file_path].to_s
+    def write_to_environment # rubocop:disable Metrics/AbcSize
+      ENV["_APPSIGNAL_ACTIVE"]                       = active?.to_s
+      ENV["_APPSIGNAL_APP_PATH"]                     = root_path.to_s
+      ENV["_APPSIGNAL_AGENT_PATH"]                   = File.expand_path("../../../ext", __FILE__).to_s
+      ENV["_APPSIGNAL_ENVIRONMENT"]                  = env
+      ENV["_APPSIGNAL_AGENT_VERSION"]                = Appsignal::Extension.agent_version
+      ENV["_APPSIGNAL_LANGUAGE_INTEGRATION_VERSION"] = "ruby-#{Appsignal::VERSION}"
+      ENV["_APPSIGNAL_DEBUG_LOGGING"]                = config_hash[:debug].to_s
+      ENV["_APPSIGNAL_LOG"]                          = config_hash[:log]
+      ENV["_APPSIGNAL_LOG_FILE_PATH"]                = log_file_path.to_s if log_file_path
+      ENV["_APPSIGNAL_PUSH_API_ENDPOINT"]            = config_hash[:endpoint]
+      ENV["_APPSIGNAL_PUSH_API_KEY"]                 = config_hash[:push_api_key]
+      ENV["_APPSIGNAL_APP_NAME"]                     = config_hash[:name]
+      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_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
+      ENV["_APPSIGNAL_WORKING_DIR_PATH"]             = config_hash[:working_dir_path] if config_hash[:working_dir_path]
+      ENV["_APPSIGNAL_ENABLE_HOST_METRICS"]          = config_hash[:enable_host_metrics].to_s
+      ENV["_APPSIGNAL_ENABLE_MINUTELY_PROBES"]       = config_hash[:enable_minutely_probes].to_s
+      ENV["_APPSIGNAL_HOSTNAME"]                     = config_hash[:hostname].to_s
+      ENV["_APPSIGNAL_PROCESS_NAME"]                 = $PROGRAM_NAME
+      ENV["_APPSIGNAL_CA_FILE_PATH"]                 = config_hash[:ca_file_path].to_s
+      ENV["_APPSIGNAL_DNS_SERVERS"]                  = config_hash[:dns_servers].join(",")
     end
 
-    protected
+    private
 
     def config_file
       @config_file ||=
@@ -149,7 +152,6 @@ module Appsignal
     end
 
     def detect_from_system
-      config_hash[:running_in_container] = true if Appsignal::System.container?
       config_hash[:log] = "stdout" if Appsignal::System.heroku?
 
       # Make active by default if APPSIGNAL_PUSH_API_KEY is present
@@ -189,9 +191,9 @@ module Appsignal
          APPSIGNAL_FRONTEND_ERROR_CATCHING_PATH APPSIGNAL_HTTP_PROXY
          APPSIGNAL_LOG APPSIGNAL_LOG_PATH APPSIGNAL_WORKING_DIR_PATH
          APPSIGNAL_HOSTNAME APPSIGNAL_CA_FILE_PATH).each do |var|
-        if env_var = ENV[var]
-          config[ENV_TO_KEY_MAPPING[var]] = env_var
-        end
+        env_var = ENV[var]
+        next unless env_var
+        config[ENV_TO_KEY_MAPPING[var]] = env_var
       end
 
       # Configuration with boolean type
@@ -201,17 +203,17 @@ module Appsignal
          APPSIGNAL_ENABLE_ALLOCATION_TRACKING APPSIGNAL_ENABLE_GC_INSTRUMENTATION
          APPSIGNAL_RUNNING_IN_CONTAINER APPSIGNAL_ENABLE_HOST_METRICS
          APPSIGNAL_SEND_PARAMS APPSIGNAL_ENABLE_MINUTELY_PROBES).each do |var|
-        if env_var = ENV[var]
-          config[ENV_TO_KEY_MAPPING[var]] = env_var == "true"
-        end
+        env_var = ENV[var]
+        next unless env_var
+        config[ENV_TO_KEY_MAPPING[var]] = env_var == "true"
       end
 
       # Configuration with array of strings type
       %w(APPSIGNAL_IGNORE_ERRORS APPSIGNAL_IGNORE_ACTIONS
          APPSIGNAL_FILTER_PARAMETERS).each do |var|
-        if env_var = ENV[var]
-          config[ENV_TO_KEY_MAPPING[var]] = env_var.split(",")
-        end
+        env_var = ENV[var]
+        next unless env_var
+        config[ENV_TO_KEY_MAPPING[var]] = env_var.split(",")
       end
 
       merge(@config_hash, config)

data/lib/appsignal/demo.rb

@@ -1,10 +1,30 @@
 require "rack/mock"
 
 module Appsignal
+  # {Appsignal::Demo} is a way to send demonstration / test samples for a
+  # exception and a performance issue.
+  #
+  # @example Loading config automatically
+  #   Appsignal::Demo.transmit
+  #
+  # @example With custom config
+  #   # If another configuration should be used, set it beforehand.
+  #   Appsignal.config = Appsignal::Config.new(Dir.pwd, "production")
+  #   Appsignal::Demo.transmit
+  #
+  # @since 2.0.0
+  # @see Appsignal::CLI::Demo
+  # @api private
   class Demo
+    # Error type used to create demonstration exception.
     class TestError < StandardError; end
 
     class << self
+      # Starts AppSignal and transmits the demonstration samples to AppSignal
+      # using the loaded configuration.
+      #
+      # @return [Boolean]
+      #   - returns `false` if Appsignal is not active.
       def transmit
         Appsignal.start
         Appsignal.start_logger

data/lib/appsignal/event_formatter.rb

@@ -8,6 +8,8 @@ module Appsignal
   # event, the same object will be called intermittently in a threaded environment.
   # So only keep global configuration as state and pass the payload around as an
   # argument if you need to use helper methods.
+  #
+  # @api private
   class EventFormatter
     class << self
       def formatters
@@ -60,7 +62,9 @@ module Appsignal
       end
     end
 
+    # @api public
     DEFAULT = 0
+    # @api public
     SQL_BODY_FORMAT = 1
   end
 end

data/lib/appsignal/event_formatter/action_view/render_formatter.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class EventFormatter
+    # @api private
     module ActionView
       class RenderFormatter < Appsignal::EventFormatter
         register "render_partial.action_view"

data/lib/appsignal/event_formatter/active_record/instantiation_formatter.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class EventFormatter
+    # @api private
     module ActiveRecord
       class InstantiationFormatter < Appsignal::EventFormatter
         register "instantiation.active_record"

data/lib/appsignal/event_formatter/active_record/sql_formatter.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class EventFormatter
+    # @api private
     module ActiveRecord
       class SqlFormatter < Appsignal::EventFormatter
         register "sql.active_record"

data/lib/appsignal/event_formatter/elastic_search/search_formatter.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class EventFormatter
+    # @api private
     module ElasticSearch
       class SearchFormatter < Appsignal::EventFormatter
         register "search.elasticsearch"

data/lib/appsignal/event_formatter/faraday/request_formatter.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class EventFormatter
+    # @api private
     module Faraday
       class RequestFormatter < Appsignal::EventFormatter
         register "request.faraday"

data/lib/appsignal/event_formatter/mongo_ruby_driver/query_formatter.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class EventFormatter
+    # @api private
     module MongoRubyDriver
       class QueryFormatter
         ALLOWED = {
@@ -44,7 +45,7 @@ module Appsignal
             "multi"  => :allow,
             "upsert" => :allow
           }
-        }
+        }.freeze
 
         # Format command based on given strategy
         def self.format(strategy, command)

data/lib/appsignal/event_formatter/moped/query_formatter.rb

@@ -1,5 +1,6 @@
 module Appsignal
   class EventFormatter
+    # @api private
     module Moped
       class QueryFormatter < Appsignal::EventFormatter
         register "query.moped"

data/lib/appsignal/extension.rb

@@ -12,6 +12,7 @@ rescue LoadError => err
 end
 
 module Appsignal
+  # @api private
   class Extension
     class << self
       def agent_config

data/lib/appsignal/garbage_collection_profiler.rb

@@ -1,41 +1,42 @@
 module Appsignal
-  # Appsignal::GarbageCollectionProfiler wraps Ruby's GC::Profiler to be able
-  # to track garbage collection time for multiple transactions, while
-  # constantly clearing GC::Profiler's total_time to make sure it doesn't leak
-  # memory by keeping garbage collection run samples in memory.
-
+  # {Appsignal::GarbageCollectionProfiler} wraps Ruby's `GC::Profiler` to be
+  # able to track garbage collection time for multiple transactions, while
+  # constantly clearing `GC::Profiler`'s total_time to make sure it doesn't
+  # leak memory by keeping garbage collection run samples in memory.
+  #
+  # @api private
   class GarbageCollectionProfiler
+    def self.lock
+      @lock ||= Mutex.new
+    end
+
     def initialize
       @total_time = 0
     end
 
-    # Whenever #total_time is called, the current GC::Profiler.total_time gets
-    # added to @total_time, after which GC::Profiler.clear is called to prevent
-    # it from leaking memory. A class-level lock is used to make sure garbage
-    # collection time is never counted more than once.
+    # Whenever {#total_time} is called, the current `GC::Profiler#total_time`
+    # gets added to `@total_time`, after which `GC::Profiler.clear` is called
+    # to prevent it from leaking memory. A class-level lock is used to make
+    # sure garbage collection time is never counted more than once.
     #
-    # Whenever @total_time gets above two billion milliseconds (about 23 days),
-    # it's reset to make sure the result fits in a signed 32-bit integer.
-
+    # Whenever `@total_time` gets above two billion milliseconds (about 23
+    # days), it's reset to make sure the result fits in a signed 32-bit
+    # integer.
+    #
+    # @return [Integer]
     def total_time
       lock.synchronize do
         @total_time += (internal_profiler.total_time * 1000).round
         internal_profiler.clear
       end
 
-      if @total_time > 2_000_000_000
-        @total_time = 0
-      end
+      @total_time = 0 if @total_time > 2_000_000_000
 
       @total_time
     end
 
     private
 
-    def self.lock
-      @lock ||= Mutex.new
-    end
-
     def internal_profiler
       GC::Profiler
     end