appsignal 3.9.3 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0c44e1ac2363e7ac8079dfe5141c24243fb5841a4cf39b9844545a57543236a
-  data.tar.gz: 7ba546cf4f4a92c2ae190ba3e697bf97e34c0bcd01592830285cfaf369503c9c
+  metadata.gz: 4a4767b1d66b7aa4d47b79e83265b1e2631b9733f730e392b109d9d563013c79
+  data.tar.gz: 231bc55dfcd8084175fb505470b266937363de1e833852dd539d2970aad36d22
 SHA512:
-  metadata.gz: f969c4bb7ff803e02c6b6076287531712aa117b3d0bf95c2e0384ef6ed13363150cde6bb67ad92ce70022e04f4ec327bc788afe1cce3a00206ee8d73fabea0d5
-  data.tar.gz: '0967f97eba597c995555beb7ffa930678e0f4ce7f4e26a4da02f59571313c52983b747259dd861cc602180d0bb02f238608ac095f44439f4ad6c3d1df8089b0c'
+  metadata.gz: 3116383c605eb524838419ca4911ad2a06ef2b2289d1b88705107c51595edcc749270fa824bc79552c6e255524409630ab477fd9fd6ab72fabf3e7a9ebd6025a
+  data.tar.gz: 471f59339ae58c4a45bcad29560e04397dd646efa7b9269167ed142c773c92018e2e34288d931c14c2a4ec3045f068f760e687179034464a8dda3001fb689244

data/.github/workflows/ci.yml

@@ -15,6 +15,8 @@ name: Ruby gem CI
     - opened
     - reopened
     - synchronize
+  schedule:
+  - cron: 0 0 * * 1-5
 concurrency:
   group: "${{ github.workflow }}-${{ github.ref }}"
   cancel-in-progress: "${{ !contains(github.ref, 'main')}}"
@@ -22,6 +24,7 @@ jobs:
   lint-git:
     name: Git linter (Lintje)
     runs-on: ubuntu-latest
+    if: "${{ github.event_name != 'schedule' }}"
     steps:
     - uses: actions/checkout@v4
       with:
@@ -2996,8 +2999,8 @@ jobs:
       JRUBY_OPTS: ''
       COV: '1'
       BUNDLE_GEMFILE: gemfiles/redis-5.gemfile
-  ruby_jruby-9-4-1-0:
-    name: Ruby jruby-9.4.1.0
+  ruby_jruby-9-4-7-0:
+    name: Ruby jruby-9.4.7.0
     needs: validation
     runs-on: ubuntu-latest
     steps:
@@ -3006,7 +3009,7 @@ jobs:
     - name: Install Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: jruby-9.4.1.0
+        ruby-version: jruby-9.4.7.0
         bundler-cache: true
     - name: Install gem extension
       run: "./support/bundler_wrapper exec rake extension:install"
@@ -3025,9 +3028,9 @@ jobs:
       JRUBY_OPTS: ''
       COV: '1'
       BUNDLE_GEMFILE: gemfiles/no_dependencies.gemfile
-  ruby_jruby-9-4-1-0__rails-6-0:
-    name: Ruby jruby-9.4.1.0 - rails-6.0
-    needs: ruby_jruby-9-4-1-0
+  ruby_jruby-9-4-7-0__rails-6-0:
+    name: Ruby jruby-9.4.7.0 - rails-6.0
+    needs: ruby_jruby-9-4-7-0
     runs-on: ubuntu-latest
     steps:
     - name: Check out repository
@@ -3035,7 +3038,7 @@ jobs:
     - name: Install Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: jruby-9.4.1.0
+        ruby-version: jruby-9.4.7.0
         bundler-cache: true
     - name: Install gem extension
       run: "./support/bundler_wrapper exec rake extension:install"
@@ -3052,9 +3055,9 @@ jobs:
       JRUBY_OPTS: ''
       COV: '1'
       BUNDLE_GEMFILE: gemfiles/rails-6.0.gemfile
-  ruby_jruby-9-4-1-0__rails-6-1:
-    name: Ruby jruby-9.4.1.0 - rails-6.1
-    needs: ruby_jruby-9-4-1-0
+  ruby_jruby-9-4-7-0__rails-6-1:
+    name: Ruby jruby-9.4.7.0 - rails-6.1
+    needs: ruby_jruby-9-4-7-0
     runs-on: ubuntu-latest
     steps:
     - name: Check out repository
