logtail-ruby 0.1.0

data/spec/logtail/log_entry_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe Logtail::LogEntry do
+  let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
+
+  describe "#to_msgpack" do
+    it "should encode properly with an event and context" do
+      event = {
+        message: "event_message",
+        event: {
+          event_type: {
+            a: 1
+          }
+        }
+      }
+      context = {custom: {a: "b"}}
+      log_entry = described_class.new("INFO", time, nil, "log message", context, event)
+      msgpack = log_entry.to_msgpack
+      expect(msgpack).to start_with("\x85\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z".force_encoding("ASCII-8BIT"))
+    end
+  end
+end

data/spec/logtail/logger_spec.rb

@@ -0,0 +1,227 @@
+require "spec_helper"
+
+describe Logtail::Logger do
+  describe "#initialize" do
+    it "shoud select the augmented formatter" do
+      logger = described_class.new(nil)
+      expect(logger.formatter).to be_kind_of(Logtail::Logger::JSONFormatter)
+    end
+
+    context "development environment" do
+      around(:each) do |example|
+        old_env = Logtail::Config.instance.environment
+        Logtail::Config.instance.environment = "development"
+        example.run
+        Logtail::Config.instance.environment = old_env
+      end
+
+      it "shoud select the message only formatter" do
+        logger = described_class.new(nil)
+        expect(logger.formatter).to be_kind_of(Logtail::Logger::MessageOnlyFormatter)
+      end
+    end
+
+    it "should allow multiple io devices" do
+      io1 = StringIO.new
+      io2 = StringIO.new
+      logger = Logtail::Logger.new(io1, io2)
+      logger.info("hello world")
+      expect(io1.string).to include("hello world")
+      expect(io2.string).to include("hello world")
+    end
+
+    it "should allow multiple io devices and loggers" do
+      io1 = StringIO.new
+      io2 = StringIO.new
+      io3 = StringIO.new
+      extra_logger = ::Logger.new(io3)
+      logger = Logtail::Logger.new(io1, io2, extra_logger)
+      logger.info("hello world")
+      expect(io1.string).to include("hello world")
+      expect(io2.string).to include("hello world")
+      expect(io3.string).to end_with("hello world\n")
+    end
+  end
+
+  describe "#add" do
+    let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
+    let(:io) { StringIO.new }
+    let(:logger) { Logtail::Logger.new(io) }
+
+    around(:each) do |example|
+      Timecop.freeze(time) { example.run }
+    end
+
+    it "should respect the level via Logger constants" do
+      logger.formatter = Logtail::Logger::MessageOnlyFormatter.new
+
+      logger.level = ::Logger::DEBUG
+      logger.info("message")
+      expect(io.string).to eq("message\n")
+
+      io.string = ""
+      logger.level = ::Logger::WARN
+      logger.info("message")
+      expect(io.string).to eq("")
+    end
+
+    it "should respect the level via level symbols" do
+      logger.formatter = Logtail::Logger::MessageOnlyFormatter.new
+
+      logger.level = :debug
+      logger.info("message")
+      expect(io.string).to eq("message\n")
+
+      io.string = ""
+      logger.level = :warn
+      logger.info("message")
+      expect(io.string).to eq("")
+    end
+
+    context "with the AugmentedFormatter" do
+      before(:each) { logger.formatter = Logtail::Logger::AugmentedFormatter.new }
+
+      it "should accept strings" do
+        logger.info("this is a test")
+        expect(io.string).to start_with("this is a test @metadata {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\"")
+      end
+
+      it "should accept non-strings" do
+        logger.info(true)
+        expect(io.string).to include("true")
+      end
+
+      context "with a context" do
+        let(:http_context) do
+          Logtail::Contexts::HTTP.new(
+            method: "POST",
+            path: "/checkout",
+            remote_addr: "123.456.789.10",
+            request_id: "abcd1234"
+          )
+        end
+
+        before(:each) do |example|
+          Logtail::CurrentContext.add(http_context)
+        end
+        after(:each) do |example|
+          Logtail::CurrentContext.remove(:http)
+        end
+
+        it "should snapshot and include the context" do
+          expect(Logtail::CurrentContext.instance).to receive(:snapshot).and_call_original
+          logger.info("this is a test")
+          expect(io.string).to start_with("this is a test @metadata {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\"")
+          expect(io.string).to include("\"http\":{\"method\":\"POST\",\"path\":\"/checkout\",\"remote_addr\":\"123.456.789.10\",\"request_id\":\"abcd1234\"}")
+        end
+      end
+
+      it "should pass hash as metadata" do
+        message = {message: "payment rejected", payment_rejected: {customer_id: "abcde1234", amount: 100}}
+        logger.info(message)
+        expect(io.string).to start_with("payment rejected @metadata {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",")
+        expect(io.string).to include("\"payment_rejected\":{\"customer_id\":\"abcde1234\",\"amount\":100}")
+      end
+
+      it "should allow :tag" do
+        logger.info("event complete", tag: "tag1")
+        expect(io.string).to include("\"tags\":[\"tag1\"]")
+      end
+
+      it "should allow :tags" do
+        tags = ["tag1", "tag2"]
+        logger.info("event complete", tags: tags)
+        expect(io.string).to include("\"tags\":[\"tag1\",\"tag2\"]")
+
+        # Ensure the tags object is not modified
+        expect(tags).to eq(["tag1", "tag2"])
+      end
+
+      it "should allow functions" do
+        logger.info do
+          {message: "payment rejected", payment_rejected: {customer_id: "abcde1234", amount: 100}}
+        end
+        expect(io.string).to start_with("payment rejected @metadata {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",")
+        expect(io.string).to include("\"payment_rejected\":{\"customer_id\":\"abcde1234\",\"amount\":100}")
+      end
+
+      it "should escape new lines" do
+        logger.info "first\nsecond"
+        expect(io.string).to start_with("first\\nsecond @metadata")
+      end
+    end
+
+    context "with the JSONFormatter" do
+      before(:each) { logger.formatter = Logtail::Logger::JSONFormatter.new }
+
+      it "should log in the correct format" do
+        logger.info("this is a test")
+        expect(io.string).to start_with("{\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",\"message\":\"this is a test\"")
+      end
+    end
+
+    context "with the HTTP log device" do
+      let(:io) { Logtail::LogDevices::HTTP.new("my_key") }
+
+      it "should use the PassThroughFormatter" do
+        expect(logger.formatter).to be_kind_of(Logtail::Logger::PassThroughFormatter)
+      end
+    end
+  end
+
+  describe "#error" do
+    let(:io) { StringIO.new }
+    let(:logger) { Logtail::Logger.new(io) }
+
+    it "should allow default usage" do
+      logger.error("log message")
+      expect(io.string).to include("log message")
+      expect(io.string).to include('"level":"error"')
+    end
+
+    it "should allow messages with options" do
+      logger.error("log message", tag: "tag")
+      expect(io.string).to include("log message")
+      expect(io.string).to include('"level":"error"')
+      expect(io.string).to include('"tags":["tag"]')
+    end
+  end
+
+  describe "#formatter=" do
+    it "should not allow changing the formatter when the device is HTTP" do
+      http_device = Logtail::LogDevices::HTTP.new("api_key")
+      logger = Logtail::Logger.new(http_device)
+      expect { logger.formatter = ::Logger::Formatter.new }.to raise_error(ArgumentError)
+    end
+
+    it "should set the formatter" do
+      logger = Logtail::Logger.new(STDOUT)
+      formatter = ::Logger::Formatter.new
+      logger.formatter = formatter
+      expect(logger.formatter).to eq(formatter)
+    end
+  end
+
+  describe "#info" do
+    let(:io) { StringIO.new }
+    let(:logger) { Logtail::Logger.new(io) }
+
+    it "should allow default usage" do
+      logger.info("log message")
+      expect(io.string).to include("log message")
+      expect(io.string).to include('"level":"info"')
+    end
+
+    it "should allow messages with options" do
+      logger.info("log message", tag: "tag")
+      expect(io.string).to include("log message")
+      expect(io.string).to include('"level":"info"')
+      expect(io.string).to include('"tags":["tag"]')
+    end
+
+    it "should accept non-string messages" do
+      logger.info(true)
+      expect(io.string).to include("true")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# Base
+require 'rubygems'
+require 'bundler/setup'
+
+# Testing
+require 'rspec'
+require 'rspec/its'
+require 'rspec/mocks'
+
+# Support files, order is relevant
+require File.join(File.dirname(__FILE__), 'support', 'socket_hostname')
+require File.join(File.dirname(__FILE__), 'support', 'timecop')
+require File.join(File.dirname(__FILE__), 'support', 'webmock')
+require File.join(File.dirname(__FILE__), 'support', 'logtail')
+
+RSpec::Support::ObjectFormatter.default_instance.max_formatted_output_length = 5_000
+
+RSpec.configure do |config|
+  config.color = true
+  config.order = :random
+  config.warnings = false
+end

data/spec/support/logtail.rb

@@ -0,0 +1,5 @@
+require "logtail"
+require "logtail/config"
+
+config = Logtail::Config.instance
+config.environment = "production"

data/spec/support/socket_hostname.rb

@@ -0,0 +1,12 @@
+require "socket"
+
+# Stub out the hostname for tests only. This can't use a normal stub in the
+# test life cycle since our test rails app is loaded once upon initialization.
+# In other words, the rails app gets loaded with the server context inserted
+# before any tests are run.
+
+class ::Socket
+  def self.gethostname
+    "computer-name.domain.com"
+  end
+end

data/spec/support/timecop.rb

@@ -0,0 +1,3 @@
+require 'timecop'
+
+Timecop.safe_mode = true

data/spec/support/webmock.rb

@@ -0,0 +1,3 @@
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: logtail-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Logtail
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  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: rails_stdout_logging
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: 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: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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:
+email:
+- hi@logtail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/logtail.rb
+- lib/logtail/config.rb
+- lib/logtail/config/integrations.rb
+- lib/logtail/context.rb
+- lib/logtail/contexts.rb
+- lib/logtail/contexts/http.rb
+- lib/logtail/contexts/release.rb
+- lib/logtail/contexts/runtime.rb
+- lib/logtail/contexts/session.rb
+- lib/logtail/contexts/system.rb
+- lib/logtail/contexts/user.rb
+- lib/logtail/current_context.rb
+- lib/logtail/event.rb
+- lib/logtail/events.rb
+- lib/logtail/events/controller_call.rb
+- lib/logtail/events/error.rb
+- lib/logtail/events/exception.rb
+- lib/logtail/events/sql_query.rb
+- lib/logtail/events/template_render.rb
+- lib/logtail/integration.rb
+- lib/logtail/integrator.rb
+- lib/logtail/log_devices.rb
+- lib/logtail/log_devices/http.rb
+- lib/logtail/log_devices/http/flushable_dropping_sized_queue.rb
+- lib/logtail/log_devices/http/request_attempt.rb
+- lib/logtail/log_entry.rb
+- lib/logtail/logger.rb
+- lib/logtail/logtail.rb
+- lib/logtail/timer.rb
+- lib/logtail/util.rb
+- lib/logtail/util/non_nil_hash_builder.rb
+- lib/logtail/version.rb
+- logtail-ruby.gemspec
+- spec/README.md
+- spec/logtail/current_context_spec.rb
+- spec/logtail/events/controller_call_spec.rb
+- spec/logtail/events/error_spec.rb
+- spec/logtail/log_devices/http_spec.rb
+- spec/logtail/log_entry_spec.rb
+- spec/logtail/logger_spec.rb
+- spec/spec_helper.rb
+- spec/support/logtail.rb
+- spec/support/socket_hostname.rb
+- spec/support/timecop.rb
+- spec/support/webmock.rb
+homepage: https://github.com/logtail/logtail-ruby
+licenses:
+- ISC
+metadata:
+  bug_tracker_uri: https://github.com/logtail/logtail-ruby/issues
+  changelog_uri: https://github.com/logtail/logtail-ruby/tree/master/CHANGELOG.md
+  homepage_uri: https://github.com/logtail/logtail-ruby
+  source_code_uri: https://github.com/logtail/logtail-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Query logs like you query your database. https://logtail.com
+test_files:
+- spec/README.md
+- spec/logtail/current_context_spec.rb
+- spec/logtail/events/controller_call_spec.rb
+- spec/logtail/events/error_spec.rb
+- spec/logtail/log_devices/http_spec.rb
+- spec/logtail/log_entry_spec.rb
+- spec/logtail/logger_spec.rb
+- spec/spec_helper.rb
+- spec/support/logtail.rb
+- spec/support/socket_hostname.rb
+- spec/support/timecop.rb
+- spec/support/webmock.rb