appsignal 2.11.1 → 2.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e4d082500efd101198339616a3f7fc05170684bb6020864bda78c34121a96ff
-  data.tar.gz: 467372cf2a4f5f0be4353a6cba168b8fad3c25b242902b4b79c949f4b9692fbc
+  metadata.gz: 2207fe155b6aec1d0fa6e271f8257e5006db693f3d30d45da0f522185b5498a6
+  data.tar.gz: 42f76f14cf36b7309ade272924f9137e763f0ca56446189d97ea83b8f95a12f6
 SHA512:
-  metadata.gz: 52206e43698413eea911c3ef8c72aba46d50718abbe5f435d66d2bc235b97cbe6899e35c639bc205c0f228a8dbd52fed48493748123be3107eace29873ddd615
-  data.tar.gz: a8eaa5c959545cc26bdc63e0d55619c906bc6496514a229febcebb606a40c552e8a981163ff532610133a17533ddca6bff3e701baa8e935a9e28df874097faca
+  metadata.gz: af7b2665f84a0ef9dc8fb7806e0095b00f48aa6273a5e5d5a75bf3c59e0910123fb50fd0380b16d6b154bf0a6c0ec8a1b42ce990b02511eaa648372a1178ac1d
+  data.tar.gz: cdbc11ff5c3e7e3b756a8e3ad4dcb1483d7e6772346e652b042e7b3e08e00130d39c2160ea7ef5e47c44f1c8818a678d0393828bf9730f456bab401393754ad0

data/.semaphore/semaphore.yml

@@ -31,6 +31,7 @@ global_job_config:
   prologue:
     commands:
     - checkout
+    - git -C /home/semaphore/.rbenv/plugins/ruby-build pull
     - sem-version ruby $RUBY_VERSION
     - "./support/check_versions"
     - cache restore $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)
@@ -992,6 +993,202 @@ blocks:
       commands:
       - "./support/bundler_wrapper exec rake test"
       - "./support/bundler_wrapper exec rake test:failure"
+- name: Ruby 3.0.0
+  dependencies:
+  - Validation
+  task:
+    prologue:
+      commands:
+      - "./support/bundler_wrapper exec rake extension:install"
+    jobs:
+    - name: Ruby 3.0.0 for no_dependencies
+      env_vars:
+      - name: RUBY_VERSION
+        value: 3.0.0
+      - name: GEMSET
+        value: no_dependencies
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/no_dependencies.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
+- name: Ruby 3.0.0 - Gems
+  dependencies:
+  - Ruby 3.0.0
+  task:
+    prologue:
+      commands:
+      - "./support/bundler_wrapper exec rake extension:install"
+    jobs:
+    - name: Ruby 3.0.0 for capistrano2
+      env_vars:
+      - name: RUBY_VERSION
+        value: 3.0.0
+      - name: GEMSET
+        value: capistrano2
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/capistrano2.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby 3.0.0 for capistrano3
+      env_vars:
+      - name: RUBY_VERSION
+        value: 3.0.0
+      - name: GEMSET
+        value: capistrano3
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/capistrano3.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby 3.0.0 for grape
+      env_vars:
+      - name: RUBY_VERSION
+        value: 3.0.0
+      - name: GEMSET
+        value: grape
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/grape.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby 3.0.0 for padrino
+      env_vars:
+      - name: RUBY_VERSION
+        value: 3.0.0
+      - name: GEMSET
+        value: padrino
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/padrino.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby 3.0.0 for que
+      env_vars:
+      - name: RUBY_VERSION
+        value: 3.0.0
+      - name: GEMSET
+        value: que
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/que.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby 3.0.0 for que_beta
+      env_vars:
+      - name: RUBY_VERSION
+        value: 3.0.0
+      - name: GEMSET
+        value: que_beta
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/que_beta.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby 3.0.0 for rails-6.0
+      env_vars:
+      - name: RUBY_VERSION
+        value: 3.0.0
+      - name: GEMSET
+        value: rails-6.0
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/rails-6.0.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby 3.0.0 for resque-2
+      env_vars:
+      - name: RUBY_VERSION
+        value: 3.0.0
+      - name: GEMSET
+        value: resque-2
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/resque-2.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby 3.0.0 for sequel
+      env_vars:
+      - name: RUBY_VERSION
+        value: 3.0.0
+      - name: GEMSET
+        value: sequel
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/sequel.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby 3.0.0 for sinatra
+      env_vars:
+      - name: RUBY_VERSION
+        value: 3.0.0
+      - name: GEMSET
+        value: sinatra
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/sinatra.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby 3.0.0 for webmachine
+      env_vars:
+      - name: RUBY_VERSION
+        value: 3.0.0
+      - name: GEMSET
+        value: webmachine
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/webmachine.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
 - name: Ruby jruby-9.1.17.0
   dependencies:
   - Validation

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+# 2.11.2
+- Support Ruby 3.0. PR #681
+- Support breadcrumbs. PR #666
+- Log Ruby errors on extension download. PR #679
+- Fix Ruby 1.9 build. PR #680
+
 # 2.11.1
 - Support AS notifications instrumenters that use `start` and `finish`.
 - Updated agent with better logging and an IO stats fix.

