appsignal 2.10.6 → 2.11.0

data/CHANGELOG.md

@@ -1,5 +1,61 @@
 # Changelog
 
+# 2.11.0
+- Track queue time regardless of namespace. Support custom namespaces. PR #602
+- Improve deprecation message from frontend error middleware. PR #620
+- Report Ruby environment metadata. PR #621, #627, #619, #618
+- Refactor: Move minutely probes to their own files and modules. PR #623
+- Allow custom action names in Que integration. Needed for Active Job
+  integration. PR #628
+- Add Active Job support. Support Active Job without separate AppSignal
+  integration of the background job library. Add support for previously
+  unsupported Active Job adapters. Adapters that were previously already
+  supported (Sidekiq, DelayedJob and Resque) still work in this new setup.
+  PR #629
+- Add automatic Resque integration. Remove manual Resque and Resque Active Job
+  integrations. PR #630
+- Fix issue with unknown events from being reported as often for long running
+  agents. Commit ba9afb538f44c68b8035a8cf40a39d89bc77b021
+- Add support for Active Job priority. PR #632
+- Track Active Job job metrics for magic dashboard. PR #633
+- Report Sidekiq `jid` (job id) as transaction id, reported as "request_id" on
+  AppSignal.com. PR #640
+- Always report Active Job ID, an internal ID used by Active Job. PR #639
+- Support Delayed::Job jobs without specific method name, using
+  `Delayed::Job.enqueue`. PR #642
+- Print warnings using Kernel.warn. PR #648
+- Update AuthCheck class to use DeprecationMessage helper. PR #649
+- Print extension load error when AppSignal is loaded. PR #651
+
+# 2.10.12
+- Fix `working_directory_path` config option loaded from environment variables.
+  PR #653
+
+# 2.10.11
+- Fix extension install report status output in `appsignal diagnose`. PR #636
+- Support setting a specific configuration file to load with the
+  `Appsignal::Config` initializer. PR #638
+
+# 2.10.10
+- Bump agent to v-4548c88. PR #634
+  - Fix issue with host metrics values being reported as "Infinity".
+
+# 2.10.9
+- Use http proxy if configured when downloading agent. PR #606
+- Clear event details cache every 48 hours.
+  Commit eb5e899db69fcd7cfa221567bfd6ac04f2654c9c
+- Add support for Resque ActiveJob queue time reporting. PR #616
+
+## 2.10.8
+- Fix failed checksum error log. PR #609
+- Fix DelayedJob action name detection for objects that listen to the `[]`
+  method and return a non-String value. #611
+- CI test build improvements. PR #607, #608, #614
+
+## 2.10.7
+- Revert fix for compatibility with the `http_logger` gem. PR #604.
+  For more information, see issue #603 about our reasoning and discussion.
+
 ## 2.10.6
 - Check if queued payloads are for correct app and not expired
 

data/README.md

@@ -9,7 +9,7 @@ issues.
 - [Ruby code documentation][ruby-doc]
 - [Support][contact]
 
