appsignal 2.9.17 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ea105e6dd4c3e9e9a6f8e5a5df0304bbc438932c820eadd4008548d02beadf9
-  data.tar.gz: 767b716c1860e4a8a6809f5765b8a6b5e97d3fe682f2d8cd8d797c1226b473bc
+  metadata.gz: 4dcc9f0ae3d601a8d8a7851943568176af63fc2aae714f996449227607a74fee
+  data.tar.gz: c5a44f8e88184697b7ae5ccd56bb13451a64e5fc51eb427fb04ee01c77aaf7ba
 SHA512:
-  metadata.gz: 7ff2cb1442967bc7e07a50c399d690c1a638a7ceff73e4c093f6157c4b84e3541333f3b169ed69e4574dd2904d07a38f3b737557f0d3c4d800ad7d074671b670
-  data.tar.gz: a06dcd00bb6644394795ce844ea9f1677e68e1b7c3c89ca2c289fc6c313fb5c8cecc6cd56453b3c7666a8c760261f1f3ec08ac74270ba17a20f1d30c690f51a3
+  metadata.gz: 71b733951dfa43726b103e3ba39e5898e68009063b97d74d7382c1f7a0687754dba9e3954da5a3f7e5646ef1871c6ef643e238afac4319b787413fe58822a91a
+  data.tar.gz: e0995a18c18ee86162d7a4bc33e046f6b3a956f955c9b6f61f0bc188a161dd222983abc26852ce69bfac0008447612702c587134b010b432dfe449c70b6f1c9d

data/.rubocop_todo.yml

@@ -89,12 +89,6 @@ Style/ClassAndModuleChildren:
   Exclude:
     - 'lib/appsignal/integrations/padrino.rb'
 
-# Offense count: 6
-Style/ClassVars:
-  Exclude:
-    - 'lib/appsignal/event_formatter.rb'
-    - 'lib/appsignal/minutely.rb'
-
 # Offense count: 1
 Style/DoubleNegation:
   Exclude:

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 2.10.0
+- Rescue errors while parsing `appsignal.yml` file. It will prints a warning
+  instead. PR #517
+- Refactoring: Reduce class variable usage. PR #520
+- Bump log level about starting new transactions while a transaction is already
+  active from debug to a warning. PR #525
+- Refactoring: Add internal AppSignal test helpers and other test suite
+  refactorings. PR #536, #537, #538, #539
+- Fix internal Rakefile loading on Ruby 1.9.3. PR #541
+- Add a `--no-color` option to the `appsignal install` command. PR #550
+- Add output coloring to `appsignal diagnose` warnings. PR #551
+- Add validation for empty Push API key. Empty Push API key values will no
+  longer start AppSignal. PR #569
+- Deprecate the JSExceptionCatcher middleware in favor of our new front-end
+  JavaScript integration (https://docs.appsignal.com/front-end/). PR #572
+
+## 2.9.18
+- Bump agent to v-c348132
+  - Improve transmitter logging on timeout
+  - Improve queued payloads transmitter. Should prevent payloads being sent
+    multiple times.
+  - Add transaction debug mode
+  - Wrap Option in Mutex in TransactionInProgess
+
 ## 2.9.17
 - Handle missing file and load errors from `application.rb` in `appsignal
   install` for Rails apps. PR #568

data/Rakefile

@@ -143,9 +143,23 @@ namespace :build do
     end
   end
 
+  def define_build_task(task_name, base_gemspec, &block)
+    Gem::PackageTask.new(base_gemspec, &block)
+  rescue StandardError => error
+    puts "Warning: An error occurred defining `build:#{task_name}:gem` Rake task."
+    puts "This task will not be availble."
+    if ENV["DEBUG"]
+      puts "#{error}: #{error.message}"
+      puts error.backtrace
+    else
+      puts "For more information, run the same command with `DEBUG=true`."
+    end
+    puts
+  end
+
   namespace :ruby do
     # Extension default set in `appsignal.gemspec`
-    Gem::PackageTask.new(base_gemspec) { |_pkg| }
+    define_build_task(:ruby, base_gemspec) { |_pkg| }
   end
 
   namespace :jruby do
@@ -157,7 +171,7 @@ namespace :build do
       s.add_dependency "ffi"
     end
 
-    Gem::PackageTask.new(spec) { |_pkg| }
+    define_build_task(:jruby, spec) { |_pkg| }
   end
 
   desc "Build all gem versions"

data/ext/agent.yml

@@ -1,70 +1,70 @@
 ---
-version: 1d8917f
+version: c348132
 mirrors:
 - https://appsignal-agent-releases.global.ssl.fastly.net
 - https://d135dj0rjqvssy.cloudfront.net
 triples:
   x86_64-darwin:
     static:
-      checksum: 777cf5c54eeb32d9d0d6de48c61f14d977244351a4a9e70c9b30c4221e38012c
+      checksum: cb287c8e2072fe5b8cf14449bd6892989c392d0c651ce339895ae0302cb69785
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: 2741e747961dbac985f5740c3c747c7a76ce88452a37604ae8c8588343a08464
+      checksum: af1ed2e9d29859ffbfc8e6903e4c51764dee94d7b4877ca8d30270b6f133a10f
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   universal-darwin:
     static:
-      checksum: 777cf5c54eeb32d9d0d6de48c61f14d977244351a4a9e70c9b30c4221e38012c
+      checksum: cb287c8e2072fe5b8cf14449bd6892989c392d0c651ce339895ae0302cb69785
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: 2741e747961dbac985f5740c3c747c7a76ce88452a37604ae8c8588343a08464
+      checksum: af1ed2e9d29859ffbfc8e6903e4c51764dee94d7b4877ca8d30270b6f133a10f
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   i686-linux:
     static:
-      checksum: 483417f3afbc76b959d68137717b85d44e9dd14c56bad3a44fd370294dc86273
+      checksum: 2c3bcd102592bf38fbdb27e7c70502dccbe54a0dc2739a9d54aaa694fcfb41fb
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: b34d007f69eea87a197e5bc8b0cd22f512dc37b732c2ae8c49f053c70c291d2c
+      checksum: 1c037b8370b755d706340e25d3e4b2f4acb279dd03873cc53bcf0a6ec0832653
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   x86-linux:
     static:
-      checksum: 483417f3afbc76b959d68137717b85d44e9dd14c56bad3a44fd370294dc86273
+      checksum: 2c3bcd102592bf38fbdb27e7c70502dccbe54a0dc2739a9d54aaa694fcfb41fb
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: b34d007f69eea87a197e5bc8b0cd22f512dc37b732c2ae8c49f053c70c291d2c
+      checksum: 1c037b8370b755d706340e25d3e4b2f4acb279dd03873cc53bcf0a6ec0832653
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   i686-linux-musl:
     static:
-      checksum: ad58fec875496aae76c870e5a1abdf37af27e4d237fc791c4820ef8ccfa05586
+      checksum: 0add9eed4452feda7fc5e1bbd0acdff32c353e4ea0b5d527959df57deb1bdcb2
       filename: appsignal-i686-linux-musl-all-static.tar.gz
   x86-linux-musl:
     static:
-      checksum: ad58fec875496aae76c870e5a1abdf37af27e4d237fc791c4820ef8ccfa05586
+      checksum: 0add9eed4452feda7fc5e1bbd0acdff32c353e4ea0b5d527959df57deb1bdcb2
       filename: appsignal-i686-linux-musl-all-static.tar.gz
   x86_64-linux:
     static:
-      checksum: dcab7852e81cbacb0a187cb62ce2f583f3ff835fb7c49c09f4e41df64b4b81c5
+      checksum: d11221c127c00128da16b419c503281407e429c0ea6f5bfe1691640b8e995e4e
       filename: appsignal-x86_64-linux-all-static.tar.gz
     dynamic:
-      checksum: 33523662808254ae1e630e33a2466bf17acfb636e3726d98d11b375619ea2cdf
+      checksum: 6869ab461fde55487d55805c396d55f36cb881998556f44236035b949939b0af
       filename: appsignal-x86_64-linux-all-dynamic.tar.gz
   x86_64-linux-musl:
     static:
-      checksum: 63cb4ac3d8befaec47eb907b1ff4c6c4af93e39fd7696db783cb6e656dda297c
+      checksum: 7ce44dc23c578933ca37a79d244bc367fdc2438408c2a61558adb92bcfebb1fa
       filename: appsignal-x86_64-linux-musl-all-static.tar.gz
     dynamic:
-      checksum: 4116c2757c2be2b8eb259d787034ec4ab4123889735ded1ef584afbd68a8247a
+      checksum: 78d98f468e3a12cc09baff9e68bc4d9cd3b79f4a3bbe744036bff685415546a4
       filename: appsignal-x86_64-linux-musl-all-dynamic.tar.gz
   x86_64-freebsd:
     static:
-      checksum: 39c006dd131d1ca452ff79ec988688a69823e0abf26ee6966b1639cc42720416
+      checksum: df5f8b61e6ecca40f349cf5c83d5f37f031850d367793dee90dc56f13974431d
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: 937fb029f9f6a57aa818d46dcf8fbbfe06481c0765ad591859fbc6970a32a1df
+      checksum: 30d0303e97386014640c5b8194b777a5741e08ab5497ba58a7d8229bd4890fc5
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz
   amd64-freebsd:
     static:
-      checksum: 39c006dd131d1ca452ff79ec988688a69823e0abf26ee6966b1639cc42720416
+      checksum: df5f8b61e6ecca40f349cf5c83d5f37f031850d367793dee90dc56f13974431d
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: 937fb029f9f6a57aa818d46dcf8fbbfe06481c0765ad591859fbc6970a32a1df
+      checksum: 30d0303e97386014640c5b8194b777a5741e08ab5497ba58a7d8229bd4890fc5
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz

data/lib/appsignal/cli.rb

@@ -32,7 +32,7 @@ module Appsignal
             when :diagnose
               Appsignal::CLI::Diagnose.run(options)
             when :install
-              Appsignal::CLI::Install.run(argv.shift)
+              Appsignal::CLI::Install.run(argv.shift, options)
             when :notify_of_deploy
               Appsignal::CLI::NotifyOfDeploy.run(options)
             end
@@ -85,8 +85,15 @@ module Appsignal
             o.on "--[no-]send-report", "Confirm sending the report to AppSignal automatically" do |arg|
               options[:send_report] = arg
             end
+            o.on "--[no-]color", "Colorize the output of the diagnose command" do |arg|
+              options[:color] = arg
+            end
+          end,
+          "install" => OptionParser.new do |o|
+            o.on "--[no-]color", "Colorize the output of the diagnose command" do |arg|
+              options[:color] = arg
+            end
           end,
-          "install" => OptionParser.new,
           "notify_of_deploy" => OptionParser.new do |o|
             o.banner = "Usage: appsignal notify_of_deploy [options]"
 

data/lib/appsignal/cli/diagnose.rb

@@ -77,6 +77,7 @@ module Appsignal
         # @return [void]
         # @api private
         def run(options = {})
+          self.coloring = options.delete(:color) { true }
           $stdout.sync = true
           header
           print_empty_line
@@ -200,7 +201,7 @@ module Appsignal
         def run_agent_diagnose_mode
           puts "Agent diagnostics"
           unless Appsignal.extension_loaded?
-            puts "  Extension is not loaded. No agent report created."
+            puts colorize("  Extension is not loaded. No agent report created.", :red)
             return
           end
 
@@ -461,10 +462,11 @@ module Appsignal
           print "  Environment: #{format_config_option(env)}"
 
           if env == ""
-            puts "\n    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 diagnose --environment=production"
+            message = "    Warning: No environment set, no config loaded!\n" \
+              "    Please make sure appsignal diagnose is run within your\n" \
+              "    project directory with an environment.\n" \
+              "      appsignal diagnose --environment=production"
+            puts "\n#{colorize(message, :red)}"
           else
             puts sources_label
           end
@@ -531,20 +533,19 @@ module Appsignal
 
         def check_api_key
           puts "Validation"
-          data_section :validation do
-            auth_check = ::Appsignal::AuthCheck.new(Appsignal.config)
-            status, error = auth_check.perform_with_result
-            result =
-              case status
-              when "200"
-                "valid"
-              when "401"
-                "invalid"
-              else
-                "Failed with status #{status}\n#{error.inspect}"
-              end
-            puts_and_save :push_api_key, "Validating Push API key", result
-          end
+          auth_check = ::Appsignal::AuthCheck.new(Appsignal.config)
+          status, error = auth_check.perform_with_result
+          result, color =
+            case status
+            when "200"
+              ["valid", :green]
+            when "401"
+              ["invalid", :red]
+            else
+              ["Failed with status #{status}\n#{error.inspect}", :red]
+            end
+          data[:validation][:push_api_key] = result
+          puts_value "Validating Push API key", colorize(result, color)
         end
 
         def print_paths_section(report)

data/lib/appsignal/cli/helpers.rb

@@ -7,24 +7,36 @@ module Appsignal
     module Helpers
       private
 
+      COLOR_CODES = {
+        :red => 31,
+        :green => 32,
+        :yellow => 33,
+        :blue => 34,
+        :pink => 35,
+        :default => 0
+      }.freeze
+
       def ruby_2_6_or_up?
         Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.6.0")
       end
 
+      def coloring=(value)
+        @coloring = value
+      end
+
+      def coloring?
+        return true unless defined?(@coloring)
+        @coloring
+      end
+
       def colorize(text, color)
+        return text unless coloring?
         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
+        reset_color_code = COLOR_CODES.fetch(:default)
+        color_code = COLOR_CODES.fetch(color, reset_color_code)
 
-        "\e[#{color_code}m#{text}\e[0m"
+        "\e[#{color_code}m#{text}\e[#{reset_color_code}m"
       end
 
       def periods

data/lib/appsignal/cli/install.rb

@@ -13,7 +13,8 @@ module Appsignal
       EXCLUDED_ENVIRONMENTS = ["test"].freeze
 
       class << self
-        def run(push_api_key)
+        def run(push_api_key, options) # rubocop:disable Metrics/AbcSize
+          self.coloring = options.delete(:color) { true }
           $stdout.sync = true
 
           puts

data/lib/appsignal/config.rb

@@ -39,7 +39,8 @@ module Appsignal
       :enable_minutely_probes         => true,
       :ca_file_path                   => File.expand_path(File.join("../../../resources/cacert.pem"), __FILE__),
       :dns_servers                    => [],
-      :files_world_accessible         => true
+      :files_world_accessible         => true,
+      :transaction_debug_mode         => false
     }.freeze
 
     ENV_TO_KEY_MAPPING = {
@@ -75,6 +76,7 @@ module Appsignal
       "APPSIGNAL_DNS_SERVERS"                    => :dns_servers,
       "APPSIGNAL_FILES_WORLD_ACCESSIBLE"         => :files_world_accessible,
       "APPSIGNAL_REQUEST_HEADERS"                => :request_headers,
+      "APPSIGNAL_TRANSACTION_DEBUG_MODE"         => :transaction_debug_mode,
       "APP_REVISION"                             => :revision
     }.freeze
 
