vigilant-ruby 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f5caf9f04f2b348390785adcecf394cdc4580b753e6811bf18f9750f2c0dffd
-  data.tar.gz: fc84b996a2a961bcb614de7e4fb38edd35773960f159f400e8950278175cb3cf
+  metadata.gz: a0280598c4039160580005f39571754a95907101b616c6d3c8354da14eefb5de
+  data.tar.gz: 9ddebfc7149b3950006c8b45c0471955b00af3f99b2b88ffbf8754ed20d2187f
 SHA512:
-  metadata.gz: 2faaac39af894099aebf8b00679607eb535e6b4331d4f8da16239b463415c2a985e850f24fad682793549ddcb56a2574836de24d31f26633be7fe45faf7db2d7
-  data.tar.gz: 4d5844559329553a0e334c1dc5d7238a130e75c7c016ae162859303b0268052a212a9361c4588eaef251556b75b30f3cd6ece2e3d336198ae1a40682c5d91c70
+  metadata.gz: 7d97948a8d9aef93514e6caa314caa4a502a721d21bc55dbe6fabcc1a98845718b6285da5ecf967a5e4554bb8157dc6d999613399e730f96103a4a254ae336a6
+  data.tar.gz: c47a61a034ee4271c7de661a765ca50fddf632c56b62a29bd8225127230fe04b4c3a5f788be0b1fd13d248e405f57e16e272f0705d66ae0161d6eeeb6ddbd80b

data/README.md

@@ -1,3 +1,57 @@
 # Vigilant Ruby SDK
 
-This is the Ruby SDK for Vigilant (https://vigilant.run).
+This is the Ruby SDK for Vigilant (https://vigilant.run).
+
+## Installation
+
+```bash
+gem install vigilant-ruby
+```
+
+## Logging Usage (Standard)
+
+```ruby
+require 'vigilant-ruby'
+
+# Initialize the logger
+logger = Vigilant::Logger.new(
+  endpoint: "ingress.vigilant.run",
+  token: "tk_0000000000000000",
+)
+
+# Basic logging
+logger.info('User logged in')
+logger.warn('Rate limit approaching')
+logger.error('Database connection failed')
+logger.debug('Processing request')
+
+# Logging with attributes
+logger.info('User logged in', { user_id: 123, ip_address: '192.168.1.1' })
+
+# Shutdown the logger
+logger.shutdown
+```
+
+## Logging Usage (Autocapture)
+
+```ruby
+require 'vigilant-ruby'
+
+# Initialize the logger
+logger = Vigilant::Logger.new(
+  endpoint: "ingress.vigilant.run",
+  token: "tk_0000000000000000",
+)
+
+# Enable autocapture
+logger.autocapture_enable
+
+# Log with autocapture
+puts "A print statement"
+
+# Log without autocapture
+logger.info("A regular log")
+
+# Shutdown the logger
+logger.shutdown
+```

data/lib/vigilant-ruby/logger.rb

@@ -92,7 +92,7 @@ module Vigilant
 
     # Shuts down the logger, flushing any pending logs.
     def shutdown
-      flush_if_needed(true)
+      flush_if_needed(force: true)
       @mutex.synchronize { @shutdown = true }
       @dispatcher_thread&.join
     end
@@ -123,7 +123,7 @@ module Vigilant
           flush_if_needed
           sleep @flush_interval
         end
-        flush_if_needed(true)
+        flush_if_needed(force: true)
       end
     end
 

data/lib/vigilant-ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vigilant
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vigilant-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Vigilant