appsignal 2.10.9 → 2.11.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfa76c78bc879ac3d9a5d079b41c79ddb2c51764167af571239970292551d3f2
-  data.tar.gz: 360aaf2f25e55c285b708cd8f379f6305bd04a4094cdb95d9cb64e0f2d772483
+  metadata.gz: 250f9ca7d702af9daaafbbced86a9122fea07296841c65c41d64a2a9a594fded
+  data.tar.gz: 1753bb37eaeadc98397573098a3b9cf1d718c072074ff3a2d45d3251e75db5f2
 SHA512:
-  metadata.gz: 7f8fbf38ae6cc5dabd63d9ecea0f5995ac5fab1bda42cab457b1b69ca834fdce746a40f7fa75f162b2c749bc4cce3e17a1b69cbc9a991a588ccac9b7de11f635
-  data.tar.gz: 8a61386562b1fd28dfa9b90493729a5392b448ad281527caaa71401a2b98fd10018e2680e920c10127dafe94da23c08ace32d681659586ab3029239bf97ae9d0
+  metadata.gz: 2bd72bf03e824a48fff4be825ce0ecab592f10f77a0163505a7c3f71bde0f8fbafd12642fc232f0528036416ac890ca3d29a44e84efce12a086959a6dcf1178a
+  data.tar.gz: e82a5e2dee87442a90ab2a67b0627f4d4d787243bde54d0ee78420f8286c97f53ca97c97e0283f6991ad123180ab6303564a610159d862e2a1ffbd5921d534f8

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+# 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
 - Clear event details cache every 48 hours.

data/ext/agent.yml

@@ -1,70 +1,70 @@
 ---
-version: 6ced5a6
+version: 38a8a6f
 mirrors:
 - https://appsignal-agent-releases.global.ssl.fastly.net
 - https://d135dj0rjqvssy.cloudfront.net
 triples:
   x86_64-darwin:
     static:
-      checksum: dcc623a7eea18727c8628cf29d30e61379e543328a53d91bcf0c5751f3f9f313
+      checksum: 47f24cd09ab00fe3419a313c52d97170c9555d3ea85c8bd98cbb295df29456dd
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: 63f2ba8289390df75b72f414ed026acca07f26ac52bd25cd679c6de776b53ca4
+      checksum: a26437fbd4c97ff0b69bf42e83d968647532648313227224df1bbbd0ed105104
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   universal-darwin:
     static:
-      checksum: dcc623a7eea18727c8628cf29d30e61379e543328a53d91bcf0c5751f3f9f313
+      checksum: 47f24cd09ab00fe3419a313c52d97170c9555d3ea85c8bd98cbb295df29456dd
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: 63f2ba8289390df75b72f414ed026acca07f26ac52bd25cd679c6de776b53ca4
+      checksum: a26437fbd4c97ff0b69bf42e83d968647532648313227224df1bbbd0ed105104
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   i686-linux:
     static:
-      checksum: 8941c1d0a546da8f63bc65953afc439987616c62f2d5307856728ae4f2e0b2f5
+      checksum: ae37b329907cead537cf2a87a562ee92120add6c8874bc2e9235e5c537bca692
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: ccb59ee85f8ba8790482db9de29be6936e92c395bb6306f0fecefbc4de50f78d
+      checksum: ee5da14c7b5d2cc2dc2ae345d19c33a08c7e4861975e34878c1c295e57b2d8bc
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   x86-linux:
     static:
-      checksum: 8941c1d0a546da8f63bc65953afc439987616c62f2d5307856728ae4f2e0b2f5
+      checksum: ae37b329907cead537cf2a87a562ee92120add6c8874bc2e9235e5c537bca692
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: ccb59ee85f8ba8790482db9de29be6936e92c395bb6306f0fecefbc4de50f78d
+      checksum: ee5da14c7b5d2cc2dc2ae345d19c33a08c7e4861975e34878c1c295e57b2d8bc
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   i686-linux-musl:
     static:
