logdash 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 215f7ee41511ec997fa91b79b8f9e4ab4f773cb53cf76851d7c705881aae8e43
+  data.tar.gz: 28961a89b4436a092d064c2ff19780bba08132f255082cf465472b5ca4d87379
+SHA512:
+  metadata.gz: e02e453c9aa4e10cab5b8788d9179c047ba38d2ca48a8174f2f95d31aa512c073d108413fa1fc144380106a4ddcb4ca3499bfb98db0fd3812a54c0e8c887acb7
+  data.tar.gz: 170b771a99b0e5ff5d14ab7ba8ed005665a9371acff2a0a158bfb6cad67447a8e40958a06d3915915a562072224fd69a07939c3e5ae307b962599086b2bba726

data/.rubocop.yml

@@ -0,0 +1,58 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+  Exclude:
+    - "bin/*"
+    - "vendor/**/*"
+    - "tmp/**/*"
+    - "logdash-*.gem"
+  SuggestExtensions: false
+
+Capybara:
+  Enabled: false
+
+FactoryBot:
+  Enabled: false
+
+Capybara/RSpec/PredicateMatcher:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "test/**/*"
+    - "ruby-sdk.gemspec"
+
+Metrics/ModuleLength:
+  Max: 150
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Metrics/AbcSize:
+  Max: 26
+
+Metrics/MethodLength:
+  Exclude:
+    - "lib/logdash/metrics.rb"

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2025-05-21
+
+### Added
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 logdash.io
+
+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,96 @@
+# logdash - Ruby SDK
+
+Logdash is a zero-config observability platform. This package serves as a Ruby interface to use it.
+
+## Pre-requisites
+
+Setup your free project in less than 2 minutes at [logdash.io](https://logdash.io/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logdash'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install logdash
+```
+
+## Logging
+
+```ruby
+require 'logdash'
+
+logdash_client = Logdash.create(api_key: "YOUR_API_KEY")
+logger = logdash_client[:logger]
+
+logger.info('Application started successfully')
+logger.error('An unexpected error occurred')
+logger.warn('Low disk space warning')
+logger.debug('Debugging information')
+logger.verbose('Verbose logging')
+logger.http('HTTP request details')
+logger.silly('Silly level logging')
+```
+
+## Metrics
+
+```ruby
+require 'logdash'
+
+logdash_client = Logdash.create(api_key: "YOUR_API_KEY")
+metrics = $logdash_client[:metrics]
+
+metrics.set('users', 0)
+metrics.mutate('users', 1)
+```
+
+## View
+
+To see the logs or metrics, go to your project dashboard.
+
+## Configuration
+
+| Parameter | Required | Default | Description                                                                                                              |
+| --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `api_key` | no       | -       | Api key used to authorize against logdash servers. If you don't provide one, logs will be logged into local console only |
+| `host`    | no       | `https://api.logdash.io` | Custom API host, useful with self-hosted instances                                                                       |
+| `verbose` | no       | `false` | Useful for debugging purposes                                                                                            |
+
+## View
+
+To see the logs or metrics, go to your project dashboard
+
+![logs](docs/logs.png)
+![delta](docs/delta.png)
+
+## License
+
+This project is licensed under the MIT License. See `LICENSE` for more information.
+
+## Contributing
+
+Contributions are welcome! Feel free to open issues or submit pull requests.
+
+### Running Tests
+
+Before submitting a PR, please run the test suite and rubocop:
+
+```bash
+bundle exec rspec
+bundle exec rubocop
+```
+
+## Support
+
+If you encounter any issues, please open an issue on GitHub or let us know at [contact@logdash.io](mailto:contact@logdash.io).

data/lib/logdash/client.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative 'logger'
+require_relative 'metrics'
+require_relative 'http_log_sync'
+
+module Logdash
+  class Client
+    attr_reader :logger, :metrics
+
+    def initialize(api_key: nil, host: 'https://api.logdash.io', verbose: false)
+      @api_key = api_key
+      @host = host
+      @verbose = verbose
+
+      log_sync_instance = create_log_sync(api_key, host, verbose)
+      @logger = Logger.new(log_sync: log_sync_instance)
+
+      @metrics = create_metrics(api_key, host, verbose)
+    end
+
+    def self.create(api_key: nil, host: 'https://api.logdash.io', verbose: false)
+      client = new(api_key: api_key, host: host, verbose: verbose)
+      { logger: client.logger, metrics: client.metrics }
+    end
+
+    private
+
+    def create_log_sync(api_key, host, verbose)
+      if api_key && !api_key.empty?
+        HttpLogSync.new(api_key: api_key, host: host, verbose: verbose)
+      else
+        puts '[LogDash] API key not provided. Using local logger only.' if verbose
+        NoopLogSync.new
+      end
+    end
+
+    def create_metrics(api_key, host, verbose)
+      if api_key && !api_key.empty?
+        Metrics.new(api_key: api_key, host: host, verbose: verbose)
+      else
+        puts '[LogDash] API key not provided. Metrics will not be registered.' if verbose
+        NoopMetrics.new
+      end
+    end
+  end
+end

data/lib/logdash/http_log_sync.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Logdash
+  class HttpLogSync
+    def initialize(api_key:, host:, verbose:)
+      @api_key = api_key
+      @host = host
+      @verbose = verbose
+      @sequence_number = 0
+      @sequence_mutex = Mutex.new
+    end
+
+    def send(message, level, created_at)
+      return unless @api_key
+
+      payload_sequence_number = next_sequence_number
+
+      Thread.new do
+        send_log_message(message, level, created_at, payload_sequence_number)
+      end
+    end
+
+    private
+
+    def next_sequence_number
+      @sequence_mutex.synchronize do
+        current_sequence = @sequence_number
+        @sequence_number += 1
+        current_sequence
+      end
+    end
+
+    def send_log_message(message, level, created_at, sequence_number)
+      uri = URI.parse("#{@host}/logs")
+      request = build_request(uri, message, level, created_at, sequence_number)
+
+      begin
+        response = http_client(uri).request(request)
+        puts "[LogDash BG] Sent log (seq: #{sequence_number}), status: #{response.code}" if @verbose
+      rescue Net::OpenTimeout, Net::ReadTimeout => e
+        puts "[LogDash BG] Timeout sending log (seq: #{sequence_number}): #{e.message}" if @verbose
+      rescue StandardError => e
+        puts "[LogDash BG] Error sending log (seq: #{sequence_number}): #{e.message}" if @verbose
+      end
+    end
+
+    def build_request(uri, message, level, created_at, sequence_number)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request['Content-Type'] = 'application/json'
+      request['project-api-key'] = @api_key
+      request.body = {
+        message: message,
+        level: level,
+        createdAt: created_at,
+        sequenceNumber: sequence_number
+      }.to_json
+      request
+    end
+
+    def http_client(uri)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = (uri.scheme == 'https')
+      http.open_timeout = 5
+      http.read_timeout = 5
+      http
+    end
+  end
+
+  class NoopLogSync
+    def send(message, level, created_at); end
+  end
+end

data/lib/logdash/logger.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Logdash
+  module Types
+    module LogLevel
+      ERROR = 'error'
+      WARN = 'warning'
+      INFO = 'info'
+      HTTP = 'http'
+      VERBOSE = 'verbose'
+      DEBUG = 'debug'
+      SILLY = 'silly'
+    end
+  end
+
+  class Logger
+    LOG_LEVEL_COLORS = {
+      Logdash::Types::LogLevel::ERROR => [231, 0, 11],
+      Logdash::Types::LogLevel::WARN => [254, 154, 0],
+      Logdash::Types::LogLevel::INFO => [21, 93, 252],
+      Logdash::Types::LogLevel::HTTP => [0, 166, 166],
+      Logdash::Types::LogLevel::VERBOSE => [0, 166, 0],
+      Logdash::Types::LogLevel::DEBUG => [0, 166, 62],
+      Logdash::Types::LogLevel::SILLY => [80, 80, 80]
+    }.freeze
+
+    def initialize(log_sync: nil, prefix_proc: nil, on_log_proc: nil)
+      @log_sync = log_sync
+      @prefix_proc = prefix_proc || default_prefix_proc
+      @on_log_proc = on_log_proc
+    end
+
+    Logdash::Types::LogLevel.constants.each do |level_const_sym|
+      level_value = Logdash::Types::LogLevel.const_get(level_const_sym)
+      define_method(level_value) do |*data|
+        _log(level_value, format_data(data))
+      end
+    end
+
+    alias log info
+
+    private
+
+    def format_data(data)
+      data.map do |item|
+        item.is_a?(String) ? item : item.to_json
+      rescue JSON::GeneratorError
+        item.to_s
+      end.join(' ')
+    end
+
+    def colorize(text, level)
+      rgb = LOG_LEVEL_COLORS[level]
+      return text unless rgb
+
+      "\e[38;2;#{rgb[0]};#{rgb[1]};#{rgb[2]}m#{text}\e[0m"
+    end
+
+    def default_prefix_proc
+      lambda do |level|
+        timestamp = colorize("[#{Time.now.utc.iso8601}]", Logdash::Types::LogLevel::SILLY)
+        level_tag = colorize("[#{level.to_s.upcase}]", level)
+        "#{timestamp} #{level_tag} "
+      end
+    end
+
+    def _log(level, message)
+      prefix = @prefix_proc.call(level)
+      puts "#{prefix}#{message}"
+      @on_log_proc&.call(level, message)
+      @log_sync&.send(message, level, Time.now.utc)
+    end
+  end
+end

data/lib/logdash/metrics.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Logdash
+  module BaseMetrics
+    def set(key, value)
+      raise NotImplementedError, "#{self.class} has not implemented method 'set'"
+    end
+
+    def mutate(key, value)
+      raise NotImplementedError, "#{self.class} has not implemented method 'mutate'"
+    end
+  end
+
+  module MetricOperation
+    SET = 'set'
+    CHANGE = 'change'
+  end
+
+  class Metrics
+    include BaseMetrics
+
+    def initialize(api_key:, host:, verbose:)
+      @api_key = api_key
+      @host = host
+      @verbose = verbose
+    end
+
+    def set(name, value)
+      puts "[LogDash] Setting metric #{name} to #{value}" if @verbose
+      send_metric_async(name, value, MetricOperation::SET)
+    end
+
+    def mutate(name, value)
+      puts "[LogDash] Mutating metric #{name} by #{value}" if @verbose
+      send_metric_async(name, value, MetricOperation::CHANGE)
+    end
+
+    private
+
+    def send_metric_async(name, value, operation)
+      return unless @api_key
+
+      Thread.new do
+        uri = URI.parse("#{@host}/metrics")
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = (uri.scheme == 'https')
+        http.open_timeout = 5
+        http.read_timeout = 5
+
+        request = Net::HTTP::Put.new(uri.request_uri)
+        request['Content-Type'] = 'application/json'
+        request['project-api-key'] = @api_key
+        request.body = {
+          name: name,
+          value: value,
+          operation: operation
+        }.to_json
+
+        response = http.request(request)
+        puts "[LogDash BG] Sent metric (#{name}, op: #{operation}), status: #{response.code}" if @verbose
+      rescue Net::OpenTimeout, Net::ReadTimeout => e
+        puts "[LogDash BG] Timeout sending metric (#{name}): #{e.message}" if @verbose
+      rescue StandardError => e
+        puts "[LogDash BG] Error sending metric (#{name}): #{e.message}" if @verbose
+      end
+    end
+  end
+
+  class NoopMetrics
+    include BaseMetrics
+
+    def set(key, value)
+      # No operation
+    end
+
+    def mutate(key, value)
+      # No operation
+    end
+  end
+end

data/lib/logdash/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Logdash
+  VERSION = '1.0.0'
+end

data/lib/logdash.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'logdash/client'
+require_relative 'logdash/version'
+require_relative 'logdash/logger'
+
+module Logdash
+  def self.create(api_key: nil, host: 'https://api.logdash.io', verbose: false)
+    Client.create(api_key: api_key, host: host, verbose: verbose)
+  end
+
+  def self.new_client(api_key: nil, host: 'https://api.logdash.io', verbose: false)
+    Client.new(api_key: api_key, host: host, verbose: verbose)
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: logdash
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- krzysztoff1
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.62'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.62'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.25'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby client to send logs and metrics to the LogDash.
+email:
+- hello@krzysztof.studio
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/logdash.rb
+- lib/logdash/client.rb
+- lib/logdash/http_log_sync.rb
+- lib/logdash/logger.rb
+- lib/logdash/metrics.rb
+- lib/logdash/version.rb
+homepage: https://logdash.io/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://logdash.io/
+  source_code_uri: https://github.com/logdash-io/ruby-sdk
+  changelog_uri: https://github.com/logdash-io/ruby-sdk/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+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.5.20
+signing_key:
+specification_version: 4
+summary: Ruby client for LogDash observability platform.
+test_files: []