faultline-rails 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 220502edbdb1e99c681f01b719d8f2987c6c18fef9e45bccd9a67bb98a17483f
+  data.tar.gz: a20654cfb53fec6a6778e9e0f8ca7c698ab210fc0aa07b4a78e1950f9ec0a270
+SHA512:
+  metadata.gz: 061df31c39e8a80be6ce09f3039d432ca44ba66470ca5c91c2c83a12a006332792eab3e088de0ab56b1e6ede23c0077f883a5195d0f3b50c3d2e7cace7143b0f
+  data.tar.gz: 5e23e10e12fea737bf89934a5a2bcf09cf11ca0fd0241cbcd7c64bef5ef7a58f7537e29faf1b55ac6c749fc182bd696393decd9219ca6051cc510e6fafbd81f5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Tamiru Hailu
+
+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,179 @@
+# Faultline Rails
+
+Faultline is a production-friendly exception dashboard for Rails 8. It records unhandled application exceptions and gives your team a fast, searchable view of messages, requests, environments, and backtraces.
+
+The dashboard is server-rendered and progressively enhanced with:
+
+- Turbo Frames for filtering and opening exception details without full-page navigation.
+- Turbo Streams for deleting one, many, or all exceptions.
+- Stimulus for loading state and small interaction behavior.
+- Tailwind-compatible utility classes for a responsive dashboard UI.
+
+## Requirements
+
+- Ruby 3.2 or newer
+- Rails 8.0 or newer
+- A database supported by Active Record
+
+## Installation
+
+Add Faultline to your application:
+
+```ruby
+# Gemfile
+gem "faultline-rails"
+```
+
+Install the dependencies and copy the engine migration:
+
+```bash
+bundle install
+bin/rails app:faultline:install:migrations
+bin/rails db:migrate
+```
+
+Mount the dashboard in your application:
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  mount Faultline::Engine => "/faultline"
+end
+```
+
+The dashboard is now available at `/faultline`.
+
+## Start logging exceptions
+
+Include `Faultline::ExceptionLoggable` in your application controller:
+
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  include Faultline::ExceptionLoggable
+end
+```
+
+Faultline logs the exception and then re-raises it so Rails keeps its normal error handling, status codes, and error pages.
+
+## Protect the dashboard
+
+The dashboard contains sensitive information, including request parameters, environment variables, and source paths. Do not expose it to unauthenticated public users.
+
+Attach your application's authorization callback:
+
+```ruby
+# config/initializers/faultline.rb
+Rails.application.config.to_prepare do
+  Faultline::LoggedExceptionsController.before_action :require_admin!
+end
+```
+
+Replace `require_admin!` with the authentication method provided by your application. You can also configure a policy, basic authentication, or an internal-only route at the host application level.
+
+## Rails 8 frontend setup
+
+Faultline includes `turbo-rails` and `stimulus-rails` as dependencies. Install the host application's Hotwire entry points when needed:
+
+```bash
+bin/rails turbo:install
+bin/rails stimulus:install
+```
+
+The default Rails 8 import-map setup will load Faultline's Stimulus controller through the engine asset pipeline. If your application uses a JavaScript bundler, register the controller from `app/javascript/controllers/faultline_controller.js` in your Stimulus application:
+
+```javascript
+import FaultlineController from "./faultline_controller"
+
+application.register("faultline", FaultlineController)
+```
+
+## Tailwind setup
+
+Faultline's dashboard uses Tailwind utility classes. Add the gem's view directory to the sources scanned by your Tailwind build; otherwise the host application will purge the dashboard classes.
+
+For Tailwind CSS v4, add a source entry to the application's Tailwind stylesheet. Use the absolute path returned by Bundler for the installed gem:
+
+```css
+@import "tailwindcss";
+@source "/absolute/path/to/faultline-rails/app/views";
+```
+
+For Tailwind CSS v3, add the gem path to `content` in `tailwind.config.js`:
+
+```javascript
+const faultlinePath = "/absolute/path/to/faultline-rails"
+
+module.exports = {
+  content: [
+    "./app/views/**/*.{erb,html}",
+    `${faultlinePath}/app/views/**/*.html.erb`
+  ]
+}
+```
+
+You can find the installed path with:
+
+```bash
+bundle show faultline-rails
+```
+
+## Configuration
+
+Set a title for the dashboard and attach additional application data to each record:
+
+```ruby
+# config/initializers/faultline.rb
+Rails.application.config.to_prepare do
+  Faultline::LoggedExceptionsController.application_name = "Acme"
+
+  ApplicationController.exception_data = lambda do |controller|
+    {
+      request_id: controller.request.request_id,
+      user_id: controller.current_user&.id
+    }
+  end
+end
+```
+
+Exclude trusted private networks from the dashboard's local-request handling:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Faultline::ExceptionLoggable
+
+  consider_local "10.0.0.0/8", "192.168.0.0/16"
+end
+```
+
+Rails' `filter_parameters` configuration is respected before request parameters are stored.
+
+## Dashboard features
+
+- Search exception messages.
+- Filter by exception class, controller/action, or age.
+- Open full exception details in a Turbo Frame.
+- Delete individual exceptions without leaving the page.
+- Delete the currently visible result set.
+- Clear the complete history.
+- Subscribe to the RSS feed at `/faultline/logged_exceptions/feed.rss`.
+
+## Data storage
+
+The engine creates a `faultline_logged_exceptions` table containing the exception class, controller/action, message, backtrace, request, environment, user information, user agent, remote IP, and timestamps.
+
+Exception records can contain secrets. Apply your normal database encryption, retention, backup, and access-control policies.
+
+## Development
+
+Run the test suite with:
+
+```bash
+bin/rails test
+```
+
+The repository includes a Rails dummy application under `test/dummy` for engine integration testing.
+
+## License
+
+Faultline Rails is released under the [MIT License](MIT-LICENSE).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/faultline_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../stylesheets/faultline .css
+//= link_directory ../javascripts/faultline .js

data/app/assets/javascripts/faultline/application.js

@@ -0,0 +1,42 @@
+class FaultlineController {
+  static targets = ["activity"]
+
+  connect() {
+    this.showActivity = this.showActivity.bind(this)
+    this.hideActivity = this.hideActivity.bind(this)
+
+    document.addEventListener("turbo:before-fetch-request", this.showActivity)
+    document.addEventListener("turbo:before-fetch-response", this.hideActivity)
+    document.addEventListener("turbo:submit-end", this.hideActivity)
+  }
+
+  disconnect() {
+    document.removeEventListener("turbo:before-fetch-request", this.showActivity)
+    document.removeEventListener("turbo:before-fetch-response", this.hideActivity)
+    document.removeEventListener("turbo:submit-end", this.hideActivity)
+  }
+
+  submit() {
+    this.showActivity()
+  }
+
+  showActivity() {
+    this.activityTarget?.classList.remove("hidden")
+  }
+
+  hideActivity() {
+    this.activityTarget?.classList.add("hidden")
+  }
+
+  closeDetails(event) {
+    event.preventDefault()
+    const details = document.getElementById("exception-details")
+    if (details) details.innerHTML = ""
+  }
+}
+
+if (window.Stimulus) {
+  window.Stimulus.register("faultline", FaultlineController)
+}
+
+export default FaultlineController

data/app/assets/stylesheets/faultline/application.css

@@ -0,0 +1,33 @@
+/*
+ * Faultline's views use Tailwind utility classes. Add the gem's view path to
+ * the host application's Tailwind sources so those classes are compiled.
+ *
+ * This small fallback keeps will_paginate usable when a host app has not yet
+ * added Tailwind's pagination styles.
+ */
+.faultline-pagination .pagination {
+  display: flex;
+  flex-wrap: wrap;
+  gap: 0.5rem;
+  align-items: center;
+}
+
+.faultline-pagination .pagination a,
+.faultline-pagination .pagination span {
+  padding: 0.35rem 0.65rem;
+  border-radius: 0.5rem;
+}
+
+.faultline-pagination .pagination a {
+  color: #4338ca;
+}
+
+.faultline-pagination .pagination a:hover {
+  background: #eef2ff;
+}
+
+.faultline-pagination .pagination .current {
+  background: #4f46e5;
+  color: white;
+  font-weight: 600;
+}

data/app/controllers/faultline/application_controller.rb

@@ -0,0 +1,4 @@
+module Faultline
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/faultline/logged_exceptions_controller.rb

@@ -0,0 +1,105 @@
+module Faultline
+  class LoggedExceptionsController < ApplicationController
+    cattr_accessor :application_name
+
+    helper_method :params_filters
+
+    def index
+      @exception_names = LoggedException.class_names
+      @controller_actions = LoggedException.controller_actions
+      @exceptions = filtered_exceptions
+    end
+
+    def query
+      @exceptions = filtered_exceptions
+
+      respond_to do |format|
+        format.turbo_stream
+        format.html { render :query }
+      end
+    end
+
+    def feed
+      @exceptions = LoggedException.all
+
+      respond_to do |format|
+        format.rss { render layout: false }
+      end
+    end
+
+    def show
+      @exception = LoggedException.find(params[:id])
+
+      respond_to do |format|
+        format.turbo_stream
+        format.html
+      end
+    end
+
+    def destroy
+      @exception = LoggedException.find(params[:id])
+      @exception.destroy!
+
+      respond_to do |format|
+        format.turbo_stream
+        format.html { redirect_to logged_exceptions_path, status: :see_other }
+      end
+    end
+
+    def destroy_all
+      exceptions = if params[:ids].present?
+        LoggedException.where(id: params[:ids].to_s.split(","))
+      else
+        filtered_scope
+      end
+      exceptions.delete_all
+      @exceptions = filtered_exceptions
+
+      respond_to do |format|
+        format.turbo_stream
+        format.html { redirect_to logged_exceptions_path(params_filters) }
+      end
+    end
+
+    def clear
+      LoggedException.delete_all
+      @exceptions = filtered_exceptions
+
+      respond_to do |format|
+        format.turbo_stream
+        format.html { redirect_back fallback_location: root_path }
+      end
+    end
+
+    private
+
+    def params_filters
+      {
+        query: params[:query],
+        date_ranges_filter: params[:date_ranges_filter],
+        exception_names_filter: params[:exception_names_filter],
+        controller_actions_filter: params[:controller_actions_filter]
+      }.compact
+    end
+
+    def filtered_exceptions
+      filtered_scope.paginate(page: params[:page], per_page: 30)
+    end
+
+    def filtered_scope
+      exceptions = LoggedException.sorted
+      exceptions = exceptions.where(id: params[:id]) if params[:id].present?
+      exceptions = exceptions.message_like(params[:query]) if params[:query].present?
+      exceptions = exceptions.days_old(params[:date_ranges_filter]) if params[:date_ranges_filter].present?
+      exceptions = exceptions.by_exception_class(params[:exception_names_filter]) if params[:exception_names_filter].present?
+
+      if params[:controller_actions_filter].present?
+        controller_name, action_name = params[:controller_actions_filter].split("/", 2)
+        exceptions = exceptions.by_controller(controller_name.underscore)
+        exceptions = exceptions.by_action(action_name.downcase) if action_name.present?
+      end
+
+      exceptions
+    end
+  end
+end

data/app/helpers/faultline/application_helper.rb

@@ -0,0 +1,4 @@
+module Faultline
+  module ApplicationHelper
+  end
+end

data/app/helpers/faultline/logged_exceptions_helper.rb

@@ -0,0 +1,34 @@
+module Faultline
+  module LoggedExceptionsHelper
+    def pretty_exception_date(exception)
+      if Date.today == exception.created_at.to_date
+        "Today, #{exception.created_at.strftime(Time::DATE_FORMATS[:exc_time])}"
+      else
+        exception.created_at.strftime(Time::DATE_FORMATS[:exc_date])
+      end
+    end
+
+    def filtered?
+      [:query, :date_ranges_filter, :exception_names_filter, :controller_actions_filter].any? { |p| params[p] }
+    end
+
+    def listify(text)
+      list_items = text.scan(/^\s*\* (.+)/).map { |match| content_tag(:li, match.first) }
+      content_tag(:ul, list_items)
+    end
+
+    def page_title(text)
+      title = [controller.application_name.presence, text].compact.join(" :: ")
+      content_for(:title, title)
+    end
+
+    # Rescue textilize call if RedCloth is not available.
+    def pretty_format(text)
+      begin
+        textilize(text).html_safe
+      rescue
+        simple_format(text).html_safe
+      end
+    end
+  end
+end

data/app/javascript/controllers/faultline_controller.js

@@ -0,0 +1,38 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = ["activity"]
+
+  connect() {
+    this.showActivity = this.showActivity.bind(this)
+    this.hideActivity = this.hideActivity.bind(this)
+
+    document.addEventListener("turbo:before-fetch-request", this.showActivity)
+    document.addEventListener("turbo:before-fetch-response", this.hideActivity)
+    document.addEventListener("turbo:submit-end", this.hideActivity)
+  }
+
+  disconnect() {
+    document.removeEventListener("turbo:before-fetch-request", this.showActivity)
+    document.removeEventListener("turbo:before-fetch-response", this.hideActivity)
+    document.removeEventListener("turbo:submit-end", this.hideActivity)
+  }
+
+  submit() {
+    this.showActivity()
+  }
+
+  showActivity() {
+    this.activityTarget?.classList.remove("hidden")
+  }
+
+  hideActivity() {
+    this.activityTarget?.classList.add("hidden")
+  }
+
+  closeDetails(event) {
+    event.preventDefault()
+    const details = document.getElementById("exception-details")
+    if (details) details.innerHTML = ""
+  }
+}

data/app/jobs/faultline/application_job.rb

@@ -0,0 +1,4 @@
+module Faultline
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/faultline/application_mailer.rb

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

data/app/models/faultline/application_record.rb

@@ -0,0 +1,5 @@
+module Faultline
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/faultline/logged_exception.rb

@@ -0,0 +1,88 @@
+module Faultline
+  class LoggedException < ApplicationRecord
+    self.table_name = "faultline_logged_exceptions"
+    HOSTNAME = Socket.gethostname
+
+    class << self
+      def create_from_exception(controller, exception, data)
+        message = "#{exception.message.inspect}\n* Extra Data\n\n#{data}" unless data.blank?
+        create!(
+          exception_class: exception.class.name,
+          controller_name: controller.controller_path,
+          action_name: controller.action_name,
+          message: message,
+          backtrace: exception.backtrace,
+          request: controller.request,
+          user_info: controller.respond_to?(:current_user, true) ? controller.current_user : nil,
+          remote_ip: controller.request.remote_ip
+        )
+      end
+
+      def host_name
+        HOSTNAME
+      end
+    end
+
+    scope :by_exception_class, lambda { |exception_class| where(:exception_class => exception_class) }
+    scope :by_controller_and_action, lambda { |controller_name, action_name| where(:controller_name => controller_name, :action_name => action_name) }
+    scope :by_controller, lambda { |controller_name| where(:controller_name => controller_name) }
+    scope :by_action, lambda { |action_name| where(:action_name => action_name) }
+    scope :message_like, ->(query) { where("message LIKE ?", "%#{sanitize_sql_like(query)}%") }
+    scope :days_old, ->(day_number) { where("created_at >= ?", day_number.to_f.days.ago.utc) }
+    scope :sorted, -> { order(created_at: :desc) }
+
+    def name
+      "#{self.exception_class} in #{self.controller_action}"
+    end
+
+    def backtrace=(trace)
+      trace = sanitize_backtrace(trace) * "\n" unless trace.is_a?(String)
+      write_attribute :backtrace, trace
+    end
+
+    def request=(request)
+      if request.is_a?(String)
+        write_attribute :request, request
+      else
+        max = request.env.keys.max { |a, b| a.length <=> b.length }
+        env = request.env.keys.sort.inject [] do |env, key|
+          env << '* ' + ("%-*s: %s" % [max.length, key, request.env[key].to_s.strip])
+        end
+        write_attribute(:environment, (env << "* Process: #{$$}" << "* Server : #{self.class.host_name}") * "\n")
+
+        write_attribute(:request, [
+          "* URL:#{" #{request.method.to_s.upcase}" unless request.get?} #{request.protocol}#{request.env["HTTP_HOST"]}#{request.fullpath}",
+          "* Format: #{request.format.to_s}",
+          "* Parameters: #{request.parameters.inspect}",
+          "* Rails Root: #{rails_root}"
+        ] * "\n")
+      end
+    end
+
+    def controller_action
+      @controller_action ||= "#{controller_name.camelcase}/#{action_name}"
+    end
+
+    def self.class_names
+      select("DISTINCT exception_class").order(:exception_class).collect(&:exception_class)
+    end
+
+    def self.controller_actions
+      select("DISTINCT controller_name, action_name").order(:controller_name, :action_name).collect(&:controller_action)
+    end
+
+    private
+
+    @@rails_root = Pathname.new(Rails.root).cleanpath.to_s
+    @@backtrace_regex = /^#{Regexp.escape(@@rails_root)}/
+
+    def sanitize_backtrace(trace)
+      gem_path = Bundler.bundle_path.to_s
+      trace.reject { |line| line.include?(gem_path) }.collect { |line| Pathname.new(line.gsub(@@backtrace_regex, "[RAILS_ROOT]")).cleanpath.to_s }
+    end
+
+    def rails_root
+      @@rails_root
+    end
+  end
+end

data/app/views/faultline/logged_exceptions/_exceptions.html.erb

@@ -0,0 +1,55 @@
+<div id="exceptions-content" class="overflow-hidden rounded-xl border border-slate-200 bg-white shadow-sm">
+  <div class="flex flex-wrap items-center justify-between gap-3 border-b border-slate-200 px-5 py-4">
+    <div>
+      <h2 class="text-lg font-semibold text-slate-900">
+        <%= t(".heading") %>
+        <% if filtered? %>
+          <span class="font-normal text-slate-500">(<%= t(".filtered") %>)</span>
+        <% end %>
+      </h2>
+      <p class="mt-1 text-sm text-slate-500"><%= t(".count", count: @exceptions.total_entries) %></p>
+    </div>
+
+    <%= link_to t(".delete_visible"), destroy_all_logged_exceptions_path(params_filters),
+      class: "rounded-lg border border-red-200 px-3 py-2 text-sm font-medium text-red-700 hover:bg-red-50",
+      data: { turbo_method: :post, turbo_confirm: t(".confirm_delete_visible"), turbo_stream: true } %>
+  </div>
+
+  <% if @exceptions.empty? %>
+    <div class="px-5 py-16 text-center text-sm text-slate-500"><%= t(".empty") %></div>
+  <% else %>
+    <div class="overflow-x-auto">
+      <table class="min-w-full divide-y divide-slate-200">
+        <thead class="bg-slate-50">
+          <tr>
+            <th class="px-5 py-3 text-left text-xs font-semibold uppercase tracking-wide text-slate-500"><%= t(".exception") %></th>
+            <th class="px-5 py-3 text-left text-xs font-semibold uppercase tracking-wide text-slate-500"><%= t(".date") %></th>
+            <th class="px-5 py-3"><span class="sr-only"><%= t(".actions") %></span></th>
+          </tr>
+        </thead>
+        <tbody class="divide-y divide-slate-100">
+          <% @exceptions.each do |exception| %>
+            <tr id="<%= dom_id(exception) %>" class="group hover:bg-slate-50">
+              <td class="max-w-2xl px-5 py-4 align-top">
+                <%= link_to exception.name, logged_exception_path(exception),
+                  class: "font-medium text-indigo-700 hover:text-indigo-900 hover:underline",
+                  data: { turbo_frame: "exception-details" } %>
+                <p class="mt-1 truncate text-sm text-slate-600"><%= exception.message %></p>
+              </td>
+              <td class="whitespace-nowrap px-5 py-4 align-top text-sm text-slate-500"><%= pretty_exception_date(exception) %></td>
+              <td class="whitespace-nowrap px-5 py-4 text-right align-top">
+                <%= link_to t(".delete"), logged_exception_path(exception),
+                  class: "text-sm font-medium text-red-600 hover:text-red-800 hover:underline",
+                  data: { turbo_method: :delete, turbo_confirm: t(".confirm_delete"), turbo_stream: true } %>
+              </td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+  <% end %>
+
+  <div class="faultline-pagination border-t border-slate-200 px-5 py-4 text-sm">
+    <%= will_paginate @exceptions, params: { controller: "logged_exceptions", action: "index" }.merge(params_filters) %>
+  </div>
+</div>

data/app/views/faultline/logged_exceptions/_feed.html.erb

@@ -0,0 +1,5 @@
+<div class="mt-6 border-t border-slate-200 pt-5">
+  <%= link_to feed_logged_exceptions_path(format: :rss), class: "text-sm font-medium text-indigo-700 hover:underline" do %>
+    <%= t(".rss_feed") %>
+  <% end %>
+</div>

data/app/views/faultline/logged_exceptions/_filter_group.html.erb

@@ -0,0 +1,10 @@
+<div class="mt-6">
+  <h3 class="text-xs font-semibold uppercase tracking-wide text-slate-500"><%= title %></h3>
+  <nav class="mt-2 max-h-40 space-y-1 overflow-y-auto">
+    <% values.each do |value| %>
+      <%= link_to value, query_logged_exceptions_path(parameter => value),
+        class: "block truncate rounded-lg px-3 py-2 text-sm text-slate-600 hover:bg-slate-100 hover:text-slate-900",
+        data: { turbo_frame: "exceptions" } %>
+    <% end %>
+  </nav>
+</div>

data/app/views/faultline/logged_exceptions/_show.html.erb

@@ -0,0 +1,37 @@
+<div class="flex items-center justify-between gap-4 border-b border-slate-200 pb-4">
+  <div>
+    <p class="text-sm text-slate-500"><%= @exception.created_at.strftime(Time::DATE_FORMATS[:exc_full]) %></p>
+    <h2 class="mt-1 break-words text-xl font-semibold text-slate-900"><%= @exception.name %></h2>
+  </div>
+  <button type="button" class="rounded-lg px-3 py-2 text-sm font-medium text-slate-600 hover:bg-slate-100" data-action="click->faultline#closeDetails">
+    <%= t(".close") %>
+  </button>
+</div>
+
+<div class="mt-5 space-y-5 text-sm text-slate-700">
+  <section>
+    <h3 class="mb-2 text-xs font-semibold uppercase tracking-wide text-slate-500"><%= t(".request") %></h3>
+    <div class="overflow-x-auto rounded-lg bg-slate-50 p-4"><%= pretty_format(@exception.request) %></div>
+  </section>
+
+  <section>
+    <h3 class="mb-2 text-xs font-semibold uppercase tracking-wide text-slate-500"><%= t(".message") %></h3>
+    <div class="rounded-lg bg-slate-50 p-4"><%= simple_format(@exception.message) %></div>
+  </section>
+
+  <section>
+    <h3 class="mb-2 text-xs font-semibold uppercase tracking-wide text-slate-500"><%= t(".backtrace") %></h3>
+    <pre class="max-h-96 overflow-auto rounded-lg bg-slate-950 p-4 text-xs leading-5 text-slate-100"><%= @exception.backtrace %></pre>
+  </section>
+
+  <section>
+    <h3 class="mb-2 text-xs font-semibold uppercase tracking-wide text-slate-500"><%= t(".environment") %></h3>
+    <div class="overflow-x-auto rounded-lg bg-slate-50 p-4"><%= pretty_format(@exception.environment) %></div>
+  </section>
+</div>
+
+<div class="mt-6 border-t border-slate-200 pt-4">
+  <%= link_to t(".delete"), logged_exception_path(@exception),
+    class: "text-sm font-medium text-red-600 hover:text-red-800 hover:underline",
+    data: { turbo_method: :delete, turbo_confirm: t(".confirm_delete"), turbo_stream: true } %>
+</div>

data/app/views/faultline/logged_exceptions/clear.turbo_stream.erb

@@ -0,0 +1,6 @@
+<%= turbo_stream.replace "exceptions" do %>
+  <%= turbo_frame_tag "exceptions" do %>
+    <%= render "exceptions" %>
+  <% end %>
+<% end %>
+<%= turbo_stream.update "exception-details", "" %>

data/app/views/faultline/logged_exceptions/destroy.turbo_stream.erb

@@ -0,0 +1,2 @@
+<%= turbo_stream.remove dom_id(@exception) %>
+<%= turbo_stream.update "exception-details", "" %>

data/app/views/faultline/logged_exceptions/destroy_all.turbo_stream.erb

@@ -0,0 +1,6 @@
+<%= turbo_stream.replace "exceptions" do %>
+  <%= turbo_frame_tag "exceptions" do %>
+    <%= render "exceptions" %>
+  <% end %>
+<% end %>
+<%= turbo_stream.update "exception-details", "" %>

data/app/views/faultline/logged_exceptions/feed.rss.builder

@@ -0,0 +1,20 @@
+xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+
+xml.rss "version" => "2.0" do
+  xml.channel do
+    xml.title "#{Faultline::LoggedExceptionsController.application_name}"
+    xml.link url_for(:only_path => false, :skip_relative_url_root => false)
+    xml.language "en-us"
+    xml.ttl "60"
+
+    @exceptions.each do |exc|
+      xml.item do
+        xml.title "#{exc.name} @ #{exc.created_at.rfc822}"
+        xml.description exc.message
+        xml.pubDate exc.created_at.rfc822
+        xml.guid [request.host_with_port, 'exceptions', exc.id.to_s].join(":"), "isPermaLink" => "false"
+        xml.link url_for(:action => 'index', :anchor => "e#{exc.id}", :only_path => false, :skip_relative_url_root => false)
+      end
+    end
+  end
+end

data/app/views/faultline/logged_exceptions/index.html.erb

@@ -0,0 +1,68 @@
+<% page_title t(".title") %>
+
+<div data-controller="faultline" class="mx-auto max-w-7xl px-4 py-8 sm:px-6 lg:px-8">
+  <div class="mb-8 flex flex-col gap-2 sm:flex-row sm:items-end sm:justify-between">
+    <div>
+      <p class="text-sm font-semibold uppercase tracking-widest text-indigo-600">Faultline</p>
+      <h1 class="mt-2 text-3xl font-bold tracking-tight text-slate-950"><%= t(".title") %></h1>
+      <p class="mt-2 text-slate-600"><%= t(".subtitle") %></p>
+    </div>
+    <%= button_to t(".clear_history"), clear_logged_exceptions_path, method: :post,
+      class: "rounded-lg bg-red-600 px-4 py-2 text-sm font-semibold text-white shadow-sm hover:bg-red-700",
+      form: { data: { turbo_stream: true } },
+      data: { turbo_confirm: t(".confirm_clear") } %>
+  </div>
+
+  <div class="grid gap-6 lg:grid-cols-[16rem_minmax(0,1fr)]">
+    <aside class="rounded-xl border border-slate-200 bg-white p-5 shadow-sm">
+      <h2 class="text-sm font-semibold uppercase tracking-wide text-slate-500"><%= t(".filters") %></h2>
+
+      <nav class="mt-4 space-y-1" aria-label="<%= t(".filters") %>">
+        <%= link_to t(".latest_exceptions"), logged_exceptions_path,
+          class: "block rounded-lg px-3 py-2 text-sm font-medium text-slate-700 hover:bg-slate-100",
+          data: { turbo_frame: "exceptions" } %>
+      </nav>
+
+      <%= render "filter_group", title: t(".exception"), values: @exception_names, parameter: :exception_names_filter %>
+      <%= render "filter_group", title: t(".controller_action"), values: @controller_actions, parameter: :controller_actions_filter %>
+
+      <div class="mt-6">
+        <h3 class="text-xs font-semibold uppercase tracking-wide text-slate-500"><%= t(".dates") %></h3>
+        <nav class="mt-2 space-y-1">
+          <% [[t(".today"), 1], [t(".last_few_days"), 3], [t(".last_7_days"), 7], [t(".last_30_days"), 30]].each do |label, days| %>
+            <%= link_to label, query_logged_exceptions_path(date_ranges_filter: days),
+              class: "block rounded-lg px-3 py-2 text-sm text-slate-600 hover:bg-slate-100 hover:text-slate-900",
+              data: { turbo_frame: "exceptions" } %>
+          <% end %>
+        </nav>
+      </div>
+
+      <div class="mt-6 border-t border-slate-200 pt-5">
+        <%= form_with url: query_logged_exceptions_path, method: :get,
+          data: { turbo_frame: "exceptions", action: "submit->faultline#submit" } do |form| %>
+          <%= form.label :query, t(".search"), class: "text-xs font-semibold uppercase tracking-wide text-slate-500" %>
+          <div class="mt-2 flex gap-2">
+            <%= form.search_field :query, placeholder: t(".search_placeholder"), class: "min-w-0 flex-1 rounded-lg border-slate-300 text-sm shadow-sm focus:border-indigo-500 focus:ring-indigo-500" %>
+            <%= form.submit t(".find"), class: "rounded-lg bg-slate-900 px-3 py-2 text-sm font-semibold text-white hover:bg-slate-700" %>
+          </div>
+        <% end %>
+      </div>
+
+      <%= render "feed" %>
+    </aside>
+
+    <div class="space-y-6">
+      <div id="activity" data-faultline-target="activity" class="hidden rounded-lg bg-indigo-50 px-4 py-3 text-sm text-indigo-700" role="status" aria-live="polite">
+        <%= t(".loading") %>
+      </div>
+
+      <%= turbo_frame_tag "exception-details", class: "block rounded-xl border border-slate-200 bg-white p-5 shadow-sm" do %>
+        <p class="py-8 text-center text-sm text-slate-500"><%= t(".select_exception") %></p>
+      <% end %>
+
+      <%= turbo_frame_tag "exceptions" do %>
+        <%= render "exceptions" %>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/faultline/logged_exceptions/query.html.erb

@@ -0,0 +1,3 @@
+<%= turbo_frame_tag "exceptions" do %>
+  <%= render "exceptions" %>
+<% end %>

data/app/views/faultline/logged_exceptions/query.turbo_stream.erb

@@ -0,0 +1,6 @@
+<%= turbo_stream.replace "exceptions" do %>
+  <%= turbo_frame_tag "exceptions" do %>
+    <%= render "exceptions" %>
+  <% end %>
+<% end %>
+<%= turbo_stream.update "exception-details", "" %>

data/app/views/faultline/logged_exceptions/show.html.erb

@@ -0,0 +1,3 @@
+<%= turbo_frame_tag "exception-details", class: "block rounded-xl border border-slate-200 bg-white p-5 shadow-sm" do %>
+  <%= render "show" %>
+<% end %>

data/app/views/faultline/logged_exceptions/show.turbo_stream.erb

@@ -0,0 +1,5 @@
+<%= turbo_stream.replace "exception-details" do %>
+  <%= turbo_frame_tag "exception-details", class: "block rounded-xl border border-slate-200 bg-white p-5 shadow-sm" do %>
+    <%= render "show" %>
+  <% end %>
+<% end %>

data/app/views/layouts/faultline/application.html.erb

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title><%= content_for?(:title) ? yield(:title) : "Faultline" %></title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <% host_assets = Rails.application.assets %>
+    <% host_stylesheet = if host_assets.respond_to?(:find_asset)
+      host_assets.find_asset("application.css")
+    elsif host_assets.respond_to?(:load_path)
+      host_assets.load_path.find("application.css")
+    end %>
+    <% host_javascript = if host_assets.respond_to?(:find_asset)
+      host_assets.find_asset("application.js")
+    elsif host_assets.respond_to?(:load_path)
+      host_assets.load_path.find("application.js")
+    end %>
+    <%= stylesheet_link_tag "application", "data-turbo-track": "reload" if host_stylesheet %>
+    <%= stylesheet_link_tag "faultline/application", "data-turbo-track": "reload" %>
+    <%= javascript_importmap_tags if respond_to?(:javascript_importmap_tags) %>
+    <%= javascript_include_tag "application", "data-turbo-track": "reload", type: "module" if host_javascript %>
+    <%= javascript_include_tag "faultline/application", "data-turbo-track": "reload", type: "module" %>
+  </head>
+  <body class="min-h-screen bg-slate-50 text-slate-900 antialiased">
+    <main>
+      <%= yield %>
+    </main>
+  </body>
+</html>

data/config/initializers/date_formats.rb

@@ -0,0 +1,5 @@
+Time::DATE_FORMATS.merge!(
+  :exc_full => "%A, %b %d, %Y at %l:%M %p",
+  :exc_date => "%b %d, %Y",
+  :exc_time => "%l:%M %p"
+)

data/config/locales/en.yml

@@ -0,0 +1,47 @@
+en:
+  faultline:
+    logged_exceptions:
+      index:
+        title: Logged Exceptions
+        subtitle: Review, filter, and remove application exceptions.
+        filters: Filters
+        latest_exceptions: Latest Exceptions
+        exception: Exception
+        controller_action: Controller / Action
+        dates: Dates
+        today: Today
+        last_few_days: Last few days
+        last_7_days: Last 7 days
+        last_30_days: Last 30 days
+        clear_history: Clear history
+        confirm_clear: Clear the complete exception history?
+        search: Search
+        search_placeholder: Search messages
+        find: Find
+        loading: Loading exceptions…
+        select_exception: Select an exception to inspect its details.
+      _exceptions:
+        heading: Exceptions
+        filtered: filtered
+        count: "%{count} total"
+        empty: No exceptions match these filters.
+        exception: Exception
+        date: Date
+        actions: Actions
+        delete: Delete
+        delete_visible: Delete visible
+        confirm_delete: Delete this exception?
+        confirm_delete_visible: Delete all visible exceptions?
+      _show:
+        close: Close
+        request: Request
+        message: Message
+        backtrace: Backtrace
+        environment: Environment
+        delete: Delete exception
+        confirm_delete: Delete this exception?
+      _feed:
+        rss_feed: Subscribe to the RSS feed
+      show:
+        title: Logged Exception
+

data/config/routes.rb

@@ -0,0 +1,13 @@
+
+Faultline::Engine.routes.draw do
+  resources :logged_exceptions do
+    collection do
+      post :clear
+      match :query, via: %i[get post]
+      post :destroy_all
+      get :feed
+    end
+  end
+
+  root :to => 'logged_exceptions#index'
+end

data/db/migrate/20240330122311_create_faultline_logged_exceptions.rb

@@ -0,0 +1,18 @@
+class CreateFaultlineLoggedExceptions < ActiveRecord::Migration[8.0]
+  def change
+    create_table :faultline_logged_exceptions do |t|
+      t.string :exception_class
+      t.string :controller_name
+      t.string :action_name
+      t.text :message
+      t.text :backtrace
+      t.text :environment
+      t.text :request
+      t.string :user_info
+      t.string :user_agent
+      t.string :remote_ip
+
+      t.timestamps
+    end
+  end
+end

data/faultline-rails.gemspec

@@ -0,0 +1,28 @@
+require_relative "lib/faultline/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "faultline-rails"
+  spec.version     = Faultline::VERSION
+  spec.authors     = ["Tamiru Hailu"]
+  spec.email       = ["tamiruhailu@gmail.com"]
+  spec.homepage    = "https://github.com/tamiru/faultline-rails"
+  spec.summary     = "A Rails 8 exception dashboard powered by Hotwire."
+  spec.description = "Faultline logs Rails exceptions and provides a Turbo, Stimulus, and Tailwind-compatible dashboard."
+  spec.license     = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/tamiru/faultline-rails/tree/main"
+  spec.metadata["changelog_uri"] = "https://github.com/tamiru/faultline-rails/blob/main/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md", "faultline-rails.gemspec"]
+  end
+
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.add_dependency "rails", "~> 8.0", ">= 8.0.0"
+  spec.add_dependency "stimulus-rails", "~> 1.3"
+  spec.add_dependency "turbo-rails", "~> 2.0"
+  spec.add_dependency "will_paginate", "~> 4.0"
+end

data/lib/faultline/engine.rb

@@ -0,0 +1,21 @@
+module Faultline
+  class Engine < ::Rails::Engine
+    isolate_namespace Faultline
+
+    engine_name "faultline"
+
+    initializer "faultline.assets", group: :all do |app|
+      next unless app.config.respond_to?(:assets) && app.config.assets
+
+      asset_root = root.join("app/assets")
+
+      if defined?(::Propshaft)
+        app.config.assets.paths.concat(
+          Dir[asset_root.join("*")].select { |path| File.directory?(path) }
+        )
+      else
+        app.config.assets.paths << asset_root
+      end
+    end
+  end
+end

data/lib/faultline/version.rb

@@ -0,0 +1,3 @@
+module Faultline
+  VERSION = "0.1.1"
+end

data/lib/faultline-rails.rb

@@ -0,0 +1 @@
+require "faultline"

data/lib/faultline.rb

@@ -0,0 +1,94 @@
+require "rails"
+require "turbo-rails"
+require "stimulus-rails"
+require "will_paginate"
+require "ipaddr"
+require "socket"
+require "faultline/version"
+require "faultline/engine"
+
+module Faultline
+  # Copyright (c) 2005 Jamis Buck
+  #
+  # 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.
+  module ExceptionLoggable
+    def self.included(target)
+      target.extend(ClassMethods)
+      target.class_attribute :local_addresses, :exception_data
+
+      target.local_addresses = [IPAddr.new("127.0.0.1")]
+    end
+
+    module ClassMethods
+      def consider_local(*args)
+        local_addresses.concat(args.flatten.map { |a| IPAddr.new(a) })
+      end
+    end
+
+    def local_request?
+      remote = IPAddr.new(request.remote_ip)
+      !self.class.local_addresses.detect { |addr| addr.include?(remote) }.nil?
+    end
+
+    # we log the exception and raise it again, for the normal handling.
+    def log_exception_handler(exception)
+      log_exception(exception)
+      raise exception
+    end
+
+    def rescue_action(exception)
+      status = response_code_for_rescue(exception)
+      log_exception(exception) if status != :not_found
+      super
+    end
+
+    def filter_sub_parameters(params, rails_filter_parameters)
+      params.each do |key, value|
+        if(value.class != Hash and value.class != ActiveSupport::HashWithIndifferentAccess)
+          params[key] = '[FILTERED]' if rails_filter_parameters.include?(key.to_sym)
+        else
+          params[key] = filter_sub_parameters(value, rails_filter_parameters)
+        end
+      end
+      params
+    end
+
+    def log_exception(exception)
+      deliverer = self.class.exception_data
+      data = case deliverer
+             when nil    then {}
+             when Symbol then send(deliverer)
+             when Proc   then deliverer.call(self)
+             end
+
+      rails_filter_parameters = defined?(::Rails) ? ::Rails.application.config.filter_parameters : []
+
+      self.request.parameters.each do |key, value|
+        if(value.class != Hash and value.class != ActiveSupport::HashWithIndifferentAccess)
+          self.request.parameters[key] = '[FILTERED]' if rails_filter_parameters.include?(key.to_sym)
+        else
+          self.request.parameters[key] = filter_sub_parameters(value, rails_filter_parameters)
+        end
+      end if rails_filter_parameters.any?
+
+      LoggedException.create_from_exception(self, exception, data)
+    end
+  end
+end

data/lib/tasks/faultline_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :faultline do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: faultline-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tamiru Hailu
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+- !ruby/object:Gem::Dependency
+  name: stimulus-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Faultline logs Rails exceptions and provides a Turbo, Stimulus, and Tailwind-compatible
+  dashboard.
+email:
+- tamiruhailu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/faultline_manifest.js
+- app/assets/javascripts/faultline/application.js
+- app/assets/stylesheets/faultline/application.css
+- app/controllers/faultline/application_controller.rb
+- app/controllers/faultline/logged_exceptions_controller.rb
+- app/helpers/faultline/application_helper.rb
+- app/helpers/faultline/logged_exceptions_helper.rb
+- app/javascript/controllers/faultline_controller.js
+- app/jobs/faultline/application_job.rb
+- app/mailers/faultline/application_mailer.rb
+- app/models/faultline/application_record.rb
+- app/models/faultline/logged_exception.rb
+- app/views/faultline/logged_exceptions/_exceptions.html.erb
+- app/views/faultline/logged_exceptions/_feed.html.erb
+- app/views/faultline/logged_exceptions/_filter_group.html.erb
+- app/views/faultline/logged_exceptions/_show.html.erb
+- app/views/faultline/logged_exceptions/clear.turbo_stream.erb
+- app/views/faultline/logged_exceptions/destroy.turbo_stream.erb
+- app/views/faultline/logged_exceptions/destroy_all.turbo_stream.erb
+- app/views/faultline/logged_exceptions/feed.rss.builder
+- app/views/faultline/logged_exceptions/index.html.erb
+- app/views/faultline/logged_exceptions/query.html.erb
+- app/views/faultline/logged_exceptions/query.turbo_stream.erb
+- app/views/faultline/logged_exceptions/show.html.erb
+- app/views/faultline/logged_exceptions/show.turbo_stream.erb
+- app/views/layouts/faultline/application.html.erb
+- config/initializers/date_formats.rb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20240330122311_create_faultline_logged_exceptions.rb
+- faultline-rails.gemspec
+- lib/faultline-rails.rb
+- lib/faultline.rb
+- lib/faultline/engine.rb
+- lib/faultline/version.rb
+- lib/tasks/faultline_tasks.rake
+homepage: https://github.com/tamiru/faultline-rails
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/tamiru/faultline-rails
+  source_code_uri: https://github.com/tamiru/faultline-rails/tree/main
+  changelog_uri: https://github.com/tamiru/faultline-rails/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: A Rails 8 exception dashboard powered by Hotwire.
+test_files: []