logtail-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5523213c7b76d65ee65d2cb78a7ae670bf08befe691a39d0e21314a213342026
+  data.tar.gz: 3a2ec12ce069f3dfb65486a77547ca8e2c43be313a4493067ea3f8df2d502db6
+SHA512:
+  metadata.gz: d6ff799030c337cf62811e4a29ecee47e3141f4c7870e9686fdb7f38b071ad758b4dcea6f05b5df44b78dd3fea4fd1c82643466e9a21e2fc445908b4e34e6259
+  data.tar.gz: 51157471d26432a6287f7ec4c3b3832609aa133fb36fa21939c8bd8a2b7f8ecd5d34100159fbbc9a129e32eb2cb8def110e11d9b938acd67ee450ee81a2ee512

data/.github/workflows/main.yml

@@ -0,0 +1,33 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-20.04
+
+    strategy:
+      matrix:
+        ruby-version:
+          - 3.0.0
+          - 2.7.2
+          - 2.6.6
+          - 2.5.8
+          - 2.4.10
+          - 2.3.8
+          - 2.2.10
+          - jruby-9.2.14.0
+          - truffleruby-21.0.0
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rspec --format documentation

data/.gitignore

@@ -0,0 +1,24 @@
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.DS_Store
+.rvmrc
+.ruby-version
+coverage
+Gemfile.lock
+*.swp
+*.gem
+
+Gemfile.lock
+gemfiles/*.lock
+
+/.bundle
+/.yardoc
+/doc
+/log
+/tmp
+/pkg

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order rand

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2021-02-11
+
+- The first version of the client.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in logtail-ruby.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE.md

@@ -0,0 +1,15 @@
+# License
+
+Copyright (c) 2016, Logtail
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+# 🪵 Logtail - Ruby Logging For Everyone
+
+[![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)
+[![Build Status](https://github.com/logtail/logtail-ruby/workflows/build/badge.svg)](https://github.com/logtail/logtail-ruby/actions?query=workflow%3Abuild)

data/Rakefile

@@ -0,0 +1,72 @@
+require "bundler/gem_tasks"
+require "logtail"
+
+def puts_with_level(message, level = :info)
+  case level
+  when :info
+    puts("\e[31m#{message}\e[0m")
+  when :error
+    puts("\e[31m#{message}\e[0m")
+  when :success
+    puts("\e[32m#{message}\e[0m")
+  else
+    puts(message)
+  end
+end
+
+task :test_the_pipes, [:api_key] do |t, args|
+  support_email = "support@logtail.com"
+  # Do not modify below this line. It's important to keep the `Logtail::Logger`
+  # because it provides an API for logging structured data and capturing context.
+  header = <<~HEREDOC
+    ### I want our own pixelart too, but no time for that for now ###
+  HEREDOC
+
+  puts header
+
+  current_context = Logtail::CurrentContext.instance.snapshot
+  entry = Logtail::LogEntry.new(:info, Time.now, nil, "Testing the pipes (click the inspect icon to view more details)", current_context, nil)
+  http_device = Logtail::LogDevices::HTTP.new(args.api_key, flush_continuously: false)
+  response = http_device.deliver_one(entry)
+  if response.is_a?(Exception)
+    message = <<~HEREDOC
+        Unable to deliver logs.
+        Here's what we received from the Logtail API:
+        #{response.inspect}
+        If you continue to have trouble please contact support:
+        #{support_email}
+    HEREDOC
+    puts_with_level(message, :error)
+  elsif response.is_a?(Net::HTTPResponse)
+    if response.code.start_with? '2'
+      puts_with_level("Logs successfully sent! View them at https://logtail.com",
+        :success)
+    else
+      message =
+        <<~HEREDOC
+        Unable to deliver logs.
+        We received a #{response.code} response from the Logtail API:
+        #{response.body.inspect}
+        If you continue to have trouble please contact support:
+        #{support_email}
+      HEREDOC
+      puts_with_level(message, :error)
+    end
+  end
+end
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'logtail'
+  $VERBOSE = nil
+
+  def reload!
+    files = $LOADED_FEATURES.select { |feat| feat =~ /\/logtail\// }
+    files.each { |file| load file }
+    "reloaded"
+  end
+
+  ARGV.clear
+  IRB.start
+end

data/lib/logtail.rb

@@ -0,0 +1,36 @@
+# Base (must come first, order matters)
+require "logtail/version"
+require "logtail/config"
+require "logtail/util"
+
+# Load frameworks
+
+# Other (sorted alphabetically)
+require "logtail/contexts"
+require "logtail/current_context"
+require "logtail/events"
+require "logtail/integration"
+require "logtail/log_devices"
+require "logtail/log_entry"
+require "logtail/logger"
+require "logtail/timer"
+require "logtail/integrator"
+require "logtail/integration"
+
+module Logtail
+  # Access the main configuration object. Please see {{Logtail::Config}} for more details.
+  def self.config
+    Config.instance
+  end
+
+  # Starts a timer for timing events. Please see {{Logtail::Logtail.start}} for more details.
+  def self.start_timer
+    Timer.start
+  end
+
+  # Adds context to all logs written within the passed block. Please see
+  # {{Logtail::CurrentContext.with}} for a more detailed description with examples.
+  def self.with_context(context, &block)
+    CurrentContext.with(context, &block)
+  end
+end

data/lib/logtail/config.rb

@@ -0,0 +1,154 @@
+require "logger"
+require "singleton"
+
+module Logtail
+  # Singleton class for reading and setting Logtail configuration.
+  #
+  # For Rails apps, this is installed into `config.logtail`. See examples below.
+  #
+  # @example Rails example
+  #   config.logtail.append_metadata = false
+  # @example Everything else
+  #   config = Logtail::Config.instance
+  #   config.append_metdata = false
+  class Config
+    # @private
+    class NoLoggerError < StandardError; end
+
+    # @private
+    class SimpleLogFormatter < ::Logger::Formatter
+      # This method is invoked when a log event occurs
+      def call(severity, timestamp, progname, msg)
+        "[Logtail] #{String === msg ? msg : msg.inspect}\n"
+      end
+    end
+
+    DEVELOPMENT_NAME = "development".freeze
+    PRODUCTION_NAME = "production".freeze
+    STAGING_NAME = "staging".freeze
+    TEST_NAME = "test".freeze
+
+    include Singleton
+
+    attr_writer :http_body_limit
+
+    # Convenience method for logging debug statements to the debug logger
+    # set in this class.
+    # @private
+    def debug(&block)
+      debug_logger = Config.instance.debug_logger
+      if debug_logger
+        message = yield
+        debug_logger.debug(message)
+      end
+      true
+    end
+
+    # This is useful for debugging. This Sets a debug_logger to view internal Logtail library
+    # log messages. The default is `nil`. Meaning log to nothing.
+    #
+    # See {#debug_to_file!} and {#debug_to_stdout!} for convenience methods that handle creating
+    # and setting the logger.
+    #
+    # @example Rails
+    #   config.logtail.debug_logger = ::Logger.new(STDOUT)
+    # @example Everything else
+    #   Logtail::Config.instance.debug_logger = ::Logger.new(STDOUT)
+    def debug_logger=(value)
+      @debug_logger = value
+    end
+
+    # Accessor method for {#debug_logger=}.
+    def debug_logger
+      @debug_logger
+    end
+
+    # A convenience method for writing internal Logtail debug messages to a file.
+    #
+    # @example Rails
+    #   config.Logtail.debug_to_file!("#{Rails.root}/log/logtail.log")
+    # @example Everything else
+    #   Logtail::Config.instance.debug_to_file!("log/logtail.log")
+    def debug_to_file!(file_path)
+      FileUtils.mkdir_p( File.dirname(file_path) )
+      file = File.open(file_path, "ab")
+      file_logger = ::Logger.new(file)
+      file_logger.formatter = SimpleLogFormatter.new
+      self.debug_logger = file_logger
+    end
+
+    # A convenience method for writing internal Logtail debug messages to STDOUT.
+    #
+    # @example Rails
+    #   config.logtail.debug_to_stdout!
+    # @example Everything else
+    #   Logtail::Config.instance.debug_to_stdout!
+    def debug_to_stdout!
+      stdout_logger = ::Logger.new(STDOUT)
+      stdout_logger.formatter = SimpleLogFormatter.new
+      self.debug_logger = stdout_logger
+    end
+
+    # The environment your app is running in. Defaults to `RACK_ENV` and `RAILS_ENV`.
+    # It should be rare that you have to set this. If the aforementioned env vars are not
+    # set please do.
+    #
+    # @example If you do not set `RACK_ENV` or `RAILS_ENV`
+    #   Logtail::Config.instance.environment = "staging"
+    def environment=(value)
+      @environment = value
+    end
+
+    # Accessor method for {#environment=}
+    def environment
+      @environment ||= ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
+    end
+
+    # Convenience method for accessing the various `Logtail::Integrations::*` class
+    # settings. These provides settings for enabling, disabled, and silencing integrations.
+    # See {Integrations} for a full list of available methods.
+    def integrations
+      Integrations
+    end
+
+    # This is the _main_ logger Logtail writes to. All of the Logtail integrations write to
+    # this logger instance. It should be set to your global logger. For Rails, this is set
+    # automatically to `Rails.logger`, you should not have to set this.
+    #
+    # @example Non-rails frameworks
+    #   my_global_logger = Logtail::Logger.new(STDOUT)
+    #   Logtail::Config.instance.logger = my_global_logger
+    def logger=(value)
+      @logger = value
+    end
+
+    # Accessor method for {#logger=}.
+    def logger
+      if @logger.is_a?(Proc)
+        @logger.call()
+      else
+        @logger ||= Logger.new(STDOUT)
+      end
+    end
+
+    # @private
+    def development?
+      environment == DEVELOPMENT_NAME
+    end
+
+    # @private
+    def test?
+      environment == TEST_NAME
+    end
+
+    # @private
+    def production?
+      environment == PRODUCTION_NAME
+    end
+
+    # @private
+    def staging?
+      environment == STAGING_NAME
+    end
+  end
+end

data/lib/logtail/config/integrations.rb

@@ -0,0 +1,17 @@
+module Logtail
+  class Config
+    # Convenience module for accessing the various `Logtail::Integrations::*` classes
+    # through the {Logtail::Config} object. Logtail couples configuration with the class
+    # responsible for implementing it. This provides for a tighter design, but also
+    # requires the user to understand and access the various classes. This module aims
+    # to provide a simple ruby-like configuration interface for internal Logtail classes.
+    #
+    # For example:
+    #
+    #     config = Logtail::Config.instance
+    #     config.integrations.active_record.silence = true
+    module Integrations
+      extend self
+    end
+  end
+end

data/lib/logtail/context.rb

@@ -0,0 +1,9 @@
+module Logtail
+  # Base class for all `Logtail::Contexts::*` classes.
+  # @private
+  class Context
+    def to_hash
+      raise(NotImplementedError.new)
+    end
+  end
+end

data/lib/logtail/contexts.rb

@@ -0,0 +1,12 @@
+require "logtail/contexts/http"
+require "logtail/contexts/release"
+require "logtail/contexts/runtime"
+require "logtail/contexts/session"
+require "logtail/contexts/system"
+require "logtail/contexts/user"
+
+module Logtail
+  # @private
+  module Contexts
+  end
+end

data/lib/logtail/contexts/http.rb

@@ -0,0 +1,31 @@
+require "logtail/context"
+
+module Logtail
+  module Contexts
+    # @private
+    class HTTP < Context
+      attr_reader :host, :method, :path, :remote_addr, :request_id
+
+      def initialize(attributes)
+        @host = attributes[:host]
+        @method = attributes[:method]
+        @path = attributes[:path]
+        @remote_addr = attributes[:remote_addr]
+        @request_id = attributes[:request_id]
+      end
+
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
+      def to_hash
+        @to_hash ||= {
+          http: Util::NonNilHashBuilder.build do |h|
+            h.add(:host, host)
+            h.add(:method, method)
+            h.add(:path, path)
+            h.add(:remote_addr, remote_addr)
+            h.add(:request_id, request_id)
+          end
+        }
+      end
+    end
+  end
+end