-      checksum: 9cfe62cfd0559b900c37b256a2ffc95021007cf3f365152b62af74b55da465a9
+      checksum: d2d6dfd5d86b229449c73c74ac6b922eeff981f451dd599cbc8b9f2b7a715931
       filename: appsignal-i686-linux-musl-all-static.tar.gz
   x86-linux-musl:
     static:
-      checksum: 9cfe62cfd0559b900c37b256a2ffc95021007cf3f365152b62af74b55da465a9
+      checksum: d2d6dfd5d86b229449c73c74ac6b922eeff981f451dd599cbc8b9f2b7a715931
       filename: appsignal-i686-linux-musl-all-static.tar.gz
   x86_64-linux:
     static:
-      checksum: fe74119337cfb8353c64707e4689dc398df1adf2d4bb1bf7750e9a71cca39b3a
+      checksum: 6b05c04df7de65be742942926c79e4d322a02dd3b18552b4eb42b420b67df214
       filename: appsignal-x86_64-linux-all-static.tar.gz
     dynamic:
-      checksum: 6816b709ca388421906b178ae592f565ebc433b59cc50223de8c914e44c75d7a
+      checksum: de2f7325d2d7d01632abe9eb135f51376ed3769167e0675b7e7c6de9702c057c
       filename: appsignal-x86_64-linux-all-dynamic.tar.gz
   x86_64-linux-musl:
     static:
-      checksum: 5382a1b0933a2b4d8fae74f89c1af7a21176a1bc100bb245078a1b369b91caca
+      checksum: 2a852991c740f93d83dbd3b34daaef45f2ebb02a921200734a6f715790d44968
       filename: appsignal-x86_64-linux-musl-all-static.tar.gz
     dynamic:
-      checksum: e222dd4b09d5042e5315512353f987b1be0302c457285de0bfaeb911d72a8e3e
+      checksum: 03fc01d09698b95a5686fc08e4cd1f35913a53413e0ae8ced877c0e7f8ca260e
       filename: appsignal-x86_64-linux-musl-all-dynamic.tar.gz
   x86_64-freebsd:
     static:
-      checksum: b98fcf6490cb5d1485e96656992ee083f534ec43d67caf015f72b8f4cc6e8fa6
+      checksum: 3a26b9a4a1c7e412f6602f4bbae8dd95ad248b41e033b967163bae2f6fac0e96
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: 28e8cab256c3550e249e0768dc9cb0f352396e972186e1ccf9f2c02461a87345
+      checksum: 4eda2bdb88670854abb07ad716e2d46de298dd8549835468c4a778f74c6a7b0e
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz
   amd64-freebsd:
     static:
-      checksum: b98fcf6490cb5d1485e96656992ee083f534ec43d67caf015f72b8f4cc6e8fa6
+      checksum: 3a26b9a4a1c7e412f6602f4bbae8dd95ad248b41e033b967163bae2f6fac0e96
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: 28e8cab256c3550e249e0768dc9cb0f352396e972186e1ccf9f2c02461a87345
+      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/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,
@@ -222,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
 
@@ -337,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

data/lib/appsignal/extension/jruby.rb

@@ -60,6 +60,9 @@ module Appsignal
           [:appsignal_string],
           :appsignal_string
         attach_function :appsignal_running_in_container, [], :bool
+        attach_function :appsignal_set_environment_metadata,
+          [:appsignal_string, :appsignal_string],
+          :void
 
         # Metrics methods
         attach_function :appsignal_set_gauge,
@@ -224,6 +227,13 @@ module Appsignal
         appsignal_running_in_container
       end
 
+      def set_environment_metadata(key, value)
+        appsignal_set_environment_metadata(
+          make_appsignal_string(key),
+          make_appsignal_string(value)
+        )
+      end
+
       def set_gauge(key, value, tags)
         appsignal_set_gauge(make_appsignal_string(key), value, tags.pointer)
       end

data/lib/appsignal/hooks/net_http.rb

@@ -25,6 +25,8 @@ module Appsignal
             end
           end
         end
+
+        Appsignal::Environment.report_enabled("net_http")
       end
     end
   end

data/lib/appsignal/hooks/redis.rb

@@ -26,6 +26,8 @@ module Appsignal
             end
           end
         end
+
+        Appsignal::Environment.report_enabled("redis")
       end
     end
   end

data/lib/appsignal/hooks/sequel.rb

@@ -56,6 +56,8 @@ module Appsignal
 
         # ... and automatically add it to future instances.
         ::Sequel::Database.extension(:appsignal_integration)
+
+        Appsignal::Environment.report_enabled("sequel")
       end
     end
   end

data/lib/appsignal/integrations/object.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+if defined?(Appsignal)
+  Appsignal::Environment.report_enabled("object_instrumentation")
+end
+
 class Object
   def self.appsignal_instrument_class_method(method_name, options = {})
     singleton_class.send \

data/lib/appsignal/integrations/resque_active_job.rb

@@ -34,6 +34,8 @@ module Appsignal
             end
           end
         end
+
+        Appsignal::Environment.report("ruby_active_job_resque_enabled") { true }
       end
     end
   end

data/lib/appsignal/transaction.rb

@@ -228,12 +228,27 @@ module Appsignal
       Appsignal.logger.warn("Queue start value #{start} is too big")
     end
 
+    # Set the queue time based on the HTTP header or `:queue_start` env key
+    # value.
+    #
+    # This method will first try to read the queue time from the HTTP headers
+    # `X-Request-Start` or `X-Queue-Start`. Which are parsed by Rack as
+    # `HTTP_X_QUEUE_START` and `HTTP_X_REQUEST_START`.
+    # The header value is parsed by AppSignal as either milliseconds or
+    # microseconds.
+    #
+    # If no headers are found, or the value could not be parsed, it falls back
+    # on the `:queue_start` env key on this Transaction's {request} environment
+    # (called like `request.env[:queue_start]`). This value is parsed by
+    # AppSignal as seconds.
+    #
+    # @see https://docs.appsignal.com/ruby/instrumentation/request-queue-time.html
+    # @return [void]
     def set_http_or_background_queue_start
-      if namespace == HTTP_REQUEST
-        set_queue_start(http_queue_start)
-      elsif namespace == BACKGROUND_JOB
-        set_queue_start(background_queue_start)
-      end
+      start = http_queue_start || background_queue_start
+      return unless start
+
+      set_queue_start(start)
     end
 
     def set_metadata(key, value)
@@ -346,14 +361,14 @@ module Appsignal
     #
     # @return [nil] if no {#environment} is present.
     # @return [nil] if there is no `:queue_start` in the {#environment}.
-    # @return [Integer]
+    # @return [Integer] `:queue_start` time (in seconds) converted to milliseconds
     def background_queue_start
       env = environment
       return unless env
       queue_start = env[:queue_start]
       return unless queue_start
 
-      (queue_start.to_f * 1000.0).to_i
+      (queue_start.to_f * 1000.0).to_i # Convert seconds to milliseconds
     end
 
     # Returns HTTP queue start time in milliseconds.

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "2.10.9".freeze
+  VERSION = "2.11.0.alpha.1".freeze
 end

data/spec/lib/appsignal/config_spec.rb

@@ -148,6 +148,7 @@ describe Appsignal::Config do
         :instrument_redis               => true,
         :instrument_sequel              => true,
         :skip_session_data              => false,
+        :send_environment_metadata      => true,
         :send_params                    => true,
         :endpoint                       => "https://push.appsignal.com",
         :push_api_key                   => "abc",
@@ -411,7 +412,8 @@ describe Appsignal::Config do
         :instrument_sequel => false,
         :files_world_accessible => false,
         :request_headers => %w[accept accept-charset],
-        :revision => "v2.5.1"
+        :revision => "v2.5.1",
+        :send_environment_metadata => false
       }
     end
     before do
@@ -428,6 +430,7 @@ describe Appsignal::Config do
       ENV["APPSIGNAL_INSTRUMENT_SEQUEL"]       = "false"
       ENV["APPSIGNAL_FILES_WORLD_ACCESSIBLE"]  = "false"
       ENV["APPSIGNAL_REQUEST_HEADERS"]         = "accept,accept-charset"
+      ENV["APPSIGNAL_SEND_ENVIRONMENT_METADATA"] = "false"
       ENV["APP_REVISION"] = "v2.5.1"
     end
 
@@ -527,6 +530,7 @@ describe Appsignal::Config do
       config[:running_in_container] = false
       config[:dns_servers] = ["8.8.8.8", "8.8.4.4"]
       config[:transaction_debug_mode] = true
+      config[:send_environment_metadata] = false
       config[:revision] = "v2.5.1"
       config.write_to_environment
     end
@@ -555,6 +559,7 @@ describe Appsignal::Config do
       expect(ENV["_APPSIGNAL_DNS_SERVERS"]).to                  eq "8.8.8.8,8.8.4.4"
       expect(ENV["_APPSIGNAL_FILES_WORLD_ACCESSIBLE"]).to       eq "true"
       expect(ENV["_APPSIGNAL_TRANSACTION_DEBUG_MODE"]).to       eq "true"
+      expect(ENV["_APPSIGNAL_SEND_ENVIRONMENT_METADATA"]).to    eq "false"
       expect(ENV["_APP_REVISION"]).to                           eq "v2.5.1"
       expect(ENV).to_not                                        have_key("_APPSIGNAL_WORKING_DIR_PATH")
       expect(ENV).to_not                                        have_key("_APPSIGNAL_WORKING_DIRECTORY_PATH")

data/spec/lib/appsignal/environment_spec.rb

