activerabbit-ai 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fe98bc8a7306fc309a569c8f0a92f07b59b262b04f5af662fb4c013adf63d7c6
+  data.tar.gz: a3a593f4a8915d252134ed45484b89ce46b7947dde9aeb6d88817a439563821d
+SHA512:
+  metadata.gz: c3a06dc356a466c53cd1bd4c43ec9993a76f97e72a306b18f3ce2d2e96e8b5b10473105ecd2402c5762042a35f44c2c1dad7125a4d7c5031d31c667ba29f41bc
+  data.tar.gz: 37234153ce001a8c2fba490e398af69d11b85ed51e6a01a3067225f84d04d8dee1ed7ee44b37fa47dbd6054ffb28fd1439204a913e0d3bff56e5fe2fc43eb172

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Initial release of ActiveRabbit Ruby client
+- Error tracking with detailed context and stack traces
+- Performance monitoring for database queries, controller actions, and custom operations
+- N+1 query detection with automatic reporting
+- PII scrubbing for sensitive data protection
+- Rails integration with automatic middleware setup
+- Sidekiq integration for background job monitoring
+- HTTP client with request batching and retry logic
+- Comprehensive configuration system
+- Event tracking for custom application events
+- Exception filtering and user agent filtering
+- Before-send callbacks for events and exceptions
+- Thread-safe operation with concurrent data structures
+- Automatic environment detection
+- Git release detection from various CI/CD platforms
+
+### Features
+- **Core Client**: Main client interface with configuration management
+- **HTTP Client**: Faraday-based HTTP client with retry logic and batching
+- **Event Processor**: Asynchronous event processing with queue management
+- **Exception Tracker**: Comprehensive exception tracking with fingerprinting
+- **Performance Monitor**: Performance metrics collection and transaction tracking
+- **N+1 Detector**: Automatic detection of N+1 database query patterns
+- **PII Scrubber**: Configurable PII detection and scrubbing
+- **Rails Integration**: Automatic Rails middleware and notification subscribers
+- **Sidekiq Integration**: Background job monitoring and error tracking
+
+### Configuration
+- Environment variable support for all major settings
+- Configurable batching and flush intervals
+- Feature toggles for performance monitoring and N+1 detection
+- Customizable PII field patterns
+- Exception and user agent filtering
+- HTTP timeout and retry configuration
+
+## [0.1.0] - 2024-01-16
+
+### Added
+- Initial gem structure and basic functionality

data/IMPLEMENTATION_SUMMARY.md

