logister-ruby 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd9ec67090820ac7b825afcbfd87a6a75f26033b0153daf8ee60b44a6d6fbbf3
-  data.tar.gz: 2175055728eb9dcc9bc9ed0acf4b3640f52900bcd35933fdd92db6ebbc1dfc3a
+  metadata.gz: '08b202068c5d0907d8c8d08b3490dfbc34af5863df48c2e7a491a9a4c18e5307'
+  data.tar.gz: ba465c7050af6b92e27a36ffd985b9eedbd667ab6be211dd9e1db457e501ff6d
 SHA512:
-  metadata.gz: cc1412c538be57e39a12e3f7c6939d1e710aa387490575ddf9af7df8ccda96cae3faafd9256348e18208ce63ebc0922f1696ae6b6d22aaeaf279c2b555960eee
-  data.tar.gz: 92276f407d774dc3010447cba8b5f0aea0c878ad8d30ba428b46585da3afbdf1dd9f0eb11b6cc62e89afa72e6433292eab19898551c5749a378d11a66aa9e646
+  metadata.gz: 55b1680278af20b4779519debd47e7f111348e5132323d07116a02cd7a26b27dd556094e479cdb871f1db64db74dc92b09fc7d52288c982048b9b084fa751b81
+  data.tar.gz: f05606399bc43607512dee0c332212f30f7d1d6352dd0c6ba3c6ce39f3fc91fb8fa61b107de1ae045736360dd026afe947cf3e3ef01fef49f353cc2d23e6e4bf

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## v0.2.4 - 2026-05-21
+
+- Enriched every Ruby error report with shared runtime, deployment, breadcrumb, and dependency context, including manual `Logister.report_error` calls.
+- Added structured nested exception cause data to Ruby error payloads.
+
+## v0.2.3 - 2026-04-22
+
+- Refined the Ruby and Rails client for Logister event delivery.
+- Added richer reporting support for logs, transactions, check-ins, ActiveJob failures, breadcrumbs, and dependency context.
+- Improved package metadata and docs linkage for the canonical Logister docs and self-hosted backend.
+- Documented the gem as the Ruby client for the Logister backend instead of only the hosted `logister.org` service.

data/README.md

@@ -1,6 +1,33 @@
 # logister-ruby
 
-`logister-ruby` sends application errors and custom metrics to `logister.org`.
+`logister-ruby` is the Ruby and Rails client for sending errors, logs, metrics, transactions, and check-ins to Logister.
+
+Install it from RubyGems as `logister-ruby`.
+
+## Table Of Contents
+
+- [What this gem is for](#what-this-gem-is-for)
+- [Self-hosted backend](#self-hosted-backend)
+- [Install From RubyGems](#install-from-rubygems)
+- [Configuration](#configuration)
+- [Reliability options](#reliability-options)
+- [Filtering and redaction](#filtering-and-redaction)
+- [Rails auto-reporting](#rails-auto-reporting)
+- [Database load metrics (ActiveRecord)](#database-load-metrics-activerecord)
+- [Breadcrumbs and dependencies](#breadcrumbs-and-dependencies)
+- [ActiveJob error context](#activejob-error-context)
+- [Manual reporting](#manual-reporting)
+- [Documentation](#documentation)
+- [Release](#release)
+
+## What this gem is for
+
+Use this gem when you want a Ruby or Rails app to send telemetry into the Logister backend.
+
+- Main Logister app: https://github.com/taimoorq/logister
+- Ruby integration docs: https://docs.logister.org/integrations/ruby/
+- Product docs: https://docs.logister.org/
+- RubyGems package: https://rubygems.org/gems/logister-ruby
 
 ## Self-hosted backend
 
@@ -8,12 +35,26 @@ Use the open source Logister app repository to self-host the ingestion UI/API ba
 
 - App source: https://github.com/taimoorq/logister
 
-## Install
+## Install From RubyGems
+
+With Bundler in a Rails or Ruby app:
 
 ```ruby
 gem "logister-ruby"
 ```
 
+Then install:
+
+```bash
+bundle install
+```
+
+Or install the gem directly from RubyGems:
+
+```bash
+gem install logister-ruby
+```
+
 Then generate an initializer in Rails:
 
 ```bash
@@ -47,6 +88,8 @@ Logister.configure do |config|
 end
 ```
 
+If you are using a self-hosted Logister install, point `config.endpoint` at your own Logister host instead of `logister.org`.
+
 ## Reliability options
 
 ```ruby
@@ -76,7 +119,8 @@ end
 ## Rails auto-reporting
 
 If Rails is present, the gem installs middleware that reports unhandled exceptions automatically.
-It also attaches richer context (trace IDs, route/response/performance info, breadcrumbs, dependency calls, and user metadata when available).
+It also attaches richer context such as trace IDs, route/response/performance info, breadcrumbs, dependency calls, and user metadata when available.
+Manual `Logister.report_error` calls use the same shared enrichment path, so Ruby apps get runtime, deployment, breadcrumb, dependency, user, and nested exception cause context even when an error is reported outside the Rails middleware.
 
 ## Database load metrics (ActiveRecord)
 
@@ -155,13 +199,23 @@ Logister.report_check_in(
 )
 ```
 
+## Documentation
+
+- Ruby integration docs: https://docs.logister.org/integrations/ruby/
+- Main Logister docs: https://docs.logister.org/
+- [Contributing](CONTRIBUTING.md)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [Security Policy](SECURITY.md)
+- [Pull Request Template](.github/PULL_REQUEST_TEMPLATE.md)
+
 ## Release
 
 Use Bundler's built-in release flow:
 
 ```bash
 # 1) bump version in lib/logister/version.rb
-# 2) commit changes
+# 2) update CHANGELOG.md
+# 3) commit changes
 bundle exec rake release
 ```
 

data/lib/logister/reporter.rb

@@ -3,6 +3,8 @@
 require 'digest'
 require 'time'
 require 'set'
+require_relative 'context_helpers'
+require_relative 'context_store'
 
 module Logister
   class Reporter
@@ -41,7 +43,7 @@ module Logister
       return false if ignored_exception?(exception)
       return false if ignored_path?(context)
 
-      merged_context = context.dup
+      merged_context = default_error_context.merge(context)
       user = current_user_context
       merged_context[:user] = user if user
 
@@ -51,11 +53,7 @@ module Logister
         message:     "#{exception.class}: #{exception.message}",
         fingerprint: fingerprint || default_fingerprint(exception),
         context:     merged_context.merge(
-          exception: {
-            class:     exception.class.to_s,
-            message:   exception.message.to_s,
-            backtrace: Array(exception.backtrace).first(50)
-          },
+          exception: exception_context(exception),
           tags: tags
         )
       )
@@ -185,6 +183,31 @@ module Logister
       Thread.current[:logister_user]
     end
 
+    def default_error_context
+      Logister::ContextHelpers.compact_deep(
+        {
+          breadcrumbs: Logister::ContextStore.breadcrumbs.presence,
+          dependencyCalls: Logister::ContextStore.dependencies.presence
+        }
+          .merge(Logister::ContextHelpers.runtime_context)
+          .merge(Logister::ContextHelpers.deployment_context)
+      )
+    rescue StandardError => e
+      @configuration.logger.warn("logister default error context failed: #{e.class} #{e.message}")
+      {}
+    end
+
+    def exception_context(exception, depth = 0)
+      return nil unless exception
+
+      {
+        class:     exception.class.to_s,
+        message:   exception.message.to_s,
+        backtrace: Array(exception.backtrace).first(50),
+        cause:     depth < 5 ? exception_context(exception.cause, depth + 1) : nil
+      }.compact
+    end
+
     def build_payload(event_type:, level:, message:, fingerprint:, context:)
       {
         event_type:  event_type,

data/lib/logister/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Logister
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 end

data/logister-ruby.gemspec

@@ -6,21 +6,25 @@ Gem::Specification.new do |spec|
   spec.authors = ['Logister']
   spec.email = ['support@logister.org']
 
-  spec.summary = 'Send Rails errors and metrics to logister.org'
-  spec.description = 'Client gem for reporting errors and custom metrics from Ruby and Rails apps to logister.org'
+  spec.summary = 'Ruby and Rails client for sending events to Logister'
+  spec.description = 'Ruby and Rails client for reporting errors, logs, metrics, transactions, and check-ins to the Logister backend, including self-hosted installs.'
   spec.homepage = 'https://github.com/taimoorq/logister-ruby'
   spec.license = 'MIT'
   spec.required_ruby_version = '>= 3.1.0'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/taimoorq/logister-ruby'
+  spec.metadata['documentation_uri'] = 'https://docs.logister.org/integrations/ruby/'
+  spec.metadata['changelog_uri'] = 'https://github.com/taimoorq/logister-ruby/blob/main/CHANGELOG.md'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/taimoorq/logister-ruby/issues'
 
   spec.files = Dir.chdir(__dir__) do
-    Dir.glob('lib/**/*') + ['README.md', 'LICENSE', 'logister-ruby.gemspec']
+    Dir.glob('lib/**/*') + ['README.md', 'CHANGELOG.md', 'LICENSE', 'logister-ruby.gemspec']
   end
 
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '>= 6.1'
+  spec.add_development_dependency 'actionpack', '>= 6.1'
   spec.add_development_dependency 'rake', '>= 13.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logister-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Logister
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -37,14 +51,15 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '13.0'
-description: Client gem for reporting errors and custom metrics from Ruby and Rails
-  apps to logister.org
+description: Ruby and Rails client for reporting errors, logs, metrics, transactions,
+  and check-ins to the Logister backend, including self-hosted installs.
 email:
 - support@logister.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - lib/generators/logister/install_generator.rb
@@ -69,6 +84,9 @@ licenses:
 metadata:
   homepage_uri: https://github.com/taimoorq/logister-ruby
   source_code_uri: https://github.com/taimoorq/logister-ruby
+  documentation_uri: https://docs.logister.org/integrations/ruby/
+  changelog_uri: https://github.com/taimoorq/logister-ruby/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/taimoorq/logister-ruby/issues
 rdoc_options: []
 require_paths:
 - lib
@@ -83,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
-summary: Send Rails errors and metrics to logister.org
+summary: Ruby and Rails client for sending events to Logister
 test_files: []