data/README.md

@@ -157,6 +157,15 @@ as most Linux distributions, FreeBSD, macOS, excluding Microsoft Windows.
 For more detailed information please visit our [Supported
 systems][supported-systems] page.
 
+## Releases
+
+Following the process below to release a new version of the Ruby gem.
+
+1. Run: `rake publish`
+  1. Update the Ruby gem version number when prompted.
+  1. Update the `CHANGELOG` file with the changes since the last release.
+1. Confirm with your two-factor authentication token for Rubygems.org, _twice_.
+
 ## Development
 
 ### Installation

data/build_matrix.yml

@@ -32,6 +32,7 @@ semaphore: # Default `.semaphore/semaphore.yml` contents
     prologue:
       commands:
         - checkout
+        - git -C /home/semaphore/.rbenv/plugins/ruby-build pull
         - sem-version ruby $RUBY_VERSION
         - ./support/check_versions
         - cache restore $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)
@@ -116,6 +117,7 @@ matrix:
       gems: "minimal"
     - ruby: "2.6.5"
     - ruby: "2.7.1"
+    - ruby: "3.0.0"
     - ruby: "jruby-9.1.17.0"
       gems: "minimal"
   gems:
@@ -138,24 +140,29 @@ matrix:
         ruby:
           - "2.6.5"
           - "2.7.1"
+          - "3.0.0"
     - gem: "rails-4.2"
       bundler: "1.17.3"
       exclude:
         ruby:
           - "2.6.5"
           - "2.7.1"
+          - "3.0.0"
     - gem: "rails-5.0"
       exclude:
         ruby:
           - "2.0.0-p648"
+          - "3.0.0"
     - gem: "rails-5.1"
       exclude:
         ruby:
           - "2.0.0-p648"
+          - "3.0.0"
     - gem: "rails-5.2"
       exclude:
         ruby:
           - "2.0.0-p648"
+          - "3.0.0"
     - gem: "rails-6.0"
       exclude:
         ruby:
@@ -167,11 +174,17 @@ matrix:
           - "jruby-9.1.17.0"
     - gem: "resque-1"
       bundler: "1.17.3"
+      exclude:
+        ruby:
+          - "3.0.0"
     - gem: "resque-2"
       exclude:
         ruby:
           - "2.0.0-p648"
     - gem: "sequel"
     - gem: "sequel-435"
+      exclude:
+        ruby:
+          - "3.0.0"
     - gem: "sinatra"
     - gem: "webmachine"

data/ext/base.rb

@@ -119,30 +119,33 @@ def download_archive(type)
 
   version = AGENT_CONFIG["version"]
   filename = ARCH_CONFIG[type]["filename"]
-  attempted_mirror_urls = []
+  download_errors = []
 
   AGENT_CONFIG["mirrors"].each do |mirror|
     download_url = [mirror, version, filename].join("/")
-    attempted_mirror_urls << download_url
     report["download"]["download_url"] = download_url
 
     begin
-      return open(
+      args = [
         download_url,
         :ssl_ca_cert => CA_CERT_PATH,
         :proxy => http_proxy
-      )
-    rescue
+      ]
+      if URI.respond_to?(:open) # rubocop:disable Style/GuardClause
+        return URI.open(*args)
+      else
+        return open(*args)
+      end
+    rescue => error
+      download_errors << "- URL: #{download_url}\n  Error: #{error.class}: #{error.message}"
       next
     end
   end
 
-  attempted_mirror_urls_mapped = attempted_mirror_urls.map { |mirror| "- #{mirror}" }
   abort_installation(
     "Could not download archive from any of our mirrors. " \
-      "Attempted to download the archive from the following urls:\n" \
-      "#{attempted_mirror_urls_mapped.join("\n")}\n" \
-      "Please make sure your network allows access to any of these mirrors."
+      "Please make sure your network allows access to any of these mirrors.\n" \
+      "Attempted to download the archive from the following urls:\n#{download_errors.join("\n")}"
   )
 end
 

