appsignal 2.5.0.alpha.1-java

data/lib/appsignal/cli/helpers.rb

@@ -0,0 +1,72 @@
+module Appsignal
+  class CLI
+    module Helpers
+      private
+
+      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.getc
+        puts
+        puts
+      end
+
+      def ask_for_input
+        value = stdin.gets
+        value ? value.chomp : ""
+      rescue Interrupt
+        puts "\nExiting..."
+        exit 1
+      end
+
+      def required_input(prompt)
+        loop do
+          print prompt
+          value = ask_for_input
+          return value unless value.empty?
+        end
+      end
+
+      def yes_or_no(prompt, options = {})
+        loop do
+          print prompt
+          input = ask_for_input.strip
+          input = options[:default] if input.empty? && options[:default]
+          case input
+          when "y", "Y", "yes"
+            return true
+          when "n", "N", "no"
+            return false
+          end
+        end
+      end
+
+      def stdin
+        $stdin
+      end
+    end
+  end
+end

data/lib/appsignal/cli/install.rb

@@ -0,0 +1,277 @@
+require "erb"
+require "ostruct"
+require "io/console"
+require "appsignal/demo"
+
+module Appsignal
+  class CLI
+    class Install
+      extend CLI::Helpers
+
+      EXCLUDED_ENVIRONMENTS = ["test"].freeze
+
+      class << self
+        def run(push_api_key)
+          $stdout.sync = true
+
+          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 'Add app' on the account overview page"
+            puts
+            puts colorize "Exiting installer...", :red
+            return
+          end
+          config = new_config
+          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
+            end
+          rescue => e
+            puts "  There was an error validating your API key:"
+            puts colorize "'#{e}'", :red
+            puts "  Please try again"
+            return
+          end
+          puts colorize "  API key valid!", :green
+          puts
+
+          if installed_frameworks.include?(:rails)
+            install_for_rails(config)
+          elsif installed_frameworks.include?(:padrino)
+            install_for_padrino(config)
+          elsif installed_frameworks.include?(:grape)
+            install_for_grape(config)
+          elsif installed_frameworks.include?(:sinatra)
+            install_for_sinatra(config)
+          else
+            print colorize "Warning:", :red
+            puts " We could not detect which framework you are using. "\
+              "We'd be very grateful if you email us on support@appsignal.com "\
+              "with information about your setup."
+            puts
+            done_notice
+          end
+        end
+
+        def install_for_rails(config)
+          require File.expand_path(File.join(Dir.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, %w[development 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'"
+          puts
+          puts "  You can find more information in the documentation:"
+          puts "  http://docs.appsignal.com/ruby/integrations/sinatra.html"
+          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, %w[development 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/ruby/integrations/padrino.html"
+          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, %w[development production staging], true)
+
+          puts "Manual Grape configuration needed"
+          puts "  See the installation instructions at:"
+          puts "  http://docs.appsignal.com/ruby/integrations/grape.html"
+          press_any_key
+          done_notice
+        end
+
+        def install_for_capistrano
+          capfile = File.join(Dir.pwd, "Capfile")
+          return unless File.exist?(capfile)
+          return if File.read(capfile) =~ %r{require ['|"]appsignal/capistrano}
+
+          puts "Installing for Capistrano"
+          print "  Adding AppSignal integration to Capfile"
+          File.open(capfile, "a") do |f|
+            f.write "\nrequire 'appsignal/capistrano'\n"
+          end
+          periods
+          puts
+          puts
+        end
+
+        def configure(config, environments, name_overwritten)
+          install_for_capistrano
+
+          ENV["APPSIGNAL_APP_ENV"] = "development"
+
+          puts "How do you want to configure AppSignal?"
+          puts "  (1) a config file"
+          puts "  (2) environment variables"
+          loop do
+            print "  Choose (1/2): "
+            case ask_for_input
+            when "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
+            when "2"
+              ENV["APPSIGNAL_ACTIVE"] = "true"
+              ENV["APPSIGNAL_PUSH_API_KEY"] = config[:push_api_key]
+              ENV["APPSIGNAL_APP_NAME"] = config[:name]
+
+              puts
+              puts "Add the following environment variables to configure AppSignal:"
+              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
+          if Gem.win_platform?
+            puts "The AppSignal agent currently does not work on Microsoft " \
+              "Windows. Please push these changes to your staging/production " \
+              "environment and make sure some actions are performed. " \
+              "AppSignal should pick up your app after a few minutes."
+          else
+            puts "  Sending example data to AppSignal..."
+            if Appsignal::Demo.transmit
+              puts "  Example data sent!"
+              puts "  It may take about a minute for the data to appear on https://appsignal.com/accounts"
+              puts
+              puts "  Please return to your browser and follow the instructions."
+            else
+              puts "  Couldn't start the AppSignal agent and send example data to AppSignal.com"
+              puts "  Please use `appsignal diagnose` to debug your configuration."
+            end
+          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
+          Dir.glob(
+            File.join(Dir.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(Dir.pwd, "config"))
+          File.write(File.join(Dir.pwd, "config/appsignal.yml"), config)
+        end
+
+        def new_config
+          Appsignal::Config.new(Dir.pwd, "")
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/cli/notify_of_deploy.rb

@@ -0,0 +1,113 @@
+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]
+
+          validate_active_config(config)
+          required_config = [:revision, :user]
+          required_config << :environment if config.env.empty?
+          required_config << :name if !config[:name] || config[:name].empty?
+          validate_required_options(options, required_config)
+
+          Appsignal::Marker.new(
+            {
+              :revision => options[:revision],
+              :user => options[:user]
+            },
+            config
+          ).transmit
+        end
+
+        private
+
+        def validate_required_options(options, required_options)
+          missing = required_options.select do |required_option|
+            val = options[required_option]
+            val.nil? || (val.respond_to?(:empty?) && val.empty?)
+          end
+          return unless missing.any?
+
+          puts "Error: Missing options: #{missing.join(", ")}"
+          exit 1
+        end
+
+        def validate_active_config(config)
+          return if config.active?
+
+          puts "Error: No valid config found."
+          exit 1
+        end
+
+        def config_for(environment)
+          Appsignal::Config.new(
+            Dir.pwd,
+            environment,
+            {},
+            Logger.new(StringIO.new)
+          )
+        end
+      end
+    end
+  end
+end