appsignal 3.2.1-java → 3.3.0-java

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.3.0
+
+### Added
+
+- [e4314b5b](https://github.com/appsignal/appsignal-ruby/commit/e4314b5b2d3fdf7865555535b2324094ec620349) minor - Hanami 2 is now supported. Requests will now appear as performance measurements.
+
+## 3.2.2
+
+### Changed
+
+- [2b1964d9](https://github.com/appsignal/appsignal-ruby/commit/2b1964d94eee0b20c12f5c602c427643057e787b) patch - Track new Ruby 3.2 VM cache metrics. In Ruby 3.2 the `class_serial` and `global_constant_state` metrics are no longer reported for the "Ruby (VM) metrics" magic dashboard, because Ruby 3.2 removed these metrics. Instead we will now report the new `constant_cache_invalidations` and `constant_cache_misses` metrics reported by Ruby 3.2.
+- [6804e898](https://github.com/appsignal/appsignal-ruby/commit/6804e89817234c88105d2376687b5574bfc8e8c9) patch - Use log formatter if set in logger
+
 ## 3.2.1
 
 ### Fixed

data/README.md

@@ -232,6 +232,7 @@ configurations you need to run the spec suite with a specific Gemfile.
 BUNDLE_GEMFILE=gemfiles/capistrano2.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/capistrano3.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/grape.gemfile bundle exec rspec
+BUNDLE_GEMFILE=gemfiles/hanami.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/http5.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/no_dependencies.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/padrino.gemfile bundle exec rspec

data/build_matrix.yml

@@ -25,6 +25,12 @@ semaphore: # Default `.semaphore/semaphore.yml` contents
       commands:
         - checkout
         - rm -f $HOME/.rbenv/plugins/rbenv-gem-rehash/etc/rbenv.d/exec/~gem-rehash.bash
+        - |
+          if [ -n "$_LIBYAML" ]; then
+            install-package --update libyaml-dev
+          else
+            echo Skipping libyaml-dev install
+          fi
         - |
           if [ -n "$_C_VERSION" ]; then
             sem-version c $_C_VERSION
@@ -54,8 +60,8 @@ semaphore: # Default `.semaphore/semaphore.yml` contents
       task:
         prologue:
           commands:
-            - cache restore $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)
-            - cache restore $_GEMS_CACHE-gems-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)
+            - cache restore $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec)
+            - cache restore $_GEMS_CACHE-gems-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec)
             - ./support/bundler_wrapper install --jobs=3 --retry=3
         jobs:
         - name: Validate CI setup
@@ -71,15 +77,15 @@ semaphore: # Default `.semaphore/semaphore.yml` contents
         epilogue:
           on_pass:
             commands:
-              - cache store $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE) .bundle
-              - cache store $_GEMS_CACHE-gems-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE) $HOME/.gem
+              - cache store $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec) .bundle
+              - cache store $_GEMS_CACHE-gems-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec) $HOME/.gem
     - name: Ruby linters
       dependencies: []
       task:
         prologue:
           commands:
-            - cache restore $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)
-            - cache restore $_GEMS_CACHE-gems-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)
+            - cache restore $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec)
+            - cache restore $_GEMS_CACHE-gems-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec)
             - ./support/bundler_wrapper install --jobs=3 --retry=3
         jobs:
         - name: RuboCop
@@ -95,8 +101,8 @@ semaphore: # Default `.semaphore/semaphore.yml` contents
         epilogue:
           on_pass:
             commands:
-              - cache store $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE) .bundle
-              - cache store $_GEMS_CACHE-gems-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE) $HOME/.gem
+              - cache store $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec) .bundle
+              - cache store $_GEMS_CACHE-gems-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec) $HOME/.gem
     - name: Other linters
       dependencies: []
       task:
@@ -143,16 +149,16 @@ matrix:
       value: "1"
   prologue: # Shared for all jobs in the build matrix
     commands:
-      - cache restore $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)
-      - cache restore $_GEMS_CACHE-gems-$RUBY_VERSION-$(checksum $BUNDLE_GEMFILE)
+      - cache restore $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec)
+      - cache restore $_GEMS_CACHE-gems-$RUBY_VERSION-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec)
       - ./support/install_deps
       - bundle config set clean 'true'
       - ./support/bundler_wrapper install --jobs=3 --retry=3
   epilogue: # Shared for all jobs in the build matrix
     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
+        - cache store $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec) .bundle
+        - cache store $_GEMS_CACHE-gems-$RUBY_VERSION-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec) $HOME/.gem
     on_fail:
       commands:
         - "[ -e ext/install.report ] && cat ext/install.report || echo 'No ext/install.report file found'"
@@ -196,36 +202,44 @@ matrix:
     - ruby: "2.5.8"
       gems: "minimal"
     - ruby: "2.6.9"
