appsignal 4.0.9 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e98be4df445350c51cb3b1d3543300257051dda917d8433a4503c9eda77d2cd6
-  data.tar.gz: bca5d410c1a2fb91812d2cc63b19a04b0db6cafd18c368a1ece930915bbf0a66
+  metadata.gz: fd929ef03ad3a9ceec274cc57e036614e3b2dfb76be026b8c0b878a35a5ce654
+  data.tar.gz: ef77980f54715f5b4a05ee218df8a0e51b3f867643ca793ef790dda3f324e05c
 SHA512:
-  metadata.gz: ca0b4443929b282883b1d74f0092526bb69b3c223a6a60af1de372cf6af2acde569e57ada8b67b8aaac6645ada48b2c253ec595c1aec72bd5c812d03b577e953
-  data.tar.gz: 5e3d0d285a6ebf6a7b8beae27fdaceec6365aa016fa1181e1572f42054fced494771eac6fd62434efb5cd4dae7ee7ca542aa1b6ac5d680139ec7d24dfd238c55
+  metadata.gz: 0a6ad722785e28515a5d716df4dbf4aad9bc134718ebc2354cd4bcd3fda75c923cd1266f249e2d019cdc459ca43fc0ca2559cc4733859a05546a809f1e5f5410
+  data.tar.gz: 0cf285924ec8dd63cbcdb89a0354f76dfdc86d6737dc32c80f2538ae136b8653763b67a3507238db866751869d7c17f817eb2e766b4b7860584f4618be550d58

data/CHANGELOG.md

@@ -1,5 +1,50 @@
 # AppSignal for Ruby gem Changelog
 
