appsignal 3.0.7 → 3.0.11

data/lib/appsignal/cli/diagnose.rb

@@ -105,7 +105,6 @@ module Appsignal
           paths_report = Paths.new
           data[:paths] = paths_report.report
           print_paths_section(paths_report)
-          print_empty_line
 
           transmit_report_to_appsignal if send_report_to_appsignal?(options)
         end
@@ -327,6 +326,7 @@ module Appsignal
           puts "AppSignal library"
           data_section :library do
             save :language, "ruby"
+            puts_value "Language", "Ruby"
             puts_and_save :package_version, "Gem version", Appsignal::VERSION
             puts_and_save :agent_version, "Agent version", Appsignal::Extension.agent_version
             puts_and_save :extension_loaded, "Extension loaded", Appsignal.extension_loaded
@@ -399,6 +399,7 @@ module Appsignal
           puts "    Architecture: #{report["architecture"]}"
           puts "    Target: #{report["target"]}"
           puts "    Musl override: #{report["musl_override"]}"
+          puts "    Linux ARM override: #{report["linux_arm_override"]}"
           puts "    Library type: #{report["library_type"]}"
           puts "    Source: #{report["source"]}" if report["source"] != "remote"
           puts "    Dependencies: #{report["dependencies"]}"
@@ -416,7 +417,7 @@ module Appsignal
           rbconfig = RbConfig::CONFIG
           puts "Host information"
           data_section :host do
-            puts_and_save :architecture, "Architecture", rbconfig["host_cpu"]
+            puts_and_save :architecture, "Architecture", Appsignal::System.agent_architecture
 
             os_label = os = rbconfig["host_os"]
             os_label = "#{os} (Microsoft Windows is not supported.)" if Gem.win_platform?
@@ -573,9 +574,13 @@ module Appsignal
             "(file: #{ownership[:user]}:#{ownership[:uid]}, " \
             "process: #{process_user[:user]}:#{process_user[:uid]})"
           puts_value "Ownership?", owner, :level => 2
-          return unless path.key?(:content)
-          puts "    Contents (last 10 lines):"
-          puts path[:content].last(10)
+
+          if path.key?(:content)
+            puts "    Contents (last 10 lines):"
+            puts path[:content].last(10)
+          else
+            print_empty_line
+          end
         end
 
         def print_empty_line

data/lib/appsignal/system.rb

@@ -8,6 +8,7 @@ module Appsignal
   # @api private
   module System
     LINUX_TARGET = "linux".freeze
+    LINUX_ARM_ARCHITECTURE = "aarch64".freeze
     MUSL_TARGET = "linux-musl".freeze
     FREEBSD_TARGET = "freebsd".freeze
     GEM_EXT_PATH = File.expand_path("../../../ext", __FILE__).freeze
@@ -18,15 +19,18 @@ module Appsignal
 
     # Detect agent and extension platform build
     #
-    # Used by `ext/extconf.rb` to select which build it should download and
+    # Used by `ext/*` to select which build it should download and
     # install.
     #
-    # Use `export APPSIGNAL_BUILD_FOR_MUSL=1` if the detection doesn't work
-    # and to force selection of the musl build.
+    # - Use `export APPSIGNAL_BUILD_FOR_MUSL=1` if the detection doesn't work
+    #   and to force selection of the musl build.
+    # - Use `export APPSIGNAL_BUILD_FOR_LINUX_ARM=1` to enable the experimental
+    #   Linux ARM build.
     #
     # @api private
     # @return [String]
     def self.agent_platform
+      return LINUX_TARGET if force_linux_arm_build?
       return MUSL_TARGET if force_musl_build?
 
       host_os = RbConfig::CONFIG["host_os"].downcase
@@ -53,6 +57,22 @@ module Appsignal
       local_os
     end
 