@@ -219,6 +221,7 @@ module Appsignal
       ENV["_APPSIGNAL_CA_FILE_PATH"]                 = config_hash[:ca_file_path].to_s
       ENV["_APPSIGNAL_DNS_SERVERS"]                  = config_hash[:dns_servers].join(",")
       ENV["_APPSIGNAL_FILES_WORLD_ACCESSIBLE"]       = config_hash[:files_world_accessible].to_s
+      ENV["_APPSIGNAL_TRANSACTION_DEBUG_MODE"]       = config_hash[:transaction_debug_mode].to_s
       ENV["_APP_REVISION"]                           = config_hash[:revision].to_s
     end
 
@@ -234,11 +237,12 @@ module Appsignal
           "#{endpoint_uri.scheme}://#{endpoint_uri.host}:#{endpoint_uri.port}"
         end
 
-      if config_hash[:push_api_key]
-        @valid = true
-      else
+      push_api_key = config_hash[:push_api_key] || ""
+      if push_api_key.strip.empty?
         @valid = false
-        @logger.error "Push api key not set after loading config"
+        @logger.error "Push API key not set after loading config"
+      else
+        @valid = true
       end
     end
 
@@ -253,8 +257,10 @@ module Appsignal
       {}.tap do |hash|
         hash[:log] = "stdout" if Appsignal::System.heroku?
 
-        # Make active by default if APPSIGNAL_PUSH_API_KEY is present
-        hash[:active] = true if ENV["APPSIGNAL_PUSH_API_KEY"]
+        # Make AppSignal active by default if APPSIGNAL_PUSH_API_KEY
+        # environment variable is present and not empty.
+        env_push_api_key = ENV["APPSIGNAL_PUSH_API_KEY"] || ""
+        hash[:active] = true unless env_push_api_key.strip.empty?
       end
     end
 
@@ -271,9 +277,17 @@ module Appsignal
 
         maintain_backwards_compatibility(config_for_this_env)
       else
-        @logger.error "Not loading from config file: config for '#{env}' not found"
+        logger.error "Not loading from config file: config for '#{env}' not found"
         nil
       end
+    rescue => e
+      message = "An error occured while loading the AppSignal config file." \
+        " Skipping file config.\n" \
+        "File: #{config_file.inspect}\n" \
+        "#{e.name}: #{e}"
+      $stderr.puts "appsignal: #{message}"
+      logger.error "#{message}\n#{e.backtrace.join("\n")}"
+      nil
     end
 
     # Maintain backwards compatibility with config files generated by earlier
@@ -324,7 +338,7 @@ 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
-         APPSIGNAL_FILES_WORLD_ACCESSIBLE].each do |var|
+         APPSIGNAL_FILES_WORLD_ACCESSIBLE APPSIGNAL_TRANSACTION_DEBUG_MODE].each do |var|
         env_var = ENV[var]
         next unless env_var
         config[ENV_TO_KEY_MAPPING[var]] = env_var.casecmp("true").zero?