data/gemfiles/no_dependencies.gemfile

@@ -2,4 +2,11 @@ source 'https://rubygems.org'
 
 gem 'rack', '~> 1.6'
 
+ruby_version = Gem::Version.new(RUBY_VERSION)
+if ruby_version < Gem::Version.new("2.0.0")
+  # Newer versions of this gem have rexml as a dependency which doesn't work on
+  # Ruby 1.9
+  gem "crack", "0.4.4"
+end
+
 gemspec :path => '../'

data/gemfiles/resque-2.gemfile

@@ -2,7 +2,6 @@ source 'https://rubygems.org'
 
 gem 'resque', "~> 2.0"
 gem 'sinatra'
-gem 'mime-types', '~> 2.6'
 
 gemspec :path => '../'
 

data/gemfiles/webmachine.gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'webmachine'
+gem 'webrick'
 
 gemspec :path => '../'

data/lib/appsignal/cli/diagnose/utils.rb

@@ -34,20 +34,17 @@ module Appsignal
         end
 
         def self.parse_yaml(contents)
-          arguments = [contents]
           if YAML.respond_to? :safe_load
-            method = :safe_load
-            arguments << \
-              if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.6.0")
-                # Use keyword params for Ruby 2.6 and up
-                { :permitted_classes => [Time] }
-              else
-                [Time]
-              end
+            if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.6.0")
+              # Use keyword params for Ruby 2.6 and up
+              YAML.safe_load(contents, :permitted_classes => [Time])
+            else
+              YAML.safe_load(contents, [Time])
+            end
           else
-            method = :load
+            # Support for Ruby versions without YAML.safe_load
+            YAML.load(contents) # rubocop:disable Security/YAMLLoad
           end
-          YAML.send(method, *arguments)
         end
       end
     end

data/lib/appsignal/cli/install.rb

@@ -278,14 +278,11 @@ module Appsignal
             "../../../resources/appsignal.yml.erb"
           )
           file_contents = File.read(filename)
-          arguments = [file_contents]
-          if ruby_2_6_or_up?
-            arguments << { :trim_mode => "-" }
-          else
-            arguments << nil
-            arguments << "-"
-          end
-          template = ERB.new(*arguments)
+          template = if ruby_2_6_or_up?
+                       ERB.new(file_contents, :trim_mode => "-")
+                     else
+                       ERB.new(file_contents, nil, "-")
+                     end
           config = template.result(OpenStruct.new(data).instance_eval { binding })
 
           FileUtils.mkdir_p(File.join(Dir.pwd, "config"))

data/lib/appsignal/helpers/instrumentation.rb

@@ -380,6 +380,38 @@ module Appsignal
       end
       alias :tag_job :tag_request
 
+      # Add breadcrumbs to the transaction.
+      #
+      # Breadcrumbs can be used to trace what path a user has taken
+      # before encounterin an error.
+      #
+      # Only the last 20 added breadcrumbs will be saved.
+      #
+      # @example
+      #   Appsignal.add_breadcrumb("Navigation", "http://blablabla.com", "", { :response => 200 }, Time.now.utc)
+      #   Appsignal.add_breadcrumb("Network", "[GET] http://blablabla.com", "", { :response => 500 })
+      #   Appsignal.add_breadcrumb("UI", "closed modal(change_password)", "User closed modal without actions")
+      #
+      # @param category [String] category of breadcrumb
+      #   e.g. "UI", "Network", "Navigation", "Console".
+      # @param action [String] name of breadcrumb
+      #   e.g "The user clicked a button", "HTTP 500 from http://blablabla.com"
+      # @option message [String]  optional message in string format
+      # @option metadata [Hash<String,String>]  key/value metadata in <string, string> format
+      # @option time [Time] time of breadcrumb, should respond to `.to_i` defaults to `Time.now.utc`
+      # @return [void]
+      #
+      # @see Transaction#add_breadcrumb
+      # @see http://docs.appsignal.com/ruby/instrumentation/breadcrumbs.html
+      #   Breadcrumb reference
+      # @since 2.12.0
+      def add_breadcrumb(category, action, message = "", metadata = {}, time = Time.now.utc)
+        return unless active?
+        transaction = Appsignal::Transaction.current
+        return false unless transaction
+        transaction.add_breadcrumb(category, action, message, metadata, time)
+      end
+
       # Instrument helper for AppSignal.
       #
       # For more help, read our custom instrumentation guide, listed under "See

data/lib/appsignal/transaction.rb

