vigilant-ruby 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f5caf9f04f2b348390785adcecf394cdc4580b753e6811bf18f9750f2c0dffd
-  data.tar.gz: fc84b996a2a961bcb614de7e4fb38edd35773960f159f400e8950278175cb3cf
+  metadata.gz: 6f7f1ed256105eb26d3eca1221963c0cb0db06d2fab56630059fc3fc7d064e34
+  data.tar.gz: ff68b2953e375a0e9e741914aca017b614b689870ba4e728e8d153d496c8e38f
 SHA512:
-  metadata.gz: 2faaac39af894099aebf8b00679607eb535e6b4331d4f8da16239b463415c2a985e850f24fad682793549ddcb56a2574836de24d31f26633be7fe45faf7db2d7
-  data.tar.gz: 4d5844559329553a0e334c1dc5d7238a130e75c7c016ae162859303b0268052a212a9361c4588eaef251556b75b30f3cd6ece2e3d336198ae1a40682c5d91c70
+  metadata.gz: 931ce0b4a70c782502d0771cf967517d8cc58556f2a69b0fc9a65195f7065f22df5cbcdf538fd5f568a24f2f2625b5fd3bac75f2a181585ceec8f06ee037c4f2
+  data.tar.gz: f7bf06387f135895cc032b9af406bf5ef2b19d3fc41796d8a2ddbb563fa4f55cfcc570faa489f55c524c7a20e1807919b0c11e60feef4431d502a061b2f279ce

data/README.md

@@ -1,3 +1,59 @@
 # 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(
+  name: 'test-app',
+  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(
+  name: 'test-app',
+  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

@@ -18,11 +18,13 @@ module Vigilant
   class Logger
     # Initialize a Vigilant::Logger instance.
     #
+    # @param name [String] The name of the application.
     # @param endpoint [String] The base endpoint for the Vigilant API (e.g. "ingress.vigilant.run").
     # @param token [String] The authentication token for the Vigilant API.
     # @param insecure [Boolean] Whether to use HTTP instead of HTTPS (optional, defaults to false).
     # @param passthrough [Boolean] Whether to also print logs to stdout/stderr (optional, defaults to true).
-    def initialize(endpoint:, token:, insecure: false, passthrough: true)
+    def initialize(endpoint:, token:, name: 'test-app', insecure: false, passthrough: true)
+      @name = name
       @token = token
 
       protocol = insecure ? 'http://' : 'https://'
@@ -92,7 +94,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
@@ -106,7 +108,7 @@ module Vigilant
         timestamp: Time.now.utc.strftime('%Y-%m-%dT%H:%M:%S.%9NZ'),
         body: body.to_s,
         level: level.to_s,
-        attributes: attributes.transform_values(&:to_s)
+        attributes: internal_attributes.merge(attributes.transform_values(&:to_s))
       }
 
       @queue << log_msg
@@ -123,7 +125,7 @@ module Vigilant
           flush_if_needed
           sleep @flush_interval
         end
-        flush_if_needed(true)
+        flush_if_needed(force: true)
       end
     end
 
@@ -165,6 +167,10 @@ module Vigilant
 
       http.request(request)
     end
+
+    def internal_attributes
+      { 'service.name' => @name }
+    end
   end
 
   # Interceptor for capturing stdout

data/lib/vigilant-ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vigilant
-  VERSION = '0.0.4'
+  VERSION = '0.0.6'
 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.6
 platform: ruby
 authors:
 - Vigilant