appsignal 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e29c3c25c84a87e0b4c79ac4b415fb35ce9cf8cd
-  data.tar.gz: d60ecade3fca8316872d961745c5785cd8124f81
+  metadata.gz: 1aa4703023302308a9af7c3133cbbb347bc03eaa
+  data.tar.gz: 7c262a115fb2abeb53af582af27536b836e60475
 SHA512:
-  metadata.gz: b2f474eff84fde5d6771f6963b54017eae2e3f4129b82b93ac52acd80fe9df5ba81a5b03ce06feba7d580518237c73be0902f0b327fdc20353698618c073cf56
-  data.tar.gz: 7553ea79e37867266b626c823663ca688e1f2891b284b4191e055aa450a4262764697363ce0f490cd6d373cdd9b9263f8acb8c807d66d52009e9a8d6b40f1891
+  metadata.gz: 57f347f6c7d8a8fa9729fe7f20679437b737455155c45430c1d0532b1ea8b38aab5d7af35b0b02108110919606af60b33579fdf7c0ce4d3c00cae043dba3ae3c
+  data.tar.gz: 1b74452af063d9299bd1040e98373ddfecae5a0de90a2a365bd7ba24d95fc2f78019b1e1675ff85d3bde8ad215ba10c63bcbbdb5296f91d87ed7f74027b9daf4

data/.travis.yml

@@ -32,6 +32,7 @@ gemfile:
   - "gemfiles/grape.gemfile"
 
 matrix:
+  fast_finish: true
   exclude:
     - rvm: "2.0.0"
       gemfile: "gemfiles/rails-5.0.gemfile"

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+# 2.0.4
+* Use consistent log format for both file and STDOUT logs. PR #203
+* Fix log path in `appsignal diagnose` for Rails applications. PR #218, #222
+* Change default log path to `./log` rather than project root for all non-Rails
+  applications. PR #222
+* Load the `APPSIGNAL_APP_ENV` environment configuration option consistently
+  for all integrations. PR #204
+* Support the `--environment` option on the `appsignal diagnose` command. PR
+  #214
+* Use the real system `/tmp` directory, not a symlink. PR #219
+* Run the AppSignal agent in diagnose mode in the `appsignal diagnose` command.
+  PR #221
+* Test for directory and file ownership and permissions in the
+  `appsignal diagnose` command. PR #216
+* Test if current user is `root` in the `appsignal diagnose` command. PR #215
+* Output last couple of lines from `appsignal.log` on agent connection
+  failures.
+* Agent will no longer fail to start if no writable log path is found.
+  Commit 8920865f6158229a46ed4bd1cc98d99a849884c0, change in agent.
+* Internal refactoring of the test suite and the `appsignal install` command.
+  PR #200, #205
+
 # 2.0.3
 * Fix JavaScript exception catcher throwing an error on finishing a
   transaction. PR #210

data/README.md

@@ -31,7 +31,7 @@ AppSignal will automatically monitor requests, report any exceptions that are
 thrown and any performance issues that might have occurred.
 
 You can also add extra information to requests by adding custom instrumentation
-and by adding metadata.
+and by adding tags.
 
 ### Track any error
 
@@ -50,16 +50,20 @@ end
 
 Read more about [Exception handling][exception-handling] in our documentation.
 
-### Set metadata
+### Tagging
 
-Need more information with errors and performance issues? Add metadata to your
+Need more information with errors and performance issues? Add tags to your
 requests to identify common factors for problems.
 
 ```ruby
-Appsignal.set_metadata("user id", user.id)
-Appsignal.set_metadata("comments count", user.comments.count)
+Appsignal.tag_request(
+  user: current_user.id,
+  locale: I18n.locale
+)
 ```
 
+Read more about [Tagging][tagging] in our documentation.
+
 ### Custom instrumentation
 
 If you need more fine-grained instrumentation you can add custom

data/appsignal.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'rack'
   gem.add_dependency 'thread_safe'
 
-  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rake', '~> 11'
   gem.add_development_dependency 'rspec', '~> 2.14.1'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'timecop'

data/ext/agent.yml

