logtail-rails 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36cc8a6525761e524273966307ac9a3ec250e797030ba959016f6a633b404076
-  data.tar.gz: c9a0c0999fcef3fcb8277a618ba5efe23c74cd257805205c3736a2ea9398174b
+  metadata.gz: 0ea78494f4dc7a43dd8898e76f16af5a6f97ed276a15cb8249337a4f3cf695f1
+  data.tar.gz: f65e846b9a01b66fd91712109d01d52462a528e847b0b1f3d2f11b26bb9b3142
 SHA512:
-  metadata.gz: 7a739ca51649acfba9dc3c49c1ff7105728fe43738d7c60fd566644eb9c73428bfeabb96a5fed3da44fba80ce98b3fc2a5dc8825028d7b5362e433a1d3022c77
-  data.tar.gz: 460aa9fe05000534e693b4dabefb4f19fcf8d967aa895ba7e475f94309b4291d20fd72c376ae2d190b9fcccc747c57ef318b0bf7c1d07a5ea06dfe9303827c5f
+  metadata.gz: 433ab451bc4287d63668e667c6a71b2c114653cf71153e2cab23b0f1515d38d1290c8637787318493e475207a12e99de886dcc5c6222bdf5e41379e682e08bc2
+  data.tar.gz: 2f1b9607a6d7e972a81d4d62754c395b8bfc0bdb302f06cfb6b8a60c909886c3661f0999015fa902d7a4dbfbf3c989c7809b8c4a5f0a93901e44fc7b4ba50783

data/README.md

