findbug 0.2.0

data/lib/generators/findbug/templates/initializer.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+# Findbug Configuration
+#
+# This file configures Findbug, your self-hosted error and performance monitoring.
+# See https://github.com/ITSSOUMIT/findbug for full documentation.
+#
+
+Findbug.configure do |config|
+  # ============================================================================
+  # CORE SETTINGS
+  # ============================================================================
+
+  # Enable or disable Findbug (default: true)
+  # Set to false in test environment to reduce noise
+  config.enabled = !Rails.env.test?
+
+  # Redis URL for the buffer
+  # We recommend using a separate database (e.g., /1) from your main Redis
+  config.redis_url = ENV.fetch("FINDBUG_REDIS_URL", "redis://localhost:6379/1")
+
+  # Redis connection pool settings
+  config.redis_pool_size = ENV.fetch("FINDBUG_REDIS_POOL_SIZE", 5).to_i
+
+  # ============================================================================
+  # ERROR CAPTURE
+  # ============================================================================
+
+  # Sample rate for error capture (0.0 to 1.0)
+  # 1.0 = capture 100% of errors (recommended for most apps)
+  # Lower this for extremely high-traffic apps
+  config.sample_rate = 1.0
+
+  # Exceptions to ignore (won't be captured)
+  # Add exceptions that are "expected" in normal operation
+  config.ignored_exceptions = [
+    ActiveRecord::RecordNotFound,      # 404s
+    ActionController::RoutingError,    # Invalid routes
+    ActionController::UnknownFormat    # Format not supported
+  ]
+
+  # URL paths to ignore (regex patterns)
+  # Useful for health checks, assets, etc.
+  config.ignored_paths = [
+    /^\/health/,
+    /^\/assets/,
+    /^\/packs/
+  ]
+
+  # ============================================================================
+  # PERFORMANCE MONITORING
+  # ============================================================================
+
+  # Enable performance monitoring (default: true)
+  config.performance_enabled = true
+
+  # Sample rate for performance data (0.0 to 1.0)
+  # Performance data is more voluminous, so sampling is common
+  config.performance_sample_rate = 0.1  # 10% of requests
+
+  # Only capture requests slower than this (in ms)
+  # Set to 0 to capture all sampled requests
+  config.slow_request_threshold_ms = 0
+
+  # Threshold for flagging slow SQL queries (in ms)
+  config.slow_query_threshold_ms = 100
+
+  # ============================================================================
+  # DATA SCRUBBING (Security)
+  # ============================================================================
+
+  # Field names to scrub (replaced with [FILTERED])
+  # Add any custom sensitive fields your app uses
+  config.scrub_fields = %w[
+    password
+    password_confirmation
+    secret
+    token
+    api_key
+    credit_card
+    ssn
+  ]
+
+  # Scrub sensitive headers (default: true)
+  config.scrub_headers = true
+
+  # ============================================================================
+  # STORAGE & RETENTION
+  # ============================================================================
+
+  # How many days to keep data (default: 30)
+  config.retention_days = 30
+
+  # Maximum events in Redis buffer before old ones are dropped
+  config.max_buffer_size = 10_000
+
+  # Queue name for Findbug background jobs
+  config.queue_name = "findbug"
+
+  # ============================================================================
+  # WEB DASHBOARD
+  # ============================================================================
+
+  # Dashboard authentication (required for dashboard to be enabled)
+  # We recommend using environment variables for security
+  config.web_username = ENV["FINDBUG_USERNAME"]
+  config.web_password = ENV["FINDBUG_PASSWORD"]
+
+  # Dashboard URL path (default: "/findbug")
+  config.web_path = "/findbug"
+
+  # ============================================================================
+  # ALERTS
+  # ============================================================================
+
+  config.alerts do |alerts|
+    # Throttle period - don't alert for same error more than once in this period
+    alerts.throttle_period = 5.minutes
+
+    # Email alerts
+    # alerts.email(
+    #   enabled: true,
+    #   recipients: ["dev-team@example.com"]
+    # )
+
+    # Slack alerts
+    # alerts.slack(
+    #   enabled: true,
+    #   webhook_url: ENV["SLACK_WEBHOOK_URL"],
+    #   channel: "#errors"  # optional
+    # )
+
+    # Discord alerts
+    # alerts.discord(
+    #   enabled: true,
+    #   webhook_url: ENV["DISCORD_WEBHOOK_URL"]
+    # )
+
+    # Generic webhook
+    # alerts.webhook(
+    #   enabled: true,
+    #   url: "https://your-service.com/findbug-webhook",
+    #   headers: { "Authorization" => "Bearer #{ENV['WEBHOOK_TOKEN']}" }
+    # )
+  end
+
+  # ============================================================================
+  # MISC
+  # ============================================================================
+
+  # Release/version identifier (auto-detected from git or ENV)
+  # Useful for tracking which deploy introduced a bug
+  # config.release = ENV["GIT_COMMIT"]
+
+  # Custom logger (defaults to Rails.logger)
+  # config.logger = Rails.logger
+end