@@ -0,0 +1,167 @@
+describe Appsignal::Environment do
+  include EnvironmentMetadataHelper
+
+  before(:context) { start_agent }
+  before { capture_environment_metadata_report_calls }
+
+  def report(key, &value_block)
+    described_class.report(key, &value_block)
+  end
+
+  describe ".report" do
+    it "sends environment metadata to the extension" do
+      logs =
+        capture_logs do
+          report("_test_ruby_version") { "1.0.0" }
+          expect_environment_metadata("_test_ruby_version", "1.0.0")
+        end
+      expect(logs).to be_empty
+    end
+
+    context "when the key is a non String type" do
+      it "does not set the value" do
+        logs =
+          capture_logs do
+            report(:_test_symbol) { "1.0.0" }
+            expect_not_environment_metadata(:_test_symbol)
+            expect_not_environment_metadata("_test_symbol")
+          end
+        expect(logs).to contains_log(
+          :error,
+          "Unable to report on environment metadata: Unsupported value type for :_test_symbol"
+        )
+      end
+    end
+
+    context "when the key is nil" do
+      it "does not set the value" do
+        logs =
+          capture_logs do
+            report(nil) { "1" }
+            expect_not_environment_metadata(nil)
+          end
+        expect(logs).to contains_log(
+          :error,
+          "Unable to report on environment metadata: Unsupported value type for nil"
+        )
+      end
+    end
+
+    context "when the value is true or false" do
+      it "reports true or false as Strings" do
+        logs =
+          capture_logs do
+            report("_test_true") { true }
+            report("_test_false") { false }
+            expect_environment_metadata("_test_true", "true")
+            expect_environment_metadata("_test_false", "false")
+          end
+        expect(logs).to be_empty
+      end
+    end
+
+    context "when the value is nil" do
+      it "does not set the value" do
+        logs =
+          capture_logs do
+            report("_test_ruby_version") { nil }
+            expect_not_environment_metadata("_test_ruby_version")
+          end
+        expect(logs).to contains_log(
+          :error,
+          "Unable to report on environment metadata \"_test_ruby_version\": " \
+            "Unsupported value type for nil"
+        )
+      end
+    end
+
+    context "when the value block raises an error" do
+      it "does not re-raise the error and writes it to the log" do
+        logs =
+          capture_logs do
+            report("_test_error") { raise "uh oh" }
+            expect_not_environment_metadata("_test_error")
+          end
+        expect(logs).to contains_log(
+          :error,
+          "Unable to report on environment metadata \"_test_error\":\n" \
+            "RuntimeError: uh oh"
+        )
+      end
+    end
+
+    context "when something unforseen errors" do
+      it "does not re-raise the error and writes it to the log" do
+        klass = Class.new do
+          def inspect
+            raise "inspect error"
+          end
+        end
+
+        logs =
+          capture_logs do
+            report(klass.new) { raise "value error" }
+            expect(Appsignal::Extension).to_not have_received(:set_environment_metadata)
+          end
+        expect(logs).to contains_log(
+          :error,
+          "Unable to report on environment metadata:\n" \
+            "RuntimeError: inspect error"
+        )
+      end
+    end
+  end
+
+  describe ".report_supported_gems" do
+    it "reports about all AppSignal supported gems in the bundle" do
+      logs = capture_logs { described_class.report_supported_gems }
+
+      expect(logs).to be_empty
+
+      bundle_gem_specs = ::Bundler.rubygems.all_specs
+      rack_spec = bundle_gem_specs.find { |s| s.name == "rack" }
+      rake_spec = bundle_gem_specs.find { |s| s.name == "rake" }
+      expect_environment_metadata("ruby_rack_version", rack_spec.version.to_s)
+      expect_environment_metadata("ruby_rake_version", rake_spec.version.to_s)
+      expect(rack_spec.version.to_s).to_not be_empty
+      expect(rake_spec.version.to_s).to_not be_empty
+    end
+
+    context "when something unforseen errors" do
+      it "does not re-raise the error and writes it to the log" do
+        expect(Bundler).to receive(:rubygems).and_raise(RuntimeError, "bundler error")
+
+        logs = capture_logs { described_class.report_supported_gems }
+        expect(logs).to contains_log(
+          :error,
+          "Unable to report supported gems:\nRuntimeError: bundler error"
+        )
+      end
+    end
+  end
+
+  describe ".report_enabled" do
+    it "reports a feature being enabled" do
+      logs = capture_logs { described_class.report_enabled("a_test") }
+
+      expect(logs).to be_empty
+      expect_environment_metadata("ruby_a_test_enabled", "true")
+    end
+
+    context "when something unforseen errors" do
+      it "does not re-raise the error and writes it to the log" do
+        klass = Class.new do
+          def to_s
+            raise "to_s error"
+          end
+        end
+
+        logs = capture_logs { described_class.report_enabled(klass.new) }
+        expect(logs).to contains_log(
+          :error,
+          "Unable to report integration enabled:\nRuntimeError: to_s error"
+        )
+      end
+    end
+  end
+end

data/spec/lib/appsignal/transaction_spec.rb

@@ -500,23 +500,40 @@ describe Appsignal::Transaction do
     end
 
     describe "#set_http_or_background_queue_start" do
-      context "for a http transaction" do
-        let(:namespace) { Appsignal::Transaction::HTTP_REQUEST }
-        let(:env) { { "HTTP_X_REQUEST_START" => (fixed_time * 1000).to_s } }
+      let(:header_factor) { 1_000 }
+      let(:env_queue_start) { fixed_time + 20 } # in seconds
 
-        it "should set the queue start on the transaction" do
-          expect(transaction).to receive(:set_queue_start).with(13_897_836_000)
+      context "when a queue time is found in a request header" do
+        let(:header_time) { ((fixed_time + 10) * header_factor).to_i } # in milliseconds
+        let(:env) { { "HTTP_X_REQUEST_START" => "t=#{header_time}" } }
+
+        it "sets the http header value in milliseconds on the transaction" do
+          expect(transaction).to receive(:set_queue_start).with(1_389_783_610_000)
 
           transaction.set_http_or_background_queue_start
         end
+
+        context "when a :queue_start key is found in the transaction environment" do
+          let(:env) do
+            {
+              "HTTP_X_REQUEST_START" => "t=#{header_time}",
+              :queue_start => env_queue_start
+            }
+          end
+
+          it "sets the http header value in milliseconds on the transaction" do
+            expect(transaction).to receive(:set_queue_start).with(1_389_783_610_000)
+
+            transaction.set_http_or_background_queue_start
+          end
+        end
       end
 
-      context "for a background transaction" do
-        let(:namespace) { Appsignal::Transaction::BACKGROUND_JOB }
-        let(:env) { { :queue_start => fixed_time } }
+      context "when a :queue_start key is found in the transaction environment" do
+        let(:env) { { :queue_start => env_queue_start } } # in seconds
 
-        it "should set the queue start on the transaction" do
-          expect(transaction).to receive(:set_queue_start).with(1_389_783_600_000)
+        it "sets the :queue_start value in milliseconds on the transaction" do
+          expect(transaction).to receive(:set_queue_start).with(1_389_783_620_000)
 
           transaction.set_http_or_background_queue_start
         end
@@ -910,7 +927,7 @@ describe Appsignal::Transaction do
       context "when queue start is set" do
         let(:env) { background_env_with_data }
 
-        it { is_expected.to eq 1_389_783_590_000 }
+        it { is_expected.to eq 1_389_783_600_000 }
       end
     end
 
@@ -949,7 +966,7 @@ describe Appsignal::Transaction do
             it { is_expected.to be_nil }
           end
 
-          context "with some cruft" do
+          context "with unparsable content at the end" do
             let(:env) { { "HTTP_X_REQUEST_START" => "t=#{slightly_earlier_time_value}aaaa" } }
 
             it { is_expected.to eq 1_389_783_599_600 }
@@ -969,7 +986,7 @@ describe Appsignal::Transaction do
         end
       end
 
-      context "time in miliseconds" do
+      context "time in milliseconds" do
         let(:factor) { 1_000 }
 
         it_should_behave_like "http queue start"

data/spec/lib/appsignal_spec.rb

@@ -1,4 +1,6 @@
 describe Appsignal do
+  include EnvironmentMetadataHelper
+
   before do
     # Make sure we have a clean state because we want to test
     # initialization here.
@@ -80,18 +82,22 @@ describe Appsignal do
           allow(GC::Profiler).to receive(:enable)
           Appsignal.config.config_hash[:enable_allocation_tracking] = true
           Appsignal.config.config_hash[:enable_gc_instrumentation] = true
+          capture_environment_metadata_report_calls
         end
 
         it "should enable Ruby's GC::Profiler" do
           expect(GC::Profiler).to receive(:enable)
           Appsignal.start
+          expect_environment_metadata("ruby_gc_instrumentation_enabled", "true")
         end
 
         unless Appsignal::System.jruby?
+
           it "installs the allocation event hook" do
             expect(Appsignal::Extension).to receive(:install_allocation_event_hook)
               .and_call_original
             Appsignal.start
+            expect_environment_metadata("ruby_allocation_tracking_enabled", "true")
           end
         end
       end
@@ -100,6 +106,7 @@ describe Appsignal do
         before do
           Appsignal.config.config_hash[:enable_allocation_tracking] = false
           Appsignal.config.config_hash[:enable_gc_instrumentation] = false
+          capture_environment_metadata_report_calls
         end
 
         it "should not enable Ruby's GC::Profiler" do
@@ -110,11 +117,13 @@ describe Appsignal do
         it "should not install the allocation event hook" do
           expect(Appsignal::Minutely).not_to receive(:install_allocation_event_hook)
           Appsignal.start
