Commit ebadb22
committed
feat: add configurable service lifetimes, OpenTelemetry instrumentation, and test barriers
## Summary
Enhanced GUSTO with flexible dependency injection, comprehensive observability, and
integration testing support to provide a production-ready job queue solution.
## Changes
### Service Lifetime Configuration
- Added configurable service lifetimes (Scoped/Transient/Singleton) for JobQueue and IJobStorageProvider
- Updated JobQueueWorker to resolve dependencies from scoped service providers
- Default lifetime is Scoped for optimal database context integration
- Supports EF Core DbContext, MongoDB scoped collections, and stateless singleton providers
### OpenTelemetry Instrumentation
- Added ActivitySource for distributed tracing with ProcessBatch and ExecuteJob spans
- Implemented comprehensive metrics:
- `gusto.jobs.processed` - Counter for successful job executions
- `gusto.jobs.failed` - Counter for failed jobs with exception types
- `gusto.job.duration` - Histogram of job execution times
- `gusto.batch.duration` - Histogram of batch processing times
- `gusto.batch.size` - Histogram of jobs per batch
- Created GustoTelemetry class with ActivitySourceName and MeterName constants
- All metrics include detailed tags (job.type, job.method, job.status, exception.type)
- Zero performance impact when OpenTelemetry is not configured (~1-10ns overhead when configured)
### Testing Support
- Added BatchStartBarrier to pause worker at batch start for test setup
- Added BatchCompletedBarrier to signal batch completion for deterministic assertions
- Eliminates flaky tests from polling and arbitrary delays
- Fully documented with integration test examples
### Code Quality Improvements
- Refactored JobQueueWorker for improved readability with extracted methods
- Each method now has a single, clear responsibility
- Better separation of concerns for batch processing, job execution, and telemetry
### Documentation
- Updated README with service lifetime configuration examples
- Added OpenTelemetry integration guide with metrics table
- Documented test barriers with complete integration test example
- Added use cases for different service lifetime scenarios1 parent 27c9b5e commit ebadb22
6 files changed
Lines changed: 505 additions & 72 deletions
File tree
- src
- ByteBard.GUSTO.JobQueue
- ByteBard.GUSTO.Tests
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| 10 | + | |
10 | 11 | | |
11 | 12 | | |
12 | 13 | | |
| 14 | + | |
| 15 | + | |
13 | 16 | | |
14 | 17 | | |
15 | 18 | | |
| |||
96 | 99 | | |
97 | 100 | | |
98 | 101 | | |
99 | | - | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
100 | 106 | | |
101 | 107 | | |
102 | 108 | | |
| |||
259 | 265 | | |
260 | 266 | | |
261 | 267 | | |
262 | | - | |
| 268 | + | |
263 | 269 | | |
264 | 270 | | |
265 | 271 | | |
266 | | - | |
| 272 | + | |
267 | 273 | | |
268 | 274 | | |
269 | 275 | | |
270 | 276 | | |
271 | 277 | | |
272 | | - | |
| 278 | + | |
273 | 279 | | |
274 | 280 | | |
275 | 281 | | |
276 | | - | |
| 282 | + | |
277 | 283 | | |
278 | 284 | | |
279 | 285 | | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
| 296 | + | |
| 297 | + | |
| 298 | + | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
| 306 | + | |
| 307 | + | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
| 311 | + | |
| 312 | + | |
| 313 | + | |
| 314 | + | |
| 315 | + | |
| 316 | + | |
| 317 | + | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
| 325 | + | |
| 326 | + | |
| 327 | + | |
| 328 | + | |
| 329 | + | |
| 330 | + | |
| 331 | + | |
| 332 | + | |
| 333 | + | |
| 334 | + | |
| 335 | + | |
| 336 | + | |
| 337 | + | |
| 338 | + | |
| 339 | + | |
| 340 | + | |
| 341 | + | |
| 342 | + | |
| 343 | + | |
| 344 | + | |
| 345 | + | |
| 346 | + | |
| 347 | + | |
| 348 | + | |
| 349 | + | |
| 350 | + | |
| 351 | + | |
| 352 | + | |
| 353 | + | |
| 354 | + | |
| 355 | + | |
| 356 | + | |
| 357 | + | |
| 358 | + | |
| 359 | + | |
| 360 | + | |
| 361 | + | |
| 362 | + | |
| 363 | + | |
| 364 | + | |
| 365 | + | |
| 366 | + | |
| 367 | + | |
| 368 | + | |
| 369 | + | |
| 370 | + | |
| 371 | + | |
| 372 | + | |
| 373 | + | |
| 374 | + | |
| 375 | + | |
| 376 | + | |
| 377 | + | |
| 378 | + | |
| 379 | + | |
| 380 | + | |
| 381 | + | |
| 382 | + | |
| 383 | + | |
| 384 | + | |
| 385 | + | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
| 390 | + | |
| 391 | + | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
| 395 | + | |
| 396 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
0 commit comments