appsignal 1.1.0.beta.12 → 1.1.0.beta.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 012b200a89f80f3b02f9914a8f527b9e54f7b440
-  data.tar.gz: b7c5c523bae9a95a6eb9fa0d5f29b976163142fa
+  metadata.gz: a8d354800e9781d6efd1a2f52be4515971519468
+  data.tar.gz: fa3a415522bcd7dd52db147d92aa68e75f373a09
 SHA512:
-  metadata.gz: e7537ed7eb7f4888d3ee4ada2dda6e8dca0791e3f9173ba804383748b627915c076c3c6c1663cfd95a9d05e7004d63ab9bd2f5f520816342323318b847dad2ba
-  data.tar.gz: 2561238aef1065a629d69034f1f787043f3c82ffa85cdaa0789f10f8bf4ed9827ac8418e8337d617e5617e349fa21747acf5fde8ad1cbcf2b30830b5cae644e7
+  metadata.gz: d526d61caca01c60a7d3dbcda9d23a25391fbfeca8a630d03c620ca229a6d63dfe89e7728d8e501042d67cf70f312e5f9a7d4483277567659cc4e4f0a5845684
+  data.tar.gz: 4a5bf45846b35bbc1bda5d9f7bf5511cfbb6e5dc793e848dae5f94a6f09972d82673f5639fade3cebdcb2d9bf16ed0ecae7e9adee008cdb83dc2f16f016619a7

data/CHANGELOG.md

@@ -1,11 +1,15 @@
 # 1.1
-* Collect global metrics for GC durations
+* Collect global metrics for GC durations (in beta, disabled by default)
 * Collect params from Delayed Job in a reliable way
 * Collect perams for Delayed Job and Sidekiq when using ActiveJob
 * Official Grape support
+* Easier installation using `bundle exec appsignal install`
+
+# 1.0.7
+* Another multibyte bugfix in sql sanizitation
 
 # 1.0.6
-* Bugfix in background thread when using heavy sanization
+* Bugfix in sql sanitization when using multibyte utf-8 characters
 
 # 1.0.5
 * Improved sql sanitization

data/Rakefile

@@ -1,6 +1,4 @@
 require 'rspec/core/rake_task'