@@ -11,6 +11,7 @@ module Appsignal
     BLANK          = "".freeze
     ALLOWED_TAG_KEY_TYPES = [Symbol, String].freeze
     ALLOWED_TAG_VALUE_TYPES = [Symbol, String, Integer].freeze
+    BREADCRUMB_LIMIT = 20
 
     class << self
       def create(id, namespace, request, options = {})
@@ -58,7 +59,7 @@ module Appsignal
       end
     end
 
-    attr_reader :ext, :transaction_id, :action, :namespace, :request, :paused, :tags, :options, :discarded
+    attr_reader :ext, :transaction_id, :action, :namespace, :request, :paused, :tags, :options, :discarded, :breadcrumbs
 
     # @!attribute params
     #   Attribute for parameters of the transaction.
@@ -80,6 +81,7 @@ module Appsignal
       @paused = false
       @discarded = false
       @tags = {}
+      @breadcrumbs = []
       @store = Hash.new({})
       @options = options
       @options[:params_method] ||= :params
@@ -156,6 +158,31 @@ module Appsignal
       @tags.merge!(given_tags)
     end
 
+    # Add breadcrumbs to the transaction.
+    #
+    # @param category [String] category of breadcrumb
+    #   e.g. "UI", "Network", "Navigation", "Console".
+    # @param action [String] name of breadcrumb
+    #   e.g "The user clicked a button", "HTTP 500 from http://blablabla.com"
+    # @option message [String]  optional message in string format
+    # @option metadata [Hash<String,String>]  key/value metadata in <string, string> format
+    # @option time [Time] time of breadcrumb, should respond to `.to_i` defaults to `Time.now.utc`
+    # @return [void]
+    #
+    # @see Appsignal.add_breadcrumb
+    # @see http://docs.appsignal.com/ruby/instrumentation/breadcrumbs.html
+    #   Breadcrumb reference
+    def add_breadcrumb(category, action, message = "", metadata = {}, time = Time.now.utc)
+      @breadcrumbs.push(
+        :time => time.to_i,
+        :category => category,
+        :action => action,
+        :message => message,
+        :metadata => metadata
+      )
+      @breadcrumbs = @breadcrumbs.last(BREADCRUMB_LIMIT)
+    end
+
     # Set an action name for the transaction.
     #
     # An action name is used to identify the location of a certain sample;
@@ -287,7 +314,8 @@ module Appsignal
         :environment  => sanitized_environment,
         :session_data => sanitized_session_data,
         :metadata     => metadata,
-        :tags         => sanitized_tags
+        :tags         => sanitized_tags,
+        :breadcrumbs  => breadcrumbs
       }.each do |key, data|
         set_sample_data(key, data)
       end

data/lib/appsignal/version.rb

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

data/spec/lib/appsignal/hooks/resque_spec.rb

@@ -60,7 +60,10 @@ describe Appsignal::Hooks::ResqueHook do
           "error" => nil,
           "namespace" => namespace,
           "metadata" => {},
-          "sample_data" => { "tags" => { "queue" => queue } }
+          "sample_data" => {
+            "breadcrumbs" => [],
+            "tags" => { "queue" => queue }
+          }
         )
         expect(transaction_hash["events"].map { |e| e["name"] })
           .to eql(["perform.resque"])
@@ -84,7 +87,10 @@ describe Appsignal::Hooks::ResqueHook do
             },
             "namespace" => namespace,
             "metadata" => {},
-            "sample_data" => { "tags" => { "queue" => queue } }
+            "sample_data" => {
+              "breadcrumbs" => [],
+              "tags" => { "queue" => queue }
+            }
           )
         end
       end
@@ -118,6 +124,7 @@ describe Appsignal::Hooks::ResqueHook do
             "metadata" => {},
             "sample_data" => {
               "tags" => { "queue" => queue },
+              "breadcrumbs" => [],
               "params" => [
                 "foo",
                 {
@@ -174,6 +181,7 @@ describe Appsignal::Hooks::ResqueHook do
             "namespace" => namespace,
             "metadata" => {},
             "sample_data" => {
+              "breadcrumbs" => [],
               "tags" => { "queue" => queue }
               # Params will be set by the ActiveJob integration
             }

data/spec/lib/appsignal/hooks/sidekiq_spec.rb

@@ -262,7 +262,8 @@ describe Appsignal::Hooks::SidekiqPlugin, :with_yaml_parse_error => false do
         "sample_data" => {
           "environment" => {},
           "params" => expected_args,
-          "tags" => {}
+          "tags" => {},
+          "breadcrumbs" => []
         }
       )
       expect_transaction_to_have_sidekiq_event(transaction_hash)
@@ -290,7 +291,8 @@ describe Appsignal::Hooks::SidekiqPlugin, :with_yaml_parse_error => false do
         "sample_data" => {
           "environment" => {},
           "params" => expected_args,
-          "tags" => {}
+          "tags" => {},
+          "breadcrumbs" => []
         }
       )
       # TODO: Not available in transaction.to_h yet.

data/spec/lib/appsignal/transaction_spec.rb

@@ -356,6 +356,57 @@ describe Appsignal::Transaction do
       end
     end
 
+    describe "#add_breadcrumb" do
+      context "when over the limit" do
+        before do
+          22.times do |i|
+            transaction.add_breadcrumb(
+              "network",
+              "GET http://localhost",
+              "User made external network request",
+              { :code => i + 1 },
+              Time.parse("10-10-2010 10:00:00 UTC")
+            )
+          end
+          transaction.sample_data
+        end
+
+        it "stores last <LIMIT> breadcrumbs on the transaction" do
+          expect(transaction.to_h["sample_data"]["breadcrumbs"].length).to eql(20)
+          expect(transaction.to_h["sample_data"]["breadcrumbs"][0]).to eq(
+            "action" => "GET http://localhost",
+            "category" => "network",
+            "message" => "User made external network request",
+            "metadata" => { "code" => 3 },
+            "time" => 1286704800 # rubocop:disable Style/NumericLiterals
+          )
+          expect(transaction.to_h["sample_data"]["breadcrumbs"][19]).to eq(
+            "action" => "GET http://localhost",
+            "category" => "network",
+            "message" => "User made external network request",
+            "metadata" => { "code" => 22 },
+            "time" => 1286704800 # rubocop:disable Style/NumericLiterals
+          )
+        end
+      end
+
+      context "with defaults" do
+        it "stores breadcrumb with defaults on transaction" do
+          timeframe_start = Time.now.utc.to_i
+          transaction.add_breadcrumb("user_action", "clicked HOME")
+          transaction.sample_data
+          timeframe_end = Time.now.utc.to_i
+
+          breadcrumb = transaction.to_h["sample_data"]["breadcrumbs"][0]
+          expect(breadcrumb["category"]).to eq("user_action")
+          expect(breadcrumb["action"]).to eq("clicked HOME")
+          expect(breadcrumb["message"]).to eq("")
+          expect(breadcrumb["time"]).to be_between(timeframe_start, timeframe_end)
+          expect(breadcrumb["metadata"]).to eq({})
+        end
+      end
+    end
+
     describe "#set_action" do
       context "when the action is set" do
         it "updates the action name on the transaction" do
@@ -649,6 +700,10 @@ describe Appsignal::Transaction do
           "tags",
           Appsignal::Utils::Data.generate({})
         ).once
+        expect(transaction.ext).to receive(:set_sample_data).with(
+          "breadcrumbs",
+          Appsignal::Utils::Data.generate([])
+        ).once
 
         transaction.sample_data
       end

data/spec/lib/appsignal_spec.rb

@@ -491,6 +491,36 @@ describe Appsignal do
       end
     end
 
+    describe ".add_breadcrumb" do
+      before { allow(Appsignal::Transaction).to receive(:current).and_return(transaction) }
+
+      context "with transaction" do
+        let(:transaction) { double }
+        it "should call add_breadcrumb on transaction" do
+          expect(transaction).to receive(:add_breadcrumb)
+            .with("Network", "http", "User made network request", { :response => 200 }, fixed_time)
+        end
+
+        after do
+          Appsignal.add_breadcrumb(
+            "Network",
+            "http",
+            "User made network request",
+            { :response => 200 },
+            fixed_time
+          )
+        end
+      end
+
+      context "without transaction" do
+        let(:transaction) { nil }
+
+        it "should not call add_breadcrumb on transaction" do
+          expect(Appsignal.add_breadcrumb("Network", "http")).to be_falsy
+        end
+      end
+    end
+
     describe "custom stats" do
       let(:tags) { { :foo => "bar" } }
 

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.11.1
+  version: 2.11.2
 platform: ruby
 authors:
 - Robert Beekman
 - Thijs Cadier
 - Tom de Bruijn
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-15 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -399,7 +399,7 @@ metadata:
   documentation_uri: https://docs.appsignal.com/ruby/
   homepage_uri: https://docs.appsignal.com/ruby/
   source_code_uri: https://github.com/appsignal/appsignal-ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -415,8 +415,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com
 test_files: