apm_bro 0.1.16 → 0.1.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7bf4fc110108b143a2f2e608090ae8c75a5882f8634ef1c01d0ddb949d41e54a
4
- data.tar.gz: 7c5bd6915f805032ca63b73ab9325ce64b262d8489c2842b45c28a02e84b961d
3
+ metadata.gz: 235bb0964fa7bad2508335a33a743a3d7202757523660570b9a0aaa31ab36a41
4
+ data.tar.gz: b75c946a211a2da589e9a05534d70669ef296cc15be3d753d349e5ff6367eb5e
5
5
  SHA512:
6
- metadata.gz: 601ed7213bb2dc1b551ba8d8e47944492bd67b727b0747aaad9c60b5ce13fb2b728b218a43eb0775e1479f5684ea1721dd0b9310bd25d2ccfcfcfad8cfc9e439
7
- data.tar.gz: b8a2e25e5c0369d7bd58fe058ef7d524bdc42c7cc22739d30f9ad0956338370f63578aa10688869c817148451b46d7b9e1dab8835c4e7f33531cd9146a04ed88
6
+ metadata.gz: 96b1f310fe50eec5072e1ac93f96108a342ab60d85aef80635ead30044174469b39979d766d69b54b767ae259be712d40fb7fd05dafc21f701deef6923e721a0
7
+ data.tar.gz: 891c797268cfb6910bf3ddfd5e139586f1c1aa4002002edf2d63287c6548374d7798d079eb94de8fa4857cf7cecf995fcea2eefd224f591e243eec8f306e79c6
data/FEATURES.md ADDED
@@ -0,0 +1,338 @@
1
+ # ApmBro Feature List
2
+
3
+ A comprehensive feature list for comparing ApmBro with other APM (Application Performance Monitoring) tools.
4
+
5
+ ## Core Architecture
6
+
7
+ - **Rails Integration**: Automatic subscription to Rails events via ActiveSupport::Notifications
8
+ - **Zero-Configuration Setup**: Works out of the box with minimal configuration
9
+ - **Asynchronous Metrics Posting**: Non-blocking HTTP requests using background threads
10
+ - **Thread-Local Storage**: Per-request metric collection using thread-local variables
11
+ - **Circuit Breaker Pattern**: Built-in circuit breaker to prevent cascading failures when APM endpoint is down
12
+ - **Deploy Tracking**: Automatic deploy ID resolution from multiple sources (Rails settings, ENV vars, Heroku, Git)
13
+
14
+ ## Request Tracking
15
+
16
+ ### Controller Action Monitoring
17
+ - **Automatic Tracking**: Tracks all controller actions automatically
18
+ - **Request Duration**: Measures total request processing time
19
+ - **HTTP Method & Path**: Captures HTTP method and request path
20
+ - **Status Codes**: Tracks HTTP response status codes
21
+ - **View Runtime**: Separate tracking of view rendering time
22
+ - **Database Runtime**: Separate tracking of database query time
23
+ - **Request Parameters**: Captures request parameters (with sensitive data filtering)
24
+ - **User Agent**: Tracks user agent strings
25
+ - **User ID Extraction**: Extracts authenticated user ID (supports Warden)
26
+ - **Environment Context**: Tracks Rails environment (development, staging, production)
27
+
28
+ ### Request Sampling
29
+ - **Configurable Sample Rate**: Percentage-based sampling (1-100%)
30
+ - **Random Sampling**: Each request has random chance of being tracked
31
+ - **Consistent Per-Request**: Sampling decision applies to all metrics for a request
32
+ - **Error Override**: Errors are always tracked regardless of sampling
33
+ - **Cost Optimization**: Reduces data volume and costs for high-traffic applications
34
+
35
+ ### Exclusion Rules
36
+ - **Controller Exclusion**: Exclude entire controllers from tracking
37
+ - **Action Exclusion**: Exclude specific controller#action combinations
38
+ - **Wildcard Support**: Pattern matching with `*` wildcards (e.g., `Admin::*`, `Admin::*#*`)
39
+ - **Job Exclusion**: Exclude specific background jobs from tracking
40
+ - **Flexible Configuration**: Configure via initializer, Rails settings, or environment variables
41
+
42
+ ## SQL Query Tracking
43
+
44
+ ### Query Details
45
+ - **Full SQL Tracking**: Captures all SQL queries executed during requests and jobs
46
+ - **Query Sanitization**: Automatically sanitizes SQL to remove sensitive data
47
+ - **Query Name**: Tracks query names (e.g., "User Load", "User Update")
48
+ - **Duration Measurement**: Precise query execution time in milliseconds
49
+ - **Cache Detection**: Identifies cached queries
50
+ - **Connection ID**: Tracks database connection ID
51
+ - **Call Stack Traces**: Full backtrace showing where queries were executed
52
+ - **Object Allocations**: Optional tracking of object allocations per query
53
+
54
+ ### Query Performance Analysis
55
+ - **Slow Query Detection**: Configurable threshold for identifying slow queries
56
+ - **EXPLAIN ANALYZE**: Automatic execution plan capture for slow queries
57
+ - **Background Execution**: EXPLAIN ANALYZE runs in separate thread (non-blocking)
58
+ - **Multi-Database Support**: Works with PostgreSQL, MySQL, SQLite, and others
59
+ - **Smart Filtering**: Automatically skips transaction queries (BEGIN, COMMIT, ROLLBACK)
60
+ - **Execution Plan Details**:
61
+ - PostgreSQL: Full EXPLAIN ANALYZE with buffer usage statistics
62
+ - MySQL: EXPLAIN ANALYZE with actual execution times
63
+ - SQLite: EXPLAIN QUERY PLAN output
64
+ - **Query Optimization Insights**: Helps identify missing indexes, full table scans, JOIN issues
65
+
66
+ ## View Rendering Tracking
67
+
68
+ ### View Performance
69
+ - **Template Rendering**: Tracks main template rendering
70
+ - **Partial Rendering**: Tracks partial template rendering with cache key information
71
+ - **Collection Rendering**: Tracks collection rendering (partials in loops)
72
+ - **Rendering Duration**: Precise timing for each view component
73
+ - **Virtual Path Tracking**: Tracks view virtual paths
74
+ - **Layout Information**: Captures layout usage
75
+
76
+ ### View Analysis
77
+ - **Slow View Detection**: Identifies the slowest rendering views
78
+ - **Frequency Analysis**: Tracks most frequently rendered views
79
+ - **Cache Hit Rate**: Calculates cache hit rates for partials
80
+ - **Collection Cache Analysis**: Tracks cache hit rates for collection rendering
81
+ - **Performance Metrics**:
82
+ - Total views rendered per request
83
+ - Total view rendering duration
84
+ - Average view rendering duration
85
+ - Breakdown by view type (template, partial, collection)
86
+
87
+ ## Memory Tracking & Leak Detection
88
+
89
+ ### Lightweight Memory Tracking (Default)
90
+ - **Memory Usage Monitoring**: Tracks memory consumption per request using GC stats
91
+ - **Memory Growth Tracking**: Measures memory growth during request processing
92
+ - **GC Statistics**: Tracks garbage collection count and heap pages
93
+ - **Minimal Performance Impact**: ~0.1ms overhead per request
94
+ - **Memory Before/After**: Captures memory state at request start and end
95
+
96
+ ### Detailed Allocation Tracking (Optional)
97
+ - **Object Allocation Tracking**: Detailed tracking of object allocations (disabled by default)
98
+ - **Allocation Sampling**: Configurable sampling rate for allocations
99
+ - **Large Object Detection**: Identifies objects larger than 1MB threshold
100
+ - **Memory Snapshots**: Periodic memory snapshots during request processing
101
+ - **Object Count Tracking**: Tracks object counts before and after requests
102
+ - **Performance Impact**: ~2-5ms overhead per request (only when enabled)
103
+
104
+ ### Memory Leak Detection
105
+ - **Pattern Detection**: Detects growing memory patterns over time
106
+ - **GC Efficiency Analysis**: Monitors garbage collection effectiveness
107
+ - **Heap Page Tracking**: Tracks heap page growth
108
+ - **Request Correlation**: Correlates memory growth with specific controllers/actions
109
+
110
+ ## Background Job Tracking
111
+
112
+ ### Job Execution Monitoring
113
+ - **ActiveJob Integration**: Automatic tracking when ActiveJob is available
114
+ - **Job Class Tracking**: Tracks job class names
115
+ - **Job ID**: Captures unique job identifiers
116
+ - **Queue Name**: Tracks which queue processed the job
117
+ - **Job Arguments**: Captures job arguments (with sensitive data filtering)
118
+ - **Duration Measurement**: Precise job execution time in milliseconds
119
+ - **Status Tracking**: Tracks job status (completed or failed)
120
+
121
+ ### Job Error Tracking
122
+ - **Exception Capture**: Captures exceptions from failed jobs
123
+ - **Exception Class**: Tracks exception class names
124
+ - **Exception Messages**: Captures exception messages (truncated to 1000 chars)
125
+ - **Backtraces**: Full exception backtraces (first 50 lines)
126
+ - **SQL Query Context**: Includes SQL queries executed during failed jobs
127
+ - **Memory Context**: Includes memory usage during job execution
128
+
129
+ ### Job SQL Tracking
130
+ - **SQL Query Tracking**: Tracks all SQL queries executed during job processing
131
+ - **Query Details**: Same detailed SQL tracking as request tracking
132
+ - **Query Context**: Full context of database operations in background jobs
133
+
134
+ ## Cache Tracking
135
+
136
+ ### Cache Operations
137
+ - **Read Operations**: Tracks cache read operations
138
+ - **Write Operations**: Tracks cache write operations
139
+ - **Delete Operations**: Tracks cache delete operations
140
+ - **Existence Checks**: Tracks cache existence checks
141
+ - **Fetch Operations**: Tracks cache fetch with hit/miss detection
142
+ - **Multi-Read Operations**: Tracks cache read_multi operations
143
+ - **Multi-Write Operations**: Tracks cache write_multi operations
144
+ - **Cache Generation**: Tracks cache generation events
145
+
146
+ ### Cache Analysis
147
+ - **Cache Hit Detection**: Identifies cache hits vs misses
148
+ - **Cache Key Tracking**: Tracks cache keys (truncated to 200 chars)
149
+ - **Store Information**: Identifies which cache store was used
150
+ - **Namespace Tracking**: Tracks cache namespaces
151
+ - **Duration Measurement**: Precise timing for each cache operation
152
+ - **Hit Rate Calculation**: Calculates cache hit rates per request
153
+
154
+ ## Redis Tracking
155
+
156
+ ### Redis Command Tracking
157
+ - **Command Monitoring**: Tracks all Redis commands executed
158
+ - **Command Name**: Captures Redis command names (GET, SET, etc.)
159
+ - **Key Tracking**: Tracks Redis keys (truncated to 200 chars)
160
+ - **Argument Count**: Tracks number of arguments per command
161
+ - **Database Selection**: Tracks which Redis database is used
162
+ - **Duration Measurement**: Precise timing for each Redis command
163
+ - **Error Tracking**: Captures Redis command errors
164
+
165
+ ### Advanced Redis Features
166
+ - **Pipeline Support**: Tracks Redis pipeline operations with command counts
167
+ - **Multi/Transaction Support**: Tracks Redis MULTI/EXEC transactions
168
+ - **ActiveSupport Integration**: Subscribes to ActiveSupport::Notifications for Redis events
169
+ - **Client Instrumentation**: Direct instrumentation of Redis::Client for comprehensive coverage
170
+
171
+ ## Error Tracking
172
+
173
+ ### Exception Handling
174
+ - **Automatic Exception Capture**: Captures exceptions from controller actions
175
+ - **Exception Class**: Tracks exception class names
176
+ - **Exception Messages**: Captures exception messages (truncated to 1000 chars)
177
+ - **Full Backtraces**: Captures complete exception backtraces (first 50 lines)
178
+ - **Request Context**: Includes full request context with exceptions
179
+ - **Error Flagging**: Errors are marked and always tracked (even with sampling)
180
+
181
+ ### Error Context
182
+ - **Controller/Action**: Identifies where the error occurred
183
+ - **Request Parameters**: Includes request parameters at time of error
184
+ - **User Information**: Includes user ID if available
185
+ - **SQL Queries**: Includes SQL queries executed before error
186
+ - **Memory State**: Includes memory usage at time of error
187
+ - **Log Messages**: Includes application logs captured during request
188
+
189
+ ## HTTP Instrumentation
190
+
191
+ ### Outgoing HTTP Tracking
192
+ - **HTTP Request Tracking**: Tracks outgoing HTTP requests (via middleware)
193
+ - **Request Context**: Captures HTTP request details
194
+ - **Response Context**: Captures HTTP response details
195
+ - **Duration Measurement**: Tracks HTTP request duration
196
+
197
+ ## Configuration & Flexibility
198
+
199
+ ### Configuration Options
200
+ - **API Key Management**: Multiple sources (config, Rails credentials, ENV)
201
+ - **Endpoint Configuration**: Configurable endpoint URL
202
+ - **Timeout Settings**: Configurable open and read timeouts
203
+ - **Enable/Disable Toggle**: Can be enabled/disabled via configuration
204
+ - **Environment Detection**: Automatic Rails environment detection
205
+
206
+ ### Circuit Breaker Configuration
207
+ - **Failure Threshold**: Configurable failure threshold (default: 3)
208
+ - **Recovery Timeout**: Configurable recovery timeout (default: 60 seconds)
209
+ - **Retry Timeout**: Configurable retry timeout (default: 300 seconds)
210
+ - **Enable/Disable**: Can enable/disable circuit breaker
211
+
212
+ ### Memory Tracking Configuration
213
+ - **Memory Tracking Toggle**: Enable/disable memory tracking
214
+ - **Allocation Tracking Toggle**: Enable/disable detailed allocation tracking
215
+ - **Sampling Configuration**: Configurable request sampling rate
216
+
217
+ ### Query Analysis Configuration
218
+ - **Slow Query Threshold**: Configurable threshold in milliseconds (default: 500ms)
219
+ - **EXPLAIN ANALYZE Toggle**: Enable/disable automatic EXPLAIN ANALYZE
220
+
221
+ ## Data Safety & Privacy
222
+
223
+ ### Data Sanitization
224
+ - **SQL Sanitization**: Automatically sanitizes SQL queries
225
+ - **Parameter Filtering**: Filters sensitive parameters (password, token, secret, key)
226
+ - **Argument Truncation**: Limits and truncates job arguments
227
+ - **Key Truncation**: Truncates cache and Redis keys to 200 characters
228
+ - **Value Truncation**: Recursively truncates nested values to prevent huge payloads
229
+ - **String Limits**: Limits string values (e.g., user agent to 200 chars, messages to 1000 chars)
230
+
231
+ ### Data Limits
232
+ - **Array Limits**: Limits array sizes (e.g., first 10 job arguments, first 5 array elements)
233
+ - **Hash Limits**: Limits hash key counts (e.g., first 20 hash keys, first 30 params)
234
+ - **Backtrace Limits**: Limits backtraces to first 50 lines
235
+ - **Allocation Limits**: Limits allocations tracked per request (max 1000)
236
+
237
+ ## Performance & Reliability
238
+
239
+ ### Performance Optimizations
240
+ - **Asynchronous Posting**: Non-blocking HTTP requests
241
+ - **Lightweight Default Mode**: Minimal overhead in default configuration
242
+ - **Sampling Support**: Reduces data volume for high-traffic applications
243
+ - **Thread-Local Storage**: Efficient per-request data collection
244
+ - **Background EXPLAIN**: EXPLAIN ANALYZE runs in background thread
245
+
246
+ ### Reliability Features
247
+ - **Circuit Breaker**: Prevents cascading failures
248
+ - **Error Handling**: Comprehensive error handling to prevent instrumentation failures
249
+ - **Graceful Degradation**: Continues working even if some features fail
250
+ - **Timeout Protection**: Configurable timeouts prevent hanging requests
251
+
252
+ ## Integration & Compatibility
253
+
254
+ ### Framework Support
255
+ - **Rails Integration**: Full Rails integration via Railtie
256
+ - **ActiveSupport Notifications**: Uses ActiveSupport::Notifications for event subscription
257
+ - **ActiveRecord Integration**: Tracks ActiveRecord SQL queries
258
+ - **ActiveJob Integration**: Tracks ActiveJob background jobs
259
+ - **ActionView Integration**: Tracks ActionView rendering
260
+
261
+ ### Database Support
262
+ - **PostgreSQL**: Full support with EXPLAIN ANALYZE
263
+ - **MySQL**: Full support with EXPLAIN ANALYZE
264
+ - **SQLite**: Full support with EXPLAIN QUERY PLAN
265
+ - **Other Databases**: Basic support with standard EXPLAIN
266
+
267
+ ### Cache Store Support
268
+ - **All Cache Stores**: Works with any Rails cache store
269
+ - **Multi-Store Support**: Tracks cache operations across different stores
270
+
271
+ ### Redis Support
272
+ - **Redis Gem**: Works with redis gem
273
+ - **Client Instrumentation**: Direct instrumentation of Redis::Client
274
+ - **Pipeline Support**: Tracks Redis pipelines
275
+ - **Transaction Support**: Tracks Redis MULTI/EXEC transactions
276
+
277
+ ## Logging & Debugging
278
+
279
+ ### Application Logging
280
+ - **Log Capture**: Captures application logs during request processing
281
+ - **Log Context**: Includes logs in metric payloads
282
+ - **Debug Logging**: Optional debug logging for skipped requests
283
+
284
+ ## Deployment & Environment
285
+
286
+ ### Deploy Tracking
287
+ - **Deploy ID Resolution**: Multiple sources for deploy identification
288
+ - Explicit configuration
289
+ - Rails settings/credentials
290
+ - Environment variables (APM_BRO_DEPLOY_ID, GIT_REV)
291
+ - Heroku (HEROKU_SLUG_COMMIT)
292
+ - Process-stable UUID fallback
293
+ - **Revision Tracking**: Includes deploy/revision ID in all metric payloads
294
+
295
+ ### Environment Support
296
+ - **Rails Environment**: Automatic Rails environment detection
297
+ - **Rack Environment**: Fallback to RACK_ENV or RAILS_ENV
298
+ - **Environment Context**: Includes environment in all metric payloads
299
+
300
+ ## Data Collection & Transmission
301
+
302
+ ### Metric Payload Structure
303
+ - **Structured Data**: Well-structured JSON payloads
304
+ - **Event Names**: Descriptive event names for different metric types
305
+ - **Timestamp Tracking**: ISO8601 timestamps for all metrics
306
+ - **Metadata**: Rich metadata including environment, host, deploy ID
307
+
308
+ ### HTTP Client
309
+ - **HTTPS Support**: Secure HTTPS communication
310
+ - **Bearer Token Auth**: API key authentication via Bearer tokens
311
+ - **JSON Encoding**: JSON-encoded payloads
312
+ - **Custom Headers**: Proper Content-Type and Authorization headers
313
+
314
+ ## Comparison-Ready Features
315
+
316
+ ### Unique Differentiators
317
+ 1. **Automatic EXPLAIN ANALYZE**: Background execution plan capture for slow queries
318
+ 2. **Lightweight Memory Tracking**: Low-overhead memory monitoring by default
319
+ 3. **Comprehensive Cache Tracking**: Detailed cache operation tracking
320
+ 4. **Redis Instrumentation**: Full Redis command tracking including pipelines
321
+ 5. **View Rendering Analysis**: Detailed view performance analysis with cache hit rates
322
+ 6. **Flexible Exclusion Rules**: Wildcard support for controller/job exclusion
323
+ 7. **Request Sampling**: Configurable percentage-based sampling
324
+ 8. **Circuit Breaker**: Built-in resilience for APM endpoint failures
325
+ 9. **Multi-Source Configuration**: Flexible configuration from multiple sources
326
+ 10. **Deploy Tracking**: Automatic deploy ID resolution from multiple sources
327
+
328
+ ### Standard APM Features
329
+ - Request/response tracking
330
+ - SQL query tracking
331
+ - Error tracking
332
+ - Background job tracking
333
+ - Memory tracking
334
+ - Performance metrics
335
+ - Exception handling
336
+ - User context
337
+ - Environment tracking
338
+
data/README.md CHANGED
@@ -99,6 +99,56 @@ Notes:
99
99
  - Wildcards `*` are supported for controller and action (e.g., `Admin::*#*`).
