appsignal 2.10.12 → 2.11.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5be928ff6008a98a5927b4af5b1aff886fa614c977bd0c15949d5058812271f
-  data.tar.gz: 281d028e86f29716f4686ed4bb24ee6ee980796501f7884d812244ba3b5bc26b
+  metadata.gz: 250f9ca7d702af9daaafbbced86a9122fea07296841c65c41d64a2a9a594fded
+  data.tar.gz: 1753bb37eaeadc98397573098a3b9cf1d718c072074ff3a2d45d3251e75db5f2
 SHA512:
-  metadata.gz: fd2e0585cdb1b54d8b517fcacb3580d17bee2836c0c387ee13b9c345d17ea8f75a3a1c5b4279e58938ec2f53d9ccf309a84047de3088a0e239663b6e07b1c968
-  data.tar.gz: cebe9bd028f453e4febcb4db07eef315b1b4e13353a412d9134e040f3cda8912247f566a275436e6798e5f49eea0f0424e5d1dfeb0a811cd37c213ab55d69f24
+  metadata.gz: 2bd72bf03e824a48fff4be825ce0ecab592f10f77a0163505a7c3f71bde0f8fbafd12642fc232f0528036416ac890ca3d29a44e84efce12a086959a6dcf1178a
+  data.tar.gz: e82a5e2dee87442a90ab2a67b0627f4d4d787243bde54d0ee78420f8286c97f53ca97c97e0283f6991ad123180ab6303564a610159d862e2a1ffbd5921d534f8

data/.semaphore/semaphore.yml

@@ -11,7 +11,7 @@ agent:
     os_image: ubuntu1804
 auto_cancel:
   running:
-    when: branch != 'main' AND branch != 'develop'
+    when: branch != 'master' AND branch != 'develop'
 global_job_config:
   env_vars:
   - name: _BUNDLER_CACHE

data/CHANGELOG.md

@@ -1,17 +1,8 @@
 # Changelog
 