+    # Detect agent and extension architecture build
+    #
+    # Used by the `ext/*` tasks to select which architecture build it should download and install.
+    #
+    # - Use `export APPSIGNAL_BUILD_FOR_LINUX_ARM=1` to enable the experimental
+    #   Linux ARM build.
+    #
+    # @api private
+    # @return [String]
+    def self.agent_architecture
+      return LINUX_ARM_ARCHITECTURE if force_linux_arm_build?
+
+      # Fallback on the Ruby
+      RbConfig::CONFIG["host_cpu"]
+    end
+
     # Returns whether or not the musl build was forced by the user.
     #
     # @api private
@@ -60,6 +80,13 @@ module Appsignal
       %w[true 1].include?(ENV["APPSIGNAL_BUILD_FOR_MUSL"])
     end
 
+    # Returns whether or not the linux ARM build was selected by the user.
+    #
+    # @api private
+    def self.force_linux_arm_build?
+      %w[true 1].include?(ENV["APPSIGNAL_BUILD_FOR_LINUX_ARM"])
+    end
+
     # @api private
     def self.versionify(version)
       Gem::Version.new(version)

data/lib/appsignal/transaction.rb

@@ -526,7 +526,7 @@ module Appsignal
     end
 
     def cleaned_backtrace(backtrace)
-      if defined?(::Rails) && backtrace
+      if defined?(::Rails) && Rails.respond_to?(:backtrace_cleaner) && backtrace
         ::Rails.backtrace_cleaner.clean(backtrace, nil)
       else
         backtrace

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.0.7".freeze
+  VERSION = "3.0.11".freeze
 end

data/script/install_lintje

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -eu
+
+mkdir -p $HOME/bin
+cache_key=v1-lintje-$LINTJE_VERSION
+cache restore $cache_key
+
+# File exists and is executable
+if [ -x "$HOME/bin/lintje" ]; then
+  echo "Restored Lintje $LINTJE_VERSION from cache"
+else
+  echo "Downloading Lintje $LINTJE_VERSION"
+  curl -L \
+    https://github.com/tombruijn/lintje/releases/download/v$LINTJE_VERSION/x86_64-unknown-linux-gnu.tar.gz | \
+    tar -xz --directory $HOME/bin
+  cache store $cache_key $HOME/bin/lintje
+fi

data/spec/lib/appsignal/cli/diagnose_spec.rb

