-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathobservability.go
More file actions
1078 lines (1003 loc) · 27 KB
/
observability.go
File metadata and controls
1078 lines (1003 loc) · 27 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package queue
import (
"context"
"crypto/sha1"
"errors"
"fmt"
"sort"
"sync"
"time"
)
// EventKind identifies a queue runtime event.
// @group Driver Integration
type EventKind string
const (
// EventEnqueueAccepted indicates a job was accepted for enqueue.
EventEnqueueAccepted EventKind = "enqueue_accepted"
// EventEnqueueRejected indicates enqueue failed.
EventEnqueueRejected EventKind = "enqueue_rejected"
// EventEnqueueDuplicate indicates enqueue was rejected as duplicate.
EventEnqueueDuplicate EventKind = "enqueue_duplicate"
// EventEnqueueCanceled indicates enqueue was canceled by context.
EventEnqueueCanceled EventKind = "enqueue_canceled"
// EventProcessStarted indicates a handler started processing.
EventProcessStarted EventKind = "process_started"
// EventProcessSucceeded indicates a handler completed successfully.
EventProcessSucceeded EventKind = "process_succeeded"
// EventProcessFailed indicates a handler returned an error.
EventProcessFailed EventKind = "process_failed"
// EventProcessRetried indicates a failed attempt was requeued for retry.
EventProcessRetried EventKind = "process_retried"
// EventProcessArchived indicates a failed attempt reached terminal state.
EventProcessArchived EventKind = "process_archived"
// EventQueuePaused indicates queue consumption was paused.
EventQueuePaused EventKind = "queue_paused"
// EventQueueResumed indicates queue consumption was resumed.
EventQueueResumed EventKind = "queue_resumed"
// EventProcessRecovered indicates a stale in-flight job was requeued for recovery.
EventProcessRecovered EventKind = "process_recovered"
// EventRepublishFailed indicates an internal delay/retry republish attempt failed.
EventRepublishFailed EventKind = "republish_failed"
)
// Event is emitted through Observer hooks for queue/worker activity.
// @group Driver Integration
type Event struct {
Kind EventKind
Driver Driver
Queue string
JobType string
JobKey string
Attempt int
MaxRetry int
Scheduled bool
Duration time.Duration
Err error
Time time.Time
}
// Observer receives queue runtime events.
// @group Observability
type Observer interface {
// Observe handles a queue runtime event.
// @group Observability
//
// Example: observe runtime event
//
// var observer queue.Observer
// observer.Observe(queue.Event{
// Kind: queue.EventEnqueueAccepted,
// Driver: queue.DriverSync,
// Queue: "default",
// })
Observe(event Event)
}
// ObserverFunc adapts a function to an Observer.
// @group Observability
type ObserverFunc func(event Event)
// Observe calls the wrapped function.
// @group Observability
//
// Example: observer func logging hook
//
// logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
// observer := queue.ObserverFunc(func(event queue.Event) {
// logger.Info("queue event",
// "kind", event.Kind,
// "driver", event.Driver,
// "queue", event.Queue,
// "job_type", event.JobType,
// "attempt", event.Attempt,
// "max_retry", event.MaxRetry,
// "duration", event.Duration,
// "err", event.Err,
// )
// })
// observer.Observe(queue.Event{
// Kind: queue.EventProcessSucceeded,
// Driver: queue.DriverSync,
// Queue: "default",
// JobType: "emails:send",
// })
func (f ObserverFunc) Observe(event Event) {
f(event)
}
type multiObserver struct {
observers []Observer
}
// MultiObserver fans out events to multiple observers.
// @group Observability
//
// Example: fan out to multiple observers
//
// events := make(chan queue.Event, 2)
// observer := queue.MultiObserver(
// queue.ChannelObserver{Events: events},
// queue.ObserverFunc(func(queue.Event) {}),
// )
// observer.Observe(queue.Event{Kind: queue.EventEnqueueAccepted})
// fmt.Println(len(events))
// // Output: 1
func MultiObserver(observers ...Observer) Observer {
filtered := make([]Observer, 0, len(observers))
for _, observer := range observers {
if observer != nil {
filtered = append(filtered, observer)
}
}
return &multiObserver{observers: filtered}
}
func (m *multiObserver) Observe(event Event) {
for _, observer := range m.observers {
safeObserve(observer, event)
}
}
// ChannelObserver forwards events to a channel.
// @group Observability
type ChannelObserver struct {
Events chan<- Event
DropIfFull bool
}
// Observe forwards an event to the configured channel.
// @group Observability
//
// Example: channel observer
//
// ch := make(chan queue.Event, 1)
// observer := queue.ChannelObserver{Events: ch}
// observer.Observe(queue.Event{Kind: queue.EventProcessStarted, Queue: "default"})
// event := <-ch
// _ = event
func (c ChannelObserver) Observe(event Event) {
if c.Events == nil {
return
}
if c.DropIfFull {
select {
case c.Events <- event:
default:
}
return
}
c.Events <- event
}
// StatsProvider exposes driver-native queue snapshots.
// @group Observability
type StatsProvider interface {
Stats(ctx context.Context) (StatsSnapshot, error)
}
// QueueController exposes queue pause/resume controls.
// @group Observability
type QueueController interface {
Pause(ctx context.Context, queueName string) error
Resume(ctx context.Context, queueName string) error
}
// ErrPauseUnsupported indicates queue pause/resume is unsupported by a driver.
var ErrPauseUnsupported = errors.New("pause/resume is not supported by this driver")
// QueueCounters exposes normalized queue counters collected from events.
// @group Observability
type QueueCounters struct {
Pending int64
Active int64
Scheduled int64
Retry int64
Archived int64
Processed int64
Failed int64
Paused int64
AvgWait time.Duration
AvgRun time.Duration
}
// ThroughputWindow captures processed vs failed counts in a fixed window.
// @group Observability
type ThroughputWindow struct {
Processed int64
Failed int64
}
// QueueThroughput contains rolling throughput windows for a queue.
// @group Observability
type QueueThroughput struct {
Hour ThroughputWindow
Day ThroughputWindow
Week ThroughputWindow
}
// StatsSnapshot is a point-in-time view of counters by queue.
// @group Observability
type StatsSnapshot struct {
ByQueue map[string]QueueCounters
ThroughputByQueue map[string]QueueThroughput
}
// Queue returns queue counters for a queue name.
// @group Observability
//
// Example: queue counters getter
//
// collector := queue.NewStatsCollector()
// collector.Observe(queue.Event{
// Kind: queue.EventEnqueueAccepted,
// Driver: queue.DriverSync,
// Queue: "default",
// Time: time.Now(),
// })
// snapshot := collector.Snapshot()
// counters, ok := snapshot.Queue("default")
// fmt.Println(ok, counters.Pending)
// // Output: true 1
func (s StatsSnapshot) Queue(name string) (QueueCounters, bool) {
if s.ByQueue == nil {
return QueueCounters{}, false
}
counters, ok := s.ByQueue[name]
return counters, ok
}
// Throughput returns rolling throughput windows for a queue name.
// @group Observability
//
// Example: throughput getter
//
// collector := queue.NewStatsCollector()
// collector.Observe(queue.Event{
// Kind: queue.EventProcessSucceeded,
// Driver: queue.DriverSync,
// Queue: "default",
// Time: time.Now(),
// })
// snapshot := collector.Snapshot()
// throughput, ok := snapshot.Throughput("default")
// fmt.Printf("ok=%v hour=%+v day=%+v week=%+v\n", ok, throughput.Hour, throughput.Day, throughput.Week)
// // Output: ok=true hour={Processed:1 Failed:0} day={Processed:1 Failed:0} week={Processed:1 Failed:0}
func (s StatsSnapshot) Throughput(name string) (QueueThroughput, bool) {
if s.ThroughputByQueue == nil {
return QueueThroughput{}, false
}
throughput, ok := s.ThroughputByQueue[name]
return throughput, ok
}
// Queues returns sorted queue names present in the snapshot.
// @group Observability
//
// Example: list queues
//
// collector := queue.NewStatsCollector()
// collector.Observe(queue.Event{
// Kind: queue.EventEnqueueAccepted,
// Driver: queue.DriverSync,
// Queue: "critical",
// Time: time.Now(),
// })
// snapshot := collector.Snapshot()
// names := snapshot.Queues()
// fmt.Println(len(names), names[0])
// // Output: 1 critical
func (s StatsSnapshot) Queues() []string {
if len(s.ByQueue) == 0 {
return nil
}
names := make([]string, 0, len(s.ByQueue))
for name := range s.ByQueue {
names = append(names, name)
}
sort.Strings(names)
return names
}
// Pending returns pending count for a queue.
// @group Observability
//
// Example: pending count getter
//
// snapshot := queue.StatsSnapshot{
// ByQueue: map[string]queue.QueueCounters{
// "default": {Pending: 3},
// },
// }
// fmt.Println(snapshot.Pending("default"))
// // Output: 3
func (s StatsSnapshot) Pending(name string) int64 {
counters, ok := s.Queue(name)
if !ok {
return 0
}
return counters.Pending
}
// Active returns active count for a queue.
// @group Observability
//
// Example: active count getter
//
// snapshot := queue.StatsSnapshot{
// ByQueue: map[string]queue.QueueCounters{
// "default": {Active: 2},
// },
// }
// fmt.Println(snapshot.Active("default"))
// // Output: 2
func (s StatsSnapshot) Active(name string) int64 {
counters, ok := s.Queue(name)
if !ok {
return 0
}
return counters.Active
}
// Scheduled returns scheduled count for a queue.
// @group Observability
//
// Example: scheduled count getter
//
// snapshot := queue.StatsSnapshot{
// ByQueue: map[string]queue.QueueCounters{
// "default": {Scheduled: 4},
// },
// }
// fmt.Println(snapshot.Scheduled("default"))
// // Output: 4
func (s StatsSnapshot) Scheduled(name string) int64 {
counters, ok := s.Queue(name)
if !ok {
return 0
}
return counters.Scheduled
}
// RetryCount returns retry count for a queue.
// @group Observability
//
// Example: retry count getter
//
// snapshot := queue.StatsSnapshot{
// ByQueue: map[string]queue.QueueCounters{
// "default": {Retry: 1},
// },
// }
// fmt.Println(snapshot.RetryCount("default"))
// // Output: 1
func (s StatsSnapshot) RetryCount(name string) int64 {
counters, ok := s.Queue(name)
if !ok {
return 0
}
return counters.Retry
}
// Archived returns archived count for a queue.
// @group Observability
//
// Example: archived count getter
//
// snapshot := queue.StatsSnapshot{
// ByQueue: map[string]queue.QueueCounters{
// "default": {Archived: 7},
// },
// }
// fmt.Println(snapshot.Archived("default"))
// // Output: 7
func (s StatsSnapshot) Archived(name string) int64 {
counters, ok := s.Queue(name)
if !ok {
return 0
}
return counters.Archived
}
// Processed returns processed count for a queue.
// @group Observability
//
// Example: processed count getter
//
// snapshot := queue.StatsSnapshot{
// ByQueue: map[string]queue.QueueCounters{
// "default": {Processed: 11},
// },
// }
// fmt.Println(snapshot.Processed("default"))
// // Output: 11
func (s StatsSnapshot) Processed(name string) int64 {
counters, ok := s.Queue(name)
if !ok {
return 0
}
return counters.Processed
}
// Failed returns failed count for a queue.
// @group Observability
//
// Example: failed count getter
//
// snapshot := queue.StatsSnapshot{
// ByQueue: map[string]queue.QueueCounters{
// "default": {Failed: 2},
// },
// }
// fmt.Println(snapshot.Failed("default"))
// // Output: 2
func (s StatsSnapshot) Failed(name string) int64 {
counters, ok := s.Queue(name)
if !ok {
return 0
}
return counters.Failed
}
// Paused returns paused count for a queue.
// @group Observability
//
// Example: paused count getter
//
// collector := queue.NewStatsCollector()
// collector.Observe(queue.Event{
// Kind: queue.EventQueuePaused,
// Driver: queue.DriverSync,
// Queue: "default",
// Time: time.Now(),
// })
// snapshot := collector.Snapshot()
// fmt.Println(snapshot.Paused("default"))
// // Output: 1
func (s StatsSnapshot) Paused(name string) int64 {
counters, ok := s.Queue(name)
if !ok {
return 0
}
return counters.Paused
}
// StatsCollector aggregates normalized counters from Observer events.
// @group Observability
type StatsCollector struct {
mu sync.RWMutex
byQueue map[string]*collectorQueueState
}
type collectorQueueState struct {
counters QueueCounters
processedAt []time.Time
failedAt []time.Time
pendingByKey map[string][]time.Time
waitSum time.Duration
waitCount int64
runSum time.Duration
runCount int64
}
// NewStatsCollector creates an event collector for queue counters.
// @group Constructors
//
// Example: new stats collector
//
// collector := queue.NewStatsCollector()
// _ = collector
func NewStatsCollector() *StatsCollector {
return &StatsCollector{byQueue: make(map[string]*collectorQueueState)}
}
// Observe records an event and updates normalized counters.
// @group Observability
//
// Example: observe event
//
// collector := queue.NewStatsCollector()
// collector.Observe(queue.Event{
// Kind: queue.EventEnqueueAccepted,
// Driver: queue.DriverSync,
// Queue: "default",
// Time: time.Now(),
// })
func (c *StatsCollector) Observe(event Event) {
queue := event.Queue
if queue == "" {
queue = "default"
}
now := event.Time
if now.IsZero() {
now = time.Now()
}
c.mu.Lock()
defer c.mu.Unlock()
state := c.byQueue[queue]
if state == nil {
state = &collectorQueueState{pendingByKey: make(map[string][]time.Time)}
c.byQueue[queue] = state
}
switch event.Kind {
case EventEnqueueAccepted:
state.counters.Pending++
if event.Scheduled {
state.counters.Scheduled++
}
if event.JobKey != "" {
state.pendingByKey[event.JobKey] = append(state.pendingByKey[event.JobKey], now)
}
case EventEnqueueRejected, EventEnqueueCanceled:
// no queue-depth mutation
case EventEnqueueDuplicate:
// no queue-depth mutation
case EventProcessStarted:
if state.counters.Pending > 0 {
state.counters.Pending--
}
if state.counters.Scheduled > 0 && event.Scheduled {
state.counters.Scheduled--
}
state.counters.Active++
if event.JobKey != "" {
if entries, ok := state.pendingByKey[event.JobKey]; ok && len(entries) > 0 {
enqueuedAt := entries[0]
rest := entries[1:]
if len(rest) == 0 {
delete(state.pendingByKey, event.JobKey)
} else {
state.pendingByKey[event.JobKey] = rest
}
if now.After(enqueuedAt) {
state.waitSum += now.Sub(enqueuedAt)
state.waitCount++
state.counters.AvgWait = state.waitSum / time.Duration(state.waitCount)
}
}
}
case EventProcessRetried:
state.counters.Retry++
case EventProcessArchived:
state.counters.Archived++
case EventQueuePaused:
state.counters.Paused++
case EventQueueResumed:
if state.counters.Paused > 0 {
state.counters.Paused--
}
case EventProcessSucceeded:
if state.counters.Active > 0 {
state.counters.Active--
}
state.counters.Processed++
state.processedAt = append(state.processedAt, now)
state.runSum += event.Duration
state.runCount++
state.counters.AvgRun = state.runSum / time.Duration(state.runCount)
case EventProcessFailed:
if state.counters.Active > 0 {
state.counters.Active--
}
state.counters.Failed++
state.failedAt = append(state.failedAt, now)
state.runSum += event.Duration
state.runCount++
state.counters.AvgRun = state.runSum / time.Duration(state.runCount)
}
c.pruneThroughputLocked(state, now)
}
// Snapshot returns a copy of collected counters.
// @group Observability
//
// Example: snapshot print
//
// collector := queue.NewStatsCollector()
// collector.Observe(queue.Event{
// Kind: queue.EventEnqueueAccepted,
// Driver: queue.DriverSync,
// Queue: "default",
// Time: time.Now(),
// })
// collector.Observe(queue.Event{
// Kind: queue.EventProcessStarted,
// Driver: queue.DriverSync,
// Queue: "default",
// JobKey: "job-1",
// Time: time.Now(),
// })
// collector.Observe(queue.Event{
// Kind: queue.EventProcessSucceeded,
// Driver: queue.DriverSync,
// Queue: "default",
// JobKey: "job-1",
// Duration: 12 * time.Millisecond,
// Time: time.Now(),
// })
// snapshot := collector.Snapshot()
// counters, _ := snapshot.Queue("default")
// throughput, _ := snapshot.Throughput("default")
// fmt.Printf("queues=%v\n", snapshot.Queues())
// fmt.Printf("counters=%+v\n", counters)
// fmt.Printf("hour=%+v\n", throughput.Hour)
// // Output:
// // queues=[default]
// // counters={Pending:0 Active:0 Scheduled:0 Retry:0 Archived:0 Processed:1 Failed:0 Paused:0 AvgWait:0s AvgRun:12ms}
// // hour={Processed:1 Failed:0}
func (c *StatsCollector) Snapshot() StatsSnapshot {
c.mu.RLock()
defer c.mu.RUnlock()
now := time.Now()
out := make(map[string]QueueCounters, len(c.byQueue))
throughput := make(map[string]QueueThroughput, len(c.byQueue))
for queueName, state := range c.byQueue {
out[queueName] = state.counters
throughput[queueName] = QueueThroughput{
Hour: ThroughputWindow{
Processed: countSince(state.processedAt, now.Add(-1*time.Hour)),
Failed: countSince(state.failedAt, now.Add(-1*time.Hour)),
},
Day: ThroughputWindow{
Processed: countSince(state.processedAt, now.Add(-24*time.Hour)),
Failed: countSince(state.failedAt, now.Add(-24*time.Hour)),
},
Week: ThroughputWindow{
Processed: countSince(state.processedAt, now.Add(-7*24*time.Hour)),
Failed: countSince(state.failedAt, now.Add(-7*24*time.Hour)),
},
}
}
return StatsSnapshot{ByQueue: out, ThroughputByQueue: throughput}
}
func (c *StatsCollector) pruneThroughputLocked(state *collectorQueueState, now time.Time) {
cutoff := now.Add(-7 * 24 * time.Hour)
state.processedAt = pruneBefore(state.processedAt, cutoff)
state.failedAt = pruneBefore(state.failedAt, cutoff)
}
func pruneBefore(in []time.Time, cutoff time.Time) []time.Time {
idx := 0
for idx < len(in) && in[idx].Before(cutoff) {
idx++
}
if idx == 0 {
return in
}
out := make([]time.Time, len(in)-idx)
copy(out, in[idx:])
return out
}
func countSince(in []time.Time, cutoff time.Time) int64 {
var total int64
for _, ts := range in {
if !ts.Before(cutoff) {
total++
}
}
return total
}
type observedQueue struct {
inner queueBackend
driver Driver
observer Observer
}
func newObservedQueue(inner queueBackend, driver Driver, observer Observer) queueBackend {
if observer == nil {
return inner
}
return &observedQueue{
inner: inner,
driver: driver,
observer: observer,
}
}
func (q *observedQueue) StartWorkers(ctx context.Context) error {
runtime, ok := q.inner.(interface {
StartWorkers(context.Context) error
})
if !ok {
return nil
}
return runtime.StartWorkers(ctx)
}
func (q *observedQueue) Shutdown(ctx context.Context) error {
return q.inner.Shutdown(ctx)
}
func (q *observedQueue) Stats(ctx context.Context) (StatsSnapshot, error) {
provider, ok := q.inner.(StatsProvider)
if !ok {
return StatsSnapshot{}, fmt.Errorf("stats provider is not available for driver %q", q.driver)
}
return provider.Stats(ctx)
}
func (q *observedQueue) Ready(ctx context.Context) error {
checker, ok := q.inner.(interface{ Ready(context.Context) error })
if !ok {
legacy, ok := q.inner.(interface{ Preflight(context.Context) error })
if !ok {
return nil
}
return legacy.Preflight(ctx)
}
return checker.Ready(ctx)
}
func (q *observedQueue) Pause(ctx context.Context, queueName string) error {
controller, ok := q.inner.(QueueController)
if !ok {
return ErrPauseUnsupported
}
if err := controller.Pause(ctx, queueName); err != nil {
return err
}
safeObserve(q.observer, Event{
Kind: EventQueuePaused,
Driver: q.driver,
Queue: normalizeQueueName(queueName),
Time: time.Now(),
})
return nil
}
func (q *observedQueue) Resume(ctx context.Context, queueName string) error {
controller, ok := q.inner.(QueueController)
if !ok {
return ErrPauseUnsupported
}
if err := controller.Resume(ctx, queueName); err != nil {
return err
}
safeObserve(q.observer, Event{
Kind: EventQueueResumed,
Driver: q.driver,
Queue: normalizeQueueName(queueName),
Time: time.Now(),
})
return nil
}
func (q *observedQueue) ListJobs(ctx context.Context, opts ListJobsOptions) (ListJobsResult, error) {
admin, ok := q.inner.(QueueAdmin)
if !ok {
return ListJobsResult{}, ErrQueueAdminUnsupported
}
return admin.ListJobs(ctx, opts)
}
func (q *observedQueue) RetryJob(ctx context.Context, queueName, jobID string) error {
admin, ok := q.inner.(QueueAdmin)
if !ok {
return ErrQueueAdminUnsupported
}
return admin.RetryJob(ctx, queueName, jobID)
}
func (q *observedQueue) CancelJob(ctx context.Context, jobID string) error {
admin, ok := q.inner.(QueueAdmin)
if !ok {
return ErrQueueAdminUnsupported
}
return admin.CancelJob(ctx, jobID)
}
func (q *observedQueue) DeleteJob(ctx context.Context, queueName, jobID string) error {
admin, ok := q.inner.(QueueAdmin)
if !ok {
return ErrQueueAdminUnsupported
}
return admin.DeleteJob(ctx, queueName, jobID)
}
func (q *observedQueue) ClearQueue(ctx context.Context, queueName string) error {
admin, ok := q.inner.(QueueAdmin)
if !ok {
return ErrQueueAdminUnsupported
}
return admin.ClearQueue(ctx, queueName)
}
func (q *observedQueue) History(ctx context.Context, queueName string, window QueueHistoryWindow) ([]QueueHistoryPoint, error) {
history, ok := q.inner.(QueueHistoryProvider)
if !ok {
return nil, ErrQueueAdminUnsupported
}
return history.History(ctx, queueName, window)
}
func (q *observedQueue) Dispatch(ctx context.Context, job Job) error {
err := q.inner.Dispatch(ctx, job)
opts := job.jobOptions()
base := Event{
Driver: q.driver,
Queue: jobQueueName(job),
JobType: job.Type,
JobKey: jobEventKey(job),
MaxRetry: optionInt(opts.maxRetry),
Scheduled: opts.delay > 0,
Time: time.Now(),
}
switch {
case err == nil:
base.Kind = EventEnqueueAccepted
safeObserve(q.observer, base)
case errors.Is(err, ErrDuplicate):
base.Kind = EventEnqueueDuplicate
base.Err = err
safeObserve(q.observer, base)
case errors.Is(err, context.Canceled), errors.Is(err, context.DeadlineExceeded):
base.Kind = EventEnqueueCanceled
base.Err = err
safeObserve(q.observer, base)
default:
base.Kind = EventEnqueueRejected
base.Err = err
safeObserve(q.observer, base)
}
return err
}
func (q *observedQueue) Register(jobType string, handler Handler) {
runtime, ok := q.inner.(interface {
Register(string, Handler)
})
if !ok {
return
}
if handler == nil {
runtime.Register(jobType, handler)
return
}
runtime.Register(jobType, wrapObservedHandler(q.observer, q.driver, "", jobType, handler))
}
func (q *observedQueue) Driver() Driver {
return q.driver
}
func wrapObservedHandler(observer Observer, driver Driver, queueName string, jobType string, handler Handler) Handler {
return func(ctx context.Context, job Job) error {
opts := job.jobOptions()
effectiveQueue := queueName
if effectiveQueue == "" {
effectiveQueue = jobQueueName(job)
}
start := time.Now()
base := Event{
Driver: driver,
Queue: effectiveQueue,
JobType: jobType,
JobKey: jobEventKey(job),
Attempt: opts.attempt,
MaxRetry: optionInt(opts.maxRetry),
Scheduled: opts.delay > 0,
Time: start,
}
base.Kind = EventProcessStarted
safeObserve(observer, base)
err := handler(ctx, job)
finish := base
finish.Duration = time.Since(start)
finish.Time = time.Now()
finish.Err = err
if err == nil {
finish.Kind = EventProcessSucceeded
safeObserve(observer, finish)
return nil
}
finish.Kind = EventProcessFailed
safeObserve(observer, finish)
if finish.Attempt < finish.MaxRetry {
retry := finish
retry.Kind = EventProcessRetried
retry.Err = nil
safeObserve(observer, retry)
} else {
archive := finish
archive.Kind = EventProcessArchived
archive.Err = nil
safeObserve(observer, archive)
}
return err
}
}
func safeObserve(observer Observer, event Event) {
SafeObserve(observer, event)
}
// SafeObserve delivers an event to an observer and recovers observer panics.
//
// This is an advanced helper intended for driver-module implementations.
// @group Observability
func SafeObserve(observer Observer, event Event) {
if observer == nil {
return
}
defer func() {
_ = recover()
}()
observer.Observe(event)
}
func jobQueueName(job Job) string {
queueName := job.jobOptions().queueName
if queueName == "" {
return "default"
}
return queueName
}
func optionInt(v *int) int {
if v == nil {
return 0
}
return *v
}
func jobEventKey(job Job) string {
hash := sha1.Sum(append([]byte(job.Type+":"), job.PayloadBytes()...))
return fmt.Sprintf("%x", hash[:])
}
func normalizeQueueName(name string) string {
if name == "" {
return "default"
}
return name
}
func resolveQueueRuntime(v any) queueRuntime {
switch q := v.(type) {
case nil:
return nil
case queueRuntime:
return q
case *Queue:
if q == nil {
return nil
}
return q.q
default:
return nil
}
}
// Pause pauses queue consumption for drivers that support it.
// @group Observability
//
// Example: pause queue
//
// q, _ := queue.NewSync()
// _ = queue.Pause(context.Background(), q, "default")
// snapshot, _ := queue.Snapshot(context.Background(), q, nil)
// fmt.Println(snapshot.Paused("default"))
// // Output: 1
func Pause(ctx context.Context, q any, queueName string) error {
raw := resolveQueueRuntime(q)
controller, ok := raw.(QueueController)
if !ok {
return ErrPauseUnsupported
}
return controller.Pause(ctx, queueName)
}