-    - ruby: "2.7.5"
-    - ruby: "3.0.3"
-    - ruby: "3.1.1"
-    - ruby: "3.2.0-preview1"
-    - ruby: "jruby-9.2.19.0"
-      gems: "minimal"
+    - ruby: "2.7.7"
+    - ruby: "3.0.4"
+    - ruby: "3.1.2"
+    - ruby: "3.2.0-rc1"
       env_vars:
-        - name: "_C_VERSION"
-          value: "8"
-    - ruby: "jruby-9.3.6.0"
+        - name: "_LIBYAML"
+          value: "1"
+        - name: "RUBY_CFLAGS"
+          value: "-std=gnu99"
+    - ruby: "jruby-9.3.9.0"
+      gems: "minimal"
+    - ruby: "jruby-9.4.0.0"
       gems: "minimal"
   gems:
     - gem: "no_dependencies"
     - gem: "capistrano2"
     - gem: "capistrano3"
     - gem: "grape"
+    - gem: "hanami"
+      only:
+        ruby:
+          - "3.0.4"
+          - "3.1.2"
+          - "3.2.0-rc1"
     - gem: "http5"
     - gem: "padrino"
     - gem: "psych-3"
       only:
         ruby:
-          - "3.0.3"
-          - "3.1.1"
-          - "3.2.0-preview1"
+          - "3.0.4"
+          - "3.1.2"
+          - "3.2.0-rc1"
     - gem: "psych-4"
       only:
         ruby:
-          - "3.0.3"
-          - "3.1.1"
-          - "3.2.0-preview1"
+          - "3.0.4"
+          - "3.1.2"
+          - "3.2.0-rc1"
     - gem: "que"
     - gem: "que_beta"
     - gem: "rails-3.2"
@@ -258,7 +272,7 @@ matrix:
           - "2.4.10"
           - "2.5.8"
           - "2.6.9"
-          - "2.7.5"
+          - "2.7.7"
     - gem: "rails-5.1"
       only:
         ruby:
@@ -269,7 +283,7 @@ matrix:
           - "2.4.10"
           - "2.5.8"
           - "2.6.9"
-          - "2.7.5"
+          - "2.7.7"
     - gem: "rails-5.2"
       only:
         ruby:
@@ -280,34 +294,34 @@ matrix:
           - "2.4.10"
           - "2.5.8"
           - "2.6.9"
-          - "2.7.5"
-          - "jruby-9.2.19.0"
+          - "2.7.7"
+          - "jruby-9.3.9.0"
     - gem: "rails-6.0"
       only:
         ruby:
           - "2.5.8"
           - "2.6.9"
-          - "2.7.5"
-          - "3.0.3"
-          - "jruby-9.2.19.0"
+          - "2.7.7"
+          - "3.0.4"
+          - "jruby-9.4.0.0"
     - gem: "rails-6.1"
       only:
         ruby:
           - "2.5.8"
           - "2.6.9"
-          - "2.7.5"
-          - "3.0.3"
-          - "3.1.1"
-          - "3.2.0-preview1"
-          - "jruby-9.2.19.0"
-          - "jruby-9.3.6.0"
+          - "2.7.7"
+          - "3.0.4"
+          - "3.1.2"
+          - "3.2.0-rc1"
+          - "jruby-9.4.0.0"
     - gem: "rails-7.0"
       only:
         ruby:
-          - "2.7.5"
-          - "3.0.3"
-          - "3.1.1"
-          - "3.2.0-preview1"
+          - "2.7.7"
+          - "3.0.4"
+          - "3.1.2"
+          - "3.2.0-rc1"
+          - "jruby-9.4.0.0"
     - gem: "resque-1"
       bundler: "1.17.3"
       only:
@@ -319,7 +333,7 @@ matrix:
           - "2.4.10"
           - "2.5.8"
           - "2.6.9"
-          - "2.7.5"
+          - "2.7.7"
     - gem: "resque-2"
     - gem: "sequel"
     - gem: "sequel-435"
@@ -332,6 +346,6 @@ matrix:
           - "2.4.10"
           - "2.5.8"
           - "2.6.9"
-          - "2.7.5"
+          - "2.7.7"
     - gem: "sinatra"
     - gem: "webmachine"

data/gemfiles/hanami.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem "hanami", "~> 2.0.0"
+gem "hanami-router", "~> 2.0.0"
+gem "hanami-controller", "~> 2.0.0"
+
+gemspec :path => '../'

data/lib/appsignal/cli/install.rb

@@ -61,6 +61,8 @@ module Appsignal
             install_for_padrino(config)
           elsif installed_frameworks.include?(:grape)
             install_for_grape(config)
