boringmetrics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1fbcee196ad899188c5c5984ee65ef840750920322dc7d764c622ebd2312b44f
+  data.tar.gz: 30924063fb4692030c525a011d46a12710d2be07889ef3fc327ab6e614b74c78
+SHA512:
+  metadata.gz: 4c041440af73eda67c140596f290668ea282eefd337a79ac0517c79c06e0a2589601d861fb709cef45d366faed9dfb1bd7d28ee483c7a07c0b3bc22057394c15
+  data.tar.gz: dcb9b561a76a52bc9371af098988438ba9a971ae60229598d96771d0d493e0f3a15a74ee57c3225b8fcb39f78d7bb0968223b34e3b9445e063e5b740df68e45d

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2025 Boring Metrics
+
+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,102 @@
+# Boring Metrics Ruby SDK
+
+This is a Ruby SDK for the Boring Metrics API. It provides a simple and efficient way to interact with the API from your Ruby applications.
+
+## Supported Platforms
+
+The SDK is available for the following platforms:
+
+- [`boringmetrics`](https://github.com/boringmetrics/ruby-sdk/tree/main/packages/boringmetrics): SDK for Ruby
+- [`boringmetrics-rails`](https://github.com/boringmetrics/ruby-sdk/tree/main/packages/boringmetrics-rails): SDK for Ruby on Rails
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+# For plain Ruby applications
+gem 'boringmetrics'
+
+# For Rails applications
+gem 'boringmetrics-rails'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install boringmetrics
+$ gem install boringmetrics-rails
+```
+
+## Usage
+
+### Ruby
+
+```ruby
+# Initialize the SDK
+BoringMetrics.initialize("YOUR_API_TOKEN")
+
+# Send a log
+BoringMetrics.logs.send(
+  type: "log",
+  level: "info",
+  message: "User signed in",
+  data: { user_id: "123" },
+)
+
+# Send multiple logs
+BoringMetrics.logs.send_batch([
+  { type: "log", level: "warn", message: "Something looks weird" },
+  { type: "log", level: "error", message: "Something broke!", data: { error: "Connection timeout" } }
+])
+
+# Set a live metric value
+BoringMetrics.lives.update(
+  live_id: "metric-123",
+  value: 42,
+  operation: "set",
+)
+
+# Increment a live metric value
+BoringMetrics.lives.update(
+  live_id: "metric-123",
+  value: 5,
+  operation: "increment",
+)
+```
+
+### Rails
+
+In a Rails application, you can initialize the SDK in an initializer:
+
+```ruby
+# config/initializers/boringmetrics.rb
+BoringMetrics::Rails.initialize("YOUR_API_TOKEN", {
+  logs_max_batch_size: 50,
+  logs_send_interval: 10
+})
+```
+
+The Rails integration automatically captures exceptions and logs them to BoringMetrics.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/boringmetrics/ruby-sdk.
+
+## Contributors
+
+Thanks to everyone who contributed to the Boring Metrics Ruby SDK!
+
+<a href="https://github.com/boringmetrics/ruby-sdk/graphs/contributors">
+  <img src="https://contributors-img.web.app/image?repo=boringmetrics/ruby-sdk" />
+</a>
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/boringmetrics/client.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require "concurrent"
+require "time"
+
+module BoringMetrics
+  # Main client for the BoringMetrics SDK
+  class Client
+    attr_reader :logs, :lives
+
+    # Initialize a new client
+    #
+    # @param token [String] Your BoringMetrics API token
+    # @param config [Hash] Optional configuration options
+    def initialize(token, **config)
+      @config = Configuration.new(token, **config)
+      @transport = Transport.new(@config)
+      
+      @logs_queue = Concurrent::Array.new
+      @logs_mutex = Mutex.new
+      @logs_timer = nil
+
+      @lives_queue = Concurrent::Array.new
+      @lives_mutex = Mutex.new
+      @lives_timer = nil
+
+      @logs = LogMethods.new(self)
+      @lives = LiveMethods.new(self)
+    end
+
+    # Add a log to the queue
+    #
+    # @param log [Hash] The log to add
+    # @return [void]
+    def add_log(log)
+      log_with_sent_at = log.dup
+      log_with_sent_at[:sent_at] ||= Time.now.iso8601
+
+      @logs_mutex.synchronize do
+        @logs_queue << log_with_sent_at
+        
+        if @logs_queue.size >= @config.logs_max_batch_size
+          flush_logs
+        elsif @logs_timer.nil?
+          schedule_logs_flush
+        end
+      end
+    end
+
+    # Update a live metric
+    #
+    # @param update [Hash] The live update
+    # @return [void]
+    def update_live(update)
+      update_with_sent_at = update.dup
+      update_with_sent_at[:sent_at] ||= Time.now.iso8601
+
+      @lives_mutex.synchronize do
+        @lives_queue << update_with_sent_at
+        
+        if @lives_queue.size >= @config.lives_max_batch_size
+          flush_lives
+        elsif @lives_timer.nil?
+          schedule_lives_flush
+        end
+      end
+    end
+
+    private
+
+    def schedule_logs_flush
+      @logs_timer = Concurrent::ScheduledTask.execute(@config.logs_send_interval) do
+        flush_logs
+      end
+    end
+
+    def flush_logs
+      @logs_mutex.synchronize do
+        @logs_timer&.cancel
+        @logs_timer = nil
+
+        return if @logs_queue.empty?
+
+        logs_to_send = @logs_queue.dup
+        @logs_queue.clear
+
+        send_logs(logs_to_send)
+      end
+    end
+
+    def send_logs(logs)
+      Thread.new do
+        begin
+          @transport.send_logs(logs)
+        rescue StandardError => e
+          puts "[BoringMetrics] Error sending logs: #{e.message}"
+        end
+      end
+    end
+
+    def schedule_lives_flush
+      @lives_timer = Concurrent::ScheduledTask.execute(@config.lives_debounce_time) do
+        flush_lives
+      end
+    end
+
+    def flush_lives
+      @lives_mutex.synchronize do
+        @lives_timer&.cancel
+        @lives_timer = nil
+
+        return if @lives_queue.empty?
+
+        lives_to_send = @lives_queue.dup
+        @lives_queue.clear
+
+        send_lives(lives_to_send)
+      end
+    end
+
+    def send_lives(lives)
+      Thread.new do
+        begin
+          lives.each do |live|
+            @transport.update_live(live)
+          end
+        rescue StandardError => e
+          puts "[BoringMetrics] Error sending live updates: #{e.message}"
+        end
+      end
+    end
+  end
+end

data/lib/boringmetrics/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module BoringMetrics
+  class Configuration
+    attr_accessor :api_url, :max_retry_attempts, :logs_max_batch_size, :logs_send_interval
+    
+    def initialize
+      @api_url = "https://api.getboringmetrics.com"
+      @max_retry_attempts = 5
+      @logs_max_batch_size = 100
+      @logs_send_interval = 5 # seconds
+    end
+  end
+end

data/lib/boringmetrics/live_methods.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module BoringMetrics
+  # Methods for updating live metrics
+  class LiveMethods
+    # Initialize the lives API
+    #
+    # @param client [BoringMetrics::Client] The client instance
+    def initialize(client)
+      @client = client
+    end
+
+    # Update a live metric value
+    #
+    # @param update [Hash] The live update to send
+    # @option update [String] :live_id The ID of the live metric
+    # @option update [Numeric] :value The value to set or increment
+    # @option update [String] :operation The operation to perform ("set" or "increment")
+    # @option update [String] :sent_at ISO8601 date - will be automatically set if not provided
+    # @return [void]
+    def update(update)
+      @client.update_live(update)
+    end
+
+    # Update multiple live metrics values in a batch
+    #
+    # @param updates [Array<Hash>] Array of live updates to send
+    # @return [void]
+    def update_batch(updates)
+      updates.each { |update| update(update) }
+    end
+  end
+end

data/lib/boringmetrics/log_methods.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module BoringMetrics
+  # Methods for sending logs
+  class LogMethods
+    # Initialize the logs API
+    #
+    # @param client [BoringMetrics::Client] The client instance
+    def initialize(client)
+      @client = client
+    end
+
+    # Send a single log event
+    #
+    # @param log [Hash] The log event to send
+    # @option log [String] :type The type of log (default: "log")
+    # @option log [String] :level The log level (trace, debug, info, warn, error, fatal)
+    # @option log [String] :message The log message
+    # @option log [Hash] :data Additional structured data (optional)
+    # @option log [String] :session_id Session identifier for grouping related logs (optional)
+    # @option log [String] :sent_at ISO8601 date - will be automatically set if not provided
+    # @return [void]
+    def send(log)
+      @client.add_log(log)
+    end
+
+    # Send multiple log events in a batch
+    #
+    # @param logs [Array<Hash>] Array of log events to send
+    # @return [void]
+    def send_batch(logs)
+      logs.each { |log| send(log) }
+    end
+  end
+end

data/lib/boringmetrics/transport.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+
+module BoringMetrics
+  # Transport layer for the BoringMetrics SDK
+  class Transport
+    # Initialize a new transport
+    #
+    # @param config [BoringMetrics::Configuration] The SDK configuration
+    def initialize(config)
+      @config = config
+    end
+
+    # Send logs to the BoringMetrics API
+    #
+    # @param logs [Array<Hash>] The logs to send
+    # @return [void]
+    def send_logs(logs)
+      with_retry do
+        response = connection.post("/api/v1/logs") do |req|
+          req.headers["Content-Type"] = "application/json"
+          req.headers["Authorization"] = "Bearer #{@config.token}"
+          req.body = { logs: logs }.to_json
+        end
+
+        raise "Failed to send logs: #{response.status}" unless response.success?
+      end
+    end
+
+    # Update a live metric
+    #
+    # @param update [Hash] The live update to send
+    # @return [void]
+    def update_live(update)
+      with_retry do
+        response = connection.put("/api/v1/lives/#{update[:live_id]}") do |req|
+          req.headers["Content-Type"] = "application/json"
+          req.headers["Authorization"] = "Bearer #{@config.token}"
+          req.body = { live: update }.to_json
+        end
+
+        raise "Failed to send live update: #{response.status}" unless response.success?
+      end
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: Configuration::API_URL) do |faraday|
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def with_retry
+      retries = 0
+      begin
+        yield
+      rescue StandardError => e
+        retries += 1
+        if retries <= @config.max_retry_attempts
+          sleep(2**retries * 0.1) # Exponential backoff
+          retry
+        else
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/boringmetrics/version.rb

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

data/lib/boringmetrics.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "boringmetrics/version"
+require_relative "boringmetrics/client"
+require_relative "boringmetrics/errors"
+
+# Main module for the Boring Metrics SDK
+module BoringMetrics
+  class << self
+    # @return [BoringMetrics::Client] The configured client instance
+    attr_reader :instance
+
+    # Initialize the SDK with your API token
+    # @param token [String] Your Boring Metrics API token
+    # @return [BoringMetrics::Client] The configured client instance
+    def initialize(token)
+      @instance ||= Client.new(token)
+    end
+
+    # Access logs functionality
+    # @return [BoringMetrics::Client::LogMethods]
+    def logs
+      instance.logs
+    end
+
+    # Access lives functionality
+    # @return [BoringMetrics::Client::LiveMethods]
+    def lives
+      instance.lives
+    end
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: boringmetrics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aymeric Chauvin
+bindir: bin
+cert_chain: []
+date: 2025-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: Ruby SDK for the Boring Metrics API. It provides a simple and efficient
+  way to interact with the API from your Ruby applications.
+email:
+- contact@halftheopposite.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/boringmetrics.rb
+- lib/boringmetrics/client.rb
+- lib/boringmetrics/configuration.rb
+- lib/boringmetrics/live_methods.rb
+- lib/boringmetrics/log_methods.rb
+- lib/boringmetrics/transport.rb
+- lib/boringmetrics/version.rb
+homepage: https://github.com/boringmetrics/ruby-sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/boringmetrics/ruby-sdk
+  source_code_uri: https://github.com/boringmetrics/ruby-sdk
+  changelog_uri: https://github.com/boringmetrics/ruby-sdk/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Ruby SDK for Boring Metrics
+test_files: []