@@ -3062,7 +3065,7 @@ jobs:
     - name: Install Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: jruby-9.4.1.0
+        ruby-version: jruby-9.4.7.0
         bundler-cache: true
     - name: Install gem extension
       run: "./support/bundler_wrapper exec rake extension:install"
@@ -3079,9 +3082,9 @@ jobs:
       JRUBY_OPTS: ''
       COV: '1'
       BUNDLE_GEMFILE: gemfiles/rails-6.1.gemfile
-  ruby_jruby-9-4-1-0__rails-7-0:
-    name: Ruby jruby-9.4.1.0 - rails-7.0
-    needs: ruby_jruby-9-4-1-0
+  ruby_jruby-9-4-7-0__rails-7-0:
+    name: Ruby jruby-9.4.7.0 - rails-7.0
+    needs: ruby_jruby-9-4-7-0
     runs-on: ubuntu-latest
     steps:
     - name: Check out repository
@@ -3089,7 +3092,7 @@ jobs:
     - name: Install Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: jruby-9.4.1.0
+        ruby-version: jruby-9.4.7.0
         bundler-cache: true
     - name: Install gem extension
       run: "./support/bundler_wrapper exec rake extension:install"
@@ -3106,9 +3109,9 @@ jobs:
       JRUBY_OPTS: ''
       COV: '1'
       BUNDLE_GEMFILE: gemfiles/rails-7.0.gemfile
-  ruby_jruby-9-4-1-0__rails-7-1:
-    name: Ruby jruby-9.4.1.0 - rails-7.1
-    needs: ruby_jruby-9-4-1-0
+  ruby_jruby-9-4-7-0__rails-7-1:
+    name: Ruby jruby-9.4.7.0 - rails-7.1
+    needs: ruby_jruby-9-4-7-0
     runs-on: ubuntu-latest
     steps:
     - name: Check out repository
@@ -3116,7 +3119,7 @@ jobs:
     - name: Install Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: jruby-9.4.1.0
+        ruby-version: jruby-9.4.7.0
         bundler-cache: true
     - name: Install gem extension
       run: "./support/bundler_wrapper exec rake extension:install"

data/CHANGELOG.md

