supalog 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c56751e0f6bd6c2b7fbd83d1affe843efb301c079c0f34fa9266a136b7075cac
-  data.tar.gz: 38ab5f1ad84e30db98076365905cbc8f57d9d1a132458d4aad671a3fadfed2f1
+  metadata.gz: 2855adaa624e1c11f210324472a218eeb545b4bc56aaaf3719c3b98e05fe4e91
+  data.tar.gz: fdc4f20a9d532c007b0b322e81dac15efe4d8f70e17feefe12b6e9459db8fd8c
 SHA512:
-  metadata.gz: 1888b328208392bfe29c03105b8e1e84dc06828f047ff4fa2b388cb90c55fc0da145ef0f5d996412d87e5f570ed75d559e3e9f5c3f2fb7c48a15bd766544dd62
-  data.tar.gz: db3dc693415a8b549c06aa5f5aa41404c05ace86df14320472f439085b2f47fd6cbaa0cf3f5f19f9e7a4701ee0e5702aa880ce5ee5928f29a4bf00a2fec203d4
+  metadata.gz: cc7c4215bcfdbd1bab12781d4fa8d3e435be223dd320e2eac75b99c9503934d0be50d53d00e08c00f9d3ad8d7fc066cd3be1fc83ec1241e24f2d76b155637ce0
+  data.tar.gz: a9285d3a1b32d9b9bb97efe5174c5c1729842d7598be83606f48a644a53615642dba4a4bbbb9e396f5904ed9120e7d58f6f54de7784fb53845b80f94b870a1b0

data/README.md

@@ -1,43 +1,113 @@
 # Supalog
 
-TODO: Delete this and the text below, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/supalog.svg)](https://rubygems.org/gems/supalog)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/supalog`. To experiment with that code, run `bin/console` for an interactive prompt.
+Ship your Rails logs to [Supalog](https://www.supalog.dev) with zero external dependencies.
+
+Supalog is a drop-in Rails logger that buffers log entries in memory and flushes them in batches to the Supalog ingest API via a background thread. Your existing Rails logging continues to work as normal — Supalog simply taps into it.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's Gemfile:
+
+```ruby
+gem "supalog"
+```
 
-Install the gem and add to the application's Gemfile by executing:
+Then execute:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle install
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or install it yourself:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install supalog
+```
+
+## Quick Start
+
+1. Get your API key from [supalog.dev](https://www.supalog.dev)
+
+2. Create an initializer:
+
+```ruby
+# config/initializers/supalog.rb
+Supalog.configure do |config|
+  config.api_key = ENV["SUPALOG_API_KEY"]
+end
+```
+
+That's it. Your Rails logs now flow to Supalog automatically — no other code changes needed.
+
+## Configuration
+
+| Option           | Default                      | Description                                          |
+|------------------|------------------------------|------------------------------------------------------|
+| `api_key`        | `nil`                        | **Required.** Your Supalog project API key.          |
+| `url`            | `"https://www.supalog.dev"`  | Supalog ingest endpoint.                             |
+| `flush_interval` | `5`                          | Seconds between background flushes.                  |
+| `batch_size`     | `100`                        | Max entries buffered before an immediate flush.       |
+| `enabled`        | `true`                       | Enable or disable log shipping.                      |
+
+```ruby
+Supalog.configure do |config|
+  config.api_key        = ENV["SUPALOG_API_KEY"]
+  config.url            = "https://www.supalog.dev"  # default
+  config.flush_interval = 5                          # seconds, default
+  config.batch_size     = 100                        # default
+  config.enabled        = true                         # default
+end
 ```
 
-## Usage
+### Per-Environment Usage
+
+Use `enabled` to control which environments ship logs:
 
-TODO: Write usage instructions here
+```ruby
+Supalog.configure do |config|
+  config.api_key = ENV["SUPALOG_API_KEY"]
+  config.enabled = Rails.env.production? || Rails.env.staging?
+end
+```
+
+When `enabled` is `false`, no background thread is started and log entries are silently discarded.
+
+## How It Works
+
+1. **Intercepts** — Wraps `Rails.logger` to capture every log call.
+2. **Buffers** — Stores entries in a thread-safe in-memory array.
+3. **Flushes** — A background thread sends batches to the Supalog API every `flush_interval` seconds, or immediately when `batch_size` is reached.
+4. **Passes through** — All logs still go to the original Rails logger, so your existing output (console, file, etc.) is unaffected.
+5. **Shuts down gracefully** — Remaining buffered logs are flushed on process exit via `at_exit`.
+
+Supalog never raises exceptions that could crash your application. Transport errors are silently logged to `STDERR`.
+
+## Requirements
+
+- Ruby >= 3.0
+- Rails (auto-configures via Railtie)
+- **Zero external dependencies** — uses only Ruby stdlib (`net/http`, `json`, `uri`)
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```bash
+# Run the test suite
+bundle exec rspec
+
+# Build the gem locally
+bundle exec rake build
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+# Install the gem locally
+bundle exec rake install
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/supalog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/supalog/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on [GitHub](https://github.com/chrisjeon/supalog-rb).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Supalog project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/supalog/blob/master/CODE_OF_CONDUCT.md).

data/lib/supalog/configuration.rb

@@ -2,13 +2,14 @@
 
 module Supalog
   class Configuration
-    attr_accessor :api_key, :url, :batch_size, :flush_interval
+    attr_accessor :api_key, :url, :batch_size, :flush_interval, :enabled
 
     def initialize
       @api_key = nil
       @url = "https://www.supalog.dev"
       @batch_size = 100
       @flush_interval = 5
+      @enabled = true
     end
   end
 end

data/lib/supalog/railtie.rb

@@ -4,8 +4,8 @@ require_relative "log_subscriber"
 
 module Supalog
   class Railtie < Rails::Railtie
-    initializer "supalog.configure_logging" do
-      if Supalog.configuration.api_key
+    config.after_initialize do
+      if Supalog.configuration.api_key && Supalog.enabled?
         Supalog.start!
         Supalog::LogSubscriber.attach_logger!(Rails.logger)
       end

data/lib/supalog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Supalog
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/supalog.rb

@@ -18,8 +18,13 @@ module Supalog
       start!
     end
 
+    def enabled?
+      configuration.enabled
+    end
+
     def start!
       return if @started
+      return unless enabled?
 
       @buffer = Buffer.new(
         batch_size: configuration.batch_size,
@@ -35,6 +40,8 @@ module Supalog
     end
 
     def push(entry)
+      return unless enabled?
+
       @buffer&.push(entry)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: supalog
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Chris Jeon