+          elsif installed_frameworks.include?(:hanami)
+            install_for_hanami(config)
           elsif installed_frameworks.include?(:sinatra)
             install_for_sinatra(config)
           else
@@ -162,6 +164,24 @@ module Appsignal
           done_notice
         end
 
+        def install_for_hanami(config)
+          puts "Installing for Hanami"
+          config[:name] = required_input("  Enter application name: ")
+          puts
+          configure(config, %w[development production staging], true)
+
+          puts "Finish Hanami installation"
+          puts "  Hanami requires some manual configuration."
+          puts "  After installing the gem, add the following line to config.ru:"
+          puts
+          puts "  require 'appsignal/integrations/hanami'"
+          puts
+          puts "  You can find more information in the documentation:"
+          puts "  http://docs.appsignal.com/ruby/integrations/hanami.html"
+          press_any_key
+          done_notice
+        end
+
         def install_for_capistrano
           capfile = File.join(Dir.pwd, "Capfile")
           return unless File.exist?(capfile)
@@ -256,6 +276,7 @@ module Appsignal
             out << :sinatra if framework_available? "sinatra"
             out << :padrino if framework_available? "padrino"
             out << :grape if framework_available? "grape"
+            out << :hanami if framework_available? "hanami"
           end
         end
 

data/lib/appsignal/integrations/hanami.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "appsignal"
+
+module Appsignal
+  module Integrations
+    module HanamiPlugin
+      def self.init
+        Appsignal.logger.debug("Loading Hanami integration")
+
+        hanami_app_config = ::Hanami.app.config
+        Appsignal.config = Appsignal::Config.new(
+          hanami_app_config.root || Dir.pwd,
+          hanami_app_config.env
+        )
+
+        Appsignal.start_logger
+        Appsignal.start
+
+        ::Hanami::Action.send(:prepend, Appsignal::Integrations::HanamiIntegration) if Appsignal.active?
+      end
+    end
+  end
+end
+
+module Appsignal::Integrations::HanamiIntegration
+  def call(env)
+    params = ::Hanami::Action::BaseParams.new(env)
+    request = ::Hanami::Action::Request.new(
+      :env => env,
+      :params => params,
+      :sessions_enabled => true
+    )
+
+    transaction = Appsignal::Transaction.create(
+      SecureRandom.uuid,
+      Appsignal::Transaction::HTTP_REQUEST,
+      request
+    )
+
+    begin
+      Appsignal.instrument("process_action.hanami") do
+        super.tap do |response|
+          transaction.set_metadata("status", response.status.to_s)
+        end
+      end
+    rescue Exception => error # rubocop:disable Lint/RescueException
+      transaction.set_error(error)
+      transaction.set_metadata("status", "500")
+      raise error
+    ensure
+      transaction.params = request.params.to_h
+      transaction.set_action_if_nil(self.class.name)
+      transaction.set_metadata("path", request.path)
+      transaction.set_metadata("method", request.request_method)
+      transaction.set_http_or_background_queue_start
+      Appsignal::Transaction.complete_current!
+    end
+  end
+end
+
+Appsignal::Integrations::HanamiPlugin.init

data/lib/appsignal/logger.rb

@@ -5,7 +5,7 @@ require "set"
 
 module Appsignal
   # Logger that flushes logs to the AppSignal logging service
-  class Logger < ::Logger
+  class Logger < ::Logger # rubocop:disable Metrics/ClassLength
     # Create a new logger instance
     #
     # @param group Name of the group for this logger.
@@ -20,7 +20,7 @@ module Appsignal
     # We support the various methods in the Ruby
     # logger class by supplying this method.
     # @api private
-    def add(severity, message = nil, group = nil)
+    def add(severity, message = nil, group = nil) # rubocop:disable Metrics/CyclomaticComplexity
       severity ||= UNKNOWN
       return true if severity < level
       group = @group if group.nil?
@@ -33,6 +33,7 @@ module Appsignal
         end
       end
       return if message.nil?
+      message = formatter.call(severity, 0, group, message) if formatter
       severity_number = case severity
                         when DEBUG
                           2
@@ -64,6 +65,7 @@ module Appsignal
       return if DEBUG < level
       message = yield if message.nil? && block_given?
       return if message.nil?
