dead_bro 0.2.25 → 0.2.27
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 +4 -4
- data/FEATURES.md +333 -0
- data/lib/dead_bro/configuration.rb +23 -2
- data/lib/dead_bro/job_subscriber.rb +5 -2
- data/lib/dead_bro/subscriber.rb +6 -2
- data/lib/dead_bro/version.rb +1 -1
- data/lib/dead_bro.rb +1 -0
- metadata +3 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 780f95894158f81ca92c1c1778ba4807f1dce3db4f0f3734606cf47aea3db0e4
|
|
4
|
+
data.tar.gz: 7ab0fbc93effdd1fbc0590aa30a9abc7fb1e7274f7c7f1513bdcfd2604e9200c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6552ad55cf89e93470103ee33654249c796246f416f072b9d358e3f81a49aaf5651cf52593f931ed5989800c19aea97f0857782e68989c577211b9a5d7eadb42
|
|
7
|
+
data.tar.gz: d5001a9656d7bc5407694f209fb3355d76cafc93331ae46c87485d4e187aad9592c03b0beeb305eaecafd5368ad5096ca6bb79a06ac58daadf5907e9fb0811a2
|
data/FEATURES.md
ADDED
|
@@ -0,0 +1,333 @@
|
|
|
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 (`Configuration#deploy_id=` wins when set, then ENV in `Configuration::DEPLOY_REVISION_ENV_KEYS` order—including `DEAD_BRO_DEPLOY_ID`, git/CI vars, `DD_VERSION`, etc.), otherwise a **per-process UUID** (fine for single dyno/process; unusable alone for fleets like ECS replicas)
|
|
288
|
+
- **Revision Tracking**: Includes deploy/revision ID in all metric payloads
|
|
289
|
+
|
|
290
|
+
### Environment Support
|
|
291
|
+
- **Rails Environment**: Automatic Rails environment detection
|
|
292
|
+
- **Rack Environment**: Fallback to RACK_ENV or RAILS_ENV
|
|
293
|
+
- **Environment Context**: Includes environment in all metric payloads
|
|
294
|
+
|
|
295
|
+
## Data Collection & Transmission
|
|
296
|
+
|
|
297
|
+
### Metric Payload Structure
|
|
298
|
+
- **Structured Data**: Well-structured JSON payloads
|
|
299
|
+
- **Event Names**: Descriptive event names for different metric types
|
|
300
|
+
- **Timestamp Tracking**: ISO8601 timestamps for all metrics
|
|
301
|
+
- **Metadata**: Rich metadata including environment, host, deploy ID
|
|
302
|
+
|
|
303
|
+
### HTTP Client
|
|
304
|
+
- **HTTPS Support**: Secure HTTPS communication
|
|
305
|
+
- **Bearer Token Auth**: API key authentication via Bearer tokens
|
|
306
|
+
- **JSON Encoding**: JSON-encoded payloads
|
|
307
|
+
- **Custom Headers**: Proper Content-Type and Authorization headers
|
|
308
|
+
|
|
309
|
+
## Comparison-Ready Features
|
|
310
|
+
|
|
311
|
+
### Unique Differentiators
|
|
312
|
+
1. **Automatic EXPLAIN ANALYZE**: Background execution plan capture for slow queries
|
|
313
|
+
2. **Lightweight Memory Tracking**: Low-overhead memory monitoring by default
|
|
314
|
+
3. **Comprehensive Cache Tracking**: Detailed cache operation tracking
|
|
315
|
+
4. **Redis Instrumentation**: Full Redis command tracking including pipelines
|
|
316
|
+
5. **View Rendering Analysis**: Detailed view performance analysis with cache hit rates
|
|
317
|
+
6. **Flexible Exclusion Rules**: Wildcard support for controller/job exclusion
|
|
318
|
+
7. **Request Sampling**: Configurable percentage-based sampling
|
|
319
|
+
8. **Circuit Breaker**: Built-in resilience for APM endpoint failures
|
|
320
|
+
9. **Multi-Source Configuration**: Flexible configuration from multiple sources
|
|
321
|
+
10. **Deploy Tracking**: Automatic deploy ID resolution from multiple sources
|
|
322
|
+
|
|
323
|
+
### Standard APM Features
|
|
324
|
+
- Request/response tracking
|
|
325
|
+
- SQL query tracking
|
|
326
|
+
- Error tracking
|
|
327
|
+
- Background job tracking
|
|
328
|
+
- Memory tracking
|
|
329
|
+
- Performance metrics
|
|
330
|
+
- Exception handling
|
|
331
|
+
- User context
|
|
332
|
+
- Environment tracking
|
|
333
|
+
|
|
@@ -19,6 +19,10 @@ module DeadBro
|
|
|
19
19
|
# and cache the regex form once, instead of rebuilding it per request.
|
|
20
20
|
attr_reader :excluded_controllers, :excluded_jobs, :exclusive_controllers, :exclusive_jobs
|
|
21
21
|
|
|
22
|
+
# Per-request-type sample rate overrides, keyed by exact "Controller#action"
|
|
23
|
+
# (or "JobClass#perform") strings — same identity ApmRequestType uses server-side.
|
|
24
|
+
attr_reader :sample_rates_by_type
|
|
25
|
+
|
|
22
26
|
# Tracks when we last received settings from the backend (in-memory only)
|
|
23
27
|
attr_accessor :settings_received_at
|
|
24
28
|
|
|
@@ -59,6 +63,7 @@ module DeadBro
|
|
|
59
63
|
explain_analyze_enabled slow_query_threshold_ms max_sql_queries_to_send max_logs_to_send
|
|
60
64
|
excluded_controllers excluded_jobs exclusive_controllers exclusive_jobs
|
|
61
65
|
monitor_enabled enable_db_stats enable_process_stats enable_system_stats
|
|
66
|
+
sample_rates_by_type
|
|
62
67
|
].freeze
|
|
63
68
|
|
|
64
69
|
def initialize
|
|
@@ -91,6 +96,7 @@ module DeadBro
|
|
|
91
96
|
self.excluded_jobs = []
|
|
92
97
|
self.exclusive_controllers = []
|
|
93
98
|
self.exclusive_jobs = []
|
|
99
|
+
self.sample_rates_by_type = {}
|
|
94
100
|
@monitor_enabled = false
|
|
95
101
|
@enable_db_stats = false
|
|
96
102
|
@enable_process_stats = false
|
|
@@ -134,6 +140,15 @@ module DeadBro
|
|
|
134
140
|
@compiled_exclusive_jobs = compile_patterns(@exclusive_jobs)
|
|
135
141
|
end
|
|
136
142
|
|
|
143
|
+
# Exact-match only — no wildcard/regex support, unlike the exclusion lists.
|
|
144
|
+
def sample_rates_by_type=(value)
|
|
145
|
+
return @sample_rates_by_type = {} unless value.is_a?(Hash)
|
|
146
|
+
|
|
147
|
+
@sample_rates_by_type = value.each_with_object({}) do |(k, v), memo|
|
|
148
|
+
memo[k.to_s] = v.to_i
|
|
149
|
+
end
|
|
150
|
+
end
|
|
151
|
+
|
|
137
152
|
# Apply a settings hash received from the backend response.
|
|
138
153
|
# Only known keys are applied; unknown keys are silently ignored.
|
|
139
154
|
# Serialized so concurrent HTTP threads do not interleave writes with request-thread reads.
|
|
@@ -153,6 +168,8 @@ module DeadBro
|
|
|
153
168
|
send(:"#{k}=", !!value)
|
|
154
169
|
when "excluded_controllers", "excluded_jobs", "exclusive_controllers", "exclusive_jobs"
|
|
155
170
|
send(:"#{k}=", Array(value).map(&:to_s))
|
|
171
|
+
when "sample_rates_by_type"
|
|
172
|
+
send(:"#{k}=", value)
|
|
156
173
|
end
|
|
157
174
|
end
|
|
158
175
|
end
|
|
@@ -232,8 +249,12 @@ module DeadBro
|
|
|
232
249
|
compiled.any? { |entry| match_compiled?(target, entry) }
|
|
233
250
|
end
|
|
234
251
|
|
|
235
|
-
def should_sample?
|
|
236
|
-
sample_rate =
|
|
252
|
+
def should_sample?(request_type_key = nil)
|
|
253
|
+
sample_rate = if request_type_key && @sample_rates_by_type.key?(request_type_key.to_s)
|
|
254
|
+
@sample_rates_by_type[request_type_key.to_s]
|
|
255
|
+
else
|
|
256
|
+
resolve_sample_rate
|
|
257
|
+
end
|
|
237
258
|
sample_rate = 100 if sample_rate.nil?
|
|
238
259
|
|
|
239
260
|
return true if sample_rate >= 100
|
|
@@ -44,7 +44,8 @@ module DeadBro
|
|
|
44
44
|
# enough that even the "cheap" stop/analyze work matters under load.
|
|
45
45
|
# Completions have no exception attached; the exception subscriber below
|
|
46
46
|
# always sends errors with force: true.
|
|
47
|
-
|
|
47
|
+
job_type_key = "#{job_class_name}#perform"
|
|
48
|
+
unless DeadBro.configuration.should_sample?(job_type_key)
|
|
48
49
|
drain_job_tracking
|
|
49
50
|
next
|
|
50
51
|
end
|
|
@@ -124,7 +125,9 @@ module DeadBro
|
|
|
124
125
|
logs: DeadBro.logger.logs
|
|
125
126
|
}
|
|
126
127
|
|
|
127
|
-
|
|
128
|
+
# force: true — the sampling decision above already accounted for any
|
|
129
|
+
# per-job-type override; client#post_metric must not re-roll it globally.
|
|
130
|
+
client.post_metric(event_name: name, payload: payload, force: true)
|
|
128
131
|
end
|
|
129
132
|
|
|
130
133
|
# Track job exceptions
|
data/lib/dead_bro/subscriber.rb
CHANGED
|
@@ -43,8 +43,9 @@ module DeadBro
|
|
|
43
43
|
end
|
|
44
44
|
|
|
45
45
|
has_error = data[:exception] || data[:exception_object]
|
|
46
|
+
request_type_key = "#{controller_name}##{action_name}"
|
|
46
47
|
# Errors always ship regardless of sampling (this is what the docs promise).
|
|
47
|
-
unless has_error || DeadBro.configuration.should_sample?
|
|
48
|
+
unless has_error || DeadBro.configuration.should_sample?(request_type_key)
|
|
48
49
|
drain_request_tracking
|
|
49
50
|
next
|
|
50
51
|
end
|
|
@@ -223,7 +224,10 @@ module DeadBro
|
|
|
223
224
|
cpu_time_ms: cpu_time_ms,
|
|
224
225
|
logs: DeadBro.logger.logs
|
|
225
226
|
}
|
|
226
|
-
|
|
227
|
+
# force: true — the sampling decision (global or per-request-type) was
|
|
228
|
+
# already made above; client#post_metric must not re-roll it with the
|
|
229
|
+
# global-only rate, which would silently override a per-type sample rate.
|
|
230
|
+
client.post_metric(event_name: name, payload: payload, force: true)
|
|
227
231
|
end
|
|
228
232
|
end
|
|
229
233
|
|
data/lib/dead_bro/version.rb
CHANGED
data/lib/dead_bro.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: dead_bro
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.2.
|
|
4
|
+
version: 0.2.27
|
|
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/dead_bro.rb
|
|
23
24
|
- lib/dead_bro/allocation_source_sampler.rb
|
|
@@ -79,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
79
80
|
- !ruby/object:Gem::Version
|
|
80
81
|
version: '0'
|
|
81
82
|
requirements: []
|
|
82
|
-
rubygems_version: 4.0.
|
|
83
|
+
rubygems_version: 4.0.9
|
|
83
84
|
specification_version: 4
|
|
84
85
|
summary: Minimal APM for Rails apps.
|
|
85
86
|
test_files: []
|