100
100
  - Matching is done against full names like `UsersController`, `Admin::ReportsController#index`, `MyJob`.
101
101
 
102
+ ## Exclusive Tracking (Whitelist Mode)
103
+
104
+ You can configure ApmBro to **only** track specific controllers, actions, or jobs. This is useful when you want to focus monitoring on a subset of your application.
105
+
106
+ ### Configuration
107
+
108
+ ```ruby
109
+ ApmBro.configure do |config|
110
+ # Only track these specific controller actions
111
+ config.exclusive_controller_actions = [
112
+ "UsersController#show",
113
+ "UsersController#index",
114
+ "Admin::ReportsController#*", # all actions in this controller
115
+ "Api::*#*" # all actions in all Api controllers
116
+ ]
117
+
118
+ # Only track these specific jobs
119
+ config.exclusive_jobs = [
120
+ "PaymentProcessingJob",
121
+ "EmailDeliveryJob",
122
+ "Admin::*" # all jobs in Admin namespace
123
+ ]
124
+ end
125
+ ```
126
+
127
+ ### How It Works
128
+
129
+ - **If `exclusive_controller_actions` or `exclusive_jobs` is empty/not defined**: All controllers/actions/jobs are tracked (default behavior)
130
+ - **If `exclusive_controller_actions` or `exclusive_jobs` is defined with values**: Only matching controllers/actions/jobs are tracked
131
+ - **Exclusion takes precedence**: If something is in both `excluded_*` and `exclusive_*`, it will be excluded (exclusion is checked first)
132
+
133
+ ### Use Cases
134
+
135
+ - **Focus on Critical Paths**: Monitor only your most important endpoints
136
+ - **Cost Optimization**: Track only specific high-value operations
137
+ - **Debugging**: Temporarily focus on specific controllers/jobs during investigation
138
+ - **Compliance**: Track only operations that require monitoring for compliance reasons
139
+
140
+ ### Environment Variables
141
+
142
+ You can also configure exclusive tracking via environment variables:
143
+
144
+ ```bash
145
+ # Comma-separated list of controller#action patterns
146
+ APM_BRO_EXCLUSIVE_CONTROLLER_ACTIONS="UsersController#show,Admin::*#*"
147
+
148
+ # Comma-separated list of job patterns
149
+ APM_BRO_EXCLUSIVE_JOBS="PaymentProcessingJob,EmailDeliveryJob"
150
+ ```
151
+
102
152
  ## SQL Query Tracking
103
153
 
104
154
  ApmBro automatically tracks SQL queries executed during each request and job. Each request will include a `sql_queries` array containing:
@@ -59,9 +59,10 @@ module ApmBro
59
59
  end
60
60
 
61
61
  def make_http_request(event_name, payload, api_key)
62
+ production_url = ENV["USE_STAGING_ENDPOINT"].present? ? "https://deadbro.aberatii.com/apm/v1/metrics" : "https://www.deadbro.com/apm/v1/metrics"
62
63
  endpoint_url = (@configuration.respond_to?(:ruby_dev) && @configuration.ruby_dev) ?
63
64
  "http://localhost:3100/apm/v1/metrics" :
64
- "https://www.deadbro.com/apm/v1/metrics"
65
+ production_url
65
66
 
66
67
  uri = URI.parse(endpoint_url)
67
68
  http = Net::HTTP.new(uri.host, uri.port)
@@ -4,7 +4,7 @@ module ApmBro
4
4
  class Configuration
5
5
  DEFAULT_ENDPOINT_PATH = "/v1/metrics"
6
6
 
7
- attr_accessor :api_key, :endpoint_url, :open_timeout, :read_timeout, :enabled, :ruby_dev, :memory_tracking_enabled, :allocation_tracking_enabled, :circuit_breaker_enabled, :circuit_breaker_failure_threshold, :circuit_breaker_recovery_timeout, :circuit_breaker_retry_timeout, :sample_rate, :excluded_controllers, :excluded_jobs, :excluded_controller_actions, :deploy_id, :slow_query_threshold_ms, :explain_analyze_enabled
7
+ attr_accessor :api_key, :endpoint_url, :open_timeout, :read_timeout, :enabled, :ruby_dev, :memory_tracking_enabled, :allocation_tracking_enabled, :circuit_breaker_enabled, :circuit_breaker_failure_threshold, :circuit_breaker_recovery_timeout, :circuit_breaker_retry_timeout, :sample_rate, :excluded_controllers, :excluded_jobs, :excluded_controller_actions, :exclusive_controller_actions, :exclusive_jobs, :deploy_id, :slow_query_threshold_ms, :explain_analyze_enabled
8
8
 
9
9
  def initialize
10
10
  @api_key = nil
@@ -23,6 +23,8 @@ module ApmBro
23
23
  @excluded_controllers = []
24
24
  @excluded_jobs = []
25
25
  @excluded_controller_actions = []
26
+ @exclusive_controller_actions = []
27
+ @exclusive_jobs = []
26
28
  @deploy_id = resolve_deploy_id
27
29
  @slow_query_threshold_ms = 500 # Default: 500ms
28
30
  @explain_analyze_enabled = false # Enable EXPLAIN ANALYZE for slow queries by default
@@ -106,6 +108,12 @@ module ApmBro
106
108
  list.any? { |pat| match_name_or_pattern?(job_class_name, pat) }
107
109
  end
108
110
 
111
+ def exclusive_job?(job_class_name)
112
+ list = resolve_exclusive_jobs
113
+ return true if list.nil? || list.empty? # If not defined, allow all (default behavior)
114
+ list.any? { |pat| match_name_or_pattern?(job_class_name, pat) }
115
+ end
116
+
109
117
  def excluded_controller_action?(controller_name, action_name)
110
118
  list = resolve_excluded_controller_actions
111
119
  return false if list.nil? || list.empty?
@@ -113,6 +121,13 @@ module ApmBro
113
121
  list.any? { |pat| match_name_or_pattern?(target, pat) }