+      message = formatter.call(DEBUG, 0, @group, message) if formatter
       Appsignal::Extension.log(
         @group,
         2,
@@ -80,6 +82,7 @@ module Appsignal
       return if INFO < level
       message = yield if message.nil? && block_given?
       return if message.nil?
+      message = formatter.call(INFO, 0, @group, message) if formatter
       Appsignal::Extension.log(
         @group,
         3,
@@ -96,6 +99,7 @@ module Appsignal
       return if WARN < level
       message = yield if message.nil? && block_given?
       return if message.nil?
+      message = formatter.call(WARN, 0, @group, message) if formatter
       Appsignal::Extension.log(
         @group,
         5,
@@ -112,6 +116,7 @@ module Appsignal
       return if ERROR < level
       message = yield if message.nil? && block_given?
       return if message.nil?
+      message = formatter.call(ERROR, 0, @group, message) if formatter
       Appsignal::Extension.log(
         @group,
         6,
@@ -128,6 +133,7 @@ module Appsignal
       return if FATAL < level
       message = yield if message.nil? && block_given?
       return if message.nil?
+      message = formatter.call(FATAL, 0, @group, message) if formatter
       Appsignal::Extension.log(
         @group,
         7,

data/lib/appsignal/probes/mri.rb

@@ -18,17 +18,38 @@ module Appsignal
       def call
         stat = RubyVM.stat
 
-        set_gauge(
-          "ruby_vm",
-          stat[:class_serial],
-          :metric => :class_serial
-        )
-
-        set_gauge(
-          "ruby_vm",
-          stat[:constant_cache] ? stat[:constant_cache].values.sum : stat[:global_constant_state],
-          :metric => :global_constant_state
-        )
+        constant_cache_invalidations = stat[:constant_cache_invalidations]
+        if constant_cache_invalidations
+          set_gauge(
+            "ruby_vm",
+            constant_cache_invalidations,
+            :metric => :constant_cache_invalidations
+          )
+        end
+
+        constant_cache_misses = stat[:constant_cache_misses]
+        if constant_cache_misses
+          set_gauge(
+            "ruby_vm",
+            constant_cache_misses,
+            :metric => :constant_cache_misses
+          )
+        end
+
+        class_serial = stat[:class_serial]
+        if class_serial
+          set_gauge("ruby_vm", class_serial, :metric => :class_serial)
+        end
+
+        global_constant_state =
+          stat[:constant_cache] ? stat[:constant_cache].values.sum : stat[:global_constant_state]
+        if global_constant_state
+          set_gauge(
+            "ruby_vm",
+            global_constant_state,
+            :metric => :global_constant_state
+          )
+        end
 
         set_gauge("thread_count", Thread.list.size)
         if Appsignal::GarbageCollection.enabled?

data/lib/appsignal/version.rb

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

data/spec/lib/appsignal/auth_check_spec.rb

@@ -20,12 +20,7 @@ describe Appsignal::AuthCheck do
   end
 
   def build_uri_query_string(hash)
-    hash.map do |k, v|
-      k.to_s.tap do |s|
-        next unless v
-        s << "=#{v}"
-      end
-    end.join("&")
+    URI.encode_www_form(hash)
   end
 
   describe "#perform" do

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

@@ -660,7 +660,73 @@ describe Appsignal::CLI::Install do
     end
   end
 
-  if !rails_present? && !sinatra_present? && !padrino_present? && !grape_present?
+  if hanami2_present?
+    context "with hanami" do
+      it_behaves_like "push_api_key validation"
+      it_behaves_like "requires an application name"
+
+      describe "hanami specific tests" do
+        let(:installation_instructions) do
+          [
+            "Installing for Hanami",
+            "Hanami requires some manual configuration.",
+            "http://docs.appsignal.com/ruby/integrations/hanami.html"
+          ]
+        end
+        let(:app_name) { "Test app" }
+        before { enter_app_name app_name }
+
+        describe "configuration with environment variables" do
+          before { choose_environment_config }
+
+          it_behaves_like "windows installation"
+          it_behaves_like "capistrano install"
+          it_behaves_like "demo data"
+
+          it "prints environment variables" do
+            run
+
+            expect(output).to include_env_push_api_key(push_api_key)
+            expect(output).to include_env_app_name(app_name)
+          end
+
+          it "completes the installation" do
+            run
+
+            expect(output).to include(*installation_instructions)
+            expect(output).to include_complete_install
+          end
+        end
+
+        describe "configure with a configuration file" do
+          before { choose_config_file }
+
+          it_behaves_like "windows installation"
+          it_behaves_like "capistrano install"
+          it_behaves_like "demo data"
+
+          it "writes configuration to file" do
+            run
+            expect(output).to include_file_config
+            expect(config_file).to configure_app_name(app_name)
+            expect(config_file).to configure_push_api_key(push_api_key)
+            expect(config_file).to configure_environment("development")
+            expect(config_file).to configure_environment("staging")
+            expect(config_file).to configure_environment("production")
+          end
+
+          it "completes the installation" do
+            run
+
+            expect(output).to include(*installation_instructions)
+            expect(output).to include_complete_install
+          end
+        end
+      end
+    end
+  end
+
+  if !rails_present? && !sinatra_present? && !padrino_present? && !grape_present? && !hanami2_present?
     context "with unknown framework" do
       let(:push_api_key) { "my_key" }