-import 'lib/tasks/diag.rake'
-
 GEMFILES = %w(
   capistrano2
   capistrano3

data/gemfiles/grape.gemfile

@@ -2,6 +2,4 @@ source 'https://rubygems.org'
 
 gem 'grape', '0.14.0'
 
-gem 'generator_spec'
-
 gemspec :path => '../'

data/gemfiles/padrino.gemfile

@@ -2,6 +2,4 @@ source 'https://rubygems.org'
 
 gem 'padrino', '~> 0.12.0'
 
-gem 'generator_spec'
-
 gemspec :path => '../'

data/gemfiles/rails-3.2.gemfile

@@ -4,6 +4,4 @@ gem 'rails', '~> 3.2.14'
 
 gem 'test-unit'
 
-gem 'generator_spec'
-
 gemspec :path => '../'

data/gemfiles/rails-4.0.gemfile

@@ -2,6 +2,6 @@ source 'https://rubygems.org'
 
 gem 'rails', '~> 4.0.0'
 
-gem 'generator_spec'
+gem 'mime-types', '~> 2.6'
 
 gemspec :path => '../'

data/gemfiles/rails-4.1.gemfile

@@ -2,6 +2,6 @@ source 'https://rubygems.org'
 
 gem 'rails', '~> 4.1.0'
 
-gem 'generator_spec'
+gem 'mime-types', '~> 2.6'
 
 gemspec :path => '../'

data/gemfiles/rails-4.2.gemfile

@@ -2,6 +2,6 @@ source 'https://rubygems.org'
 
 gem 'rails', '~> 4.2.0'
 
-gem 'generator_spec'
+gem 'mime-types', '~> 2.6'
 
 gemspec :path => '../'

data/gemfiles/rails-5.0.gemfile

@@ -2,6 +2,4 @@ source 'https://rubygems.org'
 
 gem 'rails', '~> 5.0.0.beta'
 
-gem 'generator_spec'
-
 gemspec :path => '../'

data/lib/appsignal/auth_check.rb

@@ -4,7 +4,7 @@ module Appsignal
 
     attr_reader :config, :logger
 
-    def initialize(config, logger)
+    def initialize(config, logger=Appsignal.logger)
       @config = config
       @logger = logger
     end

data/lib/appsignal/cli.rb

@@ -2,10 +2,13 @@ require 'optparse'
 require 'logger'
 require 'yaml'
 require 'appsignal'
+require 'appsignal/cli/diagnose'
+require 'appsignal/cli/install'
+require 'appsignal/cli/notify_of_deploy'
 
 module Appsignal
   class CLI
-    AVAILABLE_COMMANDS = %w(notify_of_deploy).freeze
+    AVAILABLE_COMMANDS = %w(diagnose install notify_of_deploy).freeze
 
     class << self
       attr_accessor :options, :config, :initial_config
@@ -21,8 +24,12 @@ module Appsignal
           if AVAILABLE_COMMANDS.include?(command)
             commands[command].parse!(argv)
             case command.to_sym
+            when :diagnose
+              Appsignal::CLI::Diagnose.run
+            when :install
+              Appsignal::CLI::Install.run(argv.shift, config(nil))
             when :notify_of_deploy
-              notify_of_deploy
+              Appsignal::CLI::NotifyOfDeploy.run(options, config)
             end
           else
             puts "Command '#{command}' does not exist, run appsignal -h to "\
@@ -36,12 +43,8 @@ module Appsignal
         end
       end
 
-      def logger
-        Logger.new($stdout)
-      end
-
-      def config
-        @config ||= Appsignal::Config.new(
+      def config(logger=Logger.new($stdout))
+        Appsignal::Config.new(
           ENV['PWD'],
           options[:environment],
           initial_config,
@@ -70,6 +73,8 @@ module Appsignal
 
       def command_option_parser
         {
+          'diagnose' => OptionParser.new,
+          'install' => OptionParser.new,
           'notify_of_deploy' => OptionParser.new do |o|
             o.banner = 'Usage: appsignal notify_of_deploy [options]'
 
@@ -91,40 +96,6 @@ module Appsignal
           end
         }
       end
-
-      def notify_of_deploy
-        validate_active_config
-        validate_required_options([:revision, :user, :environment])
-
-        Appsignal::Marker.new(
-          {
-            :revision => options[:revision],
-            :user => options[:user]
-          },
-          config,
-          logger
-        ).transmit
-      end
-
-      protected
-
-      def validate_required_options(required_options)
-        missing = required_options.select do |required_option|
-          val = options[required_option]
-          val.nil? || (val.respond_to?(:empty?) && val.empty?)
-        end
-        if missing.any?
-          puts "Missing options: #{missing.join(', ')}"
-          exit(1)
-        end
-      end
-
-      def validate_active_config
-        unless config.active?
-          puts 'Exiting: No config file or push api key env var found'
-          exit(1)
-        end
-      end
     end
   end
 end

data/lib/appsignal/cli/diagnose.rb

@@ -0,0 +1,72 @@
+module Appsignal
+  class CLI
+    class Diagnose
+      class << self
+        def run
+          gem_version
+          agent_version
+          start_appsignal
+          config
+          check_api_key
+          paths_writable
+          check_ext_install
+        end
+
+        def gem_version
+          puts "Gem version: #{Appsignal::VERSION}"
+        end
+
+        def agent_version
+          puts "Agent version: #{Appsignal::Extension.agent_version}"
+        end
+
+        def start_appsignal
+          Appsignal.start
+        end
+
+        def config
+          start_appsignal
+          Appsignal.config.config_hash.each do |key, val|
+            puts "Config #{key}: #{val}"
+          end
+        end
+
+        def paths_writable
+          start_appsignal
+          possible_paths = [
+            Appsignal.config.root_path,
+            Appsignal.config.log_file_path
+          ]
+
+          puts "Checking if required paths are writable:"
+          possible_paths.each do |path|
+            result = File.writable?(path) ? 'Ok' : 'Failed'
+            puts "#{path} ...#{result}"
+          end
+          puts "\n"
+        end
+
+        def check_api_key
+          start_appsignal
+          auth_check = ::Appsignal::AuthCheck.new(Appsignal.config, Appsignal.logger)
+          status, result = auth_check.perform_with_result
+          if status == '200'
+            puts "Checking API key: Ok"
+          else
+            puts "Checking API key: Failed"
+          end
+        end
+
+        def check_ext_install
+          require 'bundler/cli'
+          require "bundler/cli/common"
+          path     = Bundler::CLI::Common.select_spec('appsignal').full_gem_path
+          log_path = "#{path.strip}/ext/install.log"
+          puts "Showing last lines of extension install log: #{log_path}"
+          puts File.read(log_path)
+          puts "\n"
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/cli/install.rb

@@ -0,0 +1,296 @@
+require 'erb'
+require 'ostruct'
+require 'io/console'
+
+module Appsignal
+  class CLI
+    class Install
+      EXCLUDED_ENVIRONMENTS = ['test'].freeze
+
+      class << self
+        def run(push_api_key, config)
+          puts
+          puts colorize "#######################################", :green
+          puts colorize "## Starting AppSignal Installer      ##", :green
+          puts colorize "## --------------------------------- ##", :green
+          puts colorize "## Need help?  support@appsignal.com ##", :green
+          puts colorize "## Docs?       docs.appsignal.com    ##", :green
+          puts colorize "#######################################", :green
+          puts
+          unless push_api_key
+            puts colorize 'Problem encountered:', :red
+            puts '  No push api key entered.'
+            puts '  - Sign up for AppSignal and follow the instructions'
+            puts "  - Already signed up? Click 'new app' on the account overview"
+            puts
+            puts colorize 'Exiting installer...', :red
+            return false
+          end
+
+          config[:push_api_key] = push_api_key
+
+          print 'Validating api key'
+          periods
+          puts
+          begin
+            auth_check = Appsignal::AuthCheck.new(config)
+            unless auth_check.perform == '200'
+              puts "\n  Api key '#{config[:push_api_key]}' is not valid, please get a new one on https://appsignal.com"
+              return false
+            end
+          rescue Exception => e
+            puts "  There was an error validating your api key:"
+            puts colorize "'#{e}'", :red
+            puts "  Please try again"
+            return false
+          end
+          puts colorize '  Api key valid!', :green
+          puts
+
+          if installed_frameworks.include?(:rails)
+            install_for_rails(config)
+          elsif installed_frameworks.include?(:sinatra) && !installed_frameworks.include?(:padrino)
+            install_for_sinatra(config)
+          elsif installed_frameworks.include?(:padrino)
+            install_for_padrino(config)
+          elsif installed_frameworks.include?(:grape)
+            install_for_grape(config)
+          else
+            puts "We could not detect which framework you are using. We'll be very grateful if you e-mail ons on support@appsignal.com with information about your setup."
+            return false
+          end
+
+          true
+        end
+
+        def install_for_rails(config)
+          require File.expand_path(File.join(ENV['PWD'], 'config/application.rb'))
+
+          puts 'Installing for Ruby on Rails'
+
+          config[:name] = Rails.application.class.parent_name
+
+          name_overwritten = yes_or_no("  Your app's name is: '#{config[:name]}' \n  Do you want to change how this is displayed in AppSignal? (y/n): ")
+          puts
+          if name_overwritten
+            config[:name] = required_input("  Choose app's display name: ")
+            puts
+          end
+
+          configure(config, rails_environments, name_overwritten)
+          done_notice
+        end
+
+        def install_for_sinatra(config)
+          puts 'Installing for Sinatra'
+          config[:name] = required_input('  Enter application name: ')
+          puts
+          configure(config, ['production', 'staging'], true)
+
+          puts "Finish Sinatra configuration"
+          puts "  Sinatra requires some manual configuration."
+          puts "  Add this line beneath require 'sinatra':"
+          puts
+          puts "  require 'appsignal/integrations/sinatra'"
+          press_any_key
+          puts "Configure subclass apps"
+          puts "  If your app is a subclass of Sinatra::Base you need to use this middleware:"
+          puts
+          puts "  use Appsignal::Rack::SinatraInstrumentation"
+          press_any_key
+          done_notice
+        end
+
+        def install_for_padrino(config)
+          puts 'Installing for Padrino'
+
+          config[:name] = required_input('  Enter application name: ')
+          puts
+
+          configure(config, ['production', 'staging'], true)
+
+          puts "Finish Padrino installation"
+          puts "  Padrino requires some manual configuration."
+          puts "  After installing the gem, add the following line to /config/boot.rb:"
+          puts
+          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"
+          press_any_key
+          done_notice
+        end
+
+        def install_for_grape(config)
+          puts 'Installing for Grape'
+
+          config[:name] = required_input('  Enter application name: ')
+          puts
+
+          configure(config, ['production', 'staging'], true)
+
+          puts "Manual Grape configuration needed"
+          puts "  See the installation instructions here:"
+          puts "  http://docs.appsignal.com/getting-started/supported-frameworks.html#grape"
+          press_any_key
+          done_notice
+        end
+
+        def colorize(text, color)
+          return text if Gem.win_platform?
+          color_code = case color
+                       when :red then 31
+                       when :green then 32
+                       when :yellow then 33
+                       when :blue then 34
+                       when :pink then 35
+                       else 0
+                       end
+         "\e[#{color_code}m#{text}\e[0m"
+        end
+
+        def periods
+          3.times do
+            print "."
+            sleep(0.5)
+          end
+        end
+
+        def press_any_key
+          puts
+          print "  Ready? Press any key:"
+          STDIN.getch
+          puts
+          puts
+        end
+
+        def yes_or_no(prompt)
+          loop do
+            print prompt
+            input = gets.chomp
+            if input == 'y'
+              return true
+            elsif input == 'n'
+              return false
+            end
+          end
+        end
+
+        def required_input(prompt)
+          loop do
+            print prompt
+            input = gets.chomp
+            if input.length > 0
+              return input
+            end
+          end
+        end
+
+        def configure(config, environments, name_overwritten)
+          puts "How do you want to configure AppSignal?"
+          puts "  (1) a config file"
+          puts "  (2) environment variables?"
+          loop do
+            print "  Choose (1/2): "
+            input = gets.chomp
+            if input == '1'
+              puts
+              print "Writing config file"
+              periods
+              puts
+              puts colorize "  Config file written to config/appsignal.yml", :green
+              write_config_file(
+                :push_api_key => config[:push_api_key],
+                :app_name => config[:name],
+                :environments => environments
+              )
+              puts
+              break
+            elsif input == '2'
+              puts
+              puts "Add the following environment variables to configure AppSignal:"
+              puts "  export APPSIGNAL_ACTIVE=true"
+              puts "  export APPSIGNAL_PUSH_API_KEY=#{config[:push_api_key]}"
+              if name_overwritten
+                puts "  export APPSIGNAL_APP_NAME=#{config[:name]}"
+              end
+              puts
+              puts "  See the documentation for more configuration options:"
+              puts "  http://docs.appsignal.com/gem-settings/configuration.html"
+              press_any_key
+              break
+            end
+          end
+        end
+
+        def done_notice
+          sleep 0.3
+          puts colorize "#####################################", :green
+          puts colorize "## AppSignal installation complete ##", :green
+          puts colorize "#####################################", :green
+          sleep 0.3
+          puts
+          puts '  Now you need to send us some data!'
+          puts
+          if Gem.win_platform?
+            puts 'The AppSignal agent currently does not work on Windows, please push these changes to your test/staging/production environment'
+          else
+            puts "  Run your app with AppSignal activated:"
+            puts "  - You can do this on your dev environment"
+            puts "  - Or deploy to staging or production"
+            puts
+            puts "  Test if AppSignal is receiving data:"
+            puts "  - Requests > 200ms are shown in AppSignal"
+            puts "  - Generate an error to test (add .xml to any path!)"
+            puts
+            puts "Return to your browser and follow the instructions!"
+          end
+        end
+
+        def installed_frameworks
+          [].tap do |out|
+            begin
+              require 'rails'
+              out << :rails
+            rescue LoadError
+            end
+            begin
+              require 'sinatra'
+              out << :sinatra
+            rescue LoadError
+            end
+            begin
+              require 'padrino'
+              out << :padrino
+            rescue LoadError
+            end
+            begin
+              require 'grape'
+              out << :grape
+            rescue LoadError
+            end
+          end
+        end
+
+        def rails_environments
+          @environments ||= Dir.glob(
+            File.join(ENV['PWD'], 'config/environments/*.rb')
+          ).map { |o| File.basename(o, ".rb") }.sort - EXCLUDED_ENVIRONMENTS
+        end
+
+        def write_config_file(data)
+          template = ERB.new(
+            File.read(File.join(File.dirname(__FILE__), "../../../resources/appsignal.yml.erb")),
+            nil,
+            '-'
+          )
+
+          config = template.result(OpenStruct.new(data).instance_eval { binding })
+
+          FileUtils.mkdir_p(File.join(ENV['PWD'], 'config'))
+          File.write(File.join(ENV['PWD'], 'config/appsignal.yml'), config)
+        end
+      end
+    end
+  end
+end