logtail-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb92429187fc50aa6622a0cc2cccf5d177819012e62a2fb952a8dd587ee2fb55
+  data.tar.gz: 4afe93789eac96a479ecfa54ca99752936bf2387bd17f0699254fa8ecef62cc0
+SHA512:
+  metadata.gz: c5be83553b8850cb86ae68858862ec1d5055a7fd8d07f310764e8da66fe0752a1deaa7d4459c04436b238351e9e4a9fd801ef93dcd751d4d7c35a2ff8d131b52
+  data.tar.gz: 483a2803fd7a1d1fe9bb9a4f078161ac4236439dd2caa376859a94eeb0a7b996e035a620d96e3b98a9e003209b912bc0e6812da6f7f0698bbb54ed59cf9638e7

data/.github/workflows/main.yml

@@ -0,0 +1,144 @@
+name: build
+
+on: [ push, pull_request ]
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+
+    strategy:
+      fail-fast: false
+
+      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
+        gemfile:
+          - rails-edge
+          - rails-6.1
+          - rails-6.0
+          - rails-5.2
+          - rails-5.1
+          - rails-5.0
+        exclude:
+          - gemfile: rails-edge
+            ruby-version: 2.6.6
+          - gemfile: rails-edge
+            ruby-version: 2.5.8
+          - gemfile: rails-edge
+            ruby-version: 2.4.10
+          - gemfile: rails-edge
+            ruby-version: 2.3.8
+          - gemfile: rails-edge
+            ruby-version: 2.2.10
+          - gemfile: rails-edge
+            ruby-version: jruby-9.2.14.0
+          - gemfile: rails-edge
+            ruby-version: truffleruby-21.0.0
+
+          - ruby-version: 3.0.0
+            gemfile: rails-5.2
+          - ruby-version: 3.0.0
+            gemfile: rails-5.1
+          - ruby-version: 3.0.0
+            gemfile: rails-5.0
+
+          - gemfile: rails-6.1
+            ruby-version: 2.4.10
+          - gemfile: rails-6.1
+            ruby-version: 2.3.8
+          - gemfile: rails-6.1
+            ruby-version: 2.2.10
+          - gemfile: rails-6.1
+            ruby-version: 2.2.10
+
+          - gemfile: rails-6.0
+            ruby-version: 2.4.10
+          - gemfile: rails-6.0
+            ruby-version: 2.3.8
+          - gemfile: rails-6.0
+            ruby-version: 2.2.10
+
+          - gemfile: rails-5.2
+            ruby-version: 2.2.10
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+      RAILS_ENV: test
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Selected Gemfile
+        run: echo $BUNDLE_GEMFILE
+
+      - 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
+
+
+  test_bundler_v1:
+    runs-on: ubuntu-20.04
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        ruby-version:
+          - 2.6.6
+          - 2.5.8
+          - 2.4.10
+          - 2.3.8
+          - 2.2.10
+        gemfile:
+          - rails-4.2
+          - rails-4.1
+          - rails-4.0
+          - rails-3.2
+
+        exclude:
+          - gemfile: rails-4.1
+            ruby-version: 2.6.6
+          - gemfile: rails-4.1
+            ruby-version: 2.5.8
+          - gemfile: rails-4.1
+            ruby-version: 2.4.10
+
+          - gemfile: rails-4.0
+            ruby-version: 2.6.6
+          - gemfile: rails-4.0
+            ruby-version: 2.5.8
+          - gemfile: rails-4.0
+            ruby-version: 2.4.10
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+      RAILS_ENV: test
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Selected Gemfile
+        run: echo $BUNDLE_GEMFILE
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler: 1.17
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rspec --format documentation

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,13 @@
+# License
+
+Copyright (c) 2021, 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,10 @@
+# 🪵 Logtail Integration For Rails
+
+[![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)
+[![Build Status](https://github.com/logtail/logtail-ruby-rails/workflows/build/badge.svg)](https://github.com/logtail/logtail-ruby-rails/actions?query=workflow%3Abuild)
+
+This library integrates the [`logtail` Ruby library](https://github.com/logtail/logtail-ruby) with
+the [rails](https://github.com/rails/rails) framework, turning your rails logs into rich structured events.
+
+* **Sign-up: [https://logtail.com](https://logtail.com)**
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/gemfiles/rails-3.0.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 3.0.0'
+
+gem 'logtail-ruby'
+gem 'logtail-rack'
+
+gemspec :path => '../'

data/gemfiles/rails-3.1.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 3.1.0'
+
+gem 'logtail-ruby'
+gem 'logtail-rack'
+
+gemspec :path => '../'

data/gemfiles/rails-3.2.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 3.2.0'
+
+gem 'logtail-ruby'
+gem 'logtail-rack'
+
+gemspec :path => '../'

data/gemfiles/rails-4.0.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.0.0'
+
+gem 'logtail-ruby'
+gem 'logtail-rack'
+
+if RUBY_PLATFORM == "java"
+  gem 'mime-types', '2.6.2'
+end
+
+gemspec :path => '../'

data/gemfiles/rails-4.1.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.1.0'
+
+gem 'logtail-ruby'
+gem 'logtail-rack'
+
+if RUBY_PLATFORM == "java"
+  gem 'mime-types', '2.6.2'
+end
+
+gemspec :path => '../'

data/gemfiles/rails-4.2.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.2.0'
+
+gem 'logtail-ruby'
+gem 'logtail-rack'
+
+if RUBY_PLATFORM == "java"
+  gem 'mime-types', '2.6.2'
+end
+
+gemspec :path => '../'

data/gemfiles/rails-5.0.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.0.0'
+
+gem 'logtail-ruby'
+gem 'logtail-rack'
+
+if RUBY_PLATFORM == "java"
+  gem 'mime-types', '2.6.2'
+end
+
+gemspec :path => '../'

data/gemfiles/rails-5.1.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.1.0'
+
+gem 'logtail-ruby'
+gem 'logtail-rack'
+
+if RUBY_PLATFORM == "java"
+  gem 'mime-types', '2.6.2'
+end
+
+gemspec :path => '../'

data/gemfiles/rails-5.2.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.2.0'
+
+gem 'logtail-ruby'
+gem 'logtail-rack'
+
+if RUBY_PLATFORM == "java"
+  gem 'mime-types', '2.6.2'
+end
+
+gemspec :path => '../'

data/gemfiles/rails-6.0.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 6.0.0'
+
+gem 'logtail-ruby'
+gem 'logtail-rack'
+
+if RUBY_PLATFORM == "java"
+  gem 'mime-types', '2.6.2'
+end
+
+gemspec :path => '../'

data/gemfiles/rails-6.1.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 6.1.0'
+
+gem 'logtail-ruby'
+gem 'logtail-rack'
+
+if RUBY_PLATFORM == "java"
+  gem 'mime-types', '2.6.2'
+end
+
+gemspec :path => '../'

data/gemfiles/rails-edge.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'rack', git: 'https://github.com/rack/rack', branch: 'master'
+gem 'arel', git: 'https://github.com/rails/arel', branch: 'master'
+gem 'rails', git: 'https://github.com/rails/rails', branch: 'main'
+
+gem 'logtail-ruby'
+gem 'logtail-rack'
+
+gemspec :path => '../'

data/lib/logtail-rails.rb

@@ -0,0 +1,64 @@
+require "logtail-rails/overrides"
+
+require "logtail"
+require "rails"
+require "logtail-rails/active_support_log_subscriber"
+require "logtail-rails/config"
+require "logtail-rails/railtie"
+
+require "logtail-rack/http_context"
+require "logtail-rack/http_events"
+require "logtail-rack/user_context"
+require "logtail-rails/session_context"
+require "logtail-rails/rack_logger"
+require "logtail-rails/error_event"
+
+require "logtail-rails/action_controller"
+require "logtail-rails/action_dispatch"
+require "logtail-rails/action_view"
+require "logtail-rails/active_record"
+
+require "logtail-rails/logger"
+
+module Logtail
+  module Integrations
+    # Module for holding *all* Rails integrations. This module does *not*
+    # extend {Integration} because it's dependent on {Rack::HTTPEvents}. This
+    # module simply disables the default HTTP request logging.
+    module Rails
+      def self.enabled?
+        Logtail::Integrations::Rack::HTTPEvents.enabled?
+      end
+
+      def self.integrate!
+        return false if !enabled?
+
+        ActionController.integrate!
+        ActionDispatch.integrate!
+        ActionView.integrate!
+        ActiveRecord.integrate!
+        RackLogger.integrate!
+      end
+
+      def self.enabled=(value)
+        Logtail::Integrations::Rails::ErrorEvent.enabled = value
+        Logtail::Integrations::Rack::HTTPContext.enabled = value
+        Logtail::Integrations::Rack::HTTPEvents.enabled = value
+        Logtail::Integrations::Rack::UserContext.enabled = value
+        SessionContext.enabled = value
+
+        ActionController.enabled = value
+        ActionView.enabled = value
+        ActiveRecord.enabled = value
+      end
+
+      # All enabled middlewares. The order is relevant. Middlewares that set
+      # context are added first so that context is included in subsequent log lines.
+      def self.middlewares
+        @middlewares ||= [Logtail::Integrations::Rack::HTTPContext, SessionContext, Logtail::Integrations::Rack::UserContext,
+          Logtail::Integrations::Rack::HTTPEvents, Logtail::Integrations::Rails::ErrorEvent].select(&:enabled?)
+      end
+    end
+  end
+end
+