-# 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.11.0
+- Track queue time regardless of namespace. Support custom namespaces. PR #602
+- Report Ruby environment metadata. PR #621
 
 # 2.10.9
 - Use http proxy if configured when downloading agent. PR #606

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/main.svg)](https://appsignal.semaphoreci.com/projects/appsignal-ruby)
+[![Build status](https://appsignal.semaphoreci.com/badges/appsignal-ruby/branches/master.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 => "main"
+  :branch => "master"
 ```
 
 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 `main` branch corresponds to the current stable release of the gem.
+The `master` 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 `main` branch if you're fixing a bug. For new new
+Open a Pull Request on the `master` 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/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/main/CHANGELOG.md",
+      "https://github.com/appsignal/appsignal-ruby/blob/master/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 main AND develop branch as we want it to build all workflows
-      when: "branch != 'main' AND branch != 'develop'"
+      # Ignore master AND develop branch as we want it to build all workflows
+      when: "branch != 'master' AND branch != 'develop'"
 
   global_job_config:
     env_vars:

data/ext/agent.yml

@@ -1,70 +1,70 @@
 ---
-version: 4548c88
+version: 38a8a6f
 mirrors:
 - https://appsignal-agent-releases.global.ssl.fastly.net
 - https://d135dj0rjqvssy.cloudfront.net
 triples:
   x86_64-darwin:
     static:
-      checksum: 322340b402d7750c107bc2c83be46598b3ec0baab27ab7083c6b49dde236cd45
+      checksum: 47f24cd09ab00fe3419a313c52d97170c9555d3ea85c8bd98cbb295df29456dd
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: e92cfc0eda7101a1f08b080233ee6f4385fe32a555b31fd62ab13e904686fbc8
+      checksum: a26437fbd4c97ff0b69bf42e83d968647532648313227224df1bbbd0ed105104
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   universal-darwin:
     static:
-      checksum: 322340b402d7750c107bc2c83be46598b3ec0baab27ab7083c6b49dde236cd45
+      checksum: 47f24cd09ab00fe3419a313c52d97170c9555d3ea85c8bd98cbb295df29456dd
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: e92cfc0eda7101a1f08b080233ee6f4385fe32a555b31fd62ab13e904686fbc8
+      checksum: a26437fbd4c97ff0b69bf42e83d968647532648313227224df1bbbd0ed105104
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   i686-linux:
     static:
-      checksum: '08addb14f53856cc1befcc4428bef7541e04ea733deb4bf600904cc780de95f5'
+      checksum: ae37b329907cead537cf2a87a562ee92120add6c8874bc2e9235e5c537bca692
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: c0c2b3a8ea9e32e686e089101c2f2b4533686eb183f4f30b9ab90cc452222bf0
+      checksum: ee5da14c7b5d2cc2dc2ae345d19c33a08c7e4861975e34878c1c295e57b2d8bc
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   x86-linux:
     static:
-      checksum: '08addb14f53856cc1befcc4428bef7541e04ea733deb4bf600904cc780de95f5'
+      checksum: ae37b329907cead537cf2a87a562ee92120add6c8874bc2e9235e5c537bca692
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: c0c2b3a8ea9e32e686e089101c2f2b4533686eb183f4f30b9ab90cc452222bf0
+      checksum: ee5da14c7b5d2cc2dc2ae345d19c33a08c7e4861975e34878c1c295e57b2d8bc
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   i686-linux-musl:
     static:
-      checksum: b9d3419bcca5a2fe07179af29b8e0fd26df73be46b18e9edaf1049d162eefed4
+      checksum: d2d6dfd5d86b229449c73c74ac6b922eeff981f451dd599cbc8b9f2b7a715931
       filename: appsignal-i686-linux-musl-all-static.tar.gz
   x86-linux-musl:
     static:
-      checksum: b9d3419bcca5a2fe07179af29b8e0fd26df73be46b18e9edaf1049d162eefed4
+      checksum: d2d6dfd5d86b229449c73c74ac6b922eeff981f451dd599cbc8b9f2b7a715931
       filename: appsignal-i686-linux-musl-all-static.tar.gz
   x86_64-linux:
     static:
-      checksum: 4befb33b621cb1d273b5dec9f3395271d4ecfe1d637d5f311c80bac105a06b4b
+      checksum: 6b05c04df7de65be742942926c79e4d322a02dd3b18552b4eb42b420b67df214
       filename: appsignal-x86_64-linux-all-static.tar.gz
     dynamic:
-      checksum: c3696467fcb00aee14041b30f827524634babe3fd2f16bd20320d3f28fb11582
+      checksum: de2f7325d2d7d01632abe9eb135f51376ed3769167e0675b7e7c6de9702c057c
       filename: appsignal-x86_64-linux-all-dynamic.tar.gz
   x86_64-linux-musl:
     static:
-      checksum: 49b95f4c3d025b633e22632ca7b401b56d8acd448a545be3976466676d5aed54
+      checksum: 2a852991c740f93d83dbd3b34daaef45f2ebb02a921200734a6f715790d44968
       filename: appsignal-x86_64-linux-musl-all-static.tar.gz
     dynamic:
-      checksum: db789b22a4ed788db73cbfca5c82cdee29d4d40bedd85a22176b95987ce2c07d
+      checksum: 03fc01d09698b95a5686fc08e4cd1f35913a53413e0ae8ced877c0e7f8ca260e
       filename: appsignal-x86_64-linux-musl-all-dynamic.tar.gz
   x86_64-freebsd:
     static:
-      checksum: b8734f66d077e9acd9fc990c812877b92e4fc783ee30f430d829da058d3a709f
+      checksum: 3a26b9a4a1c7e412f6602f4bbae8dd95ad248b41e033b967163bae2f6fac0e96
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: e8bce24495933d8fad137c1075abbf4173161d0ee3e830f83eb6bfecf309ada5
+      checksum: 4eda2bdb88670854abb07ad716e2d46de298dd8549835468c4a778f74c6a7b0e
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz
   amd64-freebsd:
     static:
-      checksum: b8734f66d077e9acd9fc990c812877b92e4fc783ee30f430d829da058d3a709f
+      checksum: 3a26b9a4a1c7e412f6602f4bbae8dd95ad248b41e033b967163bae2f6fac0e96
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: e8bce24495933d8fad137c1075abbf4173161d0ee3e830f83eb6bfecf309ada5
+      checksum: 4eda2bdb88670854abb07ad716e2d46de298dd8549835468c4a778f74c6a7b0e
       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/lib/appsignal.rb

@@ -134,11 +134,17 @@ module Appsignal
 
           if config[:enable_allocation_tracking] && !Appsignal::System.jruby?
             Appsignal::Extension.install_allocation_event_hook
+            Appsignal::Environment.report_enabled("allocation_tracking")
           end
 
-          GC::Profiler.enable if config[:enable_gc_instrumentation]
+          if config[:enable_gc_instrumentation]
+            GC::Profiler.enable
+            Appsignal::Environment.report_enabled("gc_instrumentation")
+          end
 
           Appsignal::Minutely.start if config[:enable_minutely_probes]
+
+          collect_environment_metadata
         else
           logger.info("Not starting, not active for #{config.env}")
         end
@@ -309,9 +315,23 @@ module Appsignal
       logger.warn "Unable to start logger with log path '#{path}'."
       logger.warn error
     end
+
+    def collect_environment_metadata
+      Appsignal::Environment.report("ruby_version") do
+        "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
+      end
+      Appsignal::Environment.report("ruby_engine") { RUBY_ENGINE }
+      if defined?(RUBY_ENGINE_VERSION)
+        Appsignal::Environment.report("ruby_engine_version") do
+          RUBY_ENGINE_VERSION
+        end
+      end
+      Appsignal::Environment.report_supported_gems
+    end
   end
 end
 
+require "appsignal/environment"
 require "appsignal/system"
 require "appsignal/utils"
 require "appsignal/extension"

data/lib/appsignal/capistrano.rb

@@ -3,6 +3,8 @@
 require "appsignal"
 require "capistrano/version"
 
+Appsignal::Environment.report_enabled("capistrano")
+
 if defined?(Capistrano::VERSION) && Gem::Version.new(Capistrano::VERSION) >= Gem::Version.new(3)
   # Capistrano 3+
   load File.expand_path("../integrations/capistrano/appsignal.cap", __FILE__)

data/lib/appsignal/cli/diagnose.rb

@@ -371,7 +371,7 @@ module Appsignal
         end
 
         def print_installation_result_report(report)
-          report = report.fetch("result", {})
+          report = report.fetch("download", {})
           puts "  Installation result"
           puts "    Status: #{report["status"]}"
           puts "    Message: #{report["message"]}" if report["message"]

data/lib/appsignal/config.rb

@@ -18,6 +18,7 @@ module Appsignal
       :ignore_namespaces              => [],
       :filter_parameters              => [],
       :filter_session_data            => [],
+      :send_environment_metadata      => true,
       :send_params                    => true,
       :request_headers                => %w[
         HTTP_ACCEPT HTTP_ACCEPT_CHARSET HTTP_ACCEPT_ENCODING
@@ -62,6 +63,7 @@ module Appsignal
       "APPSIGNAL_IGNORE_NAMESPACES"              => :ignore_namespaces,
       "APPSIGNAL_FILTER_PARAMETERS"              => :filter_parameters,
       "APPSIGNAL_FILTER_SESSION_DATA"            => :filter_session_data,
+      "APPSIGNAL_SEND_ENVIRONMENT_METADATA"      => :send_environment_metadata,
       "APPSIGNAL_SEND_PARAMS"                    => :send_params,
       "APPSIGNAL_HTTP_PROXY"                     => :http_proxy,
       "APPSIGNAL_ENABLE_ALLOCATION_TRACKING"     => :enable_allocation_tracking,
@@ -119,41 +121,8 @@ module Appsignal
       :initial_config, :file_config, :env_config
     attr_accessor :logger
 
-    # Initialize a new configuration object for AppSignal.
-    #
-    # If this is manually initialized, and not by {Appsignal.start}, it needs
-    # to be assigned to the {Appsignal.config} attribute.
-    #
-    # @example
-    #   require "appsignal"
-    #   Appsignal.config = Appsignal::Config.new(
-    #     app_path,
-    #     "production"
-    #   )
-    #   Appsignal.start
-    #
-    # @param root_path [String] Root path of the app.
-    # @param env [String] The environment to load when AppSignal is started. It
-    #   will look for an environment with this name in the `config/appsignal.yml`
-    #   config file.
-    # @param initial_config [Hash<String, Object>] The initial configuration to
-    #   use. This will be overwritten by the file config and environment
-    #   variables config.
-    # @param logger [Logger] The logger to use for the AppSignal gem. This is
-    #   used by the configuration class only. Default: {Appsignal.logger}. See
-    #   also {Appsignal.start_logger}.
-    # @param config_file [String] Custom config file location. Default
-    #   `config/appsignal.yml`.
-    #
-    # @see https://docs.appsignal.com/ruby/configuration/
-    #   Configuration documentation
-    # @see https://docs.appsignal.com/ruby/configuration/load-order.html
-    #   Configuration load order
-    # @see https://docs.appsignal.com/ruby/instrumentation/integrating-appsignal.html
-    #   How to integrate AppSignal manually
-    def initialize(root_path, env, initial_config = {}, logger = Appsignal.logger, config_file = nil)
+    def initialize(root_path, env, initial_config = {}, logger = Appsignal.logger)
       @root_path      = root_path
-      @config_file    = config_file
       @logger         = logger
       @valid          = false
       @config_hash    = Hash[DEFAULT_CONFIG]
@@ -255,6 +224,7 @@ module Appsignal
       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["_APPSIGNAL_SEND_ENVIRONMENT_METADATA"]    = config_hash[:send_environment_metadata].to_s
       ENV["_APP_REVISION"]                           = config_hash[:revision].to_s
     end
 
@@ -358,8 +328,7 @@ module Appsignal
       %w[APPSIGNAL_PUSH_API_KEY APPSIGNAL_APP_NAME APPSIGNAL_PUSH_API_ENDPOINT
          APPSIGNAL_FRONTEND_ERROR_CATCHING_PATH APPSIGNAL_HTTP_PROXY
          APPSIGNAL_LOG APPSIGNAL_LOG_PATH APPSIGNAL_WORKING_DIR_PATH
-         APPSIGNAL_WORKING_DIRECTORY_PATH APPSIGNAL_HOSTNAME
-         APPSIGNAL_CA_FILE_PATH APP_REVISION].each do |var|
+         APPSIGNAL_HOSTNAME APPSIGNAL_CA_FILE_PATH APP_REVISION].each do |var|
         env_var = ENV[var]
         next unless env_var
         config[ENV_TO_KEY_MAPPING[var]] = env_var
@@ -371,8 +340,9 @@ module Appsignal
          APPSIGNAL_SKIP_SESSION_DATA APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING
          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 APPSIGNAL_TRANSACTION_DEBUG_MODE].each do |var|
+         APPSIGNAL_SEND_ENVIRONMENT_METADATA APPSIGNAL_SEND_PARAMS
+         APPSIGNAL_ENABLE_MINUTELY_PROBES 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/environment.rb

@@ -0,0 +1,126 @@
+module Appsignal
+  # @api private
+  class Environment
+    # Add environment metadata.
+    #
+    # The key and value of the environment metadata must be a String, even if
+    # it's actually of another type.
+    #
+    # The value of the environment metadata is given as a block that captures
+    # errors that might be raised while fetching the value. It will not
+    # re-raise errors, but instead log them using the {Appsignal.logger}. This
+    # ensures AppSignal will not cause an error in the application when
+    # collecting this metadata.
+    #
+    # @example Reporting a key and value
+    #   Appsignal::Environment.report("ruby_version") { RUBY_VERSION }
+    #
+    # @example When a value is nil
+    #   Appsignal::Environment.report("ruby_version") { nil }
+    #   # Key and value do not get reported. A warning gets logged instead.
+    #
+    # @example When an error occurs
+    #   Appsignal::Environment.report("ruby_version") { raise "uh oh" }
+    #   # Error does not get reraised. A warning gets logged instead.
+    #
+    # @param key [String] The name of the key of the environment metadata value.
+    # @yieldreturn [String] The value of the key of the environment metadata.
+    # @return [void]
+    def self.report(key)
+      key =
+        case key
+        when String
+          key
+        else
+          Appsignal.logger.error "Unable to report on environment metadata: " \
+            "Unsupported value type for #{key.inspect}"
+          return
+        end
+
+      yielded_value =
+        begin
+          yield
+        rescue => e
+          Appsignal.logger.error \
+            "Unable to report on environment metadata #{key.inspect}:\n" \
+              "#{e.class}: #{e}"
+          return
+        end
+
+      value =
+        case yielded_value
+        when TrueClass, FalseClass
+          yielded_value.to_s
+        when String
+          yielded_value
+        else
+          Appsignal.logger.error "Unable to report on environment metadata " \
+            "#{key.inspect}: Unsupported value type for " \
+            "#{yielded_value.inspect}"
+          return
+        end
+
+      Appsignal::Extension.set_environment_metadata(key, value)
+    rescue => e
+      Appsignal.logger.error "Unable to report on environment metadata:\n" \
+        "#{e.class}: #{e}"
+    end
+
+    # @see report_supported_gems
+    SUPPORTED_GEMS = %w[
+      actioncable
+      activejob
+      capistrano
+      celluloid
+      data_mapper
+      delayed_job
+      mongo_ruby_driver
+      padrino
+      passenger
+      puma
+      que
+      rack
+      rails
+      rake
+      redis
+      resque
+      sequel
+      shoryuken
+      sidekiq
+      sinatra
+      unicorn
+      webmachine
+    ].freeze
+
+    # Report on the list of AppSignal supported gems
+    #
+    # This list is used to report if which AppSignal supported gems are present
+    # in this app and what version. This data will help AppSignal improve its
+    # support by knowing what gems and versions of gems it still needs to
+    # support or can drop support for.
+    #
+    # It will ask Bundler to report name and version information from the gems
+    # that are present in the app bundle.
+    def self.report_supported_gems
+      return unless defined?(Bundler) # Do nothing if Bundler is not present
+
+      bundle_gem_specs = ::Bundler.rubygems.all_specs
+      SUPPORTED_GEMS.each do |gem_name|
+        gem_spec = bundle_gem_specs.find { |spec| spec.name == gem_name }
+        next unless gem_spec
+
+        report("ruby_#{gem_name}_version") { gem_spec.version.to_s }
+      end
+    rescue => e
+      Appsignal.logger.error "Unable to report supported gems:\n" \
+        "#{e.class}: #{e}"
+    end
+
+    def self.report_enabled(feature)
+      Appsignal::Environment.report("ruby_#{feature}_enabled") { true }
+    rescue => e
+      Appsignal.logger.error "Unable to report integration enabled:\n" \
+        "#{e.class}: #{e}"
+    end
+  end
+end