+## 4.1.1
+
+_Published on 2024-09-28._
+
+### Changed
+
+- Add the `reported_by` tag to errors reported by the Rails error reporter so the source of the error is easier to identify. (patch [ff98ed67](https://github.com/appsignal/appsignal-ruby/commit/ff98ed677bf30242c51261bf7e44c9b6ba2f33ac))
+
+### Fixed
+
+- Fix no AppSignal internal logs being logged from Capistrano tasks. (patch [089d0325](https://github.com/appsignal/appsignal-ruby/commit/089d03251c3dc8b83658a4ebfade51ab6bed1771))
+- Report all the config options set via `Appsignal.config` in the DSL config source in the diagnose report. Previously, it would only report the options from the last time `Appsignal.configure` was called. (patch [27b9aff7](https://github.com/appsignal/appsignal-ruby/commit/27b9aff7776646dfef6c55fa589024a71052e70b))
+- Fix 'no implicit conversion of Pathname into String' error when parsing backtrace lines of error causes in Rails apps. (patch [b767f269](https://github.com/appsignal/appsignal-ruby/commit/b767f269c41cb7625d6869d8e8acb9b288292d19))
+
+## 4.1.0
+
+_Published on 2024-09-26._
+
+### Added
+
+- Add support for heartbeat check-ins.
+
+  Use the `Appsignal::CheckIn.heartbeat` method to send a single heartbeat check-in event from your application. This can be used, for example, in your application's main loop:
+
+  ```ruby
+  loop do
+    Appsignal::CheckIn.heartbeat("job_processor")
+    process_job
+  end
+  ```
+
+  Heartbeats are deduplicated and sent asynchronously, without blocking the current thread. Regardless of how often the `.heartbeat` method is called, at most one heartbeat with the same identifier will be sent every ten seconds.
+
+  Pass `continuous: true` as the second argument to send heartbeats continuously during the entire lifetime of the current process. This can be used, for example, after your application has finished its boot process:
+
+  ```ruby
+  def main
+    start_app
+    Appsignal::CheckIn.heartbeat("my_app", continuous: true)
+  end
+  ```
+
+  (minor [7ae7152c](https://github.com/appsignal/appsignal-ruby/commit/7ae7152cddae7c257e9d62d3bf2433cce1f4287d))
+- Include the first backtrace line from error causes to show where each cause originated in the interface. (patch [496b035a](https://github.com/appsignal/appsignal-ruby/commit/496b035a3510dbb6dc47c7c59172f488ec55c986))
+
 ## 4.0.9
 
 _Published on 2024-09-17._

data/lib/appsignal/check_in/cron.rb

@@ -22,13 +22,11 @@ module Appsignal
       private
 
       def event(kind)
-        {
+        Event.cron(
           :identifier => @identifier,
           :digest => @digest,
-          :kind => kind,
-          :timestamp => Time.now.utc.to_i,
-          :check_in_type => "cron"
-        }
+          :kind => kind
+        )
       end
     end
   end

data/lib/appsignal/check_in/event.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Appsignal
+  module CheckIn
+    # @api private
+    class Event
+      class << self
+        def new(check_in_type:, identifier:, digest: nil, kind: nil)
+          {
+            :identifier => identifier,
+            :digest => digest,
+            :kind => kind,
+            :timestamp => Time.now.utc.to_i,
+            :check_in_type => check_in_type
+          }.compact
+        end
+
+        def cron(identifier:, digest:, kind:)
+          new(
+            :check_in_type => "cron",
+            :identifier => identifier,
+            :digest => digest,
+            :kind => kind
+          )
+        end
+
+        def heartbeat(identifier:)
+          new(
+            :check_in_type => "heartbeat",
+            :identifier => identifier
+          )
+        end
+
+        def redundant?(event, other)
+          return false if
+            other[:check_in_type] != event[:check_in_type] ||
+              other[:identifier] != event[:identifier]
+
+          return false if event[:check_in_type] == "cron" && (
+            other[:digest] != event[:digest] ||
+            other[:kind] != event[:kind]
+          )
+
+          return false if
+            event[:check_in_type] != "cron" &&
+              event[:check_in_type] != "heartbeat"
+
+          true
+        end
+
+        def describe(events)
+          if events.empty?
+            # This shouldn't happen.
+            "no check-in events"
+          elsif events.length > 1
+            "#{events.length} check-in events"
+          else
+            event = events.first
+            if event[:check_in_type] == "cron"
+              "cron check-in `#{event[:identifier] || "unknown"}` " \
+                "#{event[:kind] || "unknown"} event (digest #{event[:digest] || "unknown"})"
+            elsif event[:check_in_type] == "heartbeat"
+              "heartbeat check-in `#{event[:identifier] || "unknown"}` event"
+            else
+              "unknown check-in event"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/check_in/scheduler.rb

@@ -29,7 +29,7 @@ module Appsignal
       def schedule(event)
         unless Appsignal.active?
           Appsignal.internal_logger.debug(
-            "Cannot transmit #{describe([event])}: AppSignal is not active"
+            "Cannot transmit #{Event.describe([event])}: AppSignal is not active"
           )
           return
         end
@@ -37,7 +37,7 @@ module Appsignal
         @mutex.synchronize do
           if @queue.closed?
             Appsignal.internal_logger.debug(
-              "Cannot transmit #{describe([event])}: AppSignal is stopped"
+              "Cannot transmit #{Event.describe([event])}: AppSignal is stopped"
             )
             return
           end
@@ -48,7 +48,7 @@ module Appsignal
           start_waker(INITIAL_DEBOUNCE_SECONDS) if @waker.nil?
 
           Appsignal.internal_logger.debug(
-            "Scheduling #{describe([event])} to be transmitted"
+            "Scheduling #{Event.describe([event])} to be transmitted"
           )
 
           # Make sure to start the thread after an event has been added.
@@ -92,7 +92,7 @@ module Appsignal
       end
 
       def transmit(events)
-        description = describe(events)
+        description = Event.describe(events)
 
         begin
           response = CheckIn.transmitter.transmit(events, :format => :ndjson)
@@ -110,42 +110,18 @@ module Appsignal
         end
       end
 
-      def describe(events)
-        if events.empty?
-          # This shouldn't happen.
-          "no check-in events"
-        elsif events.length > 1
-          "#{events.length} check-in events"
-        else
-          event = events.first
-          if event[:check_in_type] == "cron"
-            "cron check-in `#{event[:identifier] || "unknown"}` " \
-              "#{event[:kind] || "unknown"} event (digest #{event[:digest] || "unknown"})" \
-          else
-            "unknown check-in event"
-          end
-        end
-      end
-
       # Must be called from within a `@mutex.synchronize` block.
       def add_event(event)
         # Remove redundant events, keeping the newly added one, which
         # should be the one with the most recent timestamp.
-        if event[:check_in_type] == "cron"
-          # Remove any existing cron check-in event with the same identifier,
-          # digest and kind as the one we're adding.
-          @events.reject! do |existing_event|
-            next unless existing_event[:identifier] == event[:identifier] &&
-              existing_event[:digest] == event[:digest] &&
-              existing_event[:kind] == event[:kind] &&
-              existing_event[:check_in_type] == "cron"
+        @events.reject! do |existing_event|
+          next unless Event.redundant?(event, existing_event)
 
-            Appsignal.internal_logger.debug(
-              "Replacing previously scheduled #{describe([existing_event])}"
-            )
+          Appsignal.internal_logger.debug(
+            "Replacing previously scheduled #{Event.describe([existing_event])}"
+          )
 
-            true
-          end
+          true
         end
 
         @events << event

data/lib/appsignal/check_in.rb

@@ -2,10 +2,21 @@
 
 module Appsignal
   module CheckIn
+    HEARTBEAT_CONTINUOUS_INTERVAL_SECONDS = 30
     class << self
+      # @api private
+      def continuous_heartbeats
+        @continuous_heartbeats ||= []
+      end
+
+      # @api private
+      def kill_continuous_heartbeats
+        continuous_heartbeats.each(&:kill)
+      end
+
       # Track cron check-ins.
       #
-      # Track the execution of certain processes by sending a cron check-in.
+      # Track the execution of scheduled processes by sending a cron check-in.
       #
       # To track the duration of a piece of code, pass a block to {.cron}
       # to report both when the process starts, and when it finishes.
@@ -40,6 +51,37 @@ module Appsignal
         output
       end
 
+      # Track heartbeat check-ins.
+      #
+      # Track the execution of long-lived processes by sending a heartbeat
+      # check-in.
+      #
+      # @example Send a heartbeat check-in
+      #   Appsignal::CheckIn.heartbeat("main_loop")
+      #
+      # @param identifier [String] identifier of the heartbeat check-in to report.
+      # @param continuous [Boolean] whether the heartbeats should be sent continuously
+      #   during the lifetime of the process. Defaults to `false`.
+      # @yield the block to monitor.
+      # @return [void]
+      # @since 4.1.0
+      # @see https://docs.appsignal.com/check-ins/heartbeat
+      def heartbeat(identifier, continuous: false)
+        if continuous
+          continuous_heartbeats << Thread.new do
+            loop do
+              heartbeat(identifier)
+              sleep HEARTBEAT_CONTINUOUS_INTERVAL_SECONDS
+            end
+          end
+
+          return
+        end
+
+        event = Event.heartbeat(:identifier => identifier)
+        scheduler.schedule(event)
+      end
+
       # @api private
       def transmitter
         @transmitter ||= Transmitter.new(
@@ -60,5 +102,6 @@ module Appsignal
   end
 end
 
+require "appsignal/check_in/event"
 require "appsignal/check_in/scheduler"
 require "appsignal/check_in/cron"

data/lib/appsignal/config.rb

@@ -180,36 +180,19 @@ module Appsignal
       "APPSIGNAL_CPU_COUNT" => :cpu_count
     }.freeze
 
-    # @attribute [r] system_config
-    #   Config detected on the system level.
-    #   Used in diagnose report.
-    #   @api private
-    #   @return [Hash]
-    # @!attribute [r] file_config
-    #   Config loaded from `config/appsignal.yml` config file.
-    #   Used in diagnose report.
-    #   @api private
-    #   @return [Hash]
-    # @!attribute [r] env_config
-    #   Config loaded from the system environment.
-    #   Used in diagnose report.
-    #   @api private
-    #   @return [Hash]
-    # @!attribute [r] config_hash
-    #   Config used by the AppSignal gem.
-    #   Combined Hash of the {system_config}, {file_config}, {env_config}
-    #   attributes.
-    #   @see #[]
-    #   @see #[]=
-    #   @api private
-    #   @return [Hash]
+    # @api private
+    attr_reader :root_path, :env, :config_hash
 
+    # List of config option sources. If a config option was set by a source,
+    # it's listed in that source's config options hash.
+    #
+    # These options are merged as the config is initialized.
+    # Their values cannot be changed after the config is initialized.
+    #
+    # Used by the diagnose report to list which value was read from which source.
     # @api private
-    attr_accessor :root_path, :env, :config_hash
     attr_reader :system_config, :loaders_config, :initial_config, :file_config,
       :env_config, :override_config, :dsl_config
-    # @api private
-    attr_accessor :logger
 
     # Initialize a new configuration object for AppSignal.
     #
@@ -217,9 +200,6 @@ module Appsignal
     # @param env [String] The environment to load when AppSignal is started. It
     #   will look for an environment with this name in the `config/appsignal.yml`
     #   config file.
-    # @param logger [Logger] The logger to use for the AppSignal gem. This is
-    #   used by the configuration class only. Default:
-    #   {Appsignal.internal_logger}. See also {Appsignal.start}.
     #
     # @api private
     # @see https://docs.appsignal.com/ruby/configuration/
@@ -230,13 +210,11 @@ module Appsignal
     #   How to integrate AppSignal manually
     def initialize(
       root_path,
-      env,
-      logger = Appsignal.internal_logger
+      env
     )
-      @root_path = root_path
+      @root_path = root_path.to_s
       @config_file_error = false
       @config_file = config_file
-      @logger = logger
       @valid = false
 
       @env = env.to_s
@@ -402,7 +380,7 @@ module Appsignal
 
     # @api private
     def merge_dsl_options(options)
-      @dsl_config = options
+      @dsl_config.merge!(options)
       merge(options)
     end
 
@@ -426,7 +404,7 @@ module Appsignal
       push_api_key = config_hash[:push_api_key] || ""
       if push_api_key.strip.empty?
         @valid = false
-        @logger.error "Push API key not set after loading config"
+        logger.error "Push API key not set after loading config"
       else
         @valid = true
       end
@@ -445,6 +423,10 @@ module Appsignal
 
     private
 
+    def logger
+      Appsignal.internal_logger
+    end
+
     def config_file
       @config_file ||=
         root_path.nil? ? nil : File.join(root_path, "config", "appsignal.yml")
@@ -546,7 +528,7 @@ module Appsignal
 
     def merge(new_config)
       new_config.each do |key, value|
-        @logger.debug("Config key '#{key}' is being overwritten") unless config_hash[key].nil?
+        logger.debug("Config key '#{key}' is being overwritten") unless config_hash[key].nil?
         config_hash[key] = value
       end
     end

data/lib/appsignal/integrations/capistrano/appsignal.cap

@@ -10,12 +10,12 @@ namespace :appsignal do
 
     appsignal_config = Appsignal::Config.new(
       Dir.pwd,
-      appsignal_env,
-      Logger.new(StringIO.new)
+      appsignal_env
     ).tap do |c|
       c.merge_dsl_options(fetch(:appsignal_config, {}))
       c.validate
     end
+    Appsignal._start_logger
 
     if appsignal_config&.active?
       marker_data = {

data/lib/appsignal/integrations/capistrano/capistrano_2_tasks.rb

@@ -18,12 +18,12 @@ module Appsignal
 
               appsignal_config = Appsignal::Config.new(
                 ENV.fetch("PWD", nil),
-                env,
-                Appsignal::Utils::IntegrationLogger.new(StringIO.new)
+                env
               ).tap do |c|
                 c.merge_dsl_options(fetch(:appsignal_config, {}))
                 c.validate
               end
+              Appsignal._start_logger
 
               if appsignal_config&.active?
                 marker_data = {

data/lib/appsignal/integrations/railtie.rb

@@ -94,6 +94,7 @@ module Appsignal
             transaction.set_action(action_name) if action_name
             transaction.add_custom_data(custom_data) if custom_data
 
+            tags[:reported_by] = :rails_error_reporter
             tags[:severity] = severity
             tags[:source] = source.to_s if source
             transaction.add_tags(tags)

data/lib/appsignal/transaction.rb

@@ -627,7 +627,8 @@ module Appsignal
       causes_sample_data = causes.map do |e|
         {
           :name => e.class.name,
-          :message => cleaned_error_message(e)
+          :message => cleaned_error_message(e),
+          :first_line => first_formatted_backtrace_line(e)
         }
       end
 
@@ -639,6 +640,36 @@ module Appsignal
       )
     end
 
+    BACKTRACE_REGEX =
+      %r{(?<gem>[\w-]+ \(.+\) )?(?<path>:?/?\w+?.+?):(?<line>:?\d+)(?<group>:in `(?<method>.+)')?$}.freeze # rubocop:disable Layout/LineLength
+
+    def first_formatted_backtrace_line(error)
+      backtrace = cleaned_backtrace(error.backtrace)
+      first_line = backtrace&.first
+      return unless first_line
+
+      captures = BACKTRACE_REGEX.match(first_line)
+      return unless captures
+
+      captures.named_captures
+        .merge("original" => first_line)
+        .tap do |c|
+          config = Appsignal.config
+          c.delete("group") # Unused key, only for easier matching
+          # Strip of whitespace at the end of the gem name
+          c["gem"] = c["gem"]&.strip
+          # Strip the app path from the path if present
+          root_path = config.root_path
+          if c["path"].start_with?(root_path)
+            c["path"].delete_prefix!(root_path)
+            # Relative paths shouldn't start with a slash
+            c["path"].delete_prefix!("/")
+          end
+          # Add revision for linking to the repository from the UI
+          c["revision"] = config[:revision]
+        end
+    end
+
     def set_sample_data(key, data)
       return unless key && data
 

data/lib/appsignal/transmitter.rb

@@ -107,7 +107,7 @@ module Appsignal
           if ca_file && File.exist?(ca_file) && File.readable?(ca_file)
             http.ca_file = ca_file
           else
-            config.logger.warn "Ignoring non-existing or unreadable " \
+            Appsignal.internal_logger.warn "Ignoring non-existing or unreadable " \
               "`ca_file_path`: #{ca_file}"
           end
         end

data/lib/appsignal/version.rb

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

data/lib/appsignal.rb

@@ -244,8 +244,7 @@ module Appsignal
       else
         @config = Config.new(
           root_path || Config.determine_root_path,
-          Config.determine_env(env),
-          Appsignal.internal_logger
+          Config.determine_env(env)
         )
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 4.0.9
+  version: 4.1.1
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-17 00:00:00.000000000 Z
+date: 2024-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -167,6 +167,7 @@ files:
 - lib/appsignal/capistrano.rb
 - lib/appsignal/check_in.rb
 - lib/appsignal/check_in/cron.rb
+- lib/appsignal/check_in/event.rb
 - lib/appsignal/check_in/scheduler.rb
 - lib/appsignal/cli.rb
 - lib/appsignal/cli/demo.rb