supalog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c56751e0f6bd6c2b7fbd83d1affe843efb301c079c0f34fa9266a136b7075cac
+  data.tar.gz: 38ab5f1ad84e30db98076365905cbc8f57d9d1a132458d4aad671a3fadfed2f1
+SHA512:
+  metadata.gz: 1888b328208392bfe29c03105b8e1e84dc06828f047ff4fa2b388cb90c55fc0da145ef0f5d996412d87e5f570ed75d559e3e9f5c3f2fb7c48a15bd766544dd62
+  data.tar.gz: db3dc693415a8b549c06aa5f5aa41404c05ace86df14320472f439085b2f47fd6cbaa0cf3f5f19f9e7a4701ee0e5702aa880ce5ee5928f29a4bf00a2fec203d4

data/.claude/settings.local.json

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(bundle exec:*)",
+      "Bash(bundle install:*)"
+    ]
+  }
+}

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-03-17
+
+- Initial release

data/CLAUDE.md

@@ -0,0 +1,73 @@
+# CLAUDE.md
+
+## Project Overview
+
+Supalog is a Ruby gem that ships logs from Rails applications to the Supalog platform (www.supalog.dev). It provides 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.
+
+**Zero dependencies** — uses only `Net::HTTP` from Ruby stdlib.
+
+## Ingest API
+
+The gem posts to the Supalog ingest API:
+
+- **Endpoint:** `POST /api/logs`
+- **Auth:** `X-Api-Key` header with the project's API key
+- **Content-Type:** `application/json`
+- **Payload:**
+```json
+{
+  "logs": [
+    {
+      "level": "info",
+      "message": "Started GET / for 127.0.0.1",
+      "metadata": { "request_id": "abc123" },
+      "timestamp": "2026-03-17T14:30:00Z"
+    }
+  ]
+}
+```
+- **Response:** `201 Created` on success, `401 Unauthorized` on invalid API key
+
+## Architecture
+
+- **`Supalog`** — top-level module. Holds configuration, manages the buffer and background flush thread via singleton methods.
+- **`Supalog::Buffer`** — thread-safe in-memory array. Accepts log entries, returns and clears batch on flush.
+- **`Supalog::LogSubscriber`** — wraps `Rails.logger#add` to intercept log calls, writes to the buffer, and passes through to the original logger.
+- **`Supalog::Transport`** — delivers batches to the Supalog ingest API via `Net::HTTP`.
+- **`Supalog::Railtie`** — auto-configures in Rails apps. Wires up the logger when `api_key` is present.
+
+## Expected Usage
+
+```ruby
+# config/initializers/supalog.rb
+Supalog.configure do |config|
+  config.api_key = ENV["SUPALOG_API_KEY"]
+  config.url = "https://www.supalog.dev"       # optional, this is the default
+  config.flush_interval = 5                 # seconds, optional, default 5
+  config.batch_size = 100                   # optional, default 100
+end
+```
+
+Once configured, Rails logs automatically flow to Supalog. No other code changes needed.
+
+## Design Constraints
+
+- Zero external dependencies — only `net/http`, `json`, `uri` from stdlib
+- Thread-safe buffer (Mutex)
+- Background thread flushes on interval OR when batch_size is reached
+- Graceful shutdown — flush remaining buffer on `at_exit`
+- Silent failures — never raise exceptions that crash the host app. Log errors to STDERR.
+- Works with Ruby 3.0+
+
+## Common Commands
+
+- `bundle exec rspec` — run tests
+- `bundle exec rake build` — build the gem
+- `bundle exec rake install` — install locally
+- `bundle exec rake release` — release to RubyGems
+
+## Code Style
+
+- Use double quotes (`"`)
+- No external dependencies
+- Keep it minimal — this gem should be small and focused

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"supalog" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["chris@typefast.co"](mailto:"chris@typefast.co").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Chris Jeon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Supalog
+
+TODO: Delete this and the text below, and describe your gem
+
+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.
+
+## 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.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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).
+
+## 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).
+
+## 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/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/supalog/buffer.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Supalog
+  class Buffer
+    def initialize(batch_size:, flush_interval:, &on_flush)
+      @batch_size = batch_size
+      @flush_interval = flush_interval
+      @on_flush = on_flush
+      @mutex = Mutex.new
+      @entries = []
+      @stopped = false
+      start_flush_thread
+    end
+
+    def push(entry)
+      should_flush = false
+
+      @mutex.synchronize do
+        @entries << entry
+        should_flush = @entries.size >= @batch_size
+      end
+
+      flush! if should_flush
+    end
+
+    def flush!
+      batch = nil
+
+      @mutex.synchronize do
+        return if @entries.empty?
+
+        batch = @entries.dup
+        @entries.clear
+      end
+
+      @on_flush.call(batch) if batch
+    rescue => e
+      $stderr.puts "[Supalog] Flush error: #{e.message}"
+    end
+
+    def stop
+      @stopped = true
+      @flush_thread&.join(5)
+      @flush_thread = nil
+    end
+
+    def size
+      @mutex.synchronize { @entries.size }
+    end
+
+    private
+
+    def start_flush_thread
+      @flush_thread = Thread.new do
+        loop do
+          sleep @flush_interval
+          break if @stopped
+
+          flush!
+        end
+      end
+      @flush_thread.abort_on_exception = false
+    end
+  end
+end

