errorgap 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fc092f673d279e6295144e0bcd302fabf729ff193b00b14ed651706f9cbb388
-  data.tar.gz: e89ffdc6f5eaab044376725d9baa3b8584a428d7f4799a89f5c22c13b9a96b30
+  metadata.gz: cabe7a082d767651c4e56f067d77fa21486056cde995842eb4ef7f8531adbf00
+  data.tar.gz: 10cc33121d252ce987eb92ccd2e57301ea4399bafa42c2b8cada4ab0dd4d1f63
 SHA512:
-  metadata.gz: b93c2e7bbd4c4b29364a98db702c7463ac21906d73a5ace7fd779fecc209187284bc666badd6a5fe70854ae4a8f3367bbf73b8b49d0ac9e9673248e5c86ec83a
-  data.tar.gz: c5563c43afef3637222dc69b82388bd5cb42fb44daa5494c83a79d5c053da778c1fa15dc85915a6eea0ef6e7b079a002c8b1e3a6b7a5be447c2e37be5f2e7f58
+  metadata.gz: 283fcdf5b95bcbf34a175b2e9249c5e2a5b4c16f46bedfe9852f088214ada0e6aa022d84f816a4c692b36291c9a3d8a0f099ee0f18beb15cf5c856d014ecdb14
+  data.tar.gz: a66f945ca3d16ee996aeec660dc24351baa3799e7b7404ce209202e98a3c10e6df7eac940c4bdea82e4b7ca86391c98ed3b718c174c0cfe5499485cfb14bd1b2

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.3.0] - 2026-07-16
+
+### Fixed
+
+- APM span collection now works when `config.apm_enabled` is set in a Rails
+  app initializer (the common case). The `sql.active_record` subscriber was
+  previously installed only if APM was already enabled during railtie
+  initialization, which runs before `config/initializers` — so transactions
+  shipped without spans and the time breakdown showed everything as
+  "App / other".
+
+### Added
+
+- In-app backtrace frames now include a source excerpt (`source: {start_line,
+  lines}`, ±6 lines around the failing line) so the errorgap UI can render
+  backtrace source without a repository integration.
+
+- View-rendering time is now recorded as a `view` span (from Rails'
+  `process_action.action_controller` `view_runtime`), populating the
+  "View rendering" segment of the route time breakdown.
+
+## [0.2.0] - 2026-07-10
+
+### Added
+
+- `config.ignore_environments` configuration option to skip all reporting
+  (error notices and APM transactions) in the listed environments, e.g.
+  `config.ignore_environments = %w[test development]`. Also configurable via
+  the `ERRORGAP_IGNORE_ENVIRONMENTS` environment variable (comma-separated).
+- `Errorgap::Configuration#ignored_environment?` helper.
+- The Rails install generator initializer now includes `ignore_environments`
+  with `test` and `development` ignored by default.
+
+## [0.1.0] - 2026-07-09
+
+### Added
+
+- Initial release: exception capture with normalized backtraces, manual
+  `Errorgap.notify`, Rack middleware, Rails Railtie and install generator.
+- APM performance monitoring (opt-in via `config.apm_enabled`) with request
+  timing and DB query spans, sampled by `config.apm_sample_rate`.
+- Authentication via the `X-Errorgap-Project-Key` header.
+
+[0.3.0]: https://github.com/errorgaphq/errorgap-ruby/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/errorgaphq/errorgap-ruby/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/errorgaphq/errorgap-ruby/releases/tag/v0.1.0

data/README.md

@@ -27,6 +27,10 @@ Errorgap.configure do |config|
   config.project_id = ENV["ERRORGAP_PROJECT_ID"]
   config.api_key = ENV["ERRORGAP_API_KEY"]
   config.environment = ENV.fetch("RAILS_ENV", ENV.fetch("RACK_ENV", "development"))
+
+  # Skip reporting entirely (errors and APM) in these environments.
+  # Also configurable via ERRORGAP_IGNORE_ENVIRONMENTS="test,development".
+  config.ignore_environments = %w[test development]
 end
 ```
 

data/lib/errorgap/configuration.rb

@@ -11,6 +11,7 @@ module Errorgap
                   :async,
                   :logger,
                   :filter_keys,
+                  :ignore_environments,
                   :apm_enabled,
                   :apm_sample_rate
 
@@ -23,6 +24,7 @@ module Errorgap
       @root_directory = Dir.pwd
       @async = true
       @filter_keys = %w[password password_confirmation token secret api_key authorization cookie]
+      @ignore_environments = ENV.fetch("ERRORGAP_IGNORE_ENVIRONMENTS", "").split(",").map(&:strip).reject(&:empty?)
       @apm_enabled = false
       @apm_sample_rate = 1.0
     end
@@ -33,6 +35,10 @@ module Errorgap
       true
     end
 
+    def ignored_environment?
+      Array(ignore_environments).map(&:to_s).include?(environment.to_s)
+    end
+
     private
 
     def blank?(value)

data/lib/errorgap/notice.rb

@@ -4,6 +4,13 @@ require "time"
 
 module Errorgap
   class Notice
+    # Lines of context shipped either side of the failing line for in-app
+    # frames, and a cap on how many frames include an excerpt so deep
+    # backtraces don't inflate the payload.
+    SOURCE_RADIUS = 6
+    MAX_SOURCE_FRAMES = 25
+    MAX_SOURCE_LINE_LENGTH = 400
+
     def self.from_exception(error, configuration:, context: {}, environment: {}, session: {}, params: {})
       new(
         error: error,
@@ -54,18 +61,47 @@ module Errorgap
     end
 
     def backtrace_frames
+      source_frames = 0
       Array(@error.backtrace).map.with_index do |line, index|
         file, line_number, function = parse_backtrace_line(line)
-        {
+        frame = {
           file: relative_file(file),
           line: line_number,
           function: function,
           in_app: in_app?(file),
           index: index
-        }.compact
+        }
+        if in_app?(file) && source_frames < MAX_SOURCE_FRAMES &&
+           (source = source_excerpt(file, line_number))
+          frame[:source] = source
+          source_frames += 1
+        end
+        frame.compact
       end
     end
 
+    # Reads the lines around the failing line so the server can show source
+    # without needing repository access. Returns nil when the file cannot be
+    # read (precompiled deploys, eval'd code, template paths).
+    def source_excerpt(file, line_number)
+      return nil unless line_number && line_number >= 1
+      return nil unless file && File.file?(file) && File.readable?(file)
+
+      lines = File.readlines(file)
+      return nil if lines.empty? || line_number > lines.length
+
+      start_line = [line_number - SOURCE_RADIUS, 1].max
+      end_line = [line_number + SOURCE_RADIUS, lines.length].min
+      {
+        start_line: start_line,
+        lines: lines[(start_line - 1)..(end_line - 1)].map do |text|
+          text.chomp[0, MAX_SOURCE_LINE_LENGTH]
+        end
+      }
+    rescue StandardError
+      nil
+    end
+
     def parse_backtrace_line(line)
       match = line.match(/\A(.+?):(\d+)(?::in `(.*)')?\z/)
       return [line, nil, nil] unless match

data/lib/errorgap/notifier.rb

@@ -22,6 +22,8 @@ module Errorgap
 
     def notify(error, context: {}, environment: {}, session: {}, params: {}, sync: false)
       @configuration.validate!
+      return Response.new(status: 202, body: "ignored environment") if @configuration.ignored_environment?
+
       notice = Notice.from_exception(
         error,
         configuration: @configuration,

data/lib/errorgap/rails/railtie.rb

@@ -18,7 +18,11 @@ module Errorgap
       end
 
       initializer "errorgap.install_span_collector" do
-        SpanCollector.install if Errorgap.configuration.apm_enabled
+        # Unconditional: apps enable APM in config/initializers, which runs
+        # after railtie initializers, so the flag cannot be checked here. The
+        # subscribers no-op unless the middleware starts a per-request
+        # collection, which does check the flag.
+        SpanCollector.install
       end
 
       generators do

data/lib/errorgap/span_collector.rb

@@ -14,9 +14,16 @@ module Errorgap
     SKIP_NAMES = %w[SCHEMA EXPLAIN CACHE].freeze
 
     class << self
-      # Call once at boot (from Railtie) when APM is enabled.
+      # Call once at boot (from Railtie). Subscribers only record while a
+      # transaction is being collected (the middleware starts one per request
+      # when APM is enabled), so installing unconditionally is safe — and
+      # required, since app initializers that enable APM run after railtie
+      # initializers.
       def install
         return unless defined?(ActiveSupport::Notifications)
+        return if @installed
+
+        @installed = true
 
         ActiveSupport::Notifications.subscribe("sql.active_record") do |*, payload|
           next unless Thread.current[THREAD_KEY]
@@ -28,6 +35,17 @@ module Errorgap
 
           store << Span.new(kind: "db", sql: sql, duration_ms: duration_ms.round(3))
         end
+
+        # Rails reports view_runtime with database time already subtracted, so
+        # this does not double count the db spans above.
+        ActiveSupport::Notifications.subscribe("process_action.action_controller") do |*, payload|
+          next unless Thread.current[THREAD_KEY]
+
+          view_ms = payload[:view_runtime]
+          next unless view_ms&.positive?
+
+          store << Span.new(kind: "view", duration_ms: view_ms.round(3))
+        end
       end
 
       def start

data/lib/errorgap/transacter.rb

@@ -15,6 +15,7 @@ module Errorgap
     end
 
     def deliver_async(transaction)
+      return if @configuration.ignored_environment?
       return unless should_sample?
 
       Thread.new { deliver(transaction) }

data/lib/errorgap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Errorgap
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/generators/errorgap/install_generator.rb

@@ -17,6 +17,9 @@ module Errorgap
           config.root_directory = Rails.root.to_s
           config.logger = Rails.logger
 
+          # Environments in which nothing is reported (errors or APM).
+          config.ignore_environments = %w[test development]
+
           # Enable APM performance monitoring (opt-in).
           # Records HTTP request timing and DB query spans via ActiveSupport::Notifications.
           # config.apm_enabled = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: errorgap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Errorgap
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-07-07 00:00:00.000000000 Z
+date: 2026-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
 description: Captures Ruby exceptions and sends them to a Errorgap server.
 email:
 - support@errorgap.com
@@ -46,6 +60,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - exe/errorgap
@@ -66,6 +81,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/errorgaphq/errorgap-ruby
   source_code_uri: https://github.com/errorgaphq/errorgap-ruby
+  changelog_uri: https://github.com/errorgaphq/errorgap-ruby/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: