vigilant-ruby 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 598917bbfe3086a946307f7a5722b1c134aa42f17203fcbd2efc7deed68e4778
-  data.tar.gz: 2b19671efaca0de013d2591d2a1d5f077582d5e16c77950f7fd9b52a29b4a97a
+  metadata.gz: a0280598c4039160580005f39571754a95907101b616c6d3c8354da14eefb5de
+  data.tar.gz: 9ddebfc7149b3950006c8b45c0471955b00af3f99b2b88ffbf8754ed20d2187f
 SHA512:
-  metadata.gz: d02b1cffbe3eb6bf5cb5e343ddc6f631d712089e3e121a779163556aaf0d8e8cef75370f8a768eb71ecea85e1c3a7eb486f901bd4ea8bc791d85ba6614952895
-  data.tar.gz: 46a052c2a4f0ae1cab9083d8c50dd5b9e1a6950f893c408af5f9440a8acb41a42fed940cae98077fcd427d2222d565dc3a10148e5138735b9e38cee332908ba9
+  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

@@ -21,60 +21,48 @@ module Vigilant
     # @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).
-    def initialize(endpoint:, token:, insecure: false)
+    # @param passthrough [Boolean] Whether to also print logs to stdout/stderr (optional, defaults to true).
+    def initialize(endpoint:, token:, insecure: false, passthrough: true)
       @token = token
+
       protocol = insecure ? 'http://' : 'https://'