-[![Build status](https://appsignal.semaphoreci.com/badges/appsignal-ruby/branches/master.svg)](https://appsignal.semaphoreci.com/projects/appsignal-ruby)
+[![Build status](https://appsignal.semaphoreci.com/badges/appsignal-ruby/branches/main.svg)](https://appsignal.semaphoreci.com/projects/appsignal-ruby)
 [![Gem Version](https://badge.fury.io/rb/appsignal.svg)](http://badge.fury.io/rb/appsignal)
 [![Code Climate](https://codeclimate.com/github/appsignal/appsignal.png)](https://codeclimate.com/github/appsignal/appsignal)
 
@@ -183,7 +183,7 @@ installing the AppSignal C-extension.
 # Gemfile
 gem "appsignal",
   :git => "https://github.com/appsignal/appsignal-ruby.git",
-  :branch => "master"
+  :branch => "main"
 ```
 
 When you need to use a git source of the gem in your JRuby install, you'll need
@@ -242,12 +242,12 @@ a number of different Ruby versions.
 
 This gem uses [Semantic Versioning][semver].
 
-The `master` branch corresponds to the current stable release of the gem.
+The `main` branch corresponds to the current stable release of the gem.
 
 The `develop` branch is used for development of features that will end up in
 the next minor release.
 
-Open a Pull Request on the `master` branch if you're fixing a bug. For new new
+Open a Pull Request on the `main` branch if you're fixing a bug. For new new
 features, open a Pull Request on the `develop` branch.
 
 Every stable and unstable release is tagged in git with a version tag.

data/Rakefile

@@ -70,7 +70,10 @@ namespace :build_matrix do
           job = {
             "name" => "Ruby #{ruby_version} for #{gem["gem"]}",
             "env_vars" => env,
-            "commands" => ["./support/bundler_wrapper exec rake test"]
+            "commands" => [
+              "./support/bundler_wrapper exec rake test",
+              "./support/bundler_wrapper exec rake test:failure"
+            ]
           }
           if gem["gem"] == "no_dependencies"
             ruby_primary_block["task"]["jobs"] << job
@@ -364,11 +367,20 @@ end
 
 begin
   require "rspec/core/rake_task"
+  is_jruby = defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby"
+  unless is_jruby
+    jruby_opts = "--exclude-pattern=spec/lib/appsignal/extension/jruby_spec.rb"
+  end
+
   desc "Run the AppSignal gem test suite."
   RSpec::Core::RakeTask.new :test do |t|
-    is_jruby = defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby"
-    unless is_jruby
-      t.rspec_opts = "--exclude-pattern=spec/lib/appsignal/extension/jruby_spec.rb"
+    t.rspec_opts = jruby_opts
+  end
+
+  namespace :test do
+    desc "Run the Appsignal gem test in an extension failure scenario"
+    RSpec::Core::RakeTask.new :failure do |t|
+      t.rspec_opts = "#{jruby_opts} --tag extension_installation_failure"
     end
   end
 rescue LoadError # rubocop:disable Lint/HandleExceptions

data/appsignal.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |gem| # rubocop:disable Metrics/BlockLength
   gem.metadata = {
     "bug_tracker_uri"   => "https://github.com/appsignal/appsignal-ruby/issues",
     "changelog_uri"     =>
-      "https://github.com/appsignal/appsignal-ruby/blob/master/CHANGELOG.md",
+      "https://github.com/appsignal/appsignal-ruby/blob/main/CHANGELOG.md",
     "documentation_uri" => "https://docs.appsignal.com/ruby/",
     "homepage_uri"      => "https://docs.appsignal.com/ruby/",
     "source_code_uri"   => "https://github.com/appsignal/appsignal-ruby"

data/build_matrix.yml

@@ -10,8 +10,8 @@ semaphore: # Default `.semaphore/semaphore.yml` contents
   # Cancel all running and queued workflows before this one
   auto_cancel:
     running:
-      # Ignore master AND develop branch as we want it to build all workflows
-      when: "branch != 'master' AND branch != 'develop'"
+      # Ignore main AND develop branch as we want it to build all workflows
+      when: "branch != 'main' AND branch != 'develop'"
 
   global_job_config:
     env_vars:
@@ -34,15 +34,20 @@ semaphore: # Default `.semaphore/semaphore.yml` contents
         - checkout
         - sem-version ruby $RUBY_VERSION
         - ./support/check_versions
-        - cache restore $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE),$_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET,$_BUNDLER_CACHE-bundler-$RUBY_VERSION
-        - cache restore $_GEMS_CACHE-gems-$RUBY_VERSION-$(checksum $BUNDLE_GEMFILE),$_GEMS_CACHE-gems-$RUBY_VERSION
+        - cache restore $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)
+        - cache restore $_GEMS_CACHE-gems-$RUBY_VERSION-$(checksum $BUNDLE_GEMFILE)
         - ./support/install_deps
+        - bundle config set clean 'true'
         - ./support/bundler_wrapper install --jobs=3 --retry=3
     epilogue:
       on_pass:
         commands:
           - cache store $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE) .bundle
           - cache store $_GEMS_CACHE-gems-$RUBY_VERSION-$(checksum $BUNDLE_GEMFILE) $HOME/.gem
+      on_fail:
+        commands:
+          - "[ -e ext/install.report ] && cat ext/install.report || echo 'No ext/install.report file found'"
+          - "[ -f ext/mkmf.log ] && cat ext/mkmf.log || echo 'No ext/mkmf.log file found'"
 
   blocks:
     - name: Validation
@@ -110,7 +115,7 @@ matrix:
     - ruby: "2.5.7"
       gems: "minimal"
     - ruby: "2.6.5"
-    - ruby: "2.7.0"
+    - ruby: "2.7.1"
     - ruby: "jruby-9.1.17.0"
       gems: "minimal"
   gems:
@@ -119,7 +124,9 @@ matrix:
     - gem: "capistrano3"
     - gem: "grape"
     - gem: "padrino"
-      bundler: "1.17.3"
+      exclude:
+        ruby:
+          - "2.0.0-p648"
     - gem: "que"
     - gem: "que_beta"
       exclude:
@@ -130,13 +137,13 @@ matrix:
       exclude:
         ruby:
           - "2.6.5"
-          - "2.7.0"
+          - "2.7.1"
     - gem: "rails-4.2"
       bundler: "1.17.3"
       exclude:
         ruby:
           - "2.6.5"
-          - "2.7.0"
+          - "2.7.1"
     - gem: "rails-5.0"
       exclude:
         ruby:
@@ -158,8 +165,12 @@ matrix:
           - "2.3.8"
           - "2.4.9"
           - "jruby-9.1.17.0"
-    - gem: "resque"
+    - gem: "resque-1"
       bundler: "1.17.3"
+    - gem: "resque-2"
+      exclude:
+        ruby:
+          - "2.0.0-p648"
     - gem: "sequel"
     - gem: "sequel-435"
     - gem: "sinatra"

data/ext/Rakefile

@@ -11,6 +11,8 @@ end
 
 task :default do
   begin
+    fail_install_on_purpose_in_test!
+
     library_type = "dynamic"
     report["language"]["implementation"] = "jruby"
     report["build"]["library_type"] = library_type

data/ext/agent.yml

@@ -1,70 +1,70 @@
 ---
-version: 96b684b
+version: c8f8185
 mirrors:
 - https://appsignal-agent-releases.global.ssl.fastly.net
 - https://d135dj0rjqvssy.cloudfront.net
 triples:
   x86_64-darwin:
     static:
-      checksum: 6278d03abdcacde207e210374601b0a98eabace8cbc9fb74dffea3c18fc8a252
+      checksum: 8fad088047d8c73e5c0cf9213c20873ad591881d4f7059b178d8eeb89255f73e
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: b0ad069bbff68acde7ef19de47938fa786771bae4821c757718f1894b9654a93
+      checksum: 9a26f0dc170d38b068f66aaa016772f9e32e5fea99dc57bb9dfbc5f0a41dec89
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   universal-darwin:
     static:
-      checksum: 6278d03abdcacde207e210374601b0a98eabace8cbc9fb74dffea3c18fc8a252
+      checksum: 8fad088047d8c73e5c0cf9213c20873ad591881d4f7059b178d8eeb89255f73e
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: b0ad069bbff68acde7ef19de47938fa786771bae4821c757718f1894b9654a93
+      checksum: 9a26f0dc170d38b068f66aaa016772f9e32e5fea99dc57bb9dfbc5f0a41dec89
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   i686-linux:
     static:
-      checksum: f3e79a575241a50d7968fe4743c4f4e5aebb840e0b8664d055383caf696d5d38
+      checksum: 0e8c4436684824a325fa1b581f6fad88598c529307b2b5ad0cc2620d22d2782f
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: 0df11c9fe85c9c94336dfb4df788032c78eda1ea648f98e8c1e4e213258816e1
+      checksum: d0fc35643b36b368a985961ea1c68c3204927f9fed412fde64d81b04081651ff
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   x86-linux:
     static:
-      checksum: f3e79a575241a50d7968fe4743c4f4e5aebb840e0b8664d055383caf696d5d38
+      checksum: 0e8c4436684824a325fa1b581f6fad88598c529307b2b5ad0cc2620d22d2782f
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: 0df11c9fe85c9c94336dfb4df788032c78eda1ea648f98e8c1e4e213258816e1
+      checksum: d0fc35643b36b368a985961ea1c68c3204927f9fed412fde64d81b04081651ff
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   i686-linux-musl:
     static:
-      checksum: 07ab5749b532f1cc6cb45a3334fd950f6d15edacbe6d1bfe25af75b24df73cd1
+      checksum: 28b69e895da6b2a30402eed29cf8c3bbc4f647d6ce9cc5e0b11b4a771d7a1021
       filename: appsignal-i686-linux-musl-all-static.tar.gz
   x86-linux-musl:
     static:
-      checksum: 07ab5749b532f1cc6cb45a3334fd950f6d15edacbe6d1bfe25af75b24df73cd1
+      checksum: 28b69e895da6b2a30402eed29cf8c3bbc4f647d6ce9cc5e0b11b4a771d7a1021
       filename: appsignal-i686-linux-musl-all-static.tar.gz
   x86_64-linux:
     static:
-      checksum: d0e8f48973bca7d783d654404617bb5ab4f47756deb6805c4876bfcda83981cd
+      checksum: fb457dc39e005bb8f241e1e260bb9ea0460cf922db5e30f514dda8afa0bd57bc
       filename: appsignal-x86_64-linux-all-static.tar.gz
     dynamic:
-      checksum: aff7569b04416cd40440d228c5b9881b860e1ecf597bc996ac02c2735f49d993
+      checksum: 55b26406ab0309905d5ad3aa34d1910fcc473f2a475ed5b3073d160a7ea68852
       filename: appsignal-x86_64-linux-all-dynamic.tar.gz
   x86_64-linux-musl:
     static:
-      checksum: 2e3db648d0883f2a7e72f1207ec0976b97d144cafe0a3e755df2d91ca93d113f
+      checksum: cf469d6e3ee1dc6ccb9762a996355ecc407b9a906b9c0a0b6742363347ec9494
       filename: appsignal-x86_64-linux-musl-all-static.tar.gz
     dynamic:
-      checksum: 5da62f954d761af47da16f34ab675b46fedd7b91b485574bf895b43896f61ce0
+      checksum: '0938eab03f2b00583a9b730743c68d3d350090a0ff96866b960a9c78a486a992'
       filename: appsignal-x86_64-linux-musl-all-dynamic.tar.gz
   x86_64-freebsd:
     static:
-      checksum: 8dc226834ef39bac43dbc4a5c6a812c50c34669b0607036dd9494ac587e72d6a
+      checksum: 5c50e4776dbd0defe7d99015650e85d7983222ea27bd7b586b4c92f7b8336eee
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: 0edfbaa450c89dba5750b306043efc00b82851dce2b75fa6ee62de07d30b4a3b
+      checksum: 02cd3b26317100290a2cfac014db026a2607723127955da1e4ddd5b76591003a
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz
   amd64-freebsd:
     static:
-      checksum: 8dc226834ef39bac43dbc4a5c6a812c50c34669b0607036dd9494ac587e72d6a
+      checksum: 5c50e4776dbd0defe7d99015650e85d7983222ea27bd7b586b4c92f7b8336eee
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: 0edfbaa450c89dba5750b306043efc00b82851dce2b75fa6ee62de07d30b4a3b
+      checksum: 02cd3b26317100290a2cfac014db026a2607723127955da1e4ddd5b76591003a
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz

data/ext/appsignal_extension.c

@@ -639,6 +639,14 @@ static VALUE running_in_container() {
   return appsignal_running_in_container() == 1 ? Qtrue : Qfalse;
 }
 
+static VALUE set_environment_metadata(VALUE self, VALUE key, VALUE value) {
+  appsignal_set_environment_metadata(
+      make_appsignal_string(key),
+      make_appsignal_string(value)
+  );
+  return Qnil;
+}
+
 void Init_appsignal_extension(void) {
   Appsignal = rb_define_module("Appsignal");
   Extension = rb_define_class_under(Appsignal, "Extension", rb_cObject);
@@ -697,9 +705,10 @@ void Init_appsignal_extension(void) {
   // Get JSON content of a data
   rb_define_method(Data, "to_s", data_to_s, 0);
 
-  // Event hook installation
+  // Other helper methods
   rb_define_singleton_method(Extension, "install_allocation_event_hook", install_allocation_event_hook, 0);
   rb_define_singleton_method(Extension, "running_in_container?", running_in_container, 0);
+  rb_define_singleton_method(Extension, "set_environment_metadata", set_environment_metadata, 2);
 
   // Metrics
   rb_define_singleton_method(Extension, "set_gauge",              set_gauge,              3);

data/ext/base.rb

@@ -32,7 +32,8 @@ def report
           "version" => "#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}"
         },
         "download" => {
-          "checksum" => "unverified"
+          "checksum" => "unverified",
+          "http_proxy" => http_proxy
         },
         "build" => {
           "time" => Time.now.utc,
@@ -126,7 +127,11 @@ def download_archive(type)
     report["download"]["download_url"] = download_url
 
     begin
-      return open(download_url, :ssl_ca_cert => CA_CERT_PATH)
+      return open(
+        download_url,
+        :ssl_ca_cert => CA_CERT_PATH,
+        :proxy => http_proxy
+      )
     rescue
       next
     end
@@ -142,14 +147,16 @@ def download_archive(type)
 end
 
 def verify_archive(archive, type)
-  if Digest::SHA256.hexdigest(archive.read) == ARCH_CONFIG[type]["checksum"]
+  expected_checksum = ARCH_CONFIG[type]["checksum"]
+  actual_checksum = Digest::SHA256.hexdigest(archive.read)
+  if actual_checksum == expected_checksum
     report["download"]["checksum"] = "verified"
     true
   else
     report["download"]["checksum"] = "invalid"
     abort_installation(
       "Checksum of downloaded archive could not be verified: " \
-        "Expected '#{ARCH_CONFIG[type]["checksum"]}', got '#{checksum}'."
+        "Expected '#{expected_checksum}', got '#{actual_checksum}'."
     )
   end
 end
@@ -172,3 +179,14 @@ def store_download_version_on_report
   path = File.expand_path(File.join(File.dirname(__FILE__), "appsignal.version"))
   report["build"]["agent_version"] = File.read(path).strip
 end
+
+def http_proxy
+  Gem.configuration[:http_proxy] || ENV["http_proxy"] || ENV["HTTP_PROXY"]
+end
+
+# Fail the installation on purpose in a specific test environment.
+def fail_install_on_purpose_in_test!
+  return unless ENV["_TEST_APPSIGNAL_EXTENSION_FAILURE"]
+
+  raise "AppSignal internal test failure"
+end

data/ext/extconf.rb

@@ -7,6 +7,8 @@ def local_build?
 end
 
 def install
+  fail_install_on_purpose_in_test!
+
   library_type = "static"
   report["language"]["implementation"] = "ruby"
   report["build"]["library_type"] = library_type

data/gemfiles/padrino.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'padrino', '~> 0.13.0'
-gem 'rack', '~> 1.6'
+gem 'padrino', "~> 0.15"
+gem 'rack'
 
 gemspec :path => '../'

data/gemfiles/rails-4.2.gemfile

@@ -3,8 +3,15 @@ source 'https://rubygems.org'
 gem 'rails', '~> 4.2.0'
 gem 'mime-types', '~> 2.6'
 
-gemspec :path => '../'
+ruby_version = Gem::Version.new(RUBY_VERSION)
+if ruby_version < Gem::Version.new("2.3.0")
+  gem "sidekiq", "~> 4.0"
+else
+  gem "sidekiq"
+end
 
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.1.0")
+if ruby_version < Gem::Version.new("2.1.0")
   gem 'nokogiri', '~> 1.6.0'
 end
+
+gemspec :path => '../'

data/gemfiles/rails-5.0.gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'rails', '~> 5.0.0'
+gem "sidekiq"
 
 gemspec :path => '../'