appsignal 3.10.0 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a4767b1d66b7aa4d47b79e83265b1e2631b9733f730e392b109d9d563013c79
-  data.tar.gz: 231bc55dfcd8084175fb505470b266937363de1e833852dd539d2970aad36d22
+  metadata.gz: 58edd9ab16d90269a61e7e485e51078b05b60b2192461408d415eafd8327fb04
+  data.tar.gz: 92520f55157b13bbe61a98cbcc61901c3c016854a436bd4ae01ad9563d92bf9a
 SHA512:
-  metadata.gz: 3116383c605eb524838419ca4911ad2a06ef2b2289d1b88705107c51595edcc749270fa824bc79552c6e255524409630ab477fd9fd6ab72fabf3e7a9ebd6025a
-  data.tar.gz: 471f59339ae58c4a45bcad29560e04397dd646efa7b9269167ed142c773c92018e2e34288d931c14c2a4ec3045f068f760e687179034464a8dda3001fb689244
+  metadata.gz: 502fd7ada9029f2ecacb0368e8bfe8128fa7792031f1c567f73c05e2381aa1fbc9f946bd7b574352e0114413c724cace05758854725130101122121200ceaaff
+  data.tar.gz: 1d90ec5300a657522de4ec3298b3db22a60aadecafda35ffe38ffed72b1ae1d311e590a502ef6d002e99897f2d453e1b0c1d3c9f8569eebd9aa3d90610fce77e

data/.rubocop.yml

@@ -6,6 +6,7 @@ AllCops:
   Include:
     - "**/*.rb"
     - "**/*.cap"
+    - "**/*.rake"
     - "**/Gemfile"
     - "**/Rakefile"
     - "appsignal.gemspec"
@@ -13,7 +14,6 @@ AllCops:
     - "pkg/**/*"
     - "tmp/**/*"
     - "vendor/**/*"
-    - "benchmark.rake"
     - "spec/integration/diagnose/**/*"
   DisplayCopNames: true
   UseCache: true

data/CHANGELOG.md

