WIP - add e2e specs for rails structured logging

Author: solnic

spec/apps/rails-mini/Gemfile

@@ -6,5 +6,8 @@ gem "rake"
 gem "puma"
 gem 'railties', '~> 8.0'
 gem 'actionpack', '~> 8.0'
+gem 'activerecord', '~> 8.0'
+gem 'activejob', '~> 8.0'
+gem 'sqlite3', '>= 2.1'
 gem 'sentry-ruby', path: Pathname(__dir__).join("../../..").realpath
 gem 'sentry-rails', path: Pathname(__dir__).join("../../..").realpath

spec/apps/rails-mini/app.rb

@@ -5,8 +5,11 @@
 Bundler.require
 
 ENV["RAILS_ENV"] = "development"
+ENV["DATABASE_URL"] = "sqlite3::memory:"
 
-require "action_controller"
+require "action_controller/railtie"
+require "active_record/railtie"
+require "active_job/railtie"
 
 class RailsMiniApp < Rails::Application
   config.hosts = nil
@@ -17,6 +20,12 @@ class RailsMiniApp < Rails::Application
   config.api_only = true
   config.force_ssl = false
 
+  config.active_record.logger = Logger.new($stdout)
+  config.active_record.migration_error = :page_load
+
+  config.active_job.queue_adapter = :inline
+  config.active_job.logger = Logger.new($stdout)
+
   initializer :configure_sentry do
     Sentry.init do |config|
       config.dsn = ENV["SENTRY_DSN"]
@@ -30,9 +39,67 @@ class RailsMiniApp < Rails::Application
       config.release = "sentry-ruby-rails-mini-#{Time.now.utc}"
 
       config.transport.transport_class = Sentry::DebugTransport
-      config.sdk_debug_transport_log_file = "/workspace/sentry/log/sentry_debug_events.log"
       config.background_worker_threads = 0
+
+      config.enable_logs = true
+      config.structured_logger_class = Sentry::DebugStructuredLogger
+      config.rails.structured_logging.enabled = true
+      config.rails.structured_logging.attach_to = [:active_record, :action_controller, :active_job]
+    end
+  end
+end
+
+class Post < ActiveRecord::Base
+end
+
+class User < ActiveRecord::Base
+end
+
+class ApplicationJob < ActiveJob::Base
+  retry_on ActiveRecord::Deadlocked
+
+  discard_on ActiveJob::DeserializationError
+end
+
+class SampleJob < ApplicationJob
+  queue_as :default
+
+  def perform(message = "Hello from ActiveJob!")
+    Rails.logger.info("SampleJob executed with message: #{message}")
+
+    Post.count
+    User.count
+
+    message
+  end
+end
+
+class DatabaseJob < ApplicationJob
+  queue_as :default
+
+  def perform(post_title = "Test Post")
+    Rails.logger.info("DatabaseJob creating post: #{post_title}")
+
+    post = Post.create!(title: post_title, content: "Content for #{post_title}")
+    found_post = Post.find(post.id)
+
+    Rails.logger.info("DatabaseJob found post: #{found_post.title}")
+
+    found_post
+  end
+end
+
+class FailingJob < ApplicationJob
+  queue_as :default
+
+  def perform(should_fail = true)
+    Rails.logger.info("FailingJob started")
+
+    if should_fail
+      raise StandardError, "Intentional job failure for testing"
     end
+
+    "Job completed successfully"
   end
 end
 
@@ -61,7 +128,8 @@ def health
       status: "ok",
       timestamp: Time.now.utc.iso8601,
       sentry_initialized: Sentry.initialized?,
-      log_file_writable: check_log_file_writable
+      log_file_writable: check_log_file_writable,
+      structured_log_file_writable: check_structured_log_file_writable
     }
   end
 
@@ -70,6 +138,24 @@ def trace_headers
     render json: { headers: headers }
   end
 
+  def logged_events
+    if Sentry.logger.is_a?(Sentry::DebugStructuredLogger)
+      events = Sentry.logger.logged_events
+      render json: { events: events, count: events.length }
+    else
+      render json: { events: [], count: 0 }
+    end
+  end
+
+  def clear_logged_events
+    if Sentry.logger.is_a?(Sentry::DebugStructuredLogger)
+      Sentry.logger.clear
+      render json: { status: "cleared" }
+    else
+      render json: { status: "no_debug_logger" }
+    end
+  end
+
   private
 
   def check_log_file_writable
@@ -80,6 +166,127 @@ def check_log_file_writable
     false
   end
 
+  def check_structured_log_file_writable
+    if Sentry.logger.is_a?(Sentry::DebugStructuredLogger)
+      log_file_path = Sentry.logger.log_file
+      File.writable?(File.dirname(log_file_path)) &&
+        (!File.exist?(log_file_path) || File.writable?(log_file_path))
+    else
+      false
+    end
+  rescue
+    false
+  end
+
+  def set_cors_headers
+    response.headers['Access-Control-Allow-Origin'] = '*'
+    response.headers['Access-Control-Allow-Methods'] = 'GET, POST, PUT, DELETE, OPTIONS'
+    response.headers['Access-Control-Allow-Headers'] = 'Content-Type, Authorization, sentry-trace, baggage'
+  end
+end
+
+class PostsController < ActionController::Base
+  before_action :set_cors_headers
+  before_action :ensure_database_setup
+
+  def index
+    posts = Post.all.to_a
+
+    Sentry.logger.info("Posts index accessed", posts_count: posts.length)
+
+    render json: {
+      posts: posts.map { |p| { id: p.id, title: p.title, content: p.content } }
+    }
+  end
+
+  def create
+    post = Post.create!(post_params)
+
+    Sentry.logger.info("Post created", post_id: post.id, title: post.title)
+
+    render json: { post: { id: post.id, title: post.title, content: post.content } }, status: :created
+  rescue ActiveRecord::RecordInvalid => e
+    render json: { error: e.message }, status: :unprocessable_entity
+  end
+
+  def show
+    post = Post.find(params[:id])
+    render json: { post: { id: post.id, title: post.title, content: post.content } }
+  rescue ActiveRecord::RecordNotFound
+    render json: { error: "Post not found" }, status: :not_found
+  end
+
+  private
+
+  def post_params
+    params.require(:post).permit(:title, :content)
+  end
+
+  def ensure_database_setup
+    unless ActiveRecord::Base.connection.table_exists?('posts')
+      setup_database
+    end
+  end
+
+  def set_cors_headers
+    response.headers['Access-Control-Allow-Origin'] = '*'
+    response.headers['Access-Control-Allow-Methods'] = 'GET, POST, PUT, DELETE, OPTIONS'
+    response.headers['Access-Control-Allow-Headers'] = 'Content-Type, Authorization, sentry-trace, baggage'
+  end
+end
+
+class JobsController < ActionController::Base
+  before_action :set_cors_headers
+  before_action :ensure_database_setup
+
+  def sample_job
+    job = SampleJob.perform_later("Hello from Rails mini app!")
+
+    Sentry.logger.info("SampleJob enqueued", job_id: job.job_id)
+
+    render json: {
+      message: "SampleJob enqueued successfully",
+      job_id: job.job_id,
+      job_class: job.class.name
+    }
+  end
+
+  def database_job
+    title = params[:title] || "Test Post from Job"
+    job = DatabaseJob.perform_later(title)
+
+    Sentry.logger.info("DatabaseJob enqueued", job_id: job.job_id, post_title: title)
+
+    render json: {
+      message: "DatabaseJob enqueued successfully",
+      job_id: job.job_id,
+      job_class: job.class.name,
+      post_title: title
+    }
+  end
+
+  def failing_job
+    should_fail = params[:should_fail] != "false"
+    job = FailingJob.perform_later(should_fail)
+
+    Sentry.logger.info("FailingJob enqueued", job_id: job.job_id, should_fail: should_fail)
+
+    render json: {
+      message: "FailingJob enqueued successfully",
+      job_id: job.job_id,
+      job_class: job.class.name,
+      should_fail: should_fail
+    }
+  end
+
+  private
+
+  def ensure_database_setup
+    unless ActiveRecord::Base.connection.table_exists?('posts')
+      setup_database
+    end
+  end
+
   def set_cors_headers
     response.headers['Access-Control-Allow-Origin'] = '*'
     response.headers['Access-Control-Allow-Methods'] = 'GET, POST, PUT, DELETE, OPTIONS'
@@ -89,12 +296,43 @@ def set_cors_headers
 
 RailsMiniApp.initialize!
 
+def setup_database
+  ActiveRecord::Schema.define do
+    create_table :posts, force: true do |t|
+      t.string :title, null: false
+      t.text :content
+      t.timestamps
+    end
+
+    create_table :users, force: true do |t|
+      t.string :name, null: false
+      t.string :email
+      t.timestamps
+    end
+  end
+
+  Post.create!(title: "Welcome Post", content: "Welcome to the Rails mini app!")
+  Post.create!(title: "Sample Post", content: "This is a sample post for testing.")
+  User.create!(name: "Test User", email: "[email protected]")
+end
+
+setup_database
+
 RailsMiniApp.routes.draw do
   get '/health', to: 'events#health'
   get '/error', to: 'error#error'
   get '/trace_headers', to: 'events#trace_headers'
+  get '/logged_events', to: 'events#logged_events'
+  post '/clear_logged_events', to: 'events#clear_logged_events'
+
+  get '/posts', to: 'posts#index'
+  post '/posts', to: 'posts#create'
+  get '/posts/:id', to: 'posts#show'
+
+  post '/jobs/sample', to: 'jobs#sample_job'
+  post '/jobs/database', to: 'jobs#database_job'
+  post '/jobs/failing', to: 'jobs#failing_job'
 
-  # Add CORS headers for cross-origin requests from JS app
   match '*path', to: proc { |env|
     [200, {
       'Access-Control-Allow-Origin' => '*',