logister-ruby 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08b202068c5d0907d8c8d08b3490dfbc34af5863df48c2e7a491a9a4c18e5307'
-  data.tar.gz: ba465c7050af6b92e27a36ffd985b9eedbd667ab6be211dd9e1db457e501ff6d
+  metadata.gz: 63dccd6fdb12e5417bcca918c033a19e421087e188eac57f994939aa2eb4732f
+  data.tar.gz: 825d77d1304622efc28380e3e26167df40b411be97aa23219cce9d7f89944e6c
 SHA512:
-  metadata.gz: 55b1680278af20b4779519debd47e7f111348e5132323d07116a02cd7a26b27dd556094e479cdb871f1db64db74dc92b09fc7d52288c982048b9b084fa751b81
-  data.tar.gz: f05606399bc43607512dee0c332212f30f7d1d6352dd0c6ba3c6ce39f3fc91fb8fa61b107de1ae045736360dd026afe947cf3e3ef01fef49f353cc2d23e6e4bf
+  metadata.gz: 663bc90bcba5cfd300d1875536350131a5c1c2c540269168f910b648aa9a93ef98a301579389900cec0cbf135471c6078261a9a045b7be14b23987c9eef477c2
+  data.tar.gz: e0f8d74a0eff0434b7884ba945ffe96f752724c18cc3bc9b332651c02cde83e8e36a9f619e1dfe356116c6c63ef154bb79c667188cd23cf74f62b28e7d5a8361

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 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

@@ -17,6 +17,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)
 
@@ -174,6 +175,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" }
@@ -195,13 +198,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, 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 +285,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.6 -m "Release logister-ruby v0.2.6"
+git push origin main v0.2.6
 ```
 
-`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/reporter.rb

@@ -64,16 +64,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)
@@ -123,7 +136,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 +160,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 +252,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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logister-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - Logister