data/lib/appsignal/event_formatter.rb

@@ -17,15 +17,15 @@ module Appsignal
       include Appsignal::Utils::DeprecationMessage
 
       def formatters
-        @@formatters ||= {}
+        @formatters ||= {}
       end
 
       def deprecated_formatter_classes
-        @@deprecated_formatter_classes ||= {}
+        @deprecated_formatter_classes ||= {}
       end
 
       def formatter_classes
-        @@formatter_classes ||= {}
+        @formatter_classes ||= {}
       end
 
       def register(name, formatter = nil)
@@ -94,7 +94,7 @@ module Appsignal
           "https://docs.appsignal.com/ruby/instrumentation/event-formatters.html",
           logger
 
-        deprecated_formatter_classes[name] = self
+        EventFormatter.deprecated_formatter_classes[name] = self
       end
 
       def logger

data/lib/appsignal/minutely.rb

@@ -129,13 +129,13 @@ module Appsignal
       # @see ProbeCollection
       # @return [ProbeCollection] Returns list of probes.
       def probes
-        @@probes ||= ProbeCollection.new
+        @probes ||= ProbeCollection.new
       end
 
       # @api private
       def start
         stop
-        @@thread = Thread.new do
+        @thread = Thread.new do
           sleep initial_wait_time
           initialize_probes
           loop do
@@ -157,7 +157,7 @@ module Appsignal
 
       # @api private
       def stop
-        defined?(@@thread) && @@thread.kill
+        defined?(@thread) && @thread.kill
         probe_instances.clear
       end
 
@@ -206,7 +206,7 @@ module Appsignal
       end
 
       def probe_instances
-        @@probe_instances ||= {}
+        @probe_instances ||= {}
       end
     end
   end