@@ -1,5 +1,93 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.11.0
+
+_Published on 2024-07-15._
+
+### Added
+
+- Add `Appsignal.monitor` and `Appsignal.monitor_and_stop` instrumentation helpers. These helpers are a replacement for the `Appsignal.monitor_transaction` and `Appsignal.monitor_single_transaction` helpers.
+
+  Use these new helpers to create an AppSignal transaction and track any exceptions that occur within the instrumented block. This new helper supports custom namespaces and has a simpler way to set an action name. Use this helper in combination with our other `Appsignal.set_*` helpers to add more metadata to the transaction.
+
+  ```ruby
+  # New helper
+  Appsignal.monitor(
+    :namespace => "my_namespace",
+    :action => "MyClass#my_method"
+  ) do
+    # Track an instrumentation event
+    Appsignal.instrument("my_event.my_group") do
+      # Some code
+    end
+  end
+
+  # Old helper
+  Appsignal.monitor_transaction(
+    "process_action.my_group",
+    :class_name => "MyClass",
+    :action_name => "my_method"
+  ) do
+    # Some code
+  end
+  ```
+
+  The `Appsignal.monitor_and_stop` helper can be used in the same scenarios as the `Appsignal.monitor_single_transaction` helper is used. One-off Ruby scripts that are not part of a long running process.
+
+  Read our [instrumentation documentation](https://docs.appsignal.com/ruby/instrumentation/background-jobs.html) for more information about using the`Appsignal.monitor` helper.
+
+  (minor [f38f0cff](https://github.com/appsignal/appsignal-ruby/commit/f38f0cff978c7e7244beae347a8355fff19b13f1))
+- Add `Appsignal.set_session_data` helper. Set custom session data on the current transaction with the `Appsignal.set_session_data` helper. Note that this will overwrite any request session data 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_session_data("data1" => "value1", "data2" => "value2")
+  ```
+
+  (patch [48c76635](https://github.com/appsignal/appsignal-ruby/commit/48c76635043a3777de79816bdb2154ad392c1b09))
+- Add `Appsignal.set_headers` helper. Set custom request headers on the current transaction with the `Appsignal.set_headers` helper. Note that this will overwrite any request headers 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_headers("PATH_INFO" => "/some-path", "HTTP_USER_AGENT" => "Firefox")
+  ```
+
+  (patch [7d82dffd](https://github.com/appsignal/appsignal-ruby/commit/7d82dffd75a6c7c9a8b6a8fac7e6bbb70104b63c))
+- Report request headers for webmachine apps. (patch [fcfb7a0d](https://github.com/appsignal/appsignal-ruby/commit/fcfb7a0d2545a2144aa61efa61d445c0e11c7749))
+
+### Changed
+
+- Allow tags to have boolean (true/false) values.
+
+  ```ruby
+  Appsignal.set_tags("my_tag_is_amazing" => true)
+  Appsignal.set_tags("my_tag_is_false" => false)
+  ```
+
+  (patch [1b8e86cb](https://github.com/appsignal/appsignal-ruby/commit/1b8e86cba3472ebec78680ca6a2ed8aa76938724))
+- Optimize Sidekiq job arguments being recorded. Job arguments are only fetched and set when we sample the job transaction, which should decrease our overhead for all jobs we don't sample. (patch [3f957301](https://github.com/appsignal/appsignal-ruby/commit/3f95730145d6eef7eb13901853685e4d56d5495c))
+
+### Deprecated
+
+- Deprecate Transaction sample helpers: `Transaction#set_sample_data` and `Transaction#sample_data`. Please use one of the other sample data helpers instead. See our [sample data guide](https://docs.appsignal.com/guides/custom-data/sample-data.html). (patch [2d2e0e43](https://github.com/appsignal/appsignal-ruby/commit/2d2e0e43c9125b4566e3265b6e6ae85e4910652b))
+- Deprecate the `Appsignal::Transaction#set_http_or_background_queue_start` method. Use the `Appsignal::Transaction#set_queue_start` helper instead. (patch [d93e0370](https://github.com/appsignal/appsignal-ruby/commit/d93e0370ff4e37cf8d12652a6e5cca66651a5790))
+- Deprecate the `Appsignal.without_instrumentation` helper. Use the `Appsignal.ignore_instrumentation_events` helper instead. (patch [7cc3c0e4](https://github.com/appsignal/appsignal-ruby/commit/7cc3c0e41615394deec348d5e0a40b7a6c1fc1d9))
+- Deprecate the `Appsignal::Transaction::GenericRequest` class. Use the `Appsignal.set_*` helpers to set metadata on the Transaction instead. Read our [sample data guide](https://docs.appsignal.com/guides/custom-data/sample-data.html) for more information. (patch [1c69d3fd](https://github.com/appsignal/appsignal-ruby/commit/1c69d3fdf47959c240c4732f7e8551802a9eba63))
+- Deprecate the 'ID', 'request', and 'options' arguments for the `Transaction.create` and `Transaction.new` methods. To add metadata to the transaction, use the `Appsignal.set_*` helpers. Read our [sample data guide](https://docs.appsignal.com/guides/custom-data/sample-data.html) for more information on how to set metadata on transactions.
+
+  ```ruby
+  # Before
+  Appsignal::Transaction.create(
+    SecureRandom.uuid,
+    "my_namespace",
+    Appsignal::Transaction::GenericRequest.new(env) # env is a request env Hash
+  )
+
+  # After
+  Appsignal::Transaction.create("my_namespace")
+  ```
+
+  (patch [2fc2c617](https://github.com/appsignal/appsignal-ruby/commit/2fc2c617321bc6a520205cae0cfa42fb3c8fc5d8))
+- Deprecate the `Appsignal.monitor_transaction` and `Appsignal.monitor_single_transaction` helpers. See the entry about the replacement helpers `Appsignal.monitor` and `Appsignal.monitor_and_stop`. (patch [470d5813](https://github.com/appsignal/appsignal-ruby/commit/470d58132270115215093c9cffd16e52829ef4c4))
+
 ## 3.10.0
 
 _Published on 2024-07-08._

data/Gemfile

@@ -4,6 +4,7 @@ source "https://rubygems.org"
 
 gemspec
 
+gem "benchmark-ips"
 # Fix install issue for jruby on gem 3.1.8.
 # No java stub is published.
 gem "bigdecimal", "3.1.7" if RUBY_PLATFORM == "java"

data/benchmark.rake

@@ -1,5 +1,12 @@
-require 'appsignal'
-require 'benchmark'
+# frozen_string_literal: true
+
+# Run using: rake --rakefile benchmark.rake [tasks]
+
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), "lib"))
+
+require "benchmark"
+require "benchmark/ips"
+require "appsignal"
 
 def process_rss
   `ps -o rss= -p #{Process.pid}`.to_i
@@ -7,35 +14,110 @@ end
 
 GC.disable
 
-task :default => :'benchmark:all'
+task :default => :"benchmark:all"
 
 namespace :benchmark do
-  task :all => [:run_inactive, :run_active]
+  task :all => [:memory_inactive, :memory_active, :ips]
 
-  task :run_inactive do
-    puts 'Running with appsignal off'
-    ENV['APPSIGNAL_PUSH_API_KEY'] = nil
+  task :memory_inactive do
+    puts "Memory benchmark with AppSignal off"
+    ENV["APPSIGNAL_PUSH_API_KEY"] = nil
     run_benchmark
   end
 
-  task :run_active do
-    puts 'Running with appsignal on'
-    ENV['APPSIGNAL_PUSH_API_KEY'] = 'something'
+  task :memory_active do
+    puts "Memory benchmark with AppSignal on"
+    ENV["APPSIGNAL_PUSH_API_KEY"] = "something"
     run_benchmark
   end
+
+  task :ips do
+    puts "Iterations per second benchmark"
+    start_agent
+    Benchmark.ips do |x|
+      x.config(
+        :time => 5,
+        :warmup => 2
+      )
+
+      x.report("monitor transaction inactive") do |times|
+        ENV["APPSIGNAL_PUSH_API_KEY"] = nil
+
+        monitor_transaction("transaction_#{times}")
+      end
+
+      x.report("monitor transaction active") do |times|
+        ENV["APPSIGNAL_PUSH_API_KEY"] = "something"
+
+        monitor_transaction("transaction_#{times}")
+      end
+
+      x.compare!
+    end
+  end
+end
+
+def start_agent
+  Appsignal.config = Appsignal::Config.new(
+    Dir.pwd,
+    "production",
+    :endpoint => "http://localhost:8080"
+  )
+  Appsignal.start
+end
+
+def monitor_transaction(transaction_id)
+  transaction = Appsignal::Transaction.create(
+    transaction_id,
+    Appsignal::Transaction::HTTP_REQUEST
+  )
+  transaction.set_action("HomeController#show")
+  transaction.set_params(:id => 1)
+
+  Appsignal.instrument("process_action.action_controller") do
+    Appsignal.instrument_sql(
+      "sql.active_record",
+      nil,
+      "SELECT `users`.* FROM `users` WHERE `users`.`id` = ?"
+    )
+    10.times do
+      Appsignal.instrument_sql(
+        "sql.active_record",
+        nil,
+        "SELECT `todos`.* FROM `todos` WHERE `todos`.`id` = ?"
+      )
+    end
+
+    Appsignal.instrument(
+      "render_template.action_view",
+      "app/views/home/show.html.erb"
+    ) do
+      5.times do
+        Appsignal.instrument(
+          "render_partial.action_view",
+          "app/views/home/_piece.html.erb"
+        ) do
+          3.times do
+            Appsignal.instrument("cache.read")
+          end
+        end
+      end
+    end
+  end
+
+  Appsignal::Transaction.complete_current!
 end
 
 def run_benchmark
-  no_transactions = (ENV['NO_TRANSACTIONS'] || 100_000).to_i
-  no_threads = (ENV['NO_THREADS'] || 1).to_i
+  no_transactions = (ENV["NO_TRANSACTIONS"] || 100_000).to_i
+  no_threads = (ENV["NO_THREADS"] || 1).to_i
 
   total_objects = ObjectSpace.count_objects[:TOTAL]
   puts "Initializing, currently #{total_objects} objects"
   puts "RSS: #{process_rss}"
 
-  Appsignal.config = Appsignal::Config.new(Dir.pwd, 'production', :endpoint => 'http://localhost:8080')
-  Appsignal.start
-  puts "Appsignal #{Appsignal.active? ? 'active' : 'not active'}"
+  start_agent
+  puts "Appsignal #{Appsignal.active? ? "active" : "not active"}"
 
   threads = []
   puts "Running #{no_transactions} normal transactions in #{no_threads} threads"
@@ -43,39 +125,14 @@ def run_benchmark
     no_threads.times do
       thread = Thread.new do
         no_transactions.times do |i|
-          request = Appsignal::Transaction::GenericRequest.new(
-            :controller => 'HomeController',
-            :action     => 'show',
-            :params     => {:id => 1}
-          )
-          Appsignal::Transaction.create("transaction_#{i}", Appsignal::Transaction::HTTP_REQUEST, request)
-
-          Appsignal.instrument('process_action.action_controller') do
-            Appsignal.instrument_sql('sql.active_record', nil, 'SELECT `users`.* FROM `users` WHERE `users`.`id` = ?')
-            10.times do
-              Appsignal.instrument_sql('sql.active_record', nil, 'SELECT `todos`.* FROM `todos` WHERE `todos`.`id` = ?')
-            end
-
-            Appsignal.instrument('render_template.action_view', 'app/views/home/show.html.erb') do
-              5.times do
-                Appsignal.instrument('render_partial.action_view', 'app/views/home/_piece.html.erb') do
-                  3.times do
-                    Appsignal.instrument('cache.read')
-                  end
-                end
-              end
-            end
-          end
-
-          Appsignal::Transaction.complete_current!
+          monitor_transaction("transaction_#{i}")
         end
       end
       thread.abort_on_exception = true
       threads << thread
     end
-
     threads.each(&:join)
-    puts 'Finished'
+    puts "Finished"
   end)
 
   puts "Done, currently #{ObjectSpace.count_objects[:TOTAL] - total_objects} objects created"

data/lib/appsignal/cli/demo.rb

@@ -39,7 +39,6 @@ module Appsignal
     #   AppSignal demo documentation
     # @see https://docs.appsignal.com/support/debugging.html
     #   Debugging AppSignal guide
-    # @api private
     class Demo
       class << self
         # @param options [Hash]

data/lib/appsignal/config.rb

@@ -10,6 +10,7 @@ module Appsignal
   class Config
     include Appsignal::Utils::StdoutAndLoggerMessage
 
+    # @api private
     DEFAULT_CONFIG = {
       :activejob_report_errors => "all",
       :ca_file_path => File.expand_path(File.join("../../../resources/cacert.pem"), __FILE__),
@@ -67,15 +68,31 @@ module Appsignal
       "trace" => ::Logger::DEBUG
     }.freeze
 
-    ENV_TO_KEY_MAPPING = {
-      "APPSIGNAL_ACTIVE" => :active,
+    # @api private
+    ENV_STRING_KEYS = {
       "APPSIGNAL_ACTIVEJOB_REPORT_ERRORS" => :activejob_report_errors,
       "APPSIGNAL_APP_NAME" => :name,
       "APPSIGNAL_BIND_ADDRESS" => :bind_address,
       "APPSIGNAL_CA_FILE_PATH" => :ca_file_path,
-      "APPSIGNAL_CPU_COUNT" => :cpu_count,
+      "APPSIGNAL_HOSTNAME" => :hostname,
+      "APPSIGNAL_HOST_ROLE" => :host_role,
+      "APPSIGNAL_HTTP_PROXY" => :http_proxy,
+      "APPSIGNAL_LOG" => :log,
+      "APPSIGNAL_LOG_LEVEL" => :log_level,
+      "APPSIGNAL_LOG_PATH" => :log_path,
+      "APPSIGNAL_LOGGING_ENDPOINT" => :logging_endpoint,
+      "APPSIGNAL_PUSH_API_ENDPOINT" => :endpoint,
+      "APPSIGNAL_PUSH_API_KEY" => :push_api_key,
+      "APPSIGNAL_SIDEKIQ_REPORT_ERRORS" => :sidekiq_report_errors,
+      "APPSIGNAL_STATSD_PORT" => :statsd_port,
+      "APPSIGNAL_WORKING_DIRECTORY_PATH" => :working_directory_path,
+      "APPSIGNAL_WORKING_DIR_PATH" => :working_dir_path,
+      "APP_REVISION" => :revision
+    }.freeze
+    # @api private
+    ENV_BOOLEAN_KEYS = {
+      "APPSIGNAL_ACTIVE" => :active,
       "APPSIGNAL_DEBUG" => :debug,
-      "APPSIGNAL_DNS_SERVERS" => :dns_servers,
       "APPSIGNAL_ENABLE_ALLOCATION_TRACKING" => :enable_allocation_tracking,
       "APPSIGNAL_ENABLE_HOST_METRICS" => :enable_host_metrics,
       "APPSIGNAL_ENABLE_MINUTELY_PROBES" => :enable_minutely_probes,
@@ -87,100 +104,33 @@ module Appsignal
       "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,
-      "APPSIGNAL_FILTER_SESSION_DATA" => :filter_session_data,
-      "APPSIGNAL_HOSTNAME" => :hostname,
-      "APPSIGNAL_HOST_ROLE" => :host_role,
-      "APPSIGNAL_HTTP_PROXY" => :http_proxy,
-      "APPSIGNAL_IGNORE_ACTIONS" => :ignore_actions,
-      "APPSIGNAL_IGNORE_ERRORS" => :ignore_errors,
-      "APPSIGNAL_IGNORE_LOGS" => :ignore_logs,
-      "APPSIGNAL_IGNORE_NAMESPACES" => :ignore_namespaces,
       "APPSIGNAL_INSTRUMENT_HTTP_RB" => :instrument_http_rb,
       "APPSIGNAL_INSTRUMENT_NET_HTTP" => :instrument_net_http,
       "APPSIGNAL_INSTRUMENT_REDIS" => :instrument_redis,
       "APPSIGNAL_INSTRUMENT_SEQUEL" => :instrument_sequel,
-      "APPSIGNAL_LOG" => :log,
-      "APPSIGNAL_LOG_LEVEL" => :log_level,
-      "APPSIGNAL_LOG_PATH" => :log_path,
-      "APPSIGNAL_LOGGING_ENDPOINT" => :logging_endpoint,
-      "APPSIGNAL_PUSH_API_ENDPOINT" => :endpoint,
-      "APPSIGNAL_PUSH_API_KEY" => :push_api_key,
-      "APPSIGNAL_REQUEST_HEADERS" => :request_headers,
       "APPSIGNAL_RUNNING_IN_CONTAINER" => :running_in_container,
       "APPSIGNAL_SEND_ENVIRONMENT_METADATA" => :send_environment_metadata,
       "APPSIGNAL_SEND_PARAMS" => :send_params,
       "APPSIGNAL_SEND_SESSION_DATA" => :send_session_data,
-      "APPSIGNAL_SIDEKIQ_REPORT_ERRORS" => :sidekiq_report_errors,
       "APPSIGNAL_SKIP_SESSION_DATA" => :skip_session_data,
-      "APPSIGNAL_STATSD_PORT" => :statsd_port,
-      "APPSIGNAL_TRANSACTION_DEBUG_MODE" => :transaction_debug_mode,
-      "APPSIGNAL_WORKING_DIRECTORY_PATH" => :working_directory_path,
-      "APPSIGNAL_WORKING_DIR_PATH" => :working_dir_path,
-      "APP_REVISION" => :revision
+      "APPSIGNAL_TRANSACTION_DEBUG_MODE" => :transaction_debug_mode
     }.freeze
     # @api private
-    ENV_STRING_KEYS = %w[
-      APPSIGNAL_ACTIVEJOB_REPORT_ERRORS
-      APPSIGNAL_APP_NAME
-      APPSIGNAL_BIND_ADDRESS
-      APPSIGNAL_CA_FILE_PATH
-      APPSIGNAL_HOSTNAME
-      APPSIGNAL_HOST_ROLE
-      APPSIGNAL_HTTP_PROXY
-      APPSIGNAL_LOG
-      APPSIGNAL_LOG_LEVEL
-      APPSIGNAL_LOG_PATH
-      APPSIGNAL_LOGGING_ENDPOINT
-      APPSIGNAL_PUSH_API_ENDPOINT
-      APPSIGNAL_PUSH_API_KEY
-      APPSIGNAL_SIDEKIQ_REPORT_ERRORS
-      APPSIGNAL_STATSD_PORT
-      APPSIGNAL_WORKING_DIRECTORY_PATH
-      APPSIGNAL_WORKING_DIR_PATH
-      APP_REVISION
-    ].freeze
-    # @api private
-    ENV_BOOLEAN_KEYS = %w[
-      APPSIGNAL_ACTIVE
-      APPSIGNAL_DEBUG
-      APPSIGNAL_ENABLE_ALLOCATION_TRACKING
-      APPSIGNAL_ENABLE_HOST_METRICS
-      APPSIGNAL_ENABLE_MINUTELY_PROBES
-      APPSIGNAL_ENABLE_STATSD
-      APPSIGNAL_ENABLE_NGINX_METRICS
-      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
-      APPSIGNAL_INSTRUMENT_REDIS
-      APPSIGNAL_INSTRUMENT_SEQUEL
-      APPSIGNAL_RUNNING_IN_CONTAINER
-      APPSIGNAL_SEND_ENVIRONMENT_METADATA
-      APPSIGNAL_SEND_PARAMS
-      APPSIGNAL_SEND_SESSION_DATA
-      APPSIGNAL_SKIP_SESSION_DATA
-      APPSIGNAL_TRANSACTION_DEBUG_MODE
-    ].freeze
+    ENV_ARRAY_KEYS = {
+      "APPSIGNAL_DNS_SERVERS" => :dns_servers,
+      "APPSIGNAL_FILTER_METADATA" => :filter_metadata,
+      "APPSIGNAL_FILTER_PARAMETERS" => :filter_parameters,
+      "APPSIGNAL_FILTER_SESSION_DATA" => :filter_session_data,
+      "APPSIGNAL_IGNORE_ACTIONS" => :ignore_actions,
+      "APPSIGNAL_IGNORE_ERRORS" => :ignore_errors,
+      "APPSIGNAL_IGNORE_LOGS" => :ignore_logs,
+      "APPSIGNAL_IGNORE_NAMESPACES" => :ignore_namespaces,
+      "APPSIGNAL_REQUEST_HEADERS" => :request_headers
+    }.freeze
     # @api private
-    ENV_ARRAY_KEYS = %w[
-      APPSIGNAL_DNS_SERVERS
-      APPSIGNAL_FILTER_METADATA
-      APPSIGNAL_FILTER_PARAMETERS
-      APPSIGNAL_FILTER_SESSION_DATA
-      APPSIGNAL_IGNORE_ACTIONS
-      APPSIGNAL_IGNORE_ERRORS
-      APPSIGNAL_IGNORE_LOGS
-      APPSIGNAL_IGNORE_NAMESPACES
-      APPSIGNAL_REQUEST_HEADERS
-    ].freeze
-    ENV_FLOAT_KEYS = %w[
-      APPSIGNAL_CPU_COUNT
-    ].freeze
+    ENV_FLOAT_KEYS = {
+      "APPSIGNAL_CPU_COUNT" => :cpu_count
+    }.freeze
 
     # @attribute [r] system_config
     #   Config detected on the system level.
@@ -211,8 +161,10 @@ module Appsignal
     #   @api private
     #   @return [Hash]
 
+    # @api private
     attr_reader :root_path, :env, :config_hash, :system_config,
       :initial_config, :file_config, :env_config, :override_config
+    # @api private
     attr_accessor :logger
 
     # Initialize a new configuration object for AppSignal.
@@ -316,6 +268,7 @@ module Appsignal
       config_hash[key] = value
     end
 
+    # @api private
     def log_level
       level = ::Logger::DEBUG if config_hash[:debug] || config_hash[:transaction_debug_mode]
       option = config_hash[:log_level]
@@ -326,6 +279,7 @@ module Appsignal
       level.nil? ? Appsignal::Config::DEFAULT_LOG_LEVEL : level
     end
 
+    # @api private
     def log_file_path
       return @log_file_path if defined? @log_file_path
 
@@ -360,6 +314,7 @@ module Appsignal
       @valid && config_hash[:active]
     end
 
+    # @api private
     def write_to_environment # rubocop:disable Metrics/AbcSize
       ENV["_APPSIGNAL_ACTIVE"]                       = active?.to_s
       ENV["_APPSIGNAL_AGENT_PATH"]                   = File.expand_path("../../ext", __dir__).to_s
@@ -405,6 +360,7 @@ module Appsignal
       ENV["_APP_REVISION"] = config_hash[:revision].to_s
     end
 
+    # @api private
     def validate
       # Strip path from endpoint so we're backwards compatible with
       # earlier versions of the gem.
@@ -503,35 +459,35 @@ module Appsignal
       config = {}
 
       # Configuration with string type
-      ENV_STRING_KEYS.each do |var|
-        env_var = ENV.fetch(var, nil)
+      ENV_STRING_KEYS.each do |env_key, option|
+        env_var = ENV.fetch(env_key, nil)
         next unless env_var
 
-        config[ENV_TO_KEY_MAPPING[var]] = env_var
+        config[option] = env_var
       end
 
       # Configuration with boolean type
-      ENV_BOOLEAN_KEYS.each do |var|
-        env_var = ENV.fetch(var, nil)
+      ENV_BOOLEAN_KEYS.each do |env_key, option|
+        env_var = ENV.fetch(env_key, nil)
         next unless env_var
 
-        config[ENV_TO_KEY_MAPPING[var]] = env_var.casecmp("true").zero?
+        config[option] = env_var.casecmp("true").zero?
       end
 
       # Configuration with array of strings type
-      ENV_ARRAY_KEYS.each do |var|
-        env_var = ENV.fetch(var, nil)
+      ENV_ARRAY_KEYS.each do |env_key, option|
+        env_var = ENV.fetch(env_key, nil)
         next unless env_var
 
-        config[ENV_TO_KEY_MAPPING[var]] = env_var.split(",")
+        config[option] = env_var.split(",")
       end
 
       # Configuration with float type
-      ENV_FLOAT_KEYS.each do |var|
-        env_var = ENV.fetch(var, nil)
+      ENV_FLOAT_KEYS.each do |env_key, option|
+        env_var = ENV.fetch(env_key, nil)
         next unless env_var
 
-        config[ENV_TO_KEY_MAPPING[var]] = env_var.to_f
+        config[option] = env_var.to_f
       end
 
       config

data/lib/appsignal/demo.rb

@@ -39,18 +39,15 @@ module Appsignal
       private
 
       def create_example_error_request
-        transaction = Appsignal::Transaction.create(
-          SecureRandom.uuid,
-          Appsignal::Transaction::HTTP_REQUEST,
-          rack_request
-        )
+        transaction = Appsignal::Transaction.create(Appsignal::Transaction::HTTP_REQUEST)
         begin
           raise TestError,
             "Hello world! This is an error used for demonstration purposes."
         rescue => error
           Appsignal.set_error(error)
         end
-        transaction.set_http_or_background_queue_start
+        add_params_to(transaction)
+        add_headers_to(transaction)
         transaction.set_metadata("path", "/hello")
         transaction.set_metadata("method", "GET")
         transaction.set_action("DemoController#hello")
@@ -59,16 +56,13 @@ module Appsignal
       end
 
       def create_example_performance_request
-        transaction = Appsignal::Transaction.create(
-          SecureRandom.uuid,
-          Appsignal::Transaction::HTTP_REQUEST,
-          rack_request
-        )
+        transaction = Appsignal::Transaction.create(Appsignal::Transaction::HTTP_REQUEST)
         Appsignal.instrument "action_view.render", "Render hello.html.erb",
           "<h1>Hello world!</h1>" do
           sleep 2
         end
-        transaction.set_http_or_background_queue_start
+        add_params_to(transaction)
+        add_headers_to(transaction)
         transaction.set_metadata("path", "/hello")
         transaction.set_metadata("method", "GET")
         transaction.set_action("DemoController#hello")
@@ -80,13 +74,15 @@ module Appsignal
         transaction.set_metadata("demo_sample", "true")
       end
 
-      def rack_request
-        env = ::Rack::MockRequest.env_for(
-          "/demo",
-          :params => {
-            "controller" => "demo",
-            "action" => "hello"
-          },
+      def add_params_to(transaction)
+        transaction.set_params(
+          "controller" => "demo",
+          "action" => "hello"
+        )
+      end
+
+      def add_headers_to(transaction)
+        transaction.set_headers(
           "REMOTE_ADDR" => "127.0.0.1",
           "REQUEST_METHOD" => "GET",
           "SERVER_NAME" => "localhost",
@@ -102,7 +98,6 @@ module Appsignal
           "HTTP_USER_AGENT" => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_0)",
           "HTTP_REFERER" => "http://appsignal.com/accounts"
         )
-        ::Rack::Request.new(env)
       end
     end
   end

data/lib/appsignal/event_formatter/rom/sql_formatter.rb

@@ -2,6 +2,7 @@
 
 module Appsignal
   class EventFormatter
+    # @api private
     module Rom
       class SqlFormatter
         def format(payload)

data/lib/appsignal/event_formatter.rb

@@ -10,14 +10,14 @@ module Appsignal
   # event, the same object will be called intermittently in a threaded environment.
   # So only keep global configuration as state and pass the payload around as an
   # argument if you need to use helper methods.
-  #
-  # @api private
   class EventFormatter
     class << self
+      # @api private
       def formatters
         @formatters ||= {}
       end
 
+      # @api private
       def formatter_classes
         @formatter_classes ||= {}
       end
@@ -49,6 +49,7 @@ module Appsignal
         end
       end
 
+      # @api private
       def format(name, payload)
         formatter = formatters[name]
         formatter&.format(payload)