data/lib/supalog/configuration.rb

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

data/lib/supalog/log_subscriber.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Supalog
+  class LogSubscriber
+    SEVERITY_MAP = {
+      0 => "debug",
+      1 => "info",
+      2 => "warn",
+      3 => "error",
+      4 => "fatal",
+      5 => "unknown"
+    }.freeze
+
+    def self.attach_logger!(logger)
+      return unless logger
+
+      original_add = logger.method(:add)
+      severity_map = SEVERITY_MAP
+
+      logger.define_singleton_method(:add) do |severity, message = nil, progname = nil, &block|
+        msg = message || (block ? block.call : progname)
+
+        if msg
+          Supalog.push({
+            "level" => severity_map[severity] || "unknown",
+            "message" => msg.to_s,
+            "metadata" => {},
+            "timestamp" => Time.now.utc.iso8601(3)
+          })
+        end
+
+        original_add.call(severity, message, progname, &block)
+      end
+    end
+  end
+end

data/lib/supalog/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "log_subscriber"
+
+module Supalog
+  class Railtie < Rails::Railtie
+    initializer "supalog.configure_logging" do
+      if Supalog.configuration.api_key
+        Supalog.start!
+        Supalog::LogSubscriber.attach_logger!(Rails.logger)
+      end
+    end
+  end
+end

data/lib/supalog/transport.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+
+module Supalog
+  class Transport
+    CONNECT_TIMEOUT = 5
+    READ_TIMEOUT = 10
+
+    def self.deliver(batch, configuration)
+      uri = URI.join(configuration.url, "/api/logs")
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.open_timeout = CONNECT_TIMEOUT
+      http.read_timeout = READ_TIMEOUT
+
+      request = Net::HTTP::Post.new(uri.path)
+      request["Content-Type"] = "application/json"
+      request["X-Api-Key"] = configuration.api_key
+      request.body = JSON.generate({ "logs" => batch })
+
+      response = http.request(request)
+
+      unless response.is_a?(Net::HTTPSuccess)
+        $stderr.puts "[Supalog] Ingest API responded with #{response.code}: #{response.body}"
+      end
+    rescue => e
+      $stderr.puts "[Supalog] Transport error: #{e.message}"
+    end
+  end
+end

data/lib/supalog/version.rb

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

data/lib/supalog.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "supalog/version"
+require_relative "supalog/configuration"
+require_relative "supalog/buffer"
+require_relative "supalog/transport"
+
+module Supalog
+  class Error < StandardError; end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+      start!
+    end
+
+    def start!
+      return if @started
+
+      @buffer = Buffer.new(
+        batch_size: configuration.batch_size,
+        flush_interval: configuration.flush_interval
+      ) { |batch| Transport.deliver(batch, configuration) }
+
+      at_exit { shutdown }
+      @started = true
+    end
+
+    def buffer
+      @buffer
+    end
+
+    def push(entry)
+      @buffer&.push(entry)
+    end
+
+    def shutdown
+      @buffer&.flush!
+      @buffer&.stop
+      @started = false
+    end
+
+    def reset!
+      shutdown
+      @configuration = Configuration.new
+      @buffer = nil
+      @started = false
+    end
+  end
+end
+
+require_relative "supalog/railtie" if defined?(Rails::Railtie)

data/sig/supalog.rbs

@@ -0,0 +1,4 @@
+module Supalog
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: supalog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Jeon
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A drop-in Rails logger that buffers log entries and flushes them in batches
+  to the Supalog ingest API via a background thread.
+email:
+- chris@typefast.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".claude/settings.local.json"
+- CHANGELOG.md
+- CLAUDE.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/supalog.rb
+- lib/supalog/buffer.rb
+- lib/supalog/configuration.rb
+- lib/supalog/log_subscriber.rb
+- lib/supalog/railtie.rb
+- lib/supalog/transport.rb
+- lib/supalog/version.rb
+- sig/supalog.rbs
+homepage: https://supalog.dev
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://supalog.dev
+  source_code_uri: https://github.com/chrisjeon/supalog-rb
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Ship Rails logs to the Supalog platform
+test_files: []