data/sig/findbug.rbs

@@ -0,0 +1,4 @@
+module Findbug
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,251 @@
+--- !ruby/object:Gem::Specification
+name: findbug
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Soumit Das
+bindir: exe
+cert_chain: []
+date: 2026-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: stimulus-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Findbug is a Sentry-like error tracking and performance monitoring gem
+  that stores data locally using Redis and your database. Features include exception
+  capture, performance instrumentation, alerting, and a built-in dashboard.
+email:
+- its.soumit.das@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/findbug/application_controller.rb
+- app/controllers/findbug/dashboard_controller.rb
+- app/controllers/findbug/errors_controller.rb
+- app/controllers/findbug/performance_controller.rb
+- app/jobs/findbug/alert_job.rb
+- app/jobs/findbug/cleanup_job.rb
+- app/jobs/findbug/persist_job.rb
+- app/models/findbug/error_event.rb
+- app/models/findbug/performance_event.rb
+- app/views/findbug/dashboard/index.html.erb
+- app/views/findbug/errors/index.html.erb
+- app/views/findbug/errors/show.html.erb
+- app/views/findbug/performance/index.html.erb
+- app/views/findbug/performance/show.html.erb
+- app/views/layouts/findbug/application.html.erb
+- lib/findbug.rb
+- lib/findbug/alerts/channels/base.rb
+- lib/findbug/alerts/channels/discord.rb
+- lib/findbug/alerts/channels/email.rb
+- lib/findbug/alerts/channels/slack.rb
+- lib/findbug/alerts/channels/webhook.rb
+- lib/findbug/alerts/dispatcher.rb
+- lib/findbug/alerts/throttler.rb
+- lib/findbug/background_persister.rb
+- lib/findbug/capture/context.rb
+- lib/findbug/capture/exception_handler.rb
+- lib/findbug/capture/exception_subscriber.rb
+- lib/findbug/capture/message_handler.rb
+- lib/findbug/capture/middleware.rb
+- lib/findbug/configuration.rb
+- lib/findbug/engine.rb
+- lib/findbug/performance/instrumentation.rb
+- lib/findbug/performance/transaction.rb
+- lib/findbug/processing/data_scrubber.rb
+- lib/findbug/rails/controller_methods.rb
+- lib/findbug/railtie.rb
+- lib/findbug/storage/circuit_breaker.rb
+- lib/findbug/storage/connection_pool.rb
+- lib/findbug/storage/redis_buffer.rb
+- lib/findbug/tasks/findbug.rake
+- lib/findbug/version.rb
+- lib/generators/findbug/install_generator.rb
+- lib/generators/findbug/templates/POST_INSTALL
+- lib/generators/findbug/templates/create_findbug_error_events.rb
+- lib/generators/findbug/templates/create_findbug_performance_events.rb
+- lib/generators/findbug/templates/initializer.rb
+- sig/findbug.rbs
+homepage: https://github.com/ITSSOUMIT/findbug
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ITSSOUMIT/findbug
+  source_code_uri: https://github.com/ITSSOUMIT/findbug
+  changelog_uri: https://github.com/ITSSOUMIT/findbug/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: Self-hosted error tracking and performance monitoring for Rails
+test_files: []