logister-ruby 0.2.4 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08b202068c5d0907d8c8d08b3490dfbc34af5863df48c2e7a491a9a4c18e5307'
-  data.tar.gz: ba465c7050af6b92e27a36ffd985b9eedbd667ab6be211dd9e1db457e501ff6d
+  metadata.gz: bbdcfea4a9984f610510aa30780b8d94a54059bf329c387e5b47997f805ecafb
+  data.tar.gz: 242e70a27ab5bcebcc11b1c99ce6f3acf7164a5a0ad5e482afd107bfa4fb705f
 SHA512:
-  metadata.gz: 55b1680278af20b4779519debd47e7f111348e5132323d07116a02cd7a26b27dd556094e479cdb871f1db64db74dc92b09fc7d52288c982048b9b084fa751b81
-  data.tar.gz: f05606399bc43607512dee0c332212f30f7d1d6352dd0c6ba3c6ce39f3fc91fb8fa61b107de1ae045736360dd026afe947cf3e3ef01fef49f353cc2d23e6e4bf
+  metadata.gz: 58f9a2d891eec80c14c18a40ced354cdd3b19c98e88b583d709943c3b2aeab73d5af208d050566cf1ef9fc023f547972180f381a4648d585c5cd841622d145d3
+  data.tar.gz: 8175e3a5b27a40ced8c9844acd56ff460e0c9655bd514e14feb94ee9edec02cbdb1b6021ef9deb6411a3fb837891c935d812d032707124c5f32147ed52ca3083

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## v0.2.7 - 2026-05-22
+
+- Added `Logister.report_span` and opt-in Rails request span capture for request load waterfall charts.
+
+## v0.2.6 - 2026-05-22
+
+- Added README guidance for using Ruby reports with the Logister project Insights beta, including practical metric, transaction, log, check-in, and custom attribute examples.
+- Added a tag-based release workflow that publishes the gem to RubyGems with trusted publishing and then creates or updates the matching GitHub release.
+
+## v0.2.5 - 2026-05-21
+
+- Added metric value/unit options to `Logister.report_metric` while keeping the existing context/tags API.
+- Added per-check-in environment, release, occurred-at, trace ID, and request ID options to `Logister.report_check_in`.
+
 ## 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.

data/README.md

@@ -1,12 +1,13 @@
 # logister-ruby
 
-`logister-ruby` is the Ruby and Rails client for sending errors, logs, metrics, transactions, and check-ins to Logister.
+`logister-ruby` is the Ruby and Rails client for sending errors, logs, metrics, transactions, spans, 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)
+- [Package Links](#package-links)
 - [Self-hosted backend](#self-hosted-backend)
 - [Install From RubyGems](#install-from-rubygems)
 - [Configuration](#configuration)
@@ -17,6 +18,7 @@ Install it from RubyGems as `logister-ruby`.
 - [Breadcrumbs and dependencies](#breadcrumbs-and-dependencies)
 - [ActiveJob error context](#activejob-error-context)
 - [Manual reporting](#manual-reporting)
+- [Using project Insights beta](#using-project-insights-beta)
 - [Documentation](#documentation)
 - [Release](#release)
 
@@ -29,6 +31,13 @@ Use this gem when you want a Ruby or Rails app to send telemetry into the Logist
 - Product docs: https://docs.logister.org/
 - RubyGems package: https://rubygems.org/gems/logister-ruby
 
+## Package Links
+
+- RubyGems package: https://rubygems.org/gems/logister-ruby
+- GitHub releases: https://github.com/taimoorq/logister-ruby/releases
+- Source repository: https://github.com/taimoorq/logister-ruby
+- Integration docs: https://docs.logister.org/integrations/ruby/
+
 ## Self-hosted backend
 
 Use the open source Logister app repository to self-host the ingestion UI/API backend:
@@ -77,6 +86,7 @@ Logister.configure do |config|
   config.max_dependencies = 20
   config.capture_sql_breadcrumbs = true
   config.sql_breadcrumb_min_duration_ms = 25.0
+  config.capture_request_spans = true
 
   config.feature_flags_resolver = lambda do |request:, user:, **|
     { new_checkout: user&.respond_to?(:beta?) && user.beta? }
@@ -120,6 +130,7 @@ end
 
 If Rails is present, the gem installs middleware that reports unhandled exceptions automatically.
 It also attaches richer context such as trace IDs, route/response/performance info, breadcrumbs, dependency calls, and user metadata when available.
+Set `config.capture_request_spans = true` to emit root `server` spans for request load waterfall charts while keeping existing transaction events.
 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)
@@ -174,6 +185,8 @@ Logister.report_error(StandardError.new("Something failed"), tags: { area: "chec
 
 Logister.report_metric(
   message: "checkout.completed",
+  value: 1,
+  unit: "count",
   level: "info",
   context: { duration_ms: 123 },
   tags: { region: "us-east-1" }
@@ -186,6 +199,16 @@ Logister.report_transaction(
   context: { trace_id: "trace-123", request_id: "req-123" }
 )
 
+Logister.report_span(
+  name: "render checkout",
+  duration_ms: 82.1,
+  trace_id: "trace-123",
+  parent_span_id: "span-root",
+  kind: "render",
+  status: "ok",
+  context: { route: "POST /checkout" }
+)
+
 Logister.report_log(
   message: "payment provider timeout",
   level: "warn",
@@ -195,13 +218,85 @@ Logister.report_log(
 Logister.report_check_in(
   slug: "nightly-reconcile",
   status: "ok",
-  expected_interval_seconds: 900
+  expected_interval_seconds: 900,
+  duration_ms: 248.3,
+  trace_id: "trace-123",
+  request_id: "req-123"
 )
 ```
 
+## Using project Insights beta
+
+The Logister project Insights tab combines Inbox, Activity, and Performance signals into live dashboard views. Ruby apps get the most useful Insights experience when every event carries stable deployment context plus a few low-cardinality custom attributes.
+
+Use `config.environment`, `config.release`, and top-level scalar `context` values for the dimensions you want to filter by:
+
+```ruby
+Logister.configure do |config|
+  config.environment = Rails.env
+  config.release = ENV["RELEASE_SHA"]
+  config.service = "billing-web"
+end
+
+Logister.report_metric(
+  message: "queue.depth",
+  value: Sidekiq::Queue.new("billing").size,
+  unit: "jobs",
+  context: {
+    service: "billing-worker",
+    queue: "billing",
+    region: "us-east-1",
+    tenant_tier: "enterprise"
+  }
+)
+
+Logister.report_transaction(
+  name: "POST /checkout",
+  duration_ms: 184.7,
+  status: 200,
+  context: {
+    service: "billing-web",
+    route: "POST /checkout",
+    feature_flag: "new_checkout",
+    tenant_tier: "enterprise"
+  }
+)
+
+Logister.report_log(
+  message: "payment provider retry",
+  level: "warn",
+  context: {
+    service: "billing-worker",
+    provider: "stripe",
+    queue: "billing"
+  }
+)
+
+Logister.report_check_in(
+  slug: "nightly-reconcile",
+  status: "ok",
+  expected_interval_seconds: 3600,
+  duration_ms: 842.7,
+  context: {
+    service: "billing-worker",
+    queue: "reconcile"
+  }
+)
+```
+
+Practical Insights recipes:
+
+- Release validation: send `release`, then filter the Insights tab to the new release and compare errors, transaction P95, database query timing, and custom metrics.
+- Queue monitoring: report metrics such as `queue.depth`, `queue.latency`, and `jobs.retry_count` with a stable `queue` context key.
+- Performance triage: send transaction events with `route`, `service`, and `tenant_tier` so slow routes can be filtered beside errors and logs.
+- Instrumentation audit: open Insights after deploy and confirm errors, logs, metrics, transactions, spans, and check-ins all appear in the recent stream.
+
+Keep dashboard dimensions stable and low-cardinality. Good custom attribute keys include `service`, `region`, `queue`, `route`, `tenant_tier`, `provider`, and `feature_flag`. Avoid raw IDs, emails, request bodies, SQL text, and per-user values as top-level Insights dimensions.
+
 ## Documentation
 
 - Ruby integration docs: https://docs.logister.org/integrations/ruby/
+- Insights beta guide: https://docs.logister.org/product/#insights-beta
 - Main Logister docs: https://docs.logister.org/
 - [Contributing](CONTRIBUTING.md)
 - [Code of Conduct](CODE_OF_CONDUCT.md)
@@ -210,13 +305,28 @@ Logister.report_check_in(
 
 ## Release
 
-Use Bundler's built-in release flow:
+This repo runs CI on commits and pull requests. Version tags run the release workflow so RubyGems and GitHub Releases stay aligned:
 
 ```bash
 # 1) bump version in lib/logister/version.rb
 # 2) update CHANGELOG.md
 # 3) commit changes
-bundle exec rake release
+# 4) push a matching tag, for example:
+git tag -a v0.2.7 -m "Release logister-ruby v0.2.7"
+git push origin main v0.2.7
 ```
 
-`rake release` will build the gem, create a git tag, push commits/tags, and push to RubyGems.
+The `.github/workflows/release.yml` workflow verifies the tag matches `Logister::VERSION`, runs tests, builds the gem, publishes to RubyGems with trusted publishing, and then creates or updates the matching GitHub release from `CHANGELOG.md`.
+
+Before tag releases can publish the gem, configure a RubyGems trusted publisher for:
+
+- GitHub owner: `taimoorq`
+- Repository: `logister-ruby`
+- Workflow file: `.github/workflows/release.yml`
+- Environment: leave blank unless you also add a GitHub release environment to the workflow
+
+Manual publishing is still possible with Bundler's built-in release flow when needed:
+
+```bash
+bundle exec rake release
+```

data/lib/logister/configuration.rb

@@ -7,7 +7,7 @@ module Logister
                   :async, :queue_size, :max_retries, :retry_base_interval,
                   :capture_db_metrics, :db_metric_min_duration_ms, :db_metric_sample_rate,
                   :feature_flags_resolver, :dependency_resolver, :anonymize_ip,
-                  :max_breadcrumbs, :max_dependencies,
+                  :max_breadcrumbs, :max_dependencies, :capture_request_spans,
                   :capture_sql_breadcrumbs, :sql_breadcrumb_min_duration_ms
 
     def initialize
@@ -40,6 +40,7 @@ module Logister
       @anonymize_ip = false
       @max_breadcrumbs = 40
       @max_dependencies = 20
+      @capture_request_spans = false
       @capture_sql_breadcrumbs = true
       @sql_breadcrumb_min_duration_ms = 25.0
     end

data/lib/logister/railtie.rb

@@ -30,6 +30,7 @@ module Logister
         copy_setting(app, config, :anonymize_ip)
         copy_setting(app, config, :max_breadcrumbs)
         copy_setting(app, config, :max_dependencies)
+        copy_setting(app, config, :capture_request_spans)
         copy_setting(app, config, :capture_sql_breadcrumbs)
         copy_setting(app, config, :sql_breadcrumb_min_duration_ms)
       end

data/lib/logister/reporter.rb

@@ -3,6 +3,7 @@
 require 'digest'
 require 'time'
 require 'set'
+require 'securerandom'
 require_relative 'context_helpers'
 require_relative 'context_store'
 
@@ -64,16 +65,29 @@ module Logister
       @client.publish(payload)
     end
 
-    def report_metric(message:, level: 'info', context: {}, tags: {}, fingerprint: nil)
+    def report_metric(message:, value: nil, unit: nil, level: 'info', context: {}, tags: {}, fingerprint: nil)
       return false if ignored_environment?
       return false if ignored_path?(context)
 
+      metric_context = context.merge(tags: tags)
+      if value
+        metric_context = metric_context.merge(
+          metric: {
+            name: message,
+            value: value,
+            unit: unit
+          }.compact,
+          value: value,
+          unit: unit
+        ).compact
+      end
+
       payload = build_payload(
         event_type:  'metric',
         level:       level,
         message:     message,
         fingerprint: fingerprint || metric_fingerprint(message),
-        context:     context.merge(tags: tags)
+        context:     metric_context
       )
 
       payload = apply_before_notify(payload)
@@ -105,6 +119,65 @@ module Logister
       @client.publish(payload)
     end
 
+    def report_span(
+      name:,
+      duration_ms:,
+      trace_id: nil,
+      request_id: nil,
+      span_id: nil,
+      parent_span_id: nil,
+      kind: 'internal',
+      status: nil,
+      started_at: nil,
+      ended_at: nil,
+      context: {},
+      tags: {},
+      fingerprint: nil
+    )
+      return false if ignored_environment?
+      return false if ignored_path?(context)
+
+      started_at ||= Time.now.utc - (duration_ms.to_f / 1000.0)
+      span_id ||= SecureRandom.hex(8)
+      trace_id ||= span_id
+
+      payload = build_payload(
+        event_type: 'span',
+        level: status.to_s == 'error' ? 'error' : 'info',
+        message: name,
+        fingerprint: fingerprint || metric_fingerprint("span:#{kind}:#{name}"),
+        context: context.merge(
+          name: name,
+          trace_id: trace_id,
+          request_id: request_id,
+          span_id: span_id,
+          parent_span_id: parent_span_id,
+          span_kind: kind,
+          kind: kind,
+          status: status,
+          duration_ms: duration_ms,
+          started_at: normalize_timestamp(started_at),
+          ended_at: ended_at && normalize_timestamp(ended_at),
+          tags: tags
+        ).compact
+      )
+
+      payload[:started_at] = normalize_timestamp(started_at)
+      payload[:ended_at] = normalize_timestamp(ended_at) if ended_at
+      payload[:duration_ms] = duration_ms
+      payload[:trace_id] = trace_id
+      payload[:request_id] = request_id if request_id
+      payload[:span_id] = span_id
+      payload[:parent_span_id] = parent_span_id if parent_span_id
+      payload[:kind] = kind
+      payload[:status] = status if status
+
+      payload = apply_before_notify(payload)
+      return false unless payload
+
+      @client.publish(payload)
+    end
+
     def report_log(message:, level: 'info', context: {}, tags: {}, fingerprint: nil)
       return false if ignored_environment?
       return false if ignored_path?(context)
@@ -123,7 +196,19 @@ module Logister
       @client.publish(payload)
     end
 
-    def report_check_in(slug:, status: 'ok', expected_interval_seconds: 300, duration_ms: nil, context: {}, level: nil)
+    def report_check_in(
+      slug:,
+      status: 'ok',
+      expected_interval_seconds: 300,
+      duration_ms: nil,
+      context: {},
+      level: nil,
+      environment: nil,
+      release: nil,
+      occurred_at: nil,
+      trace_id: nil,
+      request_id: nil
+    )
       return false if ignored_environment?
 
       payload = build_payload(
@@ -135,9 +220,14 @@ module Logister
           check_in_slug: slug,
           check_in_status: status,
           expected_interval_seconds: expected_interval_seconds,
-          duration_ms: duration_ms
+          duration_ms: duration_ms,
+          environment: environment,
+          release: release,
+          trace_id: trace_id,
+          request_id: request_id
         ).compact
       )
+      payload[:occurred_at] = normalize_timestamp(occurred_at) if occurred_at
 
       payload = apply_before_notify(payload)
       return false unless payload
@@ -222,6 +312,10 @@ module Logister
       }
     end
 
+    def normalize_timestamp(timestamp)
+      timestamp.respond_to?(:utc) ? timestamp.utc.iso8601 : timestamp.to_s
+    end
+
     def apply_before_notify(payload)
       hook = @configuration.before_notify
       return payload unless hook.respond_to?(:call)

data/lib/logister/request_subscriber.rb

@@ -53,10 +53,41 @@ module Logister
             viewRuntimeMs: numeric(payload[:view_runtime])
           }.compact
         )
+
+        report_request_span(payload, request_id) if capture_request_spans?
       rescue StandardError => e
         logger.warn("logister request subscriber (process_action) failed: #{e.class} #{e.message}")
       end
 
+      def report_request_span(payload, request_id)
+        duration_ms = numeric(payload[:duration])
+        return unless duration_ms&.positive?
+
+        route = "#{payload[:controller]}##{payload[:action]}"
+        started_at = Time.now.utc - (duration_ms / 1000.0)
+
+        Logister.report_span(
+          name: route,
+          kind: "server",
+          status: payload[:status].to_i >= 500 ? "error" : "ok",
+          trace_id: request_id,
+          request_id: request_id,
+          duration_ms: duration_ms,
+          started_at: started_at,
+          context: {
+            route: route,
+            request_id: request_id,
+            method: payload[:method],
+            path: payload[:path],
+            status: payload[:status],
+            timing_breakdown: {
+              db: numeric(payload[:db_runtime]),
+              render: numeric(payload[:view_runtime])
+            }.compact
+          }
+        )
+      end
+
       def handle_sql_breadcrumb(started, finished, payload)
         config = configuration
         return unless config&.capture_sql_breadcrumbs
@@ -94,6 +125,12 @@ module Logister
         nil
       end
 
+      def capture_request_spans?
+        configuration&.capture_request_spans
+      rescue StandardError
+        false
+      end
+
       def logger
         configuration&.logger || Logger.new($stdout)
       rescue StandardError

data/lib/logister/version.rb

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

data/lib/logister.rb

@@ -35,6 +35,10 @@ module Logister
       reporter.report_transaction(**kwargs)
     end
 
+    def report_span(**kwargs)
+      reporter.report_span(**kwargs)
+    end
+
     def report_log(**kwargs)
       reporter.report_log(**kwargs)
     end

data/logister-ruby.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.email = ['support@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.description = 'Ruby and Rails client for reporting errors, logs, metrics, transactions, spans, 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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logister-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.7
 platform: ruby
 authors:
 - Logister
@@ -52,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 description: Ruby and Rails client for reporting errors, logs, metrics, transactions,
-  and check-ins to the Logister backend, including self-hosted installs.
+  spans, and check-ins to the Logister backend, including self-hosted installs.
 email:
 - support@logister.org
 executables: []