114
122
  end
115
123
 
124
+ def exclusive_controller_action?(controller_name, action_name)
125
+ list = resolve_exclusive_controller_actions
126
+ return true if list.nil? || list.empty? # If not defined, allow all (default behavior)
127
+ target = "#{controller_name}##{action_name}"
128
+ list.any? { |pat| match_name_or_pattern?(target, pat) }
129
+ end
130
+
116
131
  def resolve_excluded_controller_actions
117
132
  # Collect patterns from @excluded_controller_actions
118
133
  patterns = []
@@ -185,6 +200,58 @@ module ApmBro
185
200
  []
186
201
  end
187
202
 
203
+ def resolve_exclusive_controller_actions
204
+ # Collect patterns from @exclusive_controller_actions
205
+ patterns = []
206
+ if @exclusive_controller_actions && !@exclusive_controller_actions.empty?
207
+ patterns.concat(Array(@exclusive_controller_actions))
208
+ end
209
+
210
+ return patterns if !patterns.empty?
211
+
212
+ if defined?(Rails)
213
+ list = fetch_from_rails_settings(%w[apm_bro exclusive_controller_actions])
214
+ if list
215
+ rails_patterns = Array(list)
216
+ return rails_patterns if !rails_patterns.empty?
217
+ end
218
+ end
219
+
220
+ env = ENV["APM_BRO_EXCLUSIVE_CONTROLLER_ACTIONS"]
221
+ if env && !env.strip.empty?
222
+ env_patterns = env.split(",").map(&:strip)
223
+ return env_patterns if !env_patterns.empty?
224
+ end
225
+
226
+ []
227
+ end
228
+
229
+ def resolve_exclusive_jobs
230
+ # Collect patterns from @exclusive_jobs
231
+ patterns = []
232
+ if @exclusive_jobs && !@exclusive_jobs.empty?
233
+ patterns.concat(Array(@exclusive_jobs))
234
+ end
235
+
236
+ return patterns if !patterns.empty?
237
+
238
+ if defined?(Rails)
239
+ list = fetch_from_rails_settings(%w[apm_bro exclusive_jobs])
240
+ if list
241
+ rails_patterns = Array(list)
242
+ return rails_patterns if !rails_patterns.empty?
243
+ end
244
+ end
245
+
246
+ env = ENV["APM_BRO_EXCLUSIVE_JOBS"]
247
+ if env && !env.strip.empty?
248
+ env_patterns = env.split(",").map(&:strip)
249
+ return env_patterns if !env_patterns.empty?
250
+ end
251
+
252
+ []
253
+ end
254
+
188
255
  def should_sample?