-      endpoint = endpoint.sub(%r{^https?://}, '') # Remove any existing protocol
+      endpoint = endpoint.sub(%r{^https?://}, '') # remove any existing protocol
       @endpoint = URI.parse("#{protocol}#{endpoint}/api/message")
+
       @insecure = insecure
+      @passthrough = passthrough
 
-      @batch_size = DEFAULT_BATCH_SIZE
+      @batch_size     = DEFAULT_BATCH_SIZE
       @flush_interval = DEFAULT_FLUSH_INTERVAL
 
       @queue = Queue.new
       @mutex = Mutex.new
       @batch = []
 
-      start_dispatcher
-    end
+      @original_stdout = $stdout
+      @original_stderr = $stderr
 
-    # Logs a TRACE message.
-    #
-    # @param body [String] The main text of the trace message.
-    # @param attributes [Hash] Additional attributes for the log (optional).
-    def trace(body, attributes = {})
-      enqueue_log(TRACE, body, attributes)
+      @autocapture_enabled = false
+
+      start_dispatcher
     end
 
-    # Logs a DEBUG message.
-    #
-    # @param body [String] The main text of the debug message.
-    # @param attributes [Hash] Additional attributes for the log (optional).
+    # Logs a debug message.
     def debug(body, attributes = {})
       enqueue_log(DEBUG, body, attributes)
     end
 
-    # Logs an INFO message.
-    #
-    # @param body [String] The main text of the log message.
-    # @param attributes [Hash] Additional attributes for the log (optional).
+    # Logs an info message.
     def info(body, attributes = {})
       enqueue_log(INFO, body, attributes)
     end
 
-    # Logs a WARNING message.
-    #
-    # @param body [String] The main text of the warning message.
-    # @param attributes [Hash] Additional attributes for the log (optional).
+    # Logs a warning message.
     def warn(body, attributes = {})
       enqueue_log(WARNING, body, attributes)
     end
 
-    # Logs an ERROR message.
-    #
-    # @param body [String] The main text of the error message.
-    # @param error [Exception] The error object.
-    # @param attributes [Hash] Additional attributes for the log (optional).
+    # Logs an error message.
     def error(body, error = nil, attributes = {})
       if error.nil?
         enqueue_log(ERROR, body, attributes)
@@ -84,27 +72,48 @@ module Vigilant
       end
     end
 
-    def shutdown
-      flush_if_needed(true)
+    # Enables stdout/stderr autocapture.
+    def autocapture_enable
+      return if @autocapture_enabled
 
-      @mutex.synchronize do
-        @shutdown = true
-      end
+      @autocapture_enabled = true
+      $stdout = StdoutInterceptor.new(self, @original_stdout)
+      $stderr = StderrInterceptor.new(self, @original_stderr)
+    end
+
+    # Disables stdout/stderr autocapture.
+    def autocapture_disable
+      return unless @autocapture_enabled
+
+      @autocapture_enabled = false
+      $stdout = @original_stdout
+      $stderr = @original_stderr
+    end
 
+    # Shuts down the logger, flushing any pending logs.
+    def shutdown
+      flush_if_needed(force: true)
+      @mutex.synchronize { @shutdown = true }
       @dispatcher_thread&.join
     end
 
     private
 
     def enqueue_log(level, body, attributes)
-      string_attributes = attributes.transform_values(&:to_s)
+      autocaptured = attributes.delete(:_autocapture)
+
       log_msg = {
         timestamp: Time.now.utc.strftime('%Y-%m-%dT%H:%M:%S.%9NZ'),
         body: body.to_s,
         level: level.to_s,
-        attributes: string_attributes
+        attributes: attributes.transform_values(&:to_s)
       }
+
       @queue << log_msg
+
+      return unless @passthrough && !autocaptured
+
+      @original_stdout.puts(body)
     end
 
     def start_dispatcher
@@ -114,11 +123,11 @@ module Vigilant
           flush_if_needed
           sleep @flush_interval
         end
-        flush_if_needed(true)
+        flush_if_needed(force: true)
       end
     end
 
-    def flush_if_needed(force = false)
+    def flush_if_needed(force: false)
       until @queue.empty?
         msg = @queue.pop
         @mutex.synchronize { @batch << msg }
@@ -157,4 +166,110 @@ module Vigilant
       http.request(request)
     end
   end
+
+  # Interceptor for capturing stdout
+  class StdoutInterceptor
+    def initialize(logger, original)
+      @logger   = logger
+      @original = original
+    end
+
+    def write(message)
+      @logger.info(message.strip, _autocapture: true) unless message.strip.empty?
+      @original.write(message)
+    end
+
+    def puts(*messages)
+      messages.each do |m|
+        @logger.info(m.to_s.strip, _autocapture: true) unless m.to_s.strip.empty?
+      end
+      @original.puts(*messages)
+    end
+
+    def print(*messages)
+      messages.each do |m|
+        @logger.info(m.to_s.strip, _autocapture: true) unless m.to_s.strip.empty?
+      end
+      @original.print(*messages)
+    end
+
+    def printf(*args)
+      formatted = sprintf(*args)
+      @logger.info(formatted.strip, _autocapture: true) unless formatted.strip.empty?
+      @original.printf(*args)
+    end
+
+    def flush
+      @original.flush
+    end
+
+    def close
+      @original.close
+    end
+
+    def tty?
+      @original.tty?
+    end
+
+    def respond_to_missing?(meth, include_private = false)
+      @original.respond_to?(meth, include_private)
+    end
+
+    def method_missing(meth, *args, &blk)
+      @original.send(meth, *args, &blk)
+    end
+  end
+
+  # Interceptor for capturing stderr
+  class StderrInterceptor
+    def initialize(logger, original)
+      @logger   = logger
+      @original = original
+    end
+
+    def write(message)
+      @logger.error(message.strip, nil, _autocapture: true) unless message.strip.empty?
+      @original.write(message)
+    end
+
+    def puts(*messages)
+      messages.each do |m|
+        @logger.error(m.to_s.strip, nil, _autocapture: true) unless m.to_s.strip.empty?
+      end
+      @original.puts(*messages)
+    end
+
+    def print(*messages)
+      messages.each do |m|
+        @logger.error(m.to_s.strip, nil, _autocapture: true) unless m.to_s.strip.empty?
+      end
+      @original.print(*messages)
+    end
+
+    def printf(*args)
+      formatted = sprintf(*args)
+      @logger.error(formatted.strip, nil, _autocapture: true) unless formatted.strip.empty?
+      @original.printf(*args)
+    end
+
+    def flush
+      @original.flush
+    end
+
+    def close
+      @original.close
+    end
+
+    def tty?
+      @original.tty?
+    end
+
+    def respond_to_missing?(meth, include_private = false)
+      @original.respond_to?(meth, include_private)
+    end
+
+    def method_missing(meth, *args, &blk)
+      @original.send(meth, *args, &blk)
+    end
+  end
 end

data/lib/vigilant-ruby/version.rb

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

data/lib/vigilant-ruby.rb

@@ -10,12 +10,13 @@ module Vigilant
 
   # Configuration for the Vigilant logging service.
   class Configuration
-    attr_accessor :endpoint, :token, :insecure
+    attr_accessor :endpoint, :token, :insecure, :passthrough
 
     def initialize
       @endpoint = 'ingress.vigilant.run'
       @insecure = false
       @token = 'tk_1234567890'
+      @passthrough = true
     end
   end
 
@@ -32,7 +33,8 @@ module Vigilant
       @logger ||= Vigilant::Logger.new(
         endpoint: configuration.endpoint,
         insecure: configuration.insecure,
-        token: configuration.token
+        token: configuration.token,
+        passthrough: configuration.passthrough
       )
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vigilant-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Vigilant
@@ -37,34 +37,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rbs
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -118,7 +90,6 @@ files:
 - lib/vigilant-ruby.rb
 - lib/vigilant-ruby/logger.rb
 - lib/vigilant-ruby/version.rb
-- sig/vigilant.rbs
 homepage: https://vigilant.run
 licenses:
 - MIT

data/sig/vigilant.rbs

@@ -1,92 +0,0 @@
-module Vigilant
-  DEBUG: "DEBUG"
-
-  INFO: "INFO"
-
-  WARNING: "WARNING"
-
-  ERROR: "ERROR"
-
-  DEFAULT_BATCH_SIZE: 10
-
-  DEFAULT_FLUSH_INTERVAL: 5
-
-  # A thread-safe logger that batches logs and sends them to Vigilant asynchronously
-  class Logger
-    @token: untyped
-
-    @endpoint: untyped
-
-    @insecure: untyped
-
-    @batch_size: untyped
-
-    @flush_interval: untyped
-
-    @queue: untyped
-
-    @mutex: untyped
-
-    @batch: untyped
-
-    @shutdown: untyped
-
-    @dispatcher_thread: untyped
-
-    # Initialize a Vigilant::Logger instance.
-    #
-    # @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).
-    def initialize: (endpoint: untyped, token: untyped, ?insecure: bool) -> void
-
-    # Logs a TRACE message.
-    #
-    # @param body [String] The main text of the trace message.
-    # @param attributes [Hash] Additional attributes for the log (optional).
-    def trace: (untyped body, ?::Hash[untyped, untyped] attributes) -> untyped
-
-    # Logs a DEBUG message.
-    #
-    # @param body [String] The main text of the debug message.
-    # @param attributes [Hash] Additional attributes for the log (optional).
-    def debug: (untyped body, ?::Hash[untyped, untyped] attributes) -> untyped
-
-    # Logs an INFO message.
-    #
-    # @param body [String] The main text of the log message.
-    # @param attributes [Hash] Additional attributes for the log (optional).
-    def info: (untyped body, ?::Hash[untyped, untyped] attributes) -> untyped
-
-    # Logs a WARNING message.
-    #
-    # @param body [String] The main text of the warning message.
-    # @param attributes [Hash] Additional attributes for the log (optional).
-    def warn: (untyped body, ?::Hash[untyped, untyped] attributes) -> untyped
-
-    # Logs an ERROR message.
-    #
-    # @param body [String] The main text of the error message.
-    # @param error [Exception] The error object.
-    # @param attributes [Hash] Additional attributes for the log (optional).
-    def error: (untyped body, ?untyped? error, ?::Hash[untyped, untyped] attributes) -> untyped
-
-    def shutdown: () -> untyped
-
-    private
-
-    def enqueue_log: (untyped level, untyped body, untyped attributes) -> untyped
-
-    def start_dispatcher: () -> untyped
-
-    def flush_if_needed: (?bool force) -> untyped
-
-    def flush!: () -> untyped
-
-    def post_logs: (untyped batch_data) -> untyped
-  end
-end
-
-module Vigilant
-  VERSION: "0.0.2"
-end