@@ -270,9 +270,10 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
           "build" => {
             "time" => kind_of(String),
             "package_path" => File.expand_path("../../../../../", __FILE__),
-            "architecture" => rbconfig["host_cpu"],
+            "architecture" => Appsignal::System.agent_architecture,
             "target" => Appsignal::System.agent_platform,
             "musl_override" => false,
+            "linux_arm_override" => false,
             "library_type" => jruby ? "dynamic" : "static",
             "source" => "remote",
             "dependencies" => kind_of(Hash),
@@ -301,9 +302,10 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
           "  Checksum: verified",
           "Build details",
           "  Install time: 20",
-          "  Architecture: #{rbconfig["host_cpu"]}",
+          "  Architecture: #{Appsignal::System.agent_architecture}",
           "  Target: #{Appsignal::System.agent_platform}",
           "  Musl override: false",
+          "  Linux ARM override: false",
           "  Library type: #{jruby ? "dynamic" : "static"}",
           "  Dependencies: {",
           "  Flags: {",

data/spec/lib/appsignal/system_spec.rb

@@ -43,6 +43,14 @@ describe Appsignal::System do
       end
     end
 
+    context "when using the APPSIGNAL_BUILD_FOR_LINUX_ARM env var" do
+      it "returns the linux build" do
+        ENV["APPSIGNAL_BUILD_FOR_LINUX_ARM"] = "1"
+        is_expected.to eq("linux")
+        ENV.delete("APPSIGNAL_BUILD_FOR_LINUX_ARM")
+      end
+    end
+
     context "when on a musl system" do
       let(:ldd_output) { "musl libc (x86_64)\nVersion 1.1.16" }
 
@@ -93,4 +101,26 @@ describe Appsignal::System do
       end
     end
   end
+
+  describe ".agent_architecture" do
+    let(:architecture) { "x86_64" }
+    let(:ldd_output) { "" }
+    before do
+      allow(RbConfig::CONFIG).to receive(:[])
+      allow(RbConfig::CONFIG).to receive(:[]).with("host_cpu").and_return(architecture)
+    end
+    subject { described_class.agent_architecture }
+
+    it "returns the host CPU value" do
+      is_expected.to eq(architecture)
+    end
+
+    context "when using the APPSIGNAL_BUILD_FOR_LINUX_ARM env var" do
+      it "returns ARM 64 bit" do
+        ENV["APPSIGNAL_BUILD_FOR_LINUX_ARM"] = "1"
+        is_expected.to eq("aarch64")
+        ENV.delete("APPSIGNAL_BUILD_FOR_LINUX_ARM")
+      end
+    end
+  end
 end

data/spec/lib/appsignal/transaction_spec.rb

@@ -1321,6 +1321,13 @@ describe Appsignal::Transaction do
         expect(subject).to eq ["line 1", "line 2"]
       end
 
+      context "with Rails module but without backtrace_cleaner method" do
+        it "returns the backtrace uncleaned" do
+          stub_const("Rails", Module.new)
+          expect(subject).to eq ["line 1", "line 2"]
+        end
+      end
+
       if rails_present?
         context "with rails" do
           it "cleans the backtrace with the Rails backtrace cleaner" do

data/spec/lib/puma/appsignal_spec.rb

@@ -1,4 +1,6 @@
 RSpec.describe "Puma plugin" do
+  include WaitForHelper
+
   class MockPumaLauncher
     def events
       return @events if defined?(@events)
@@ -50,7 +52,7 @@ RSpec.describe "Puma plugin" do
     end
 
     def stop
-      @socket && @socket.close
+      defined?(@socket) && @socket && @socket.close
     ensure
       @socket = nil
     end
@@ -72,6 +74,9 @@ RSpec.describe "Puma plugin" do
   let(:hostname) { Socket.gethostname }
   let(:expected_default_tags) { { "hostname" => hostname } }
   let(:stats_data) { { :backlog => 1 } }
+  before :context do
+    Appsignal.stop
+  end
   before do
     module Puma
       def self.stats
@@ -117,10 +122,10 @@ RSpec.describe "Puma plugin" do
     Object.send(:remove_const, :AppsignalPumaPlugin)
   end
 
-  def run(plugin)
+  def run_plugin(plugin, &block)
     @client_thread = Thread.new { start_plugin(plugin) }
     @client_thread.abort_on_exception = true
-    sleep 0.03
+    wait_for(:puma_client_wait, &block)
   ensure
     stop_all
   end
@@ -206,16 +211,16 @@ RSpec.describe "Puma plugin" do
     end
 
     it "collects puma stats as guage metrics with the (summed) worker metrics" do
-      run(appsignal_plugin)
-
-      expect(logs).to_not include([:error, kind_of(String)])
-      expect_gauge(:workers, 2, "type" => "count")
-      expect_gauge(:workers, 2, "type" => "booted")
-      expect_gauge(:workers, 0, "type" => "old")
-      expect_gauge(:connection_backlog, 0)
-      expect_gauge(:pool_capacity, 10)
-      expect_gauge(:threads, 10, "type" => "running")
-      expect_gauge(:threads, 10, "type" => "max")
+      run_plugin(appsignal_plugin) do
+        expect(logs).to_not include([:error, kind_of(String)])
+        expect_gauge(:workers, 2, "type" => "count")
+        expect_gauge(:workers, 2, "type" => "booted")
+        expect_gauge(:workers, 0, "type" => "old")
+        expect_gauge(:connection_backlog, 0)
+        expect_gauge(:pool_capacity, 10)
+        expect_gauge(:threads, 10, "type" => "running")
+        expect_gauge(:threads, 10, "type" => "max")
+      end
     end
   end
 
@@ -230,13 +235,13 @@ RSpec.describe "Puma plugin" do
     end
 
     it "calls `puma_gauge` with the (summed) worker metrics" do
-      run(appsignal_plugin)
-
-      expect(logs).to_not include([:error, kind_of(String)])
-      expect_gauge(:connection_backlog, 0)
-      expect_gauge(:pool_capacity, 5)
-      expect_gauge(:threads, 5, "type" => "running")
-      expect_gauge(:threads, 5, "type" => "max")
+      run_plugin(appsignal_plugin) do
+        expect(logs).to_not include([:error, kind_of(String)])
+        expect_gauge(:connection_backlog, 0)
+        expect_gauge(:pool_capacity, 5)
+        expect_gauge(:threads, 5, "type" => "running")
+        expect_gauge(:threads, 5, "type" => "max")
+      end
     end
   end
 
@@ -246,10 +251,10 @@ RSpec.describe "Puma plugin" do
     after { ENV.delete("APPSIGNAL_HOSTNAME") }
 
     it "reports the APPSIGNAL_HOSTNAME as the hostname tag value" do
-      run(appsignal_plugin)
-
-      expect(logs).to_not include([:error, kind_of(String)])
-      expect_gauge(:connection_backlog, 1)
+      run_plugin(appsignal_plugin) do
+        expect(logs).to_not include([:error, kind_of(String)])
+        expect_gauge(:connection_backlog, 1)
+      end
     end
   end
 
@@ -259,11 +264,11 @@ RSpec.describe "Puma plugin" do
     end
 
     it "fetches metrics from Puma.stats instead" do
-      run(appsignal_plugin)
-
-      expect(logs).to_not include([:error, kind_of(String)])
-      expect(logs).to_not include([kind_of(Symbol), "AppSignal: No Puma stats to report."])
-      expect_gauge(:connection_backlog, 1)
+      run_plugin(appsignal_plugin) do
+        expect(logs).to_not include([:error, kind_of(String)])
+        expect(logs).to_not include([kind_of(Symbol), "AppSignal: No Puma stats to report."])
+        expect_gauge(:connection_backlog, 1)
+      end
     end
   end
 
@@ -274,22 +279,21 @@ RSpec.describe "Puma plugin" do
     end
 
     it "does not fetch metrics" do
-      run(appsignal_plugin)
-
-      expect(logs).to_not include([:error, kind_of(String)])
-      expect(logs).to include([:log, "AppSignal: No Puma stats to report."])
-      expect(messages).to be_empty
+      run_plugin(appsignal_plugin) do
+        expect(logs).to_not include([:error, kind_of(String)])
+        expect(logs).to include([:log, "AppSignal: No Puma stats to report."])
+        expect(messages).to be_empty
+      end
     end
   end
 
   context "without running StatsD server" do
     it "does nothing" do
-      Appsignal.stop
       stop_all
-      run(appsignal_plugin)
-
-      expect(logs).to_not include([:error, kind_of(String)])
-      expect(messages).to be_empty
+      run_plugin(appsignal_plugin) do
+        expect(logs).to_not include([:error, kind_of(String)])
+        expect(messages).to be_empty
+      end
     end
   end
 end

data/spec/support/helpers/wait_for_helper.rb

@@ -16,13 +16,25 @@ module WaitForHelper
   def wait_for(name)
     max_wait = 5_000
     i = 0
+    error = nil
     while i < max_wait
-      break if yield
-      i += 1
-      sleep 0.001
+      begin
+        result = yield
+        break if result
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        # Capture error so we know if it exited with an error
+        error = e
+      ensure
+        i += 1
+        sleep 0.001
+      end
     end
 
     return unless i >= max_wait
-    raise "Waited 5 seconds for #{name} condition, but was not met."
+    error_message =
+      if error
+        "\nError: #{error.class}: #{error.message}\n#{error.backtrace.join("\n")}"
+      end
+    raise "Waited 5 seconds for #{name} condition, but was not met.#{error_message}"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.0.7
+  version: 3.0.11
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-15 00:00:00.000000000 Z
+date: 2021-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -136,6 +136,7 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/chore.md"
 - ".gitignore"
+- ".gitmodules"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -270,6 +271,7 @@ files:
 - mono.yml
 - resources/appsignal.yml.erb
 - resources/cacert.pem
+- script/install_lintje
 - spec/.rubocop.yml
 - spec/lib/appsignal/auth_check_spec.rb
 - spec/lib/appsignal/capistrano2_spec.rb