189
256
  sample_rate = resolve_sample_rate
190
257
  return true if sample_rate >= 100
@@ -38,7 +38,7 @@ module ApmBro
38
38
 
39
39
  # Skip instrumentation for our own APM endpoint to prevent infinite loops,
40
40
  # but do NOT alter the original method's return value/control flow.
41
- skip_instrumentation = uri && (uri.to_s.include?("localhost") || uri.to_s.include?("uptime.aberatii.com"))
41
+ skip_instrumentation = uri && (uri.to_s.include?("localhost") || uri.to_s.include?("aberatii.com"))
42
42
 
43
43
  unless skip_instrumentation
44
44
  payload = {
@@ -85,7 +85,7 @@ module ApmBro
85
85
 
86
86
  # Skip instrumentation for our own APM endpoint to prevent infinite loops,
87
87
  # but do NOT alter the original method's return value/control flow.
88
- skip_instrumentation = req_url && req_url.include?("localhost:3100/apm/v1/metrics")
88
+ skip_instrumentation = req_url && (req_url.include?("localhost:3100/apm/v1/metrics") || req_url.include?("deadbro.aberatii.com/apm/v1/metrics"))
89
89
 
90
90
  unless skip_instrumentation
91
91
  payload = {
@@ -19,6 +19,10 @@ module ApmBro
19
19
  if ApmBro.configuration.excluded_job?(job_class_name)
20
20
  next
21
21
  end
22
+ # If exclusive_jobs is defined and not empty, only track matching jobs
23
+ unless ApmBro.configuration.exclusive_job?(job_class_name)
24
+ next
25
+ end
22
26
  rescue
23
27
  end
24
28
 
@@ -82,6 +86,10 @@ module ApmBro
82
86
  if ApmBro.configuration.excluded_job?(job_class_name)
83
87
  next
84
88
  end
89
+ # If exclusive_jobs is defined and not empty, only track matching jobs
90
+ unless ApmBro.configuration.exclusive_job?(job_class_name)
91
+ next
92
+ end
85
93
  rescue
86
94
  end
87
95
 
@@ -9,12 +9,17 @@ module ApmBro
9
9
  def self.subscribe!(client: Client.new)
10
10
  ActiveSupport::Notifications.subscribe(EVENT_NAME) do |name, started, finished, _unique_id, data|
11
11
  # Skip excluded controllers or controller#action pairs
12
+ # Also check exclusive_controller_actions - if defined, only track those
12
13
  begin
13
14
  controller_name = data[:controller].to_s
14
15
  action_name = data[:action].to_s
15
16
  if ApmBro.configuration.excluded_controller_action?(controller_name, action_name)
16
17
  next
17
18
  end
19
+ # If exclusive_controller_actions is defined and not empty, only track matching actions
20
+ unless ApmBro.configuration.exclusive_controller_action?(controller_name, action_name)
21
+ next
22
+ end
18
23
  rescue
19
24
  end
20
25
 
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module ApmBro
4
- VERSION = "0.1.16"
4
+ VERSION = "0.1.18"
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: apm_bro
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.16
4
+ version: 0.1.18
5
5
  platform: ruby
6
6
  authors:
7
7
  - Emanuel Comsa
@@ -18,6 +18,7 @@ extensions: []
18
18
  extra_rdoc_files: []
19
19
  files:
20
20
  - CHANGELOG.md
21
+ - FEATURES.md
21
22
  - README.md
22
23
  - lib/apm_bro.rb
23
24
  - lib/apm_bro/cache_subscriber.rb