logbrew-sdk 0.1.15 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f1a43a336fe87e460238a865dd71006b99975d8dda5eea4556d3b7857ce7b8e
-  data.tar.gz: 6900c3207bebf800d0c41f9fb6784af6a5051f6afa2a6bf586f8ff5c9eef49f4
+  metadata.gz: 25c59f04169b6fce06afa15c04f790fd7b0d3d8643b50c880ca2d451e71168b2
+  data.tar.gz: dec9fb58c8ba57ad3745227d5858a400947a41e62c2fea3ce66d9d9096495372
 SHA512:
-  metadata.gz: b8249769684d6d9ed2177867a5cde11f1f7ca977218c9d4b2d2d43704d54e0c38e0d0d1307f271f72003db5d2e8cb3c55094c34fcb4f940f10794ab92346a069
-  data.tar.gz: 972b7ed436cdedf8c29fec9bf75d2a2c0c73cddc5e1d3dbacbf88b7e7c9a9ffc8e6b253b93a975a60d9bca8052c0833bc3adac007ca4a09c0a5aa8a321256198
+  metadata.gz: 251d55bf921e65cd161648547aa60a9ac6242aee7659b48ef674d87e42bda61d6dea4234b7e164f2a7d996dd9af92b32cc54315bde1b5edc37a765a68bc00b36
+  data.tar.gz: 3a66a2414a69c0f85a80050f772137b85482d2212a926f5d78b6a67edab7f73394473c27b1a1ceffa54c0eea59be98d7c47048ca1a1c25739b60d9526b9e0ee1

data/README.md

@@ -23,7 +23,7 @@ needed:
 
 ```ruby
 # Gemfile
-gem "logbrew-sdk", "~> 0.1.15"
+gem "logbrew-sdk", "~> 0.1.17"
 ```
 
 ```bash
@@ -91,7 +91,7 @@ The explicit Rails capture settings are:
 | `LOGBREW_RELEASE` | unset | Optional release identifier |
 | `LOGBREW_ENDPOINT` | `https://api.logbrew.co/v1/events` | HTTPS intake URL; loopback HTTP is accepted for local development |
 | `LOGBREW_REQUEST_TIMEOUT_MS` | `10000` | Per-request delivery timeout from 1 to 600000 ms |
-| `LOGBREW_FLUSH_INTERVAL_MS` | `5000` | Automatic delivery interval from 10 to 3600000 ms |
+| `LOGBREW_FLUSH_INTERVAL_MS` | `1000` | Automatic delivery interval after the first queued event, from 10 to 3600000 ms |
 | `LOGBREW_FLUSH_THRESHOLD` | `100` | Queue size from 1 to 1000 that requests an earlier flush |
 | `LOGBREW_CAPTURE_EXCEPTION_MESSAGES` | `false` | Opt in to exception message capture |
 | `LOGBREW_CAPTURE_RAILS_LOGS` | `false` | Opt in to bounded application-origin logs on active request and job traces |
@@ -145,6 +145,24 @@ rm -f "$HOME/.logbrew/rails-service.ingest"
 unset LOGBREW_PROJECT_ID
 ```
 
+## Read Events Back
+
+A successful send shows that LogBrew accepted the request. It does not show
+that you can read the event. After your app sends one event, read it
+back with a project read key:
+
+```bash
+logbrew projects keys create "<project_id>" --kind read \
+  --ingest-key-file "$HOME/.logbrew/setup-check.read" --json
+export LOGBREW_TOKEN="$(< "$HOME/.logbrew/setup-check.read")"
+logbrew read logs --since 1h --json
+logbrew issues --since 1h --json
+```
+
+A read key reads 1 project and cannot send telemetry. Run `unset LOGBREW_TOKEN`
+when you finish. [Read your events back](https://docs.logbrew.co/guides/verify-setup)
+covers key kinds, empty results, and how to revoke the key.
+
 ## Usage
 
 ```ruby
@@ -692,7 +710,7 @@ client = LogBrew::Client.create_automatic(
   sdk_name: "checkout-worker",
   sdk_version: "1.0.0",
   transport: transport,
-  flush_interval: 5,
+  flush_interval: 1,
   flush_threshold: 100,
   retry_base_delay: 0.25,
   retry_max_delay: 30,
@@ -704,7 +722,7 @@ warn JSON.generate(client.delivery_health.to_h)
 client.shutdown
 ```
 
-The worker starts only after accepted queue work exists, then wakes when the queue reaches `flush_threshold` or `flush_interval` expires. Restart-hydrated persistent work wakes it immediately. Automatic and manual sends share the existing serialized flush, immutable failed prefix, accepted-prefix acknowledgement, batch bounds, and persistence format; no second queue or transport path is created.
+The worker starts only after accepted queue work exists, then wakes when the queue reaches `flush_threshold` or `flush_interval` expires. The defaults are 1 second and 100 events, so a single event is readable in about a second while bursts still share one request. Restart-hydrated persistent work wakes it immediately. Automatic and manual sends share the existing serialized flush, immutable failed prefix, accepted-prefix acknowledgement, batch bounds, and persistence format; no second queue or transport path is created.
 
 Retryable network, `408`, and `5xx` failures retain the exact failed body and use capped equal-jitter backoff. Authentication (`401`/`403`), quota (`429`), validation (`400`/`422`), and other non-retryable responses pause automatic sends without dropping queued work. `recover_automatic_delivery` performs one explicit synchronous flush through the owned transport and resumes scheduling only after success. Calling `flush(transport)` directly provides the same explicit recovery boundary. `stop_automatic_delivery` joins the worker without draining or discarding work; a later manual flush remains available.
 

data/lib/logbrew/rails_integration.rb

@@ -12,7 +12,7 @@ module LogBrew
     class Configuration
       DEFAULT_ENDPOINT = LogBrew::HttpTransport::DEFAULT_ENDPOINT
       DEFAULT_REQUEST_TIMEOUT_MS = 10_000
-      DEFAULT_FLUSH_INTERVAL_MS = 5_000
+      DEFAULT_FLUSH_INTERVAL_MS = 1_000
       DEFAULT_FLUSH_THRESHOLD = 100
       MAX_LABEL_BYTES = 255
       MAX_ENDPOINT_BYTES = 2_048

data/lib/logbrew/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LogBrew
-  VERSION = "0.1.15"
+  VERSION = "0.1.17"
 end

data/lib/logbrew.rb

@@ -832,7 +832,7 @@ module LogBrew
   end
 
   class Client
-    DEFAULT_AUTOMATIC_FLUSH_INTERVAL = 5.0
+    DEFAULT_AUTOMATIC_FLUSH_INTERVAL = 1.0
     DEFAULT_AUTOMATIC_FLUSH_THRESHOLD = 100
     DEFAULT_AUTOMATIC_RETRY_BASE_DELAY = 0.25
     DEFAULT_AUTOMATIC_RETRY_MAX_DELAY = 30.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logbrew-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.17
 platform: ruby
 authors:
 - LogBrew
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-14 00:00:00.000000000 Z
+date: 2026-10-26 00:00:00.000000000 Z
 dependencies: []
 description: Public LogBrew Ruby SDK with typed issue diagnostics, automatic Rails
   request/error capture, and standard-library delivery.