appsignal 3.7.4 → 3.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e1761916266f8e937324fdd06fc35239e346cef46a5835b3a4f605a724a4b32
-  data.tar.gz: 83a356f5c62b027e785a3ee5718d26df65301fb0adfad597a5699c59f754da5d
+  metadata.gz: 01c402441faf18659ecff6becf0b7ae9db255825cc873edd5bf2ccc3aaa62c6b
+  data.tar.gz: 3b9e4c29a62c073f8c9395c26f26dcfc4496af5ca9352193f04983d11bca9476
 SHA512:
-  metadata.gz: 6ddf7ffc0c9edfbe34ba1825f2e4abfc89df5238aa1866bae9652f11629c760ad7d638824650321b3e8728b409c0c9e30b64653ffd6ac1df07413490544bf7b0
-  data.tar.gz: 41be1cf851cbf8c64b2a3c0e24811c47a838e77a9ed320a9ef1695690fd186a2101feb7603166e53f44a6de9992ebec306c2b4d513ea5e663b91354307a2cbe6
+  metadata.gz: 3c1994c27480cbc29310b88c81ad09534885cf3acd43b7d2439921cf54c2f252023b44e0bf40c0f4b6fa4145fc86f2ba9ff36feca8357874576e928c75bec3e4
+  data.tar.gz: 2d77c4799ba521b3832ebba0d632a70774d767a92e694cfa23a6e82c4c25c05556f5ebad03e571e09d1ce34be234ac7ede1ae3df601247b23cb4df7ccadfe5a9

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.7.5
+
+_Published on 2024-05-14._
+
+### Added
+
+- [bf81e165](https://github.com/appsignal/appsignal-ruby/commit/bf81e16593c7598e266d1e4cfb108aeef2ed7e73) patch - Support events emitted by ViewComponent. Rendering of ViewComponent-based components will appear as events in your performance samples' event timeline.
+  
+  For AppSignal to instrument ViewComponent events, you must first configure ViewComponent to emit those events:
+  
+  ```ruby
+  # config/application.rb
+  module MyRailsApp
+    class Application < Rails::Application
+      config.view_component.instrumentation_enabled = true
+      config.view_component.use_deprecated_instrumentation_name = false
+    end
+  end
+  ```
+  
+  Thanks to Trae Robrock (@trobrock) for providing a starting point for this implementation!
+- [ad5c9955](https://github.com/appsignal/appsignal-ruby/commit/ad5c99556421fe86501205465053466a91f28448) patch - Support Kamal-based deployments. Read the `KAMAL_VERSION` environment variable, which Kamal exposes within the deployed container, if present, and use it as the application revision if it is not set. This will automatically report deploy markers for applications using Kamal.
+
+### Fixed
+
+- [30bb675f](https://github.com/appsignal/appsignal-ruby/commit/30bb675ffa99ec1949a613f309e6c1792b88d4ce) patch - Fix an issue where an error about the AppSignal internal logger is raised when sending a heartbeat.
+
 ## 3.7.4
 
 _Published on 2024-05-09._

data/Rakefile

@@ -324,7 +324,7 @@ begin
 
   desc "Run the AppSignal gem test suite."
   RSpec::Core::RakeTask.new :test do |t|
-    t.rspec_opts = exclude_pattern
+    t.rspec_opts = "#{exclude_pattern} --format documentation"
   end
 
   namespace :test do

data/ext/agent.rb

@@ -6,7 +6,7 @@
 # Modifications to this file will be overwritten with the next agent release.
 
 APPSIGNAL_AGENT_CONFIG = {
-  "version" => "0.35.5",
+  "version" => "0.35.10",
   "mirrors" => [
     "https://appsignal-agent-releases.global.ssl.fastly.net",
     "https://d135dj0rjqvssy.cloudfront.net"
@@ -14,131 +14,131 @@ APPSIGNAL_AGENT_CONFIG = {
   "triples" => {
     "x86_64-darwin" => {
       "static" => {
-        "checksum" => "3985b53b2a2814d44737182890e6fbe31b4b88361025140477a598e0e41fd948",
+        "checksum" => "8bdf6b162e03c5f63bc06f2d49ae789bb14e111636524ed78262bd543587a971",
         "filename" => "appsignal-x86_64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "d135e2daf5c041a4ce7a7ab720cfd977fbae8375a007995e33a96558d3635792",
+        "checksum" => "92535e45232d5fe2eb7b9ff2f731115de566144390cd281449acd5c3a570ebb5",
         "filename" => "appsignal-x86_64-darwin-all-dynamic.tar.gz"
       }
     },
     "universal-darwin" => {
       "static" => {
-        "checksum" => "3985b53b2a2814d44737182890e6fbe31b4b88361025140477a598e0e41fd948",
+        "checksum" => "8bdf6b162e03c5f63bc06f2d49ae789bb14e111636524ed78262bd543587a971",
         "filename" => "appsignal-x86_64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "d135e2daf5c041a4ce7a7ab720cfd977fbae8375a007995e33a96558d3635792",
+        "checksum" => "92535e45232d5fe2eb7b9ff2f731115de566144390cd281449acd5c3a570ebb5",
         "filename" => "appsignal-x86_64-darwin-all-dynamic.tar.gz"
       }
     },
     "aarch64-darwin" => {
       "static" => {
-        "checksum" => "79d22436bfe32dab4661f2a4149c6ab34c71e810c5d808ee3e60cd9f8a1395e4",
+        "checksum" => "c6453bb54a68cdb0b42864747b328e60a14b5b99921f11757de03db42041bed2",
         "filename" => "appsignal-aarch64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "2c49c8f24a9dd8f9d55c28015b3e1096180807e7b13d4a9cd8ed30f58bc6612f",
+        "checksum" => "920fa90c131752a40287b55356cd2360e17417753087b74dbf63c339f04dacc9",
         "filename" => "appsignal-aarch64-darwin-all-dynamic.tar.gz"
       }
     },
     "arm64-darwin" => {
       "static" => {
-        "checksum" => "79d22436bfe32dab4661f2a4149c6ab34c71e810c5d808ee3e60cd9f8a1395e4",
+        "checksum" => "c6453bb54a68cdb0b42864747b328e60a14b5b99921f11757de03db42041bed2",
         "filename" => "appsignal-aarch64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "2c49c8f24a9dd8f9d55c28015b3e1096180807e7b13d4a9cd8ed30f58bc6612f",
+        "checksum" => "920fa90c131752a40287b55356cd2360e17417753087b74dbf63c339f04dacc9",
         "filename" => "appsignal-aarch64-darwin-all-dynamic.tar.gz"
       }
     },
     "arm-darwin" => {
       "static" => {
-        "checksum" => "79d22436bfe32dab4661f2a4149c6ab34c71e810c5d808ee3e60cd9f8a1395e4",
+        "checksum" => "c6453bb54a68cdb0b42864747b328e60a14b5b99921f11757de03db42041bed2",
         "filename" => "appsignal-aarch64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "2c49c8f24a9dd8f9d55c28015b3e1096180807e7b13d4a9cd8ed30f58bc6612f",
+        "checksum" => "920fa90c131752a40287b55356cd2360e17417753087b74dbf63c339f04dacc9",
         "filename" => "appsignal-aarch64-darwin-all-dynamic.tar.gz"
       }
     },
     "aarch64-linux" => {
       "static" => {
-        "checksum" => "4a54587bb61f59d0b60032b2e0c1d14d2e726e20af049353c2ff279d07dd3028",
+        "checksum" => "4e90ec4bce1e632316a26fdaf03ccd8773bf7a9615eb7a1739c8c53f3fa5221a",
         "filename" => "appsignal-aarch64-linux-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "aa2d011c538ce547c87110e7c8e49a24597d60ea2d1418032fc3db06267efba2",
+        "checksum" => "d4e5811ab29f801c59caafe445a06c686245666459a45a28240c2db7395abf27",
         "filename" => "appsignal-aarch64-linux-all-dynamic.tar.gz"
       }
     },
     "i686-linux" => {
       "static" => {
-        "checksum" => "01e2237029c3af23cc6f348fb63f65a92b8caf8f4731b78d014bb4001559aad5",
+        "checksum" => "f5bcb9f732cb5af53a5de2f2c916156bdd6677c0e563ddafd23f09576440dfdc",
         "filename" => "appsignal-i686-linux-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "c1043ac92b000a406d9afb77b6ec1d3ab6cfffd63c218a720c11daa3edb7fd1f",
+        "checksum" => "52bf105113a3dbe1e9527c0c733edd3ee05788e340bd41577ed38878df6748f0",
         "filename" => "appsignal-i686-linux-all-dynamic.tar.gz"
       }
     },
     "x86-linux" => {
       "static" => {
-        "checksum" => "01e2237029c3af23cc6f348fb63f65a92b8caf8f4731b78d014bb4001559aad5",
+        "checksum" => "f5bcb9f732cb5af53a5de2f2c916156bdd6677c0e563ddafd23f09576440dfdc",
         "filename" => "appsignal-i686-linux-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "c1043ac92b000a406d9afb77b6ec1d3ab6cfffd63c218a720c11daa3edb7fd1f",
+        "checksum" => "52bf105113a3dbe1e9527c0c733edd3ee05788e340bd41577ed38878df6748f0",
         "filename" => "appsignal-i686-linux-all-dynamic.tar.gz"
       }
     },
     "x86_64-linux" => {
       "static" => {
-        "checksum" => "beae1db2c122eb579f1ccb450177b0c64d65569d774efc7a1ee72c42d3382d39",
+        "checksum" => "6faa14f508f7c27b65d912eedb31f7808e1e2fb1dcaa077db2426c321e1f5c65",
         "filename" => "appsignal-x86_64-linux-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "67650f59d2ea9c99cde7dfe44da65a506522a3cdccabe697931d89ebaea96d18",
+        "checksum" => "0981839a288dc2ab6d024bae79789a20f5cadce55c4cbcade925066b83028b65",
         "filename" => "appsignal-x86_64-linux-all-dynamic.tar.gz"
       }
     },
     "x86_64-linux-musl" => {
       "static" => {
-        "checksum" => "521c4486d10cdafa1f72103cc439d6f0e4f549f1522c4473bf43dc487ec42436",
+        "checksum" => "8f54b734e56eae7867b5474c7ad4d79e049fd4063202e1b80989795708354e49",
         "filename" => "appsignal-x86_64-linux-musl-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "0a94fcee8eb1f8fd06fce3eacffbcf9f2a52f5cde040796e19a589176525db4b",
+        "checksum" => "01df4f408e2c0f83204bedfe33e132bfdc6c4a9dcff6581bacf30df45140a49e",
         "filename" => "appsignal-x86_64-linux-musl-all-dynamic.tar.gz"
       }
     },
     "aarch64-linux-musl" => {
       "static" => {
-        "checksum" => "c29aab31f4ca59efb1483f48c0cb3c27d799347b81655a28f24c146b55aa7db6",
+        "checksum" => "b3d247d632e3465b2233dd8bb2e977f248f14286ca870e9bd7b855b550ba1c00",
         "filename" => "appsignal-aarch64-linux-musl-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "4b77ea0c1f50ada6e5f6ed693002e56db1e34e0e9d5fdb4ac80fc52fd51099b8",
+        "checksum" => "52d4a422bcf3a9bbbb6119abae21f6b1d1191309103bcfb90a1f786b1af64a71",
         "filename" => "appsignal-aarch64-linux-musl-all-dynamic.tar.gz"
       }
     },
     "x86_64-freebsd" => {
       "static" => {
-        "checksum" => "a3598e9df1b6b5970aabbbccbe4e77c2372d2320cd87bfa20f32fca53b8505e4",
+        "checksum" => "1cce550eac963e2edf405e551a613ffd15ae69e4b817b6155b8a5783a9fa9b7f",
         "filename" => "appsignal-x86_64-freebsd-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "4cbfd5e16776c8ea4308ee7f3a096c5cc137f2506f8a05d9c8504e3483fcd8ac",
+        "checksum" => "ea67b696f806127ac7e59d3dd02a5ca47de1526455b957bad4fd69d9b08913fe",
         "filename" => "appsignal-x86_64-freebsd-all-dynamic.tar.gz"
       }
     },
     "amd64-freebsd" => {
       "static" => {
-        "checksum" => "a3598e9df1b6b5970aabbbccbe4e77c2372d2320cd87bfa20f32fca53b8505e4",
+        "checksum" => "1cce550eac963e2edf405e551a613ffd15ae69e4b817b6155b8a5783a9fa9b7f",
         "filename" => "appsignal-x86_64-freebsd-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "4cbfd5e16776c8ea4308ee7f3a096c5cc137f2506f8a05d9c8504e3483fcd8ac",
+        "checksum" => "ea67b696f806127ac7e59d3dd02a5ca47de1526455b957bad4fd69d9b08913fe",
         "filename" => "appsignal-x86_64-freebsd-all-dynamic.tar.gz"
       }
     }

data/gemfiles/rails-7.1.gemfile

@@ -3,6 +3,7 @@ source "https://rubygems.org"
 gem "rails", "~> 7.1.0"
 gem "rake", "> 12.2"
 gem "sidekiq"
+gem "view_component"
 
 # Fix install issue for jruby on gem 3.1.8.
 # No java stub is published.

data/lib/appsignal/event_formatter/view_component/render_formatter.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Appsignal
+  class EventFormatter
+    # @api private
+    module ViewComponent
+      class RenderFormatter
+        BLANK = ""
+
+        attr_reader :root_path
+
+        def initialize
+          @root_path = "#{Rails.root}/"
+        end
+
+        def format(payload)
+          [payload[:name], payload[:identifier].sub(@root_path, BLANK)]
+        end
+      end
+    end
+  end
+end
+
+if defined?(Rails) && defined?(ViewComponent)
+  Appsignal::EventFormatter.register(
+    "render.view_component",
+    Appsignal::EventFormatter::ViewComponent::RenderFormatter
+  )
+  Appsignal::EventFormatter.register(
+    "!render.view_component",
+    Appsignal::EventFormatter::ViewComponent::RenderFormatter
+  )
+end

data/lib/appsignal/heartbeat.rb

@@ -45,7 +45,7 @@ module Appsignal
       response = self.class.transmitter.transmit(event(kind))
 
       if response.code.to_i >= 200 && response.code.to_i < 300
-        Appsignal.internal_logger.trace("Transmitted heartbeat `#{name}` (#{id}) #{kind} event")
+        Appsignal.internal_logger.debug("Transmitted heartbeat `#{name}` (#{id}) #{kind} event")
       else
         Appsignal.internal_logger.error(
           "Failed to transmit heartbeat event: status code was #{response.code}"

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.7.4"
+  VERSION = "3.7.5"
 end

data/spec/lib/appsignal/event_formatter/view_component/render_formatter_spec.rb

@@ -0,0 +1,43 @@
+describe Appsignal::EventFormatter::ViewComponent::RenderFormatter do
+  let(:klass) { Appsignal::EventFormatter::ViewComponent::RenderFormatter }
+
+  if DependencyHelper.rails_present? && DependencyHelper.view_component_present?
+    require "view_component"
+
+    context "when in a Rails app" do
+      let(:formatter) { klass.new }
+      before { allow(Rails.root).to receive(:to_s).and_return("/var/www/app/20130101") }
+
+      it "registers render.view_component and (deprecated) !render.view_component" do
+        expect(Appsignal::EventFormatter.registered?("render.view_component",
+          klass)).to be_truthy
+        expect(Appsignal::EventFormatter.registered?("!render.view_component",
+          klass)).to be_truthy
+      end
+
+      describe "#format" do
+        subject { formatter.format(payload) }
+
+        context "with a name and identifier" do
+          let(:payload) do
+            {
+              :name => "WhateverComponent",
+              :identifier => "/var/www/app/20130101/app/components/whatever_component.rb"
+            }
+          end
+
+          it { is_expected.to eq ["WhateverComponent", "app/components/whatever_component.rb"] }
+        end
+      end
+    end
+  else
+    context "when not in a Rails app with the ViewComponent gem" do
+      it "does not register the event formatter" do
+        expect(Appsignal::EventFormatter.registered?("render.view_component",
+          klass)).to be_falsy
+        expect(Appsignal::EventFormatter.registered?("!render.view_component",
+          klass)).to be_falsy
+      end
+    end
+  end
+end

data/spec/lib/appsignal/heartbeat_spec.rb

@@ -24,7 +24,26 @@ describe Appsignal::Heartbeat do
       expect(transmitter).to receive(:transmit).with(hash_including(
         :name => "heartbeat-name",
         :kind => "start"
-      )).and_return(nil)
+      )).and_return(Net::HTTPResponse.new(nil, "200", nil))
+
+      expect(Appsignal.internal_logger).to receive(:debug).with(
+        "Transmitted heartbeat `heartbeat-name` (#{heartbeat.id}) start event"
+      )
+      expect(Appsignal.internal_logger).not_to receive(:error)
+
+      heartbeat.start
+    end
+
+    it "should log an error if it fails" do
+      expect(transmitter).to receive(:transmit).with(hash_including(
+        :name => "heartbeat-name",
+        :kind => "start"
+      )).and_return(Net::HTTPResponse.new(nil, "499", nil))
+
+      expect(Appsignal.internal_logger).not_to receive(:debug)
+      expect(Appsignal.internal_logger).to receive(:error).with(
+        "Failed to transmit heartbeat event: status code was 499"
+      )
 
       heartbeat.start
     end
@@ -35,7 +54,26 @@ describe Appsignal::Heartbeat do
       expect(transmitter).to receive(:transmit).with(hash_including(
         :name => "heartbeat-name",
         :kind => "finish"
-      )).and_return(nil)
+      )).and_return(Net::HTTPResponse.new(nil, "200", nil))
+
+      expect(Appsignal.internal_logger).to receive(:debug).with(
+        "Transmitted heartbeat `heartbeat-name` (#{heartbeat.id}) finish event"
+      )
+      expect(Appsignal.internal_logger).not_to receive(:error)
+
+      heartbeat.finish
+    end
+
+    it "should log an error if it fails" do
+      expect(transmitter).to receive(:transmit).with(hash_including(
+        :name => "heartbeat-name",
+        :kind => "finish"
+      )).and_return(Net::HTTPResponse.new(nil, "499", nil))
+
+      expect(Appsignal.internal_logger).not_to receive(:debug)
+      expect(Appsignal.internal_logger).to receive(:error).with(
+        "Failed to transmit heartbeat event: status code was 499"
+      )
 
       heartbeat.finish
     end

data/spec/support/helpers/dependency_helper.rb

@@ -131,6 +131,10 @@ module DependencyHelper # rubocop:disable Metrics/ModuleLength
     hanami_present? && Gem.loaded_specs["hanami"].version >= Gem::Version.new("2.0")
   end
 
+  def view_component_present?
+    dependency_present? "view_component"
+  end
+
   def dependency_present?(dependency_file)
     Gem.loaded_specs.key? dependency_file
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.7.4
+  version: 3.7.5
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-09 00:00:00.000000000 Z
+date: 2024-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -203,6 +203,7 @@ files:
 - lib/appsignal/event_formatter/mongo_ruby_driver/query_formatter.rb
 - lib/appsignal/event_formatter/rom/sql_formatter.rb
 - lib/appsignal/event_formatter/sequel/sql_formatter.rb
+- lib/appsignal/event_formatter/view_component/render_formatter.rb
 - lib/appsignal/extension.rb
 - lib/appsignal/extension/jruby.rb
 - lib/appsignal/garbage_collection.rb
@@ -313,6 +314,7 @@ files:
 - spec/lib/appsignal/event_formatter/mongo_ruby_driver/query_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/rom/sql_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/sequel/sql_formatter_spec.rb
+- spec/lib/appsignal/event_formatter/view_component/render_formatter_spec.rb
 - spec/lib/appsignal/event_formatter_spec.rb
 - spec/lib/appsignal/extension/jruby_spec.rb
 - spec/lib/appsignal/extension_install_failure_spec.rb