@@ -1,18 +1,18 @@
 ---
-version: f727d42
+version: c18d324
 triples:
   x86_64-linux:
-    checksum: 9dd455ca74b1785b3e84b8c76f8e1c111a5f0c46395952521a092dee4e2990cf
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/f727d42/appsignal-x86_64-linux-all-static.tar.gz
+    checksum: 67a21c8481684466b39a55a6b7418fa838d98e3e4570c9a082ba23e5147d5a64
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/c18d324/appsignal-x86_64-linux-all-static.tar.gz
   i686-linux:
-    checksum: 9404f8af277271d67f82fc6b4662b8c41a06c49199673a419d4ef89e154bc3e7
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/f727d42/appsignal-i686-linux-all-static.tar.gz
+    checksum: 958cc0a742bea1e411bb6dbe0f7f124fe6ec273b8ae0d9b9317f306d60ee0b5d
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/c18d324/appsignal-i686-linux-all-static.tar.gz
   x86-linux:
-    checksum: 9404f8af277271d67f82fc6b4662b8c41a06c49199673a419d4ef89e154bc3e7
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/f727d42/appsignal-i686-linux-all-static.tar.gz
+    checksum: 958cc0a742bea1e411bb6dbe0f7f124fe6ec273b8ae0d9b9317f306d60ee0b5d
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/c18d324/appsignal-i686-linux-all-static.tar.gz
   x86_64-darwin:
-    checksum: feba9c23da6a7121679c992f5c542fe22e39e83985870c4f6f69e5841c0afeb8
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/f727d42/appsignal-x86_64-darwin-all-static.tar.gz
+    checksum: 89053389ddf816aaefc1580899eca8bcac9837dfdfabf6f333a853d17f2edec8
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/c18d324/appsignal-x86_64-darwin-all-static.tar.gz
   universal-darwin:
-    checksum: feba9c23da6a7121679c992f5c542fe22e39e83985870c4f6f69e5841c0afeb8
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/f727d42/appsignal-x86_64-darwin-all-static.tar.gz
+    checksum: 89053389ddf816aaefc1580899eca8bcac9837dfdfabf6f333a853d17f2edec8
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/c18d324/appsignal-x86_64-darwin-all-static.tar.gz

data/lib/appsignal.rb

@@ -226,13 +226,14 @@ module Appsignal
     def logger
       @logger ||= Logger.new(in_memory_log).tap do |l|
         l.level = Logger::INFO
-        l.formatter = log_formatter
+        l.formatter = log_formatter("appsignal")
       end
     end
 
-    def log_formatter
+    def log_formatter(prefix = nil)
+      pre = "#{prefix}: " if prefix
       proc do |severity, datetime, progname, msg|
-        "[#{datetime.strftime('%Y-%m-%dT%H:%M:%S')} (process) ##{Process.pid}][#{severity}] #{msg}\n"
+        "[#{datetime.strftime('%Y-%m-%dT%H:%M:%S')} (process) ##{Process.pid}][#{severity}] #{pre}#{msg}\n"
       end
     end
 
@@ -290,18 +291,16 @@ module Appsignal
 
     def start_stdout_logger
       @logger = Logger.new($stdout)
-      @logger.formatter = lambda do |severity, datetime, progname, msg|
-        "appsignal: #{msg}\n"
-      end
+      logger.formatter = log_formatter("appsignal")
     end
 
     def start_file_logger(path)
       @logger = Logger.new(path)
-      @logger.formatter = log_formatter
+      logger.formatter = log_formatter
     rescue SystemCallError => error
       start_stdout_logger
-      logger.warn "appsignal: Unable to start logger with log path '#{path}'."
-      logger.warn "appsignal: #{error}"
+      logger.warn "Unable to start logger with log path '#{path}'."
+      logger.warn error
     end
   end
 end

data/lib/appsignal/cli.rb

@@ -2,6 +2,7 @@ require 'optparse'
 require 'logger'
 require 'yaml'
 require 'appsignal'
+require 'appsignal/cli/helpers'
 require 'appsignal/cli/demo'
 require 'appsignal/cli/diagnose'
 require 'appsignal/cli/install'
@@ -27,9 +28,9 @@ module Appsignal
             when :demo
               Appsignal::CLI::Demo.run(options)
             when :diagnose
-              Appsignal::CLI::Diagnose.run
+              Appsignal::CLI::Diagnose.run(options)
             when :install
-              Appsignal::CLI::Install.run(argv.shift, config)
+              Appsignal::CLI::Install.run(argv.shift)
             when :notify_of_deploy
               Appsignal::CLI::NotifyOfDeploy.run(options)
             end
@@ -45,15 +46,6 @@ module Appsignal
         end
       end
 
-      def config
-        Appsignal::Config.new(
-          Dir.pwd,
-          options[:environment],
-          {},
-          Logger.new(StringIO.new)
-        )
-      end
-
       def global_option_parser
         OptionParser.new do |o|
           o.banner = 'Usage: appsignal <command> [options]'
@@ -78,11 +70,17 @@ module Appsignal
           'demo' => OptionParser.new do |o|
             o.banner = 'Usage: appsignal demo [options]'
 
-            o.on '--environment=<rails_env>', "The environment to demo" do |arg|
+            o.on '--environment=<app_env>', "The environment to demo" do |arg|
+              options[:environment] = arg
+            end
+          end,
+          'diagnose' => OptionParser.new do |o|
+            o.banner = 'Usage: appsignal diagnose [options]'
+
+            o.on '--environment=<app_env>', "The environment to diagnose" do |arg|
               options[:environment] = arg
             end
           end,
-          'diagnose' => OptionParser.new,
           'install' => OptionParser.new,
           'notify_of_deploy' => OptionParser.new do |o|
             o.banner = 'Usage: appsignal notify_of_deploy [options]'
@@ -95,7 +93,7 @@ module Appsignal
               options[:user] = arg
             end
 
-            o.on '--environment=<rails_env>', "The environment you're deploying to" do |arg|
+            o.on '--environment=<app_env>', "The environment you're deploying to" do |arg|
               options[:environment] = arg
             end
 

data/lib/appsignal/cli/diagnose.rb

@@ -1,12 +1,13 @@
 require "rbconfig"
 require "bundler/cli"
 require "bundler/cli/common"
+require "etc"
 
 module Appsignal
   class CLI
     class Diagnose
       class << self
-        def run
+        def run(options = {})
           header
           empty_line
 
@@ -16,7 +17,8 @@ module Appsignal
           host_information
           empty_line
 
-          start_appsignal
+          start_appsignal(options)
+
           config
           empty_line
 
@@ -31,16 +33,22 @@ module Appsignal
 
         private
 
-        def empty_line
-          puts "\n"
-        end
+        def start_appsignal(options)
+          current_path = Dir.pwd
+          initial_config = {}
+          if rails_app?
+            current_path = Rails.root
+            initial_config[:name] = Rails.application.class.parent_name
+            initial_config[:log_path] = Rails.root.join("log")
+          end
 
-        def start_appsignal
+          ENV['APPSIGNAL_DIAGNOSE'] = 'true'
+          Appsignal.config = Appsignal::Config.new(
+            current_path,
+            options[:environment],
+            initial_config
+          )
           Appsignal.start
-          return if config?
-
-          puts "Error: No config found!"
-          puts "Could not start AppSignal."
         end
 
         def header
@@ -58,6 +66,8 @@ module Appsignal
           puts "  Gem version: #{Appsignal::VERSION}"
           puts "  Agent version: #{Appsignal::Extension.agent_version}"
           puts "  Gem install path: #{gem_path}"
+          print "  Extension loaded: "
+          puts Appsignal.extension_loaded ? "yes" : "no"
         end
 
         def host_information
@@ -67,6 +77,8 @@ module Appsignal
           puts "  Operating System: #{rbconfig["host_os"]}"
           puts "  Ruby version: #{rbconfig["RUBY_VERSION_NAME"]}"
           puts "  Heroku: true" if Appsignal::System.heroku?
+          print "  root user: "
+          puts Process.uid == 0 ? "yes (not recommended)" : "no"
           if Appsignal::System.container?
             puts "  Container id: #{Appsignal::System::Container.id}"
           end
@@ -74,7 +86,6 @@ module Appsignal
 
         def config
           puts "Configuration"
-          return unless config?
           environment
 
           Appsignal.config.config_hash.each do |key, value|
@@ -89,32 +100,64 @@ module Appsignal
             puts "    Warning: No environment set, no config loaded!"
             puts "    Please make sure appsignal diagnose is run within your "
             puts "    project directory with an environment."
-            puts "      APPSIGNAL_APP_ENV=production appsignal diagnose"
+            puts "      appsignal diagnose --environment=production"
           end
         end
 
         def paths_writable
           puts "Required paths"
-          return unless config?
 
-          possible_paths = {
-            :root_path => Appsignal.config.root_path,
-            :log_file_path => Appsignal.config.log_file_path
-          }
-
-          possible_paths.each do |name, path|
-            result = "Not writable"
-            if path
-              if !File.exist? path
-                result = "Does not exist"
-              elsif File.writable? path
-                result = "Writable"
-              end
+          appsignal_paths.each do |name, path|
+            puts "  #{name}: #{path.to_s.inspect}"
+            unless path
+              puts "    - Configured?: no"
+              next
+            end
+            unless File.exist? path
+              puts "    - Exists?: no"
+              next
             end
-            puts "  #{name}: #{path.to_s.inspect} - #{result}"
+
+            print "    - Writable?: "
+            puts File.writable?(path) ? "yes" : "no"
+
+            ownership = path_ownership(path)
+            process_owner = ownership[:process]
+            file_owner = ownership[:file]
+            print "    - Ownership?: "
+            owned = process_owner[:uid] == file_owner[:uid]
+            print owned ? "yes" : "no"
+            print " (file: #{file_owner[:name]}:#{file_owner[:uid]}, "
+            puts "process: #{process_owner[:name]}:#{process_owner[:uid]})"
           end
         end
 
+        def path_ownership(path)
+          process_uid = Process.uid
+          file_uid = File.stat(path).uid
+          {
+            :process => {
+              :uid => process_uid,
+              :name => Etc.getpwuid(process_uid).name
+            },
+            :file => {
+              :uid => file_uid,
+              :name => Etc.getpwuid(file_uid).name
+            }
+          }
+        end
+
+        def appsignal_paths
+          config = Appsignal.config
+          log_file_path = config.log_file_path
+          {
+            :current_path => Dir.pwd,
+            :root_path => config.root_path,
+            :log_dir_path => log_file_path ? File.dirname(log_file_path) : "",
+            :log_file_path => log_file_path,
+          }
+        end
+
         def check_api_key
           auth_check = ::Appsignal::AuthCheck.new(Appsignal.config, Appsignal.logger)
           print "Validating API key: "
@@ -159,14 +202,22 @@ module Appsignal
           end
         end
 
+        def empty_line
+          puts "\n"
+        end
+
+        def rails_app?
+          require "rails"
+          require File.expand_path(File.join(Dir.pwd, "config", "application.rb"))
+          true
+        rescue LoadError
+          false
+        end
+
         def gem_path
           @gem_path ||= \
             Bundler::CLI::Common.select_spec("appsignal").full_gem_path.strip
         end
-
-        def config?
-          Appsignal.config
-        end
       end
     end
   end

data/lib/appsignal/cli/helpers.rb

@@ -0,0 +1,67 @@
+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.getch
+        puts
+        puts
+      end
+
+      def ask_for_input
+        value = stdin.gets
+        value ? value.chomp : ""
+      end
+
+      def required_input(prompt)
+        loop do
+          print prompt
+          value = ask_for_input
+          return value if value.length > 0
+        end
+      end
+
+      def yes_or_no(prompt)
+        loop do
+          print prompt
+          case ask_for_input
+          when "y"
+            return true
+          when "n"
+            return false
+          end
+        end
+      end
+
+      def stdin
+        $stdin
+      end
+    end
+  end
+end