@@ -1,5 +1,97 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.10.0
+
+_Published on 2024-07-08._
+
+### Added
+
+- Add our new recommended Rack instrumentation middleware. If an app is using the `Appsignal::Rack::GenericInstrumentation` middleware, please update it to use `Appsignal::Rack::InstrumentationMiddleware` instead.
+
+  This new middleware will not report all requests under the "unknown" action if no action name is set. To set an action name, call the `Appsignal.set_action` helper from the app.
+
+  ```ruby
+  # config.ru
+
+  # Setup AppSignal
+
+  use Appsignal::Rack::InstrumentationMiddleware
+
+  # Run app
+  ```
+
+  (minor [f2596781](https://github.com/appsignal/appsignal-ruby/commit/f259678111067bd3d7cf60552201f4d4f95a99d6))
+- Add Rake task performance instrumentation. Configure the `enable_rake_performance_instrumentation` option to `true` to enable Rake task instrumentation for both error and performance monitoring. To ignore specific Rake tasks, configure `ignore_actions` to include the name of the Rake task. (minor [63c9aeed](https://github.com/appsignal/appsignal-ruby/commit/63c9aeed978fcd0942238772c2e441b33e12e16a))
+- Add instrumentation to Rack responses, including streaming responses. New `process_response_body.rack` and `close_response_body.rack` events will be shown in the event timeline. These events show how long it takes to complete responses, depending on the response implementation, and when the response is closed.
+
+  This Sinatra route with a streaming response will be better instrumented, for example:
+
+  ```ruby
+  get "/stream" do
+    stream do |out|
+      sleep 1
+      out << "1"
+      sleep 1
+      out << "2"
+      sleep 1
+      out << "3"
+    end
+  end
+  ```
+
+  (minor [bd2f037b](https://github.com/appsignal/appsignal-ruby/commit/bd2f037ba4840f4606373ee2fc11553f098d5436))
+- Add the `Appsignal.report_error` helper to report errors. If you unsure whether to use the `Appsignal.set_error` or `Appsignal.send_error` helpers in what context, use `Appsignal.report_error` to always report the error. (minor [1502ea14](https://github.com/appsignal/appsignal-ruby/commit/1502ea147210d77dd4ee9d301c52ace30c2a6700))
+- Support nested webmachine apps. If webmachine apps are nested in other AppSignal instrumentation it will now report the webmachine instrumentation as part of the parent transaction, reporting more runtime of the request. (patch [243d20ac](https://github.com/appsignal/appsignal-ruby/commit/243d20acd68a9e59a01d74e17abb910691667b25))
+- Report the response status for Padrino requests as the `response_status` tag on samples, e.g. 200, 301, 500. This tag is visible on the sample detail page.
+  Report the response status for Padrino requests as the `response_status` metric.
+
+  (patch [9239c26b](https://github.com/appsignal/appsignal-ruby/commit/9239c26beb144b9d8bf094bc58030cd618633c38))
+- Add support for nested Padrino apps. When a Padrino app is nested in another Padrino app, or another framework like Sinatra or Rails, it will now report the entire request. (patch [9239c26b](https://github.com/appsignal/appsignal-ruby/commit/9239c26beb144b9d8bf094bc58030cd618633c38))
+- Add `Appsignal.set_params` helper. Set custom parameters on the current transaction with the `Appsignal.set_params` helper. Note that this will overwrite any request parameters that would be set automatically on the transaction. When this method is called multiple times, it will overwrite the previously set value.
+
+  ```ruby
+  Appsignal.set_params("param1" => "value1", "param2" => "value2")
+  ```
+
+  (patch [e8d73e8d](https://github.com/appsignal/appsignal-ruby/commit/e8d73e8d31264c44dd5db5d769be6b599b0ded48))
+- Add `Appsignal.set_custom_data` helper to set custom data on the transaction. Previously, this could only be set with `Appsignal::Transaction.current.set_custom_data("custom_data", ...)`. This helper makes setting the custom data more convenient. (patch [875e4435](https://github.com/appsignal/appsignal-ruby/commit/875e4435ba97838f79a02ff456d3418bc012634a))
+- Add `Appsignal.set_tags` helper as an alias for `Appsignal.tag_request`. This is a context independent named alias available on the Transaction class as well. (patch [1502ea14](https://github.com/appsignal/appsignal-ruby/commit/1502ea147210d77dd4ee9d301c52ace30c2a6700))
+- Add a block argument to the `Appsignal.set_params` and `Appsignal::Transaction#set_params` helpers. When `set_params` is called with a block argument, the block is executed when the parameters are stored on the Transaction. This block is only called when the Transaction is sampled. Use this block argument to avoid having to parse parameters for every transaction, to speed things up when the transaction is not sampled.
+
+  ```ruby
+  Appsignal.set_params do
+    # Some slow code to parse parameters
+    JSON.parse('{"param1": "value1"}')
+  end
+  ```
+
+  (patch [1502ea14](https://github.com/appsignal/appsignal-ruby/commit/1502ea147210d77dd4ee9d301c52ace30c2a6700))
+
+### Deprecated
+
+- Deprecate the `appsignal.action` and `appsignal.route` request env methods to set the transaction action name. Use the `Appsignal.set_action` helper instead.
+
+  ```ruby
+  # Before
+  env["appsignal.action"] = "POST /my-action"
+  env["appsignal.route"] = "POST /my-action"
+
+  # After
+  Appsignal.set_action("POST /my-action")
+  ```
+
+  (patch [1e6d0b31](https://github.com/appsignal/appsignal-ruby/commit/1e6d0b315577176d4dd37db0a8f5fde89c66e8a4))
+- Deprecate the `Appsignal::Rack::StreamingListener` middleware. Use the `Appsignal::Rack::InstrumentationMiddleware` middleware instead. (patch [57d6fa33](https://github.com/appsignal/appsignal-ruby/commit/57d6fa3386d9a9720da76c7b899a332952d472e0))
+- Deprecate the `Appsignal::Rack::GenericInstrumentation` middleware. Use the `Appsignal::Rack::InstrumentationMiddleware` middleware instead. See also the changelog entry about the `InstrumentationMiddleware`. (patch [1502ea14](https://github.com/appsignal/appsignal-ruby/commit/1502ea147210d77dd4ee9d301c52ace30c2a6700))
+
+### Fixed
+
+- Fix issue with AppSignal getting stuck in a boot loop when loading the Padrino integration with: `require "appsignal/integrations/padrino"`
+  This could happen in nested applications, like a Padrino app in a Rails app. AppSignal will now use the first config AppSignal starts with.
+
+  (patch [10722b60](https://github.com/appsignal/appsignal-ruby/commit/10722b60d0ad9dc63b2c7add7d5ee8703190b8f0))
+- Fix the deprecation warning of `Bundler.rubygems.all_specs` usage. (patch [1502ea14](https://github.com/appsignal/appsignal-ruby/commit/1502ea147210d77dd4ee9d301c52ace30c2a6700))
+
 ## 3.9.3
 
 _Published on 2024-07-02._

data/README.md

@@ -9,7 +9,6 @@ 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)
 [![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)
 

data/Rakefile

@@ -127,7 +127,7 @@ namespace :build_matrix do
       output = `git status`
       if output.include? GITHUB_ACTION_WORKFLOW_FILE
         puts "The `#{GITHUB_ACTION_WORKFLOW_FILE}` is modified. The changes were not committed."
-        puts "Please run `rake build_matrix:semaphore:generate` and commit the changes."
+        puts "Please run `rake build_matrix:github:generate` and commit the changes."
         exit 1
       end
     end

data/build_matrix.yml

@@ -2,14 +2,11 @@ github:
   name: Ruby gem CI
   "on":
     push:
-      branches:
-        - "main"
-        - "develop"
+      branches: ["main", "develop"]
     pull_request:
-      types:
-        - opened
-        - reopened
-        - synchronize
+      types: [opened, reopened, synchronize]
+    schedule:
+      - cron: "0 0 * * 1-5"
 
   concurrency:
     group: ${{ github.workflow }}-${{ github.ref }}
@@ -19,6 +16,7 @@ github:
     lint-git:
       name: "Git linter (Lintje)"
       runs-on: ubuntu-latest
+      if: ${{ github.event_name != 'schedule' }}
       steps:
         - uses: actions/checkout@v4
           with:
@@ -93,7 +91,7 @@ matrix:
     - ruby: "3.1.3"
     - ruby: "3.0.5"
     - ruby: "2.7.8"
-    - ruby: "jruby-9.4.1.0"
+    - ruby: "jruby-9.4.7.0"
       gems: "minimal"
   gems:
     - gem: "no_dependencies"
@@ -146,7 +144,7 @@ matrix:
         ruby:
           - "3.0.5"
           - "2.7.8"
-          - "jruby-9.4.1.0"
+          - "jruby-9.4.7.0"
     - gem: "rails-6.1"
       only:
         ruby:
@@ -155,7 +153,7 @@ matrix:
           - "3.1.3"
           - "3.0.5"
           - "2.7.8"
-          - "jruby-9.4.1.0"
+          - "jruby-9.4.7.0"
     - gem: "rails-7.0"
       only:
         ruby:
@@ -164,7 +162,7 @@ matrix:
           - "3.1.3"
           - "3.0.5"
           - "2.7.8"
-          - "jruby-9.4.1.0"
+          - "jruby-9.4.7.0"
     - gem: "rails-7.1"
       only:
         ruby:
@@ -172,7 +170,7 @@ matrix:
           - "3.2.1"
           - "3.1.3"
           - "3.0.5"
-          - "jruby-9.4.1.0"
+          - "jruby-9.4.7.0"
     - gem: "sequel"
     - gem: "sinatra"
     - gem: "webmachine1"

data/gemfiles/webmachine1.gemfile

@@ -1,6 +1,7 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'webmachine', '~> 1.6'
-gem 'webrick'
+gem "i18n", "~> 0.0" # Lock to pre 1.x version as it's not compatible
+gem "webmachine", "~> 1.6"
+gem "webrick"
 
-gemspec :path => '../'
+gemspec :path => "../"

data/lib/appsignal/config.rb

@@ -23,6 +23,7 @@ module Appsignal
       :enable_gvl_global_timer => true,
       :enable_gvl_waiting_threads => true,
       :enable_rails_error_reporter => true,
+      :enable_rake_performance_instrumentation => false,
       :endpoint => "https://push.appsignal.com",
       :files_world_accessible => true,
       :filter_metadata => [],
@@ -83,6 +84,8 @@ module Appsignal
       "APPSIGNAL_ENABLE_GVL_GLOBAL_TIMER" => :enable_gvl_global_timer,
       "APPSIGNAL_ENABLE_GVL_WAITING_THREADS" => :enable_gvl_waiting_threads,
       "APPSIGNAL_ENABLE_RAILS_ERROR_REPORTER" => :enable_rails_error_reporter,
+      "APPSIGNAL_ENABLE_RAKE_PERFORMANCE_INSTRUMENTATION" =>
+        :enable_rake_performance_instrumentation,
       "APPSIGNAL_FILES_WORLD_ACCESSIBLE" => :files_world_accessible,
       "APPSIGNAL_FILTER_METADATA" => :filter_metadata,
       "APPSIGNAL_FILTER_PARAMETERS" => :filter_parameters,
@@ -150,6 +153,7 @@ module Appsignal
       APPSIGNAL_ENABLE_GVL_GLOBAL_TIMER
       APPSIGNAL_ENABLE_GVL_WAITING_THREADS
       APPSIGNAL_ENABLE_RAILS_ERROR_REPORTER
+      APPSIGNAL_ENABLE_RAKE_PERFORMANCE_INSTRUMENTATION
       APPSIGNAL_FILES_WORLD_ACCESSIBLE
       APPSIGNAL_INSTRUMENT_HTTP_RB
       APPSIGNAL_INSTRUMENT_NET_HTTP

data/lib/appsignal/environment.rb

@@ -121,7 +121,12 @@ module Appsignal
     def self.report_supported_gems
       return unless defined?(Bundler) # Do nothing if Bundler is not present
 
-      bundle_gem_specs = ::Bundler.rubygems.all_specs
+      bundle_gem_specs =
+        if ::Bundler.rubygems.respond_to?(:installed_specs)
+          ::Bundler.rubygems.installed_specs
+        else
+          ::Bundler.rubygems.all_specs
+        end
       SUPPORTED_GEMS.each do |gem_name|
         gem_spec = bundle_gem_specs.find { |spec| spec.name == gem_name }
         next unless gem_spec

data/lib/appsignal/helpers/instrumentation.rb

@@ -195,6 +195,7 @@ module Appsignal
       #   used to send the error.
       # @return [void]
       #
+      # @see Transaction#report_error
       # @see https://docs.appsignal.com/ruby/instrumentation/exception-handling.html
       #   Exception handling guide
       # @see https://docs.appsignal.com/ruby/instrumentation/tagging.html
@@ -294,6 +295,7 @@ module Appsignal
       # @return [void]
       #
       # @see Transaction#set_error
+      # @see Transaction#report_error
       # @see https://docs.appsignal.com/ruby/instrumentation/exception-handling.html
       #   Exception handling guide
       # @since 0.6.6
@@ -334,6 +336,74 @@ module Appsignal
       alias :set_exception :set_error
       alias :add_exception :set_error
 
+      # Report an error.
+      #
+      # If a transaction is currently active, it will report the error on the
+      # current transaction. If no transaction is active, it will report the
+      # error on a new transaction.
+      #
+      # **Note**: If AppSignal is not active, no error is reported.
+      #
+      # **Note**: If the given exception argument is not an Exception subclass,
+      # it will not be reported.
+      #
+      # @example
+      #   class SomeController < ApplicationController
+      #     def create
+      #       # Do something that breaks
+      #     rescue => error
+      #       Appsignal.report_error(error)
+      #     end
+      #   end
+      #
+      # @example Add more metadata to transaction
+      #   Appsignal.report_error(error) do |transaction|
+      #     transaction.set_namespace("my_namespace")
+      #     transaction.set_action("my_action_name")
+      #     transaction.set_params(:search_query => params[:search_query])
+      #     transaction.set_tags(:key => "value")
+      #   end
+      #
+      # @param exception [Exception] The error to add to the current
+      #   transaction.
+      # @yield [transaction] yields block to allow modification of the
+      #   transaction.
+      # @yieldparam transaction [Transaction] yields the AppSignal transaction
+      #   used to report the error.
+      # @return [void]
+      #
+      # @see https://docs.appsignal.com/ruby/instrumentation/exception-handling.html
+      #   Exception handling guide
+      # @since 3.10.0
+      def report_error(exception)
+        unless exception.is_a?(Exception)
+          internal_logger.error "Appsignal.report_error: Cannot set error. " \
+            "The given value is not an exception: #{exception.inspect}"
+          return
+        end
+        return unless active?
+
+        has_parent_transaction = Appsignal::Transaction.current?
+        transaction =
+          if has_parent_transaction
+            Appsignal::Transaction.current
+          else
+            Appsignal::Transaction.new(
+              SecureRandom.uuid,
+              Appsignal::Transaction::HTTP_REQUEST,
+              Appsignal::Transaction::GenericRequest.new({})
+            )
+          end
+
+        transaction.set_error(exception)
+        yield transaction if block_given?
+
+        return if has_parent_transaction
+
+        transaction.complete
+      end
+      alias :report_exception :report_error
+
       # Set a custom action name for the current transaction.
       #
       # When using an integration such as the Rails or Sinatra AppSignal will
@@ -404,13 +474,44 @@ module Appsignal
         Appsignal::Transaction.current.set_namespace(namespace)
       end
 
+      # Set custom data on the current transaction.
+      #
+      # Add extra information about the request or background that cannot be
+      # expressed in tags, like nested data structures.
+      #
+      # When this method is called multiple times, it will overwrite the
+      # previously set value.
+      #
+      # @example
+      #   Appsignal.set_custom_data(:user => { :locale => "en" })
+      #   Appsignal.set_custom_data([
+      #     "array with data",
+      #     :options => { :verbose => true }
+      #   ])
+      #
+      # @since 3.10.0
+      # @see Transaction#set_custom_data
+      # @see https://docs.appsignal.com/guides/custom-data/sample-data.html
+      #   Sample data guide
+      # @param data [Hash/Array]
+      # @return [void]
+      def set_custom_data(data)
+        return unless active?
+        return unless Appsignal::Transaction.current?
+
+        transaction = Appsignal::Transaction.current
+        transaction.set_custom_data(data)
+      end
+
       # Set tags on the current transaction.
       #
       # Tags are extra bits of information that are added to transaction and
       # appear on sample details pages on AppSignal.com.
       #
+      # When this method is called multiple times, it will merge the tags.
+      #
       # @example
-      #   Appsignal.tag_request(:locale => "en")
+      #   Appsignal.tag_request(:locale => "en", :user_id => 1)
       #   Appsignal.tag_request("locale" => "en")
       #   Appsignal.tag_request("user_id" => 1)
       #
@@ -445,6 +546,67 @@ module Appsignal
         transaction.set_tags(tags)
       end
       alias :tag_job :tag_request
+      alias :set_tags :tag_request
+
+      # Set parameters on the current transaction.
+      #
+      # Parameters are automatically set by most of our integrations. It should
+      # not be necessary to call this method unless you want to report
+      # different parameters.
+      #
+      # To filter parameters, see our parameter filtering guide.
+      #
+      # When this method is called multiple times, it will overwrite the
+      # previously set value.
+      #
+      # When no parameters are set this way, the transaction will look for
+      # parameters in its request environment.
+      #
+      # A block can be given to this method to defer the fetching and parsing
+      # of the parameters until and only when the transaction is sampled.
+      #
+      # When both the `params` and a block is given to this method, the
+      # `params` argument is leading and the block will _not_ be called.
+      #
+      # @example Set parameters
+      #   Appsignal.set_params("param1" => "value1")
+      #
+      # @example Calling `set_params` multiple times will only keep the last call
+      #   Appsignal.set_params("param1" => "value1")
+      #   Appsignal.set_params("param2" => "value2")
+      #   # The parameters are: { "param2" => "value2" }
+      #
+      # @example Calling `set_params` with a block
+      #   Appsignal.set_params do
+      #     # Some slow code to parse parameters
+      #     JSON.parse('{"param1": "value1"}')
+      #   end
+      #   # The parameters are: { "param1" => "value1" }
+      #
+      # @example Calling `set_params` with a parameter and a block
+      #   Appsignal.set_params("argument" => "argument value") do
+      #     # Some slow code to parse parameters
+      #     JSON.parse('{"param1": "value1"}')
+      #   end
+      #   # The parameters are: { "argument" => "argument value" }
+      #
+      # @since 3.10.0
+      # @param params [Hash] The parameters to set on the transaction.
+      # @yield This block is called when the transaction is sampled. The block's
+      #   return value will become the new parameters.
+      # @see https://docs.appsignal.com/guides/custom-data/sample-data.html
+      #   Sample data guide
+      # @see https://docs.appsignal.com/guides/filter-data/filter-parameters.html
+      #   Parameter filtering guide
+      # @see Transaction#set_params
+      # @return [void]
+      def set_params(params = nil, &block)
+        return unless active?
+        return unless Appsignal::Transaction.current?
+
+        transaction = Appsignal::Transaction.current
+        transaction.set_params(params, &block)
+      end
 
       # Add breadcrumbs to the transaction.
       #

data/lib/appsignal/hooks/active_job.rb

@@ -62,12 +62,7 @@ module Appsignal
             end
 
           if transaction
-            transaction.set_params_if_nil(
-              Appsignal::Utils::HashSanitizer.sanitize(
-                job["arguments"],
-                Appsignal.config[:filter_parameters]
-              )
-            )
+            transaction.set_params_if_nil(job["arguments"])
 
             transaction_tags = ActiveJobHelpers.transaction_tags_for(job)
             transaction_tags["active_job_id"] = job["job_id"]

data/lib/appsignal/integrations/padrino.rb

@@ -1,18 +1,30 @@
 # frozen_string_literal: true
 
 require "appsignal"
+require "appsignal/rack/sinatra_instrumentation"
 
 module Appsignal
   module Integrations
     # @api private
     module PadrinoPlugin
       def self.init
-        Appsignal.internal_logger.debug("Loading Padrino (#{Padrino::VERSION}) integration")
+        Padrino::Application.prepend Appsignal::Integrations::PadrinoIntegration
 
-        root = Padrino.mounted_root
-        Appsignal.config = Appsignal::Config.new(root, Padrino.env)
+        Padrino.before_load do
+          Appsignal.internal_logger.debug("Loading Padrino (#{Padrino::VERSION}) integration")
 
-        Appsignal.start
+          unless Appsignal.active?
+            root = Padrino.mounted_root
+            Appsignal.config = Appsignal::Config.new(root, Padrino.env)
+            Appsignal.start
+          end
+
+          next unless Appsignal.active?
+
+          Padrino.use ::Rack::Events, [Appsignal::Rack::EventHandler.new]
+          Padrino.use Appsignal::Rack::SinatraBaseInstrumentation,
+            :instrument_event_name => "process_action.padrino"
+        end
       end
     end
   end
@@ -20,35 +32,23 @@ end
 
 module Appsignal
   module Integrations
+    # @api private
     module PadrinoIntegration
       def route!(base = settings, pass_block = nil)
         return super if !Appsignal.active? || env["sinatra.static_file"]
 
-        transaction = Appsignal::Transaction.create(
-          SecureRandom.uuid,
-          Appsignal::Transaction::HTTP_REQUEST,
-          request
-        )
         begin
-          Appsignal.instrument("process_action.padrino") do
-            super
-          end
-        rescue Exception => error # rubocop:disable Lint/RescueException
-          transaction.set_error(error)
-          raise error
+          super
         ensure
+          transaction = Appsignal::Transaction.current
           transaction.set_action_if_nil(get_payload_action(request))
-          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
 
       private
 
       def get_payload_action(request)
-        # Short-circut is there's no request object to obtain information from
+        # Short-circuit is there's no request object to obtain information from
         return settings.name.to_s unless request
 
         # Newer versions expose the action / controller on the request class.
@@ -75,8 +75,4 @@ module Appsignal
   end
 end
 
-Padrino::Application.prepend Appsignal::Integrations::PadrinoIntegration
-
-Padrino.after_load do
-  Appsignal::Integrations::PadrinoPlugin.init
-end
+Appsignal::Integrations::PadrinoPlugin.init