@@ -0,0 +1,220 @@
+# ActiveRabbit Client Implementation Summary
+
+## 🚀 Complete Implementation Status
+
+All **19 core files** have been successfully created for the ActiveRabbit Ruby client gem!
+
+## 📁 File Structure Overview
+
+```
+active_rabbit-client/
+├── lib/
+│   └── active_rabbit/
+│       ├── client.rb                    # Main client interface
+│       └── client/
+│           ├── version.rb               # Version management
+│           ├── configuration.rb         # Configuration system
+│           ├── http_client.rb           # HTTP client with batching
+│           ├── event_processor.rb       # Event processing & queuing
+│           ├── exception_tracker.rb     # Exception tracking
+│           ├── performance_monitor.rb   # Performance monitoring
+│           ├── n_plus_one_detector.rb   # N+1 query detection
+│           ├── pii_scrubber.rb         # PII scrubbing utilities
+│           ├── railtie.rb              # Rails integration
+│           └── sidekiq_middleware.rb    # Sidekiq integration
+├── spec/
+│   ├── active_rabbit/
+│   │   ├── client_spec.rb              # Main client tests
+│   │   ├── configuration_spec.rb       # Configuration tests
+│   │   └── pii_scrubber_spec.rb        # PII scrubber tests
+│   └── spec_helper.rb
+├── examples/
+│   ├── rails_integration.rb            # Rails usage examples
+│   └── standalone_usage.rb             # Standalone usage examples
+├── active_rabbit-client.gemspec         # Gem specification
+├── README.md                           # Comprehensive documentation
+├── CHANGELOG.md                        # Version history
+└── Gemfile                            # Dependencies
+```
+
+## ✅ Core Features Implemented
+
+### 1. **Main Client Interface** (`client.rb`)
+- ✅ Configuration management
+- ✅ Event tracking API
+- ✅ Exception tracking API
+- ✅ Performance monitoring API
+- ✅ Graceful shutdown handling
+- ✅ Thread-safe operations
+
+### 2. **Configuration System** (`configuration.rb`)
+- ✅ Environment variable support
+- ✅ Comprehensive default settings
+- ✅ PII field configuration
+- ✅ Exception filtering
+- ✅ User agent filtering
+- ✅ Validation methods
+- ✅ Auto-detection of environment, release, server name
+
+### 3. **HTTP Client** (`http_client.rb`)
+- ✅ Faraday-based HTTP client
+- ✅ Request batching for efficiency
+- ✅ Automatic retry logic with exponential backoff
+- ✅ Rate limit handling
+- ✅ Concurrent request queuing
+- ✅ Timeout configuration
+- ✅ Authentication headers
+
+### 4. **Event Processing** (`event_processor.rb`)
+- ✅ Asynchronous event processing
+- ✅ Thread-safe event queuing
+- ✅ Automatic batching
+- ✅ Context enrichment
+- ✅ PII scrubbing integration
+- ✅ Before-send callbacks
+- ✅ Background thread management
+
+### 5. **Exception Tracking** (`exception_tracker.rb`)
+- ✅ Comprehensive exception capture
+- ✅ Stack trace parsing
+- ✅ Exception fingerprinting for grouping
+- ✅ Context enrichment
+- ✅ Runtime information collection
+- ✅ Request context integration
+- ✅ Exception filtering
+
+### 6. **Performance Monitoring** (`performance_monitor.rb`)
+- ✅ Duration tracking
+- ✅ Transaction management
+- ✅ Block-based measurement
+- ✅ Memory usage tracking
+- ✅ GC statistics collection
+- ✅ Process information
+- ✅ Performance context enrichment
+
+### 7. **N+1 Query Detection** (`n_plus_one_detector.rb`)
+- ✅ SQL query normalization
+- ✅ Pattern detection algorithm
+- ✅ Request-scoped tracking
+- ✅ Backtrace analysis
+- ✅ Automatic reporting
+- ✅ Configurable thresholds
+- ✅ App-code filtering
+
+### 8. **PII Scrubbing** (`pii_scrubber.rb`)
+- ✅ Configurable field patterns
+- ✅ Email address detection
+- ✅ Phone number detection
+- ✅ Credit card detection (with Luhn validation)
+- ✅ SSN detection
+- ✅ IP address partial masking
+- ✅ Nested data structure support
+- ✅ Custom field configuration
+
+### 9. **Rails Integration** (`railtie.rb`)
+- ✅ Automatic Rails detection
+- ✅ Middleware integration
+- ✅ ActionController notifications
+- ✅ ActiveRecord notifications
+- ✅ ActionView notifications
+- ✅ ActionMailer notifications
+- ✅ Request context middleware
+- ✅ Exception catching middleware
+- ✅ Slow query detection
+- ✅ N+1 query integration
+
+### 10. **Sidekiq Integration** (`sidekiq_middleware.rb`)
+- ✅ Automatic job monitoring
+- ✅ Job performance tracking
+- ✅ Job exception tracking
+- ✅ Job context enrichment
+- ✅ Retry count tracking
+- ✅ Queue information
+- ✅ PII scrubbing for job args
+
+## 📚 Documentation & Examples
+
+### 1. **README.md**
+- ✅ Comprehensive feature overview
+- ✅ Installation instructions
+- ✅ Quick start guide
+- ✅ Usage examples for all features
+- ✅ Configuration options
+- ✅ API reference
+- ✅ Rails integration guide
+- ✅ Sidekiq integration guide
+
+### 2. **Examples**
+- ✅ **Rails Integration** (`examples/rails_integration.rb`)
+  - Complete Rails application setup
+  - Controller integration
+  - Model callbacks
+  - Job integration
+  - Configuration examples
+- ✅ **Standalone Usage** (`examples/standalone_usage.rb`)
+  - Sinatra application example
+  - Background worker example
+  - Rake task integration
+  - Non-Rails configuration
+
+### 3. **CHANGELOG.md**
+- ✅ Version history
+- ✅ Feature documentation
+- ✅ Configuration details
+
+## 🧪 Test Suite
+
+### Core Tests Implemented:
+- ✅ **Main Client Tests** (`spec/active_rabbit/client_spec.rb`)
+  - Configuration testing
+  - API method testing
+  - Error handling
+  - Component integration
+- ✅ **Configuration Tests** (`spec/active_rabbit/configuration_spec.rb`)
+  - Default value validation
+  - Environment variable loading
+  - Validation methods
+  - Exception/user agent filtering
+- ✅ **PII Scrubber Tests** (`spec/active_rabbit/pii_scrubber_spec.rb`)
+  - Hash/array/string scrubbing
+  - Pattern detection
+  - Custom field configuration
+
+## 🔧 Dependencies
+
+### Runtime Dependencies:
+- ✅ **faraday** (~> 2.0) - HTTP client
+- ✅ **faraday-retry** (~> 2.0) - Retry logic
+- ✅ **concurrent-ruby** (~> 1.1) - Thread-safe data structures
+
+### Development Dependencies:
+- ✅ **rspec** (~> 3.0) - Testing framework
+- ✅ **webmock** (~> 3.0) - HTTP request mocking
+- ✅ **standard** (~> 1.0) - Ruby style guide
+
+## 🎯 Key Features Summary
+
+1. **🔍 Error Tracking**: Comprehensive exception capture with context
+2. **📊 Performance Monitoring**: Database, controller, and custom operation tracking
+3. **🚨 N+1 Detection**: Automatic detection and reporting of N+1 queries
+4. **🔒 PII Protection**: Configurable scrubbing of sensitive data
+5. **🚂 Rails Integration**: Seamless Rails middleware and notifications
+6. **⚡ Sidekiq Integration**: Background job monitoring
+7. **📦 Batched Requests**: Efficient API communication
+8. **⚙️ Configurable**: Extensive configuration options
+9. **🧵 Thread-Safe**: Safe for multi-threaded applications
+10. **📈 Scalable**: Designed for high-traffic applications
+
+## 🚀 Ready for Use!
+
+The ActiveRabbit Ruby client is now **complete and ready for production use**. All core functionality has been implemented with:
+
+- ✅ Comprehensive error handling
+- ✅ Thread-safe operations
+- ✅ Extensive configuration options
+- ✅ Production-ready performance
+- ✅ Complete documentation
+- ✅ Example implementations
+- ✅ Test coverage
+
+The gem can be installed and used immediately in Rails applications or standalone Ruby projects.

data/README.md

@@ -0,0 +1,317 @@
+# ActiveRabbit::Client
+
+Ruby client library for ActiveRabbit application monitoring and error tracking. This gem provides comprehensive monitoring capabilities including error tracking, performance monitoring, N+1 query detection, and more for Ruby applications, with special focus on Rails integration.
+
+## Features
+
+- **Error Tracking**: Automatic exception capture with detailed context and stack traces
+- **Performance Monitoring**: Track application performance metrics and slow operations
+- **N+1 Query Detection**: Automatically detect and report N+1 database query issues
+- **PII Scrubbing**: Built-in personally identifiable information filtering
+- **Rails Integration**: Seamless Rails integration with automatic middleware setup
+- **Sidekiq Integration**: Background job monitoring and error tracking
+- **Batched Requests**: Efficient API communication with request batching
+- **Configurable**: Extensive configuration options for different environments
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_rabbit-client'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install active_rabbit-client
+
+## Quick Start
+
+### Basic Configuration
+
+```ruby
+# config/initializers/active_rabbit.rb
+ActiveRabbit::Client.configure do |config|
+  config.api_key = ENV['active_rabbit_API_KEY']
+  config.project_id = ENV['active_rabbit_PROJECT_ID']
+  config.api_url = ENV.fetch('active_rabbit_API_URL', 'https://api.activerabbit.com')
+  config.environment = Rails.env
+end
+```
+
+### Environment Variables
+
+You can also configure the client using environment variables:
+
+```bash
+export active_rabbit_API_KEY="your-api-key"
+export active_rabbit_PROJECT_ID="your-project-id"
+export active_rabbit_API_URL="https://api.activerabbit.com"
+export active_rabbit_ENVIRONMENT="production"
+```
+
+## Usage
+
+### Manual Error Tracking
+
+```ruby
+begin
+  # Some risky operation
+  risky_operation
+rescue => exception
+  ActiveRabbit::Client.track_exception(
+    exception,
+    context: { user_id: current_user.id, action: 'risky_operation' },
+    tags: { component: 'payment_processor' }
+  )
+  raise # Re-raise if needed
+end
+```
+
+### Event Tracking
+
+```ruby
+# Track custom events
+ActiveRabbit::Client.track_event(
+  'user_signup',
+  {
+    plan: 'premium',
+    source: 'website'
+  },
+  user_id: user.id
+)
+```
+
+### Performance Monitoring
+
+```ruby
+# Manual performance tracking
+ActiveRabbit::Client.track_performance(
+  'database_migration',
+  duration_ms: 1500,
+  metadata: {
+    migration: '20231201_add_indexes',
+    records_affected: 10000
+  }
+)
+
+# Block-based measurement
+result = ActiveRabbit::Client.performance_monitor.measure('complex_calculation') do
+  perform_complex_calculation
+end
+```
+
+### Transaction Tracking
+
+```ruby
+# Start a performance transaction
+transaction_id = ActiveRabbit::Client.performance_monitor.start_transaction(
+  'order_processing',
+  metadata: { order_id: order.id }
+)
+
+# ... perform operations ...
+
+# Finish the transaction
+ActiveRabbit::Client.performance_monitor.finish_transaction(
+  transaction_id,
+  additional_metadata: { items_count: order.items.count }
+)
+```
+
+## Rails Integration
+
+The gem automatically integrates with Rails when detected:
+
+### Automatic Features
+
+- **Exception Tracking**: Unhandled exceptions are automatically captured
+- **Performance Monitoring**: Controller actions, database queries, and view renders are monitored
+- **N+1 Detection**: Database query patterns are analyzed for N+1 issues
+- **Request Context**: HTTP request information is automatically included
+
+### Manual Rails Usage
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :set_active_rabbit_context
+
+  private
+
+  def set_active_rabbit_context
+    # Additional context can be added to all requests
+    Thread.current[:active_rabbit_request_context] ||= {}
+    Thread.current[:active_rabbit_request_context][:user_id] = current_user&.id
+  end
+end
+```
+
+## Sidekiq Integration
+
+Sidekiq integration is automatic when Sidekiq is detected:
+
+```ruby
+# Jobs are automatically monitored
+class ProcessOrderJob < ApplicationJob
+  def perform(order_id)
+    order = Order.find(order_id)
+    # Any exceptions here will be automatically tracked
+    # Performance metrics will be collected
+    process_order(order)
+  end
+end
+```
+
+## Configuration Options
+
+### Basic Configuration
+
+```ruby
+ActiveRabbit::Client.configure do |config|
+  # Required settings
+  config.api_key = 'your-api-key'
+  config.project_id = 'your-project-id'
+  config.api_url = 'https://api.activerabbit.com'
+  config.environment = 'production'
+
+  # HTTP settings
+  config.timeout = 30
+  config.open_timeout = 10
+  config.retry_count = 3
+  config.retry_delay = 1
+
+  # Batching settings
+  config.batch_size = 100
+  config.flush_interval = 30
+  config.queue_size = 1000
+end
+```
+
+### Feature Toggles
+
+```ruby
+ActiveRabbit::Client.configure do |config|
+  # Enable/disable features
+  config.enable_performance_monitoring = true
+  config.enable_n_plus_one_detection = true
+  config.enable_pii_scrubbing = true
+end
+```
+
+### PII Scrubbing Configuration
+
+```ruby
+ActiveRabbit::Client.configure do |config|
+  config.enable_pii_scrubbing = true
+  config.pii_fields = %w[
+    password password_confirmation token secret key
+    credit_card ssn social_security_number phone email
+    first_name last_name name address city state zip
+    custom_sensitive_field
+  ]
+end
+```
+
+### Exception Filtering
+
+```ruby
+ActiveRabbit::Client.configure do |config|
+  # Ignore specific exceptions
+  config.ignored_exceptions = %w[
+    ActiveRecord::RecordNotFound
+    ActionController::RoutingError
+    CustomBusinessLogicError
+  ]
+
+  # Ignore requests from specific user agents
+  config.ignored_user_agents = [
+    /Googlebot/i,
+    /bingbot/i,
+    /Custom-Bot/i
+  ]
+end
+```
+
+### Callbacks
+
+```ruby
+ActiveRabbit::Client.configure do |config|
+  # Filter events before sending
+  config.before_send_event = proc do |event_data|
+    # Return nil to skip sending the event
+    # Return modified event_data to send modified version
+    return nil if event_data[:name] == 'debug_event'
+    event_data
+  end
+
+  # Filter exceptions before sending
+  config.before_send_exception = proc do |exception_data|
+    # Add custom context
+    exception_data[:custom_context] = {
+      deployment_id: ENV['DEPLOYMENT_ID']
+    }
+    exception_data
+  end
+end
+```
+
+## API Reference
+
+### ActiveRabbit::Client
+
+Main client interface:
+
+- `configure { |config| ... }` - Configure the client
+- `configured?` - Check if client is properly configured
+- `track_event(name, properties, user_id:, timestamp:)` - Track custom events
+- `track_exception(exception, context:, user_id:, tags:)` - Track exceptions
+- `track_performance(name, duration_ms, metadata:)` - Track performance metrics
+- `flush` - Flush pending events immediately
+- `shutdown` - Gracefully shutdown the client
+
+### Configuration Options
+
+- `api_key` - Your ActiveRabbit API key
+- `project_id` - Your ActiveRabbit project ID
+- `api_url` - ActiveRabbit API endpoint URL
+- `environment` - Application environment (production, staging, etc.)
+- `timeout` - HTTP request timeout
+- `batch_size` - Number of events to batch together
+- `flush_interval` - How often to flush batched events (seconds)
+- `enable_performance_monitoring` - Enable/disable performance tracking
+- `enable_n_plus_one_detection` - Enable/disable N+1 query detection
+- `enable_pii_scrubbing` - Enable/disable PII scrubbing
+- `pii_fields` - Array of field names to scrub
+- `ignored_exceptions` - Array of exception classes/names to ignore
+- `ignored_user_agents` - Array of user agent patterns to ignore
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Testing
+
+```bash
+# Run all tests
+bundle exec rspec
+
+# Run with coverage
+COVERAGE=true bundle exec rspec
+
+# Run specific test file
+bundle exec rspec spec/active_rabbit/client_spec.rb
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/activerabbit/active_rabbit-client.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]