+          expect_not_environment_metadata("ruby_allocation_tracking_enabled")
         end
 
         it "should not add the gc probe to minutely" do
           expect(Appsignal::Minutely).not_to receive(:register_garbage_collection_probe)
           Appsignal.start
+          expect_not_environment_metadata("ruby_gc_instrumentation_enabled")
         end
       end
 
@@ -139,6 +148,19 @@ describe Appsignal do
           Appsignal.start
         end
       end
+
+      describe "environment metadata" do
+        before { capture_environment_metadata_report_calls }
+
+        it "collects and reports environment metadata" do
+          Appsignal.start
+          expect_environment_metadata("ruby_version", "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}")
+          expect_environment_metadata("ruby_engine", RUBY_ENGINE)
+          if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.3.0")
+            expect_environment_metadata("ruby_engine_version", RUBY_ENGINE_VERSION)
+          end
+        end
+      end
     end
 
     context "with debug logging" do

data/spec/support/helpers/env_helpers.rb

@@ -27,7 +27,7 @@ module EnvHelpers
       :priority => 1,
       :attempts => 0,
       :queue => "default",
-      :queue_start => fixed_time - 10.0
+      :queue_start => fixed_time
     }.merge(args)
   end
 end

data/spec/support/helpers/environment_metdata_helper.rb

@@ -0,0 +1,16 @@
+module EnvironmentMetadataHelper
+  def capture_environment_metadata_report_calls
+    allow(Appsignal::Extension).to receive(:set_environment_metadata)
+      .and_call_original
+  end
+
+  def expect_environment_metadata(key, value)
+    expect(Appsignal::Extension).to have_received(:set_environment_metadata)
+      .with(key, value)
+  end
+
+  def expect_not_environment_metadata(key)
+    expect(Appsignal::Extension).to_not have_received(:set_environment_metadata)
+      .with(key, anything)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.10.9
+  version: 2.11.0.alpha.1
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2020-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -190,6 +190,7 @@ files:
 - lib/appsignal/cli/notify_of_deploy.rb
 - lib/appsignal/config.rb
 - lib/appsignal/demo.rb
+- lib/appsignal/environment.rb
 - lib/appsignal/event_formatter.rb
 - lib/appsignal/event_formatter/action_view/render_formatter.rb
 - lib/appsignal/event_formatter/active_record/instantiation_formatter.rb
@@ -274,6 +275,7 @@ files:
 - spec/lib/appsignal/cli_spec.rb
 - spec/lib/appsignal/config_spec.rb
 - spec/lib/appsignal/demo_spec.rb
+- spec/lib/appsignal/environment_spec.rb
 - spec/lib/appsignal/event_formatter/action_view/render_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/active_record/instantiation_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/active_record/sql_formatter_spec.rb
@@ -348,6 +350,7 @@ files:
 - spec/support/helpers/dependency_helper.rb
 - spec/support/helpers/directory_helper.rb
 - spec/support/helpers/env_helpers.rb
+- spec/support/helpers/environment_metdata_helper.rb
 - spec/support/helpers/example_exception.rb
 - spec/support/helpers/example_standard_error.rb
 - spec/support/helpers/log_helpers.rb
@@ -391,9 +394,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.4
 signing_key:
@@ -414,6 +417,7 @@ test_files:
 - spec/lib/appsignal/cli_spec.rb
 - spec/lib/appsignal/config_spec.rb
 - spec/lib/appsignal/demo_spec.rb
+- spec/lib/appsignal/environment_spec.rb
 - spec/lib/appsignal/event_formatter/action_view/render_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/active_record/instantiation_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/active_record/sql_formatter_spec.rb
@@ -488,6 +492,7 @@ test_files:
 - spec/support/helpers/dependency_helper.rb
 - spec/support/helpers/directory_helper.rb
 - spec/support/helpers/env_helpers.rb
+- spec/support/helpers/environment_metdata_helper.rb
 - spec/support/helpers/example_exception.rb
 - spec/support/helpers/example_standard_error.rb
 - spec/support/helpers/log_helpers.rb