@@ -1,10 +1,82 @@
-# 🪵 Logtail Integration For Rails
+# Logtail - Ruby on Rails Logging Made Easy
+  
+  [![Logtail ruby dashboard](https://user-images.githubusercontent.com/19272921/154085622-59997d5a-3f91-4bc9-a815-3b8ead16d28d.jpeg)](https://betterstack.com/logtail)
 
 [![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)
+[![Gem Version](https://badge.fury.io/rb/logtail-ruby.svg)](https://badge.fury.io/rb/logtail-ruby)
 [![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.
+Collect logs directly from your Ruby on Rails projects. To start logging Ruby projects explore the [Logtail Ruby library](https://github.com/logtail/logtail-ruby).
 
-* **Sign-up: [https://logtail.com](https://logtail.com)**
+[Logtail](https://betterstack.com/logtail) is a hosted service that centralizes all of your logs into one place. Allowing for analysis, correlation and filtering with SQL. Actionable Grafana dashboards and collaboration come built-in. Logtail works with [any language or platform and any data source](https://docs.logtail.com/). 
 
+### Features
+- Simple integration.
+- Support for structured logging and events.
+- Automatically captures useful context.
+- Performant, light weight, with a thoughtful design.
+
+### Supported language versions
+- Ruby 2.7.0 or newer Rails 6.1.4.2 or newer
+
+# Installation
+Install the Logtail Ruby on Rails client library, run the following command:
+
+```bash
+bundle add logtail-rails
+```
+
+Alternatively, add `gem "logtail-rails"` to your `Gemfile` manually and then run `bundle install`.
+
+---
+
+# Example project
+
+To help you get started with using Logtail in your Ruby on Rails projects, we have prepared a simple program that showcases the usage of Logtail logger.
+
+## Download and install the example project
+
+You can download the [example project](https://github.com/logtail/logtail-ruby-rails/tree/main/example-project) from GitHub directly or you can clone it to a select directory. Make sure you are in the projects directory and run the following command:
+
+```bash
+bundle install
+```
+
+This will install all dependencies listed in the `Gemfile.lock` file.
+
+Then run the following command to create the default config file:
+
+```bash
+bundle exec rake logtail:install source_token=SOURCE_TOKEN
+```
+
+*Don't forget to replace `SOURCE_TOKEN` with your actual source token which you can find by going to logtail.com -> sources -> edit.  This will generate config/initializers/logtail.rb.*
+
+ ## Run the example project
+ 
+ To run the example application, run the following command:
+
+```bash
+rails server
+```
+
+This will open a local server [127.0.0.1:3000.](http://127.0.0.1:3000/) On the main page, click the "Let's go!" button to generate test logs.
+
+You should see the following output:
+
+```bash
+All done!
+Log into your Logtail account to check your logs.
+```
+
+This will create a total of 6 different logs, each corresponding to a different log level and one with additional structured data. You can review these logs in Logtail.
+
+## Explore how example project works
+ 
+Learn how to setup Ruby logging by exploring the workings of the [example project](https://github.com/logtail/logtail-ruby-rails/tree/main/example-project) in detail. 
+ 
+---
+ 
+## Get in touch
+
+Have any questions? Please explore the Logtail [documentation](https://docs.logtail.com/) or contact our [support](https://betterstack.com/help).

data/example-project/Logtail-rails-main/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/example-project/Logtail-rails-main/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css

data/example-project/Logtail-rails-main/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS (and SCSS, if configured) file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/example-project/Logtail-rails-main/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/example-project/Logtail-rails-main/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/example-project/Logtail-rails-main/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/example-project/Logtail-rails-main/app/controllers/example_controller.rb

@@ -0,0 +1,35 @@
+class ExampleController < ApplicationController
+    # Index action
+    def index
+        send_logs_path = '/send_logs'
+    end
+
+    # The following action send example logs
+    def send_logs
+        # Sending logs using the Rails.logger
+
+        # Send debug logs messages using the debug() method
+        Rails.logger.debug("Hey! I am debuging!")
+
+        # Send informative messages about interesting events using the info() method
+        Rails.logger.info("You know what's interesting? Logtail !")
+
+        # Send messages about worrying events using the warn() method
+        Rails.logger.warn("Something might not be quite right...")
+
+        # Send error messages using the error() method
+        Rails.logger.error("Oops! Something went wrong.")
+
+        # Send messages about fatal events thet caused the app to crash using the fatal() method
+        Rails.logger.fatal("Application crashed! Needs to be fixed ASP!")
+
+        # You can also provide additional information when logging
+        Rails.logger.warn("log structured data",
+            name: {
+                first: "John",
+                last: "Smith"
+            },
+            id: 123456
+        )
+    end
+end

data/example-project/Logtail-rails-main/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/example-project/Logtail-rails-main/app/helpers/example_helper.rb

@@ -0,0 +1,2 @@
+module ExampleHelper
+end

data/example-project/Logtail-rails-main/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/example-project/Logtail-rails-main/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout "mailer"
+end

data/example-project/Logtail-rails-main/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+end

data/example-project/Logtail-rails-main/app/views/example/index.html.erb

@@ -0,0 +1,3 @@
+<h1>Hello from Logtail</h1>
+<p>Click the button below to send some example logs</p>
+<%= button_to "Let's go!", send_logs_path, method: :get %>

data/example-project/Logtail-rails-main/app/views/example/send_logs.html.erb

@@ -0,0 +1,4 @@
+<b>All done!</b>
+<p>
+ Log into your Logtail account to check your logs.
+</p>

data/example-project/Logtail-rails-main/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>LogtailExampleProject</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/example-project/Logtail-rails-main/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/example-project/Logtail-rails-main/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/example-project/Logtail-rails-main/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/example-project/Logtail-rails-main/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/example-project/Logtail-rails-main/bin/setup

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   FileUtils.cp "config/database.yml.sample", "config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system! "bin/rails db:prepare"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Restarting application server =="
+  system! "bin/rails restart"
+end

data/example-project/Logtail-rails-main/config/application.rb

@@ -0,0 +1,22 @@
+require_relative "boot"
+
+require "rails/all"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module LogtailExampleProject
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 7.0
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
+  end
+end

data/example-project/Logtail-rails-main/config/boot.rb

@@ -0,0 +1,4 @@
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "bundler/setup" # Set up gems listed in the Gemfile.
+require "bootsnap/setup" # Speed up boot time by caching expensive operations.

data/example-project/Logtail-rails-main/config/cable.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+
+test:
+  adapter: test
+
+production:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  channel_prefix: logtail_example_project_production

data/example-project/Logtail-rails-main/config/credentials.yml.enc

@@ -0,0 +1 @@
+/oo/MoIWYd/RzSBWDWV3JYZ4pYEOSE4xcZi6dGbLt+QwHfQ57XLx4JI0LtBoKgu3ngdmWN2wCo1g25Y9hUOrnashiibq2wPSxJ6AJ28vtEbZf9I/zlVqlXBoWcQf2zQby3EqJ1vu66QdPmi8DzKE+WrgDkdM/VEVB74O4SttiZnhXzOTI7AOOnHs4QrWD31z/mJvJ2ujQ8PqOgLqHDB7FdUZnaiKDcua1YufJuSTOSeMlsY4QbndHccPW1yk7/m2Hw+TwXO47eQ1wypJH4+wlgFf0M4dwL7so7iJo344gHfxgDbB7XsSjCuY03Hz+09Mn/chGh4Tph6v9cikmQTkjLVhOFMy2W2RwFAmtLiqBcInVUkGzDIB2IMacI+icjXFsZuCB5DldQeQ2F0c+2R48eAafbEa2kPPTkzC--zWoiSA3j0KBnrbHx--eQ+1lyd10SbjpZ144VEAXA==

data/example-project/Logtail-rails-main/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite. Versions 3.8.0 and up are supported.
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem "sqlite3"
+#
+default: &default
+  adapter: sqlite3
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/example-project/Logtail-rails-main/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative "application"
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/example-project/Logtail-rails-main/config/environments/development.rb

@@ -0,0 +1,70 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded any time
+  # it changes. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable server timing
+  config.server_timing = true
+
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join("tmp/caching-dev.txt").exist?
+    config.action_controller.perform_caching = true
+    config.action_controller.enable_fragment_cache_logging = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      "Cache-Control" => "public, max-age=#{2.days.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  config.active_storage.service = :local
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Highlight code that triggered database queries in logs.
+  config.active_record.verbose_query_logs = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+
+  # Uncomment if you wish to allow Action Cable access from any origin.
+  # config.action_cable.disable_request_forgery_protection = true
+end

data/example-project/Logtail-rails-main/config/environments/production.rb

@@ -0,0 +1,93 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
+  # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
+  # config.require_master_key = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.public_file_server.enabled = ENV["RAILS_SERVE_STATIC_FILES"].present?
+
+  # Compress CSS using a preprocessor.
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.asset_host = "http://assets.example.com"
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for Apache
+  # config.action_dispatch.x_sendfile_header = "X-Accel-Redirect" # for NGINX
+
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  config.active_storage.service = :local
+
+  # Mount Action Cable outside main process or domain.
+  # config.action_cable.mount_path = nil
+  # config.action_cable.url = "wss://example.com/cable"
+  # config.action_cable.allowed_request_origins = [ "http://example.com", /http:\/\/example.*/ ]
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Include generic and useful information about system operation, but avoid logging too much
+  # information to avoid inadvertent exposure of personally identifiable information (PII).
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  config.log_tags = [ :request_id ]
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Use a real queuing backend for Active Job (and separate queues per environment).
+  # config.active_job.queue_adapter     = :resque
+  # config.active_job.queue_name_prefix = "logtail_example_project_production"
+
+  config.action_mailer.perform_caching = false
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Don't log any deprecations.
+  config.active_support.report_deprecations = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Use a different logger for distributed setups.
+  # require "syslog/logger"
+  # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new "app-name")
+
+  if ENV["RAILS_LOG_TO_STDOUT"].present?
+    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger    = ActiveSupport::TaggedLogging.new(logger)
+  end
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end

data/example-project/Logtail-rails-main/config/environments/test.rb

@@ -0,0 +1,60 @@
+require "active_support/core_ext/integer/time"
+
+# The test environment is used exclusively to run your application's
+# test suite. You never need to work with it otherwise. Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs. Don't rely on the data there!
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Turn false under Spring and add config.action_view.cache_template_loading = true.
+  config.cache_classes = true
+
+  # Eager loading loads your whole application. When running a single test locally,
+  # this probably isn't necessary. It's a good idea to do in a continuous integration
+  # system, or in some way before deploying your code.
+  config.eager_load = ENV["CI"].present?
+
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    "Cache-Control" => "public, max-age=#{1.hour.to_i}"
+  }
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  config.cache_store = :null_store
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Store uploaded files on the local file system in a temporary directory.
+  config.active_storage.service = :test
+
+  config.action_mailer.perform_caching = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+end

data/example-project/Logtail-rails-main/config/initializers/assets.rb

@@ -0,0 +1,12 @@
+# Be sure to restart your server when you modify this file.
+
+# Version of your assets, change this if you want to expire all your assets.
+Rails.application.config.assets.version = "1.0"
+
+# Add additional assets to the asset load path.
+# Rails.application.config.assets.paths << Emoji.images_path
+
+# Precompile additional assets.
+# application.js, application.css, and all non-JS/CSS in the app/assets
+# folder are already added.
+# Rails.application.config.assets.precompile += %w( admin.js admin.css )

data/example-project/Logtail-rails-main/config/initializers/content_security_policy.rb

@@ -0,0 +1,26 @@
+# Be sure to restart your server when you modify this file.
+
+# Define an application-wide content security policy
+# For further information see the following documentation
+# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
+
+# Rails.application.configure do
+#   config.content_security_policy do |policy|
+#     policy.default_src :self, :https
+#     policy.font_src    :self, :https, :data
+#     policy.img_src     :self, :https, :data
+#     policy.object_src  :none
+#     policy.script_src  :self, :https
+#     policy.style_src   :self, :https
+#     # Specify URI for violation reports
+#     # policy.report_uri "/csp-violation-report-endpoint"
+#   end
+#
+#   # Generate session nonces for permitted importmap and inline scripts
+#   config.content_security_policy_nonce_generator = ->(request) { request.session.id.to_s }
+#   config.content_security_policy_nonce_directives = %w(script-src)
+#
+#   # Report CSP violations to a specified URI. See:
+#   # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy-Report-Only
+#   # config.content_security_policy_report_only = true
+# end

data/example-project/Logtail-rails-main/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure parameters to be filtered from the log file. Use this to limit dissemination of
+# sensitive information. See the ActiveSupport::ParameterFilter documentation for supported
+# notations and behaviors.
+Rails.application.config.filter_parameters += [
+  :passw, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn
+]

data/example-project/Logtail-rails-main/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, "\\1en"
+#   inflect.singular /^(ox)en/i, "\\1"
+#   inflect.irregular "person", "people"
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym "RESTful"
+# end

data/example-project/Logtail-rails-main/config/initializers/logtail.rb

@@ -0,0 +1,6 @@
+if ENV['LOGTAIL_SKIP_LOGS'].blank? && !Rails.env.test?
+  http_device = Logtail::LogDevices::HTTP.new('fKZJDFD11XoK693LdMTiQpuM')
+  Rails.logger = Logtail::Logger.new(http_device)
+else
+  Rails.logger = Logtail::Logger.new(STDOUT)
+end

data/example-project/Logtail-rails-main/config/initializers/permissions_policy.rb

@@ -0,0 +1,11 @@
+# Define an application-wide HTTP permissions policy. For further
+# information see https://developers.google.com/web/updates/2018/06/feature-policy
+#
+# Rails.application.config.permissions_policy do |f|
+#   f.camera      :none
+#   f.gyroscope   :none
+#   f.microphone  :none
+#   f.usb         :none
+#   f.fullscreen  :self
+#   f.payment     :self, "https://secure.example.com"
+# end

data/example-project/Logtail-rails-main/config/locales/en.yml

@@ -0,0 +1,33 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t "hello"
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t("hello") %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# The following keys must be escaped otherwise they will not be retrieved by
+# the default I18n backend:
+#
+# true, false, on, off, yes, no
+#
+# Instead, surround them with single quotes.
+#
+# en:
+#   "true": "foo"
+#
+# To learn more, please read the Rails Internationalization guide
+# available at https://guides.rubyonrails.org/i18n.html.
+
+en:
+  hello: "Hello world"

data/example-project/Logtail-rails-main/config/puma.rb

@@ -0,0 +1,43 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
+threads min_threads_count, max_threads_count
+
+# Specifies the `worker_timeout` threshold that Puma will use to wait before
+# terminating a worker in development environments.
+#
+worker_timeout 3600 if ENV.fetch("RAILS_ENV", "development") == "development"
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the `pidfile` that Puma will use.
+pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked web server processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!
+
+# Allow puma to be restarted by `bin/rails restart` command.
+plugin :tmp_restart

data/example-project/Logtail-rails-main/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+  # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
+  get '/send_logs', to: 'example#send_logs', as: 'send_logs'
+
+  # Defines the root path route ("/")
+  root 'example#index'  
+end

data/example-project/Logtail-rails-main/config/storage.yml

@@ -0,0 +1,34 @@
+test:
+  service: Disk
+  root: <%= Rails.root.join("tmp/storage") %>
+
+local:
+  service: Disk
+  root: <%= Rails.root.join("storage") %>
+
+# Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
+# amazon:
+#   service: S3
+#   access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+#   secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+#   region: us-east-1
+#   bucket: your_own_bucket-<%= Rails.env %>
+
+# Remember not to checkin your GCS keyfile to a repository
+# google:
+#   service: GCS
+#   project: your_project
+#   credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
+#   bucket: your_own_bucket-<%= Rails.env %>
+
+# Use bin/rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
+# microsoft:
+#   service: AzureStorage
+#   storage_account_name: your_account_name
+#   storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
+#   container: your_container_name-<%= Rails.env %>
+
+# mirror:
+#   service: Mirror
+#   primary: local
+#   mirrors: [ amazon, google, microsoft ]

data/example-project/Logtail-rails-main/config.ru

@@ -0,0 +1,6 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative "config/environment"
+
+run Rails.application
+Rails.application.load_server

data/example-project/Logtail-rails-main/test/application_system_test_case.rb

@@ -0,0 +1,5 @@
+require "test_helper"
+
+class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
+end

data/example-project/Logtail-rails-main/test/channels/application_cable/connection_test.rb

@@ -0,0 +1,11 @@
+require "test_helper"
+
+class ApplicationCable::ConnectionTest < ActionCable::Connection::TestCase
+  # test "connects with cookies" do
+  #   cookies.signed[:user_id] = 42
+  #
+  #   connect
+  #
+  #   assert_equal connection.user_id, "42"
+  # end
+end

data/example-project/Logtail-rails-main/test/controllers/example_controller_test.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class ExampleControllerTest < ActionDispatch::IntegrationTest
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/example-project/Logtail-rails-main/test/test_helper.rb

@@ -0,0 +1,13 @@
+ENV["RAILS_ENV"] ||= "test"
+require_relative "../config/environment"
+require "rails/test_help"
+
+class ActiveSupport::TestCase
+  # Run tests in parallel with specified workers
+  parallelize(workers: :number_of_processors)
+
+  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/example-project/README.md

@@ -0,0 +1,205 @@
+# Logtail Ruby on Rails example project
+
+To help you get started with using Logtail in your Ruby on Rails projects, we have prepared a simple program that showcases the usage of Logtail logger.
+
+## Download and install the example project
+You can download the example project from GitHub directly or you can clone it to a select directory. Make sure you are in the projects directory and run the following command:
+
+```bash
+bundle install
+```
+
+This will install all dependencies listed in the `Gemfile.lock` file.
+
+ ## Run the example project
+ 
+ To run the example application, run the following command:
+
+```bash
+rails server
+```
+
+This will open a local server [127.0.0.1:3000.](http://127.0.0.1:3000/) On the main page, click the "Let's go!" button to generate test logs.
+
+You should see the following output:
+
+```bash
+All done!
+Log into your Logtail account to check your logs.
+```
+
+This will create a total of 6 different logs, each corresponding to a different log level and one with additional structured data. You can review these logs in Logtail.
+
+# Logging
+
+To send logs to Logtail use the `Rails.logger` logger. It provides 5 logging methods for the 5 default log levels. The log levels and their method are:
+
+- **DEBUG** - Send debug messages using the `debug()` method
+- **INFO** - Send informative messages about the application progress using the `info()` method
+- **WARN** - Report non-critical issues using the `warn()` method
+- **ERROR** - Send messages about serious problems using the `error()` method
+- **FATAL** - Send messages about fatal events that caused the app to crash using the `fatal()` method
+
+## Logging example
+
+In this example, we will send two logs - **DEBUG** and **INFO**
+
+```ruby
+# Send debug logs messages using the debug() method
+Rails.logger.debug("Logtail is ready!")
+
+# Send informative messages about interesting events using the info() method
+Rails.logger.info("I am using Logtail!")
+```
+
+This will create the following output:
+
+```json
+{
+    "dt": "2021-03-29T11:24:54.788Z",
+    "level": "debug",
+    "message": "Logtail is ready!",
+    "context": {
+        "runtime": {
+            "thread_id": 123,
+            "file": "main.rb",
+            "line": 6,
+            "frame": null,
+            "frame_label": "<main>"
+        },
+        "system": {
+            "hostname": "hostname"
+            "pid": 1234
+        }
+    }
+}
+
+{
+    "dt": "2021-03-29T11:24:54.788Z",
+    "level": "info",
+    "message": "I am using Logtail!",
+    "context": {
+        "runtime": {
+            "thread_id": 123,
+            "file": "main.rb",
+            "line": 6,
+            "frame": null,
+            "frame_label": "<main>"
+        },
+        "system": {
+            "hostname": "hostname"
+            "pid": 1234
+        }
+    }
+}
+```
+
+## Log structured data
+
+You can also log additional structured data. This can help you provide additional information when debugging and troubleshooting your application. You can provide this data as the second argument to any logging method.
+
+```ruby
+# Send messages about worrying events using the warn() method
+# You can also log additional structured data
+Rails.logger.warn(
+    "log structured data",
+    item: {
+        url: "https://fictional-store.com/item-123",
+        price: 100.00
+    }
+)
+```
+
+This will create the following output:
+
+```json
+{
+    "dt": "2021-03-29T11:24:54.788Z",
+    "level": "warn",
+    "message": "log structured data",
+    "item": {
+        "url": "https://fictional-store.com/item-123",
+        "price": 100.00
+    },
+    "context": {
+        "runtime": {
+            "thread_id": 123,
+            "file": "main.rb",
+            "line": 7,            
+            "frame": null,
+            "frame_label": "<main>"
+        },
+        "system": {
+            "hostname": "hostname"
+            "pid": 1234
+        }
+    }
+}
+```
+
+## Context
+
+We add information about the current runtime environment and the current process into a `context` field of the logged item by default.
+
+If you want to add custom information to all logged items (e.g., the ID of the current user), you can do so by adding a custom context:
+
+```ruby
+# Provide context to the logs
+Logtail.with_context(user: { id: 123 }) do
+    Rails.logger.info('new subscription')
+end
+```
+
+This will generate the following JSON output:
+
+```json
+{
+    "dt": "2021-03-29T11:24:54.788Z",
+    "level": "warn",
+    "message": "new subscription",
+    "context": {
+        "runtime": {
+            "thread_id": 123456,
+            "file": "main.rb",
+            "line": 2,            
+            "frame": null,
+            "frame_label": "<main>"
+        },
+        "system": {
+            "hostname": "hostname"
+            "pid": 1234
+        },
+        "user": {
+            "id": 123
+        }
+    }
+}
+```
+
+We will automatically add the information about the current user to each log if you're using Ruby on Rails and the Devise gem.
+
+If you're not using Devise or you want to log some additional information for every request your Rails app handles, you can easily implement this using Rails' `around_action` in your application controller. A simple implementation could look like this:
+
+```ruby
+class ApplicationController < ActionController::Base
+  around_action :with_logtail_context
+
+  private
+
+    def with_logtail_context
+      if user_signed_in?
+        Logtail.with_context(user_context) { yield }
+      else
+        yield
+      end
+    end
+    
+    def user_context
+      Logtail::Contexts::User.new(
+        id: current_user.id,
+        name: current_user.name,
+        email: current_user.email
+      )
+    end
+end
+```

data/lib/logtail-rails/version.rb

@@ -1,7 +1,7 @@
 module Logtail
   module Integrations
     module Rails
-      VERSION = "0.1.6"
+      VERSION = "0.1.7"
     end
   end
 end

data/lib/logtail-rails.rb

@@ -1,7 +1,11 @@
 require "logtail-rails/overrides"
 
 require "logtail"
-require "rails"
+
+require "rails/railtie"
+require "active_record"
+require "rack"
+
 require "logtail-rails/active_support_log_subscriber"
 require "logtail-rails/config"
 require "logtail-rails/railtie"

data/logtail-rails.gemspec

@@ -29,7 +29,10 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "logtail", "~> 0.1"
   spec.add_runtime_dependency "logtail-rack", "~> 0.1"
-  spec.add_runtime_dependency "rails", ">= 3.0.0"
+
+  spec.add_runtime_dependency 'activerecord', '>= 3.0.0'
+  spec.add_runtime_dependency 'railties', '>= 3.0.0'
+  spec.add_runtime_dependency 'actionpack', '>= 3.0.0'
 
   spec.add_development_dependency "bundler", ">= 0.0"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logtail-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Logtail
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-02 00:00:00.000000000 Z
+date: 2022-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logtail
@@ -39,7 +39,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -192,6 +220,51 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- example-project/Logtail-rails-main/Rakefile
+- example-project/Logtail-rails-main/app/assets/config/manifest.js
+- example-project/Logtail-rails-main/app/assets/stylesheets/application.css
+- example-project/Logtail-rails-main/app/channels/application_cable/channel.rb
+- example-project/Logtail-rails-main/app/channels/application_cable/connection.rb
+- example-project/Logtail-rails-main/app/controllers/application_controller.rb
+- example-project/Logtail-rails-main/app/controllers/example_controller.rb
+- example-project/Logtail-rails-main/app/helpers/application_helper.rb
+- example-project/Logtail-rails-main/app/helpers/example_helper.rb
+- example-project/Logtail-rails-main/app/jobs/application_job.rb
+- example-project/Logtail-rails-main/app/mailers/application_mailer.rb
+- example-project/Logtail-rails-main/app/models/application_record.rb
+- example-project/Logtail-rails-main/app/views/example/index.html.erb
+- example-project/Logtail-rails-main/app/views/example/send_logs.html.erb
+- example-project/Logtail-rails-main/app/views/layouts/application.html.erb
+- example-project/Logtail-rails-main/app/views/layouts/mailer.html.erb
+- example-project/Logtail-rails-main/app/views/layouts/mailer.text.erb
+- example-project/Logtail-rails-main/bin/rails
+- example-project/Logtail-rails-main/bin/rake
+- example-project/Logtail-rails-main/bin/setup
+- example-project/Logtail-rails-main/config.ru
+- example-project/Logtail-rails-main/config/application.rb
+- example-project/Logtail-rails-main/config/boot.rb
+- example-project/Logtail-rails-main/config/cable.yml
+- example-project/Logtail-rails-main/config/credentials.yml.enc
+- example-project/Logtail-rails-main/config/database.yml
+- example-project/Logtail-rails-main/config/environment.rb
+- example-project/Logtail-rails-main/config/environments/development.rb
+- example-project/Logtail-rails-main/config/environments/production.rb
+- example-project/Logtail-rails-main/config/environments/test.rb
+- example-project/Logtail-rails-main/config/initializers/assets.rb
+- example-project/Logtail-rails-main/config/initializers/content_security_policy.rb
+- example-project/Logtail-rails-main/config/initializers/filter_parameter_logging.rb
+- example-project/Logtail-rails-main/config/initializers/inflections.rb
+- example-project/Logtail-rails-main/config/initializers/logtail.rb
+- example-project/Logtail-rails-main/config/initializers/permissions_policy.rb
+- example-project/Logtail-rails-main/config/locales/en.yml
+- example-project/Logtail-rails-main/config/puma.rb
+- example-project/Logtail-rails-main/config/routes.rb
+- example-project/Logtail-rails-main/config/storage.yml
+- example-project/Logtail-rails-main/test/application_system_test_case.rb
+- example-project/Logtail-rails-main/test/channels/application_cable/connection_test.rb
+- example-project/Logtail-rails-main/test/controllers/example_controller_test.rb
+- example-project/Logtail-rails-main/test/test_helper.rb
+- example-project/README.md
 - gemfiles/rails-3.0.gemfile
 - gemfiles/rails-3.1.gemfile
 - gemfiles/rails-3.2.gemfile
@@ -257,7 +330,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Logtail.com Rails integration