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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
use actix::prelude::*;
use serde_derive::{Deserialize, Serialize};
use std::collections::{HashMap, VecDeque};
use std::time::Duration;
use crate::common::logger::*;
use crate::common::now_millis;
use crate::metric::{self, Metrics};
use crate::pipeline::*;
use crate::service::server::TopologyServer;
use crate::source::*;
/// Log targets
static TARGET_SOURCE_ACTOR: &'static str = "tempest::topology::SourceActor";
static TARGET_TOPOLOGY_ACTOR: &'static str = "tempest::topology::TopologyActor";
static TARGET_PIPELINE_ACTOR: &'static str = "tempest::topology::PipelineActor";
/**
* This is what a user implements in order to run a topology
*
*/
pub trait Topology<SB: SourceBuilder> {
// should return a topology service
// constructed from the builder
fn service() {}
fn builder() -> TopologyBuilder<SB>;
fn test_builder() -> TopologyBuilder<SB> {
Self::builder()
}
}
#[derive(Clone, Debug, PartialEq)]
pub enum TopologyFailurePolicy {
/// Messages with Errors/Timeouts are left unacked.
/// This is used when the message Source has it's own
/// mechanism for dealing with Failures.
/// For example, SQS automatically re-delivers unacked messages
/// after a period of time. This should also be used
/// when the Tempest source client implements it's own way
/// of dealing with failure.
None,
/// Messages are automatically acked, regardless of msg state
/// (success, error, timeout)
BestEffort,
/// Messages are held within the Topology and retried up to this limit
/// The retry interval is every 60s.
Retry(usize),
}
impl Default for TopologyFailurePolicy {
fn default() -> Self {
TopologyFailurePolicy::BestEffort
}
}
// Some of these properties are stored as String
// to make it easier to share with Actix actors
#[derive(Clone, Debug, Default, PartialEq)]
pub struct TopologyOptions {
/// Name of the topology
pub name: String,
/// host:port
host_port: Option<String>,
/// The host:port of the agent this topology
/// should communicates with
agent_host_port: Option<String>,
/// How should we handle failures?
failure_policy: Option<TopologyFailurePolicy>,
/// Max amount of time, in milliseconds, to wait before
/// moving a pending message into a failure state.
/// What happens after a timeout depends on
/// the failure policy configuration.
msg_timeout: Option<usize>,
/// Metric flush interval in milliseconds
/// This value is overridden by `Topology.toml`
/// configuration.
pub metric_flush_interval: Option<u64>,
/// Define a list of metric targets
/// for sending metrics too.
/// This value is overridden by `Topology.toml`
/// configuration.
pub metric_targets: Vec<metric::MetricTarget>,
/// Graceful shutdown period
pub graceful_shutdown: Option<u64>,
}
impl TopologyOptions {
pub fn name(&mut self, name: &'static str) {
self.name = name.to_string();
}
pub fn failure_policy(&mut self, policy: TopologyFailurePolicy) {
self.failure_policy = Some(policy);
}
pub fn msg_timeout(&mut self, ms: usize) {
self.msg_timeout = Some(ms);
}
pub fn host_port(&mut self, host_port: String) {
self.host_port = Some(host_port);
}
pub fn agent_host_port(&mut self, host_port: String) {
self.agent_host_port = Some(host_port);
}
pub fn graceful_shutdown(&mut self, ms: u64) {
self.graceful_shutdown = Some(ms);
}
pub fn metric_flush_interval(&mut self, ms: u64) {
self.metric_flush_interval = Some(ms);
}
pub fn metric_target(&mut self, target: metric::MetricTarget) {
self.metric_targets.push(target);
}
}
#[derive(Default)]
pub struct TopologyBuilder<SB: SourceBuilder> {
pub options: TopologyOptions,
pub pipeline: Pipeline,
pub source_builder: SB,
}
impl<SB> TopologyBuilder<SB>
where
SB: SourceBuilder + Default,
<SB as SourceBuilder>::Source: Source + 'static + Default,
{
pub fn name(mut self, name: &'static str) -> Self {
self.options.name(name);
self
}
pub fn failure_policy(mut self, policy: TopologyFailurePolicy) -> Self {
self.options.failure_policy(policy);
self
}
pub fn msg_timeout(mut self, ms: usize) -> Self {
self.options.msg_timeout(ms);
self
}
pub fn graceful_shutdown(mut self, ms: u64) -> Self {
self.options.graceful_shutdown(ms);
self
}
pub fn metric_flush_interval(mut self, ms: u64) -> Self {
self.options.metric_flush_interval(ms);
self
}
pub fn metric_target(mut self, target: metric::MetricTarget) -> Self {
self.options.metric_target(target);
self
}
pub fn pipeline(mut self, pipe: Pipeline) -> Self {
self.pipeline = pipe.build();
self
}
pub fn source(mut self, sb: SB) -> Self {
self.source_builder = sb;
self
}
pub fn source_actor(&self) -> SourceActor {
SourceActor {
source: Box::new(self.source_builder.build()),
ack_queue: VecDeque::new(),
backoff: 1u64,
metrics: Metrics::default().named(vec!["source"]),
shutdown: false,
}
}
pub fn topology_actor(&self) -> TopologyActor {
TopologyActor {
options: self.options.clone(),
metrics: Metrics::default().named(vec!["topology"]),
retry: None,
}
}
pub fn pipeline_actor(&self) -> PipelineActor {
PipelineActor {
pipeline: self.pipeline.runtime(),
inflight: PipelineInflight::new(self.options.msg_timeout.clone()),
available: PipelineAvailable::new(self.pipeline.names()),
aggregate: PipelineAggregate::new(self.pipeline.names()),
metrics: Metrics::default().named(vec!["pipeline"]),
}
}
}
// Shutdown message
#[derive(Message, Debug)]
pub(crate) struct ShutdownMsg {}
// A Task can return multiple messages
// in a response which are then passed into
// the next TaskService. For this reason,
// we need to keep track
// of the index of the sub-task so we know
// when to mark the edge as visted.
#[derive(Serialize, Deserialize, Message, Debug)]
pub struct TaskMsg {
pub source_id: MsgId,
pub edge: Edge,
pub index: usize,
pub msg: Msg,
}
#[derive(Message, Debug)]
pub enum TaskRequest {
// session_id, task_name, count
GetAvailable(usize, String, Option<usize>),
// session_id, task_name, tasks
GetAvailableResponse(usize, String, Option<Vec<TaskMsg>>),
}
#[derive(Message, Serialize, Deserialize, Debug)]
pub enum TaskResponse {
// source_id, edge, index, response
Ack(MsgId, Edge, usize, Option<Vec<Msg>>),
// source_id, edge, index
Error(MsgId, Edge, usize),
}
// Default Source stub to get around having to implement SourceActor::default
// and not knowing what the Source type is
pub struct DefaultSource {}
impl Source for DefaultSource {
fn name(&self) -> &'static str {
"Default"
}
fn healthy(&mut self) -> SourceResult<()> {
unimplemented!("Failed to run healthy check")
}
}
pub struct SourceActor {
// Some struct that implements Source trait
source: Box<dyn Source>,
// This queue of messages to ack
ack_queue: VecDeque<MsgId>,
// backoff delay
backoff: u64,
// metrics
metrics: Metrics,
/// shutdown command controls when to stop polling
/// for new messages. this is configured for graceful shutdowns
/// and allows the topology to continue draining inflight messages
shutdown: bool,
}
// Default is required to make use of the actix System Registry
// This method should never be called though...
impl Default for SourceActor {
fn default() -> Self {
SourceActor {
source: Box::new(DefaultSource {}),
ack_queue: VecDeque::new(),
backoff: 1u64,
metrics: Metrics::default().named(vec!["source"]),
shutdown: false,
}
}
}
impl SourceActor {
/// Resets backoff and poll_interval to the source config
fn reset_backoff(&mut self) {
let poll_interval = match self.source.poll_interval() {
Ok(SourceInterval::Millisecond(ms)) => ms,
Err(_err) => &1000u64,
};
self.backoff = *poll_interval;
}
/// Bump the backoff value
fn backoff(&mut self, bump: u64) {
// read max_backoff from source
let max_backoff = self.source.max_backoff().unwrap();
if self.backoff < *max_backoff {
self.backoff += bump;
}
}
fn monitor(&mut self, _ctx: &mut Context<Self>) {
// Call the source.monitor method
// up to the source to determine what this does
let _ = self.source.monitor();
}
fn poll(&mut self, ctx: &mut Context<Self>) {
trace!(
target: TARGET_SOURCE_ACTOR,
"SourceActor#poll before (backoff={})",
self.backoff
);
let results = match self.source.poll() {
Ok(option) => match option {
Some(results) => {
self.metrics
.incr_labels(vec!["poll"], vec![("status", "success")]);
results
}
None => vec![],
},
Err(_err) => {
self.metrics
.incr_labels(vec!["poll"], vec![("status", "error")]);
vec![]
}
};
// if results are empty
// we need to initiate the backoff
let msg_count = results.len();
if msg_count == 0usize {
self.backoff(100u64);
} else {
self.reset_backoff();
}
if msg_count > 0usize {
self.metrics
.counter(vec!["msg", "read"], msg_count as isize);
}
// What's our current backoff
self.metrics.gauge(vec!["backoff"], self.backoff as isize);
// reschedule poll again if we aren't in shutdown mode
if !self.shutdown {
ctx.run_later(Duration::from_millis(self.backoff), Self::poll);
} else {
warn!(
target: TARGET_SOURCE_ACTOR,
"SourceActor shutdown enabled: stop polling"
);
}
let topology = TopologyActor::from_registry();
if !topology.connected() {
error!(
target: TARGET_SOURCE_ACTOR,
"TopologyActor#poll topology actor isn't connected"
);
self.metrics.counter_labels(
vec!["msg", "dropped"],
results.len() as isize,
vec![("from", "source"), ("reason", "topology_disconnected")],
);
return;
}
// println!("Source polled {:?} msgs", results.len());
// send these msg to the topology actor
for msg in results {
match topology.try_send(msg) {
// count errors here...
// we need to know when to backoff
// if we can reach the addr
Err(SendError::Full(msg)) => {
// sleep & update backoff here?
// we need future `poll` calls
// from getting into the method
// at the same time we need to slow
// down how fast we push messages into
// the addr
error!(
target: TARGET_SOURCE_ACTOR,
"TopologyActor mailbox is full, dropping msg: {:?}", &msg
);
self.metrics.incr_labels(
vec!["msg", "dropped"],
vec![("from", "source"), ("reason", "topology_full")],
);
}
Err(SendError::Closed(msg)) => {
// we need to kill this actor here
// TODO: move this to deadletter q?
error!(
target: TARGET_SOURCE_ACTOR,
"TopologyActor is closed, dropping msg: {:?}", &msg
);
self.metrics.incr_labels(
vec!["msg", "dropped"],
vec![("from", "source"), ("reason", "topology_closed")],
);
}
Ok(_) => {
self.metrics
.incr_labels(vec!["msg", "moved"], vec![("to", "topology")]);
}
}
}
}
/// Drain the batch_ack_queue and send all messages into the source.batch_ack method
fn batch_ack(&mut self, _ctx: &mut Context<Self>) {
let msgs = self.ack_queue.drain(..).collect::<Vec<_>>();
let len = msgs.len();
if len > 0 {
trace!(target: TARGET_SOURCE_ACTOR, "Acking: {} msgs", &len);
let result = self.source.batch_ack(msgs);
self.ack_result(len, result);
}
}
/// Drain the queue and ack individual msgs one at a time
fn individual_ack(&mut self, _ctx: &mut Context<Self>) {
let msgs = self.ack_queue.drain(..).collect::<Vec<_>>();
trace!(
target: TARGET_SOURCE_ACTOR,
"Ack individual msgs: {} msgs",
msgs.len()
);
for msg in msgs {
let result = self.source.ack(msg);
self.ack_result(1usize, result);
}
}
fn ack_result(&mut self, sent: usize, results: SourceResult<(i32, i32)>) {
match results {
Ok((tried, acked)) => {
let mut labels = vec![];
let error_count = (tried - acked).to_string();
if tried == acked {
labels.push(("status", "success"));
} else {
labels.push(("status", "partial_success"));
labels.push(("error_count", &error_count));
}
self.metrics
.counter_labels(vec!["msg", "acked"], acked as isize, labels);
}
Err(err) => {
error!(target: TARGET_SOURCE_ACTOR, "Ack msg err: {:?}", &err);
self.metrics.counter_labels(
vec!["msg", "acked"],
0isize,
vec![
("status", "error"),
("error_count", &(*&sent as isize).to_string()),
],
);
}
}
}
}
impl Actor for SourceActor {
type Context = Context<Self>;
fn started(&mut self, ctx: &mut Context<Self>) {
// setup the source here...
// TODO: verify this isn't an error
match self.source.setup() {
Err(err) => {
warn!(
target: TARGET_SOURCE_ACTOR,
"Failed to setup source... trigger shutdown: {:?}", &err
);
System::current().stop();
self.metrics.incr(vec!["setup", "error"]);
return;
}
_ => {}
}
// Add metrics labels
self.metrics.add_label("source_name", self.source.name());
// From here on out we use the backoff as the polling interval
// and poll_interval is only used to reset the backoff
self.reset_backoff();
// start polling the source
ctx.run_later(Duration::from_millis(self.backoff), Self::poll);
// initialize defined ack policy...
let ack_interval = match self.source.ack_interval() {
Ok(v) => v,
Err(_err) => &SourceInterval::Millisecond(1000),
};
// schedule next poll for batch or individual acking
// no-ack doesn't run the interval
let duration = ack_interval.as_duration();
match self.source.ack_policy() {
Ok(policy) => match policy {
SourceAckPolicy::Batch(_batch_size) => {
ctx.run_interval(duration, Self::batch_ack);
}
SourceAckPolicy::Individual => {
ctx.run_interval(duration, Self::individual_ack);
}
SourceAckPolicy::None => {
warn!(
target: TARGET_SOURCE_ACTOR,
"SourceAckPolicy is None. Disabling ack interval"
);
}
},
_ => {}
}
// schedule monitoring
let monitor_interval = self.source.monitor_interval();
if let Ok(SourceInterval::Millisecond(duration)) = &monitor_interval {
if duration > &0u64 {
let dur = monitor_interval.unwrap().as_duration();
warn!(
target: TARGET_SOURCE_ACTOR,
"Configuring source monitor with interval: {:?}", &dur
);
ctx.run_interval(dur, Self::monitor);
}
}
metric::backend::MetricsBackendActor::subscribe(
"SourceActor",
ctx.address().clone().recipient(),
);
}
}
impl Supervised for SourceActor {}
impl SystemService for SourceActor {}
#[derive(Message, Debug)]
pub struct SourceAckMsg(MsgId);
impl Handler<SourceAckMsg> for SourceActor {
type Result = ();
fn handle(&mut self, msg: SourceAckMsg, _ctx: &mut Context<Self>) {
// println!("push ack_queue msg_id: {:?}", &msg);
match &self.source.ack_policy() {
Ok(policy) => match policy {
SourceAckPolicy::Batch(_size) => {
self.ack_queue.push_back(msg.0);
}
SourceAckPolicy::Individual => {
self.ack_queue.push_back(msg.0);
}
SourceAckPolicy::None => {}
},
_ => {}
}
}
}
impl Handler<ShutdownMsg> for SourceActor {
type Result = ();
fn handle(&mut self, _msg: ShutdownMsg, _ctx: &mut Context<Self>) {
warn!(
target: TARGET_SOURCE_ACTOR,
"SourceActor received shutdown msg"
);
self.shutdown = true;
}
}
impl Handler<metric::backend::Flush> for SourceActor {
type Result = ();
fn handle(&mut self, _msg: metric::backend::Flush, _ctx: &mut Context<Self>) {
// Flush source metrics
self.source.flush_metrics();
// Flush source_actor metrics
self.metrics.flush();
}
}
/// TopologyRetry mechanism used when TopologyFailurePolicy::Retry(count)
/// is declared.
///
/// This has a clone cost to it:
/// - All inflight source messages are stored in this data structure.
/// - For every retry, we must clone the source message.
/// - Every ack and error must clone the msg id
///
/// This isn't optimal but will work for retrying messages
/// if the source service doesn't implement one for you.
///
#[derive(Default)]
struct TopologyRetry {
/// The number of times to retry a message
count: usize,
/// Track polled messages and keep count of how many times
/// they've been retried
inflight: HashMap<MsgId, SourceMsg>,
/// A queue of which msgs to retry
queue: VecDeque<MsgId>,
}
impl TopologyRetry {
fn new(count: usize) -> Self {
Self {
count: count,
..Default::default()
}
}
/// When new source messages are received
/// by the TopologyActor, they're stored
/// here for the duration of the Pipeline
fn store(&mut self, msg: SourceMsg) {
let msg_id = msg.id.clone();
self.inflight.insert(msg_id, msg);
}
/// Dumb implementation for now...
/// Add timestamps later so we can
/// implement retry based on time delay
/// Return bool for tracking if msg_id was added or not
fn put(&mut self, msg_id: MsgId) -> bool {
let mut success = false;
match self.inflight.get_mut(&msg_id) {
Some(msg) => {
if msg.delivered < self.count {
self.queue.push_back(msg_id);
success = true;
}
}
None => {}
}
success
}
/// Get a list of source messages and bump the delivered count
/// on the way out
fn get(&mut self) -> Vec<SourceMsg> {
// A msg id must exist in the inflight message
// otherwise we drop it...
let mut retry = vec![];
for msg_id in self.queue.drain(..) {
match self.inflight.get_mut(&msg_id) {
Some(msg) => {
msg.delivered += 1;
retry.push(msg.clone());
}
None => {}
}
}
retry
}
fn delete(&mut self, msg_id: MsgId) {
self.inflight.remove(&msg_id);
}
}
#[derive(Default)]
pub struct TopologyActor {
// topology options
options: TopologyOptions,
// metrics
metrics: Metrics,
// Retry data structure
retry: Option<TopologyRetry>,
}
impl TopologyActor {
fn handle_failure(&mut self, msg_id: MsgId) {
match &self.options.failure_policy {
Some(policy) => match policy {
TopologyFailurePolicy::BestEffort => {
let source = SourceActor::from_registry();
if !source.connected() {
error!(
target: TARGET_TOPOLOGY_ACTOR,
"SourceActor isn't connected, fail to generate BestEffort ack"
);
self.metrics.incr_labels(
vec!["source", "msg", "ack", "dropped"],
vec![("reason", "source_disconnected")],
);
return;
}
// Source ack msg
let _ = source.try_send(SourceAckMsg(msg_id));
}
TopologyFailurePolicy::Retry(count) => match self.retry.as_mut() {
Some(retry) => {
let msg_id2 = msg_id.clone();
if !retry.put(msg_id) {
// delete retry inflight entry (we prob hit max retries)
retry.delete(msg_id2);
warn!(
target: TARGET_TOPOLOGY_ACTOR,
"TopologyFailurePolicy::Retry({}), dropped", &count
);
self.metrics.incr(vec!["source", "msg", "retry", "dropped"]);
} else {
warn!(
target: TARGET_TOPOLOGY_ACTOR,
"TopologyFailurePolicy::Retry({}), queue msg", &count
);
self.metrics.incr(vec!["source", "msg", "retry", "queued"]);
}
}
None => {}
},
TopologyFailurePolicy::None => {
warn!(
target: TARGET_TOPOLOGY_ACTOR,
"TopologyFailurePolicy::None, drop msg"
);
self.metrics.incr_labels(
vec!["source", "msg", "ack", "dropped"],
vec![("reason", "failure_policy_none")],
);
}
},
None => {
warn!(
target: TARGET_TOPOLOGY_ACTOR,
"TopologyFailurePolicy undefined, drop msg"
);
self.metrics.incr_labels(
vec!["source", "msg", "ack", "dropped"],
vec![("reason", "failure_policy_none")],
);
}
}
}
fn retry_failure(&mut self, ctx: &mut Context<Self>) {
if self.retry.is_none() {
return;
}
// Flush retry queue of SourceMsg back into
// the self...
// This should have controls on the number of messages here...
// Otherwise, the retry could just lead to more failures
// (downstream services, etc.)
let addr = ctx.address();
match self.retry.as_mut() {
Some(retry) => {
for mut msg in retry.get() {
// We must reset the msg.ts
// to avoid a quick timeout
msg.ts = now_millis();
let _ = addr.do_send(msg);
}
}
None => {}
}
}
}
impl Actor for TopologyActor {
type Context = Context<Self>;
fn started(&mut self, ctx: &mut Context<Self>) {
// Set the mailbox capacity to infinite
ctx.set_mailbox_capacity(0);
// initialize topology retry mechanics?
if let Some(TopologyFailurePolicy::Retry(count)) = self.options.failure_policy {
self.retry = Some(TopologyRetry::new(count));
ctx.run_interval(Duration::from_secs(60), Self::retry_failure);
}
metric::backend::MetricsBackendActor::subscribe(
"TopologyActor",
ctx.address().clone().recipient(),
);
}
}
impl Supervised for TopologyActor {}
impl SystemService for TopologyActor {}
impl Handler<SourceMsg> for TopologyActor {
type Result = ();
fn handle(&mut self, msg: SourceMsg, _ctx: &mut Context<Self>) {
let pipeline = PipelineActor::from_registry();
if !pipeline.connected() {
// TODO: wire up a retry here?
error!(
target: TARGET_TOPOLOGY_ACTOR,
"PipelineActor isn't connected, dropping msg: {:?}", &msg
);
self.metrics.incr_labels(
vec!["msg", "dropped"],
vec![("from", "source"), ("reason", "pipeline_disconnected")],
);
return;
}
// Store this message if the failure policy is Retry and
// this is the first time delivering this message.
// The msg must have a delivered == 0 on it... otherwise nothing
// will be retried
if self.retry.is_some() {
if msg.delivered == 0 {
match self.retry.as_mut() {
Some(retry) => {
retry.store(msg.clone());
}
None => {}
}
}
}
match pipeline.try_send(PipelineMsg::TaskRoot(msg)) {
Err(SendError::Full(msg)) => {
// TODO: wire up "holding queue" and trigger backoff here
error!(
target: TARGET_TOPOLOGY_ACTOR,
"PipelineActor mailbox is full, dropping msg: {:?}", &msg
);
self.metrics.incr_labels(
vec!["msg", "dropped"],
vec![("from", "source"), ("reason", "pipeline_mailbox_full")],
);
}
Err(SendError::Closed(msg)) => {
// TODO: trigger shutdown here
error!(
target: TARGET_TOPOLOGY_ACTOR,
"PipelineActor is closed, dropping msg: {:?}", &msg
);
self.metrics.incr_labels(
vec!["msg", "dropped"],
vec![("from", "source"), ("reason", "pipeline_closed")],
);
}
Ok(_) => {
self.metrics
.incr_labels(vec!["msg", "moved"], vec![("to", "pipeline")]);
}
}
}
}
// Client -> Server request for available tasks and
// and response back out through the TopologyServer
impl Handler<TaskRequest> for TopologyActor {
type Result = ();
fn handle(&mut self, msg: TaskRequest, _ctx: &mut Context<Self>) {
match &msg {
TaskRequest::GetAvailable(_, _, _) => {
// forward this to pipeline actor
let pipeline = PipelineActor::from_registry();
if !pipeline.connected() {
// TODO: handle implications here
error!(
target: TARGET_TOPOLOGY_ACTOR,
"PipelineActor isn't connected, dropping GetAvailable request"
);
self.metrics.incr_labels(
vec!["task", "request", "dropped"],
vec![("reason", "pipeline_disconnected")],
);
return;
}
pipeline.do_send(msg);
}
TaskRequest::GetAvailableResponse(_, _, _) => {
let topology_server = TopologyServer::from_registry();
if !topology_server.connected() {
// TODO: handle implications here. Does this mean the TopologyServer is no longer running?
error!(
target: TARGET_TOPOLOGY_ACTOR,
"TopologyServer isn't connected, dropping GetAvailableResponse"
);
self.metrics.incr_labels(
vec!["task", "response", "dropped"],
vec![("reason", "topology_server_connected_error")],
);
return;
}
topology_server.do_send(msg);
}
}
}
}
// Client -> Server response for processed tasks
impl Handler<TaskResponse> for TopologyActor {
type Result = ();
// This is for a message moving back up the chain...
// mostly for stats purposes
fn handle(&mut self, msg: TaskResponse, _ctx: &mut Context<Self>) {
// println!("Handler<TaskResponse> for TopologyActor: {:?}", &msg);
// forward this to the pipeline actor
let pipeline = PipelineActor::from_registry();
if !pipeline.connected() {
// TODO: handle implications here.
error!(
target: TARGET_TOPOLOGY_ACTOR,
"PipelineActor isn't connected, dropping TaskResponse"
);
self.metrics.incr_labels(
vec!["task", "response", "dropped"],
vec![("reason", "pipeline_disconnected")],
);
return;
}
let pipe_msg = match &msg {
TaskResponse::Ack(_, _, _, _) => PipelineMsg::TaskAck(msg),
TaskResponse::Error(_, _, _) => PipelineMsg::TaskError(msg),
};
pipeline.do_send(pipe_msg);
}
}
impl Handler<PipelineMsg> for TopologyActor {
type Result = ();
// This is for a message moving back up the chain...
// mostly for stats purposes
fn handle(&mut self, msg: PipelineMsg, _ctx: &mut Context<Self>) {
// println!("Handler<PipelineMsg> for TopologyActor {:?}", &msg);
match msg {
PipelineMsg::SourceMsgAck(msg_id) => {
let source = SourceActor::from_registry();
if !source.connected() {
error!(
target: TARGET_TOPOLOGY_ACTOR,
"SourceActor isn't connected, dropping PipelineMsg::SourceMsgAck"
);
self.metrics.incr_labels(
vec!["source", "msg", "ack", "dropped"],
vec![("reason", "source_disconnected")],
);
return;
}
// We have to cleanup the retry inflight data
// if retry is initialized
if self.retry.is_some() {
let retry = self.retry.as_mut().unwrap();
retry.delete(msg_id.clone());
}
// send msg to source ack_queue
let _ = source.try_send(SourceAckMsg(msg_id));
self.metrics
.incr_labels(vec!["source", "msg", "ack"], vec![("from", "pipeline")]);
}
PipelineMsg::SourceMsgTimeout(msg_id) => {
debug!(
target: TARGET_TOPOLOGY_ACTOR,
"Pipeline timeout msg: {:?}", &msg_id
);
self.handle_failure(msg_id);
self.metrics
.incr_labels(vec!["source", "msg", "timeout"], vec![("from", "pipeline")]);
}
PipelineMsg::SourceMsgError(msg_id) => {
debug!(
target: TARGET_TOPOLOGY_ACTOR,
"Pipeline error msg: {:?}", &msg_id
);
self.handle_failure(msg_id);
self.metrics
.incr_labels(vec!["source", "msg", "error"], vec![("from", "pipeline")]);
}
_ => {}
}
}
}
impl Handler<metric::backend::Flush> for TopologyActor {
type Result = ();
fn handle(&mut self, _msg: metric::backend::Flush, _ctx: &mut Context<Self>) {
self.metrics.flush();
}
}
#[derive(Message, Debug)]
pub enum PipelineMsg {
TaskRoot(SourceMsg),
TaskAck(TaskResponse),
TaskError(TaskResponse),
SourceMsgAck(MsgId),
SourceMsgTimeout(MsgId),
SourceMsgError(MsgId),
}
#[derive(Default)]
pub struct PipelineActor {
/// Pipeline task definitions and graph
pub pipeline: Pipeline,
/// Messages in-flight and their state
/// HashMap<source_msg_id, (timestamp, state)>
pub inflight: PipelineInflight,
/// Queues of available tasks for processing
/// by connected TaskServices
pub available: PipelineAvailable,
/// Aggregate tasks by msg_id and task_name
/// before making them available for downstream tasks
pub aggregate: PipelineAggregate,
/// metrics
pub metrics: Metrics,
}
impl Actor for PipelineActor {
type Context = Context<Self>;
fn started(&mut self, ctx: &mut Context<Self>) {
metric::backend::MetricsBackendActor::subscribe(
"PipelineActor",
ctx.address().clone().recipient(),
);
}
}
impl Supervised for PipelineActor {}
impl SystemService for PipelineActor {}
impl PipelineActor {
pub fn task_root(&mut self, src_msg: SourceMsg) {
let matrix = self.pipeline.matrix.clone();
let root = matrix[0].0.to_string();
let task_name = matrix[0].1.to_string();
let edge = (root, task_name.clone());
// 1. msg state (we always start with 1 msg)
let mut msg_state = PipelineMsgState::new(matrix);
&msg_state.edge_start(edge.clone(), 1);
// 2. inflight
self.inflight
.root(src_msg.id.clone(), src_msg.ts.clone(), msg_state);
// 3. available
// create TaskMsg and it to PipelineAvailable
// for the starting task name
let task_msg = TaskMsg {
source_id: src_msg.id.clone(),
edge: edge,
index: 0,
msg: src_msg.msg.clone(),
};
self.available.push(&task_name, task_msg);
// bump metrics
self.metrics
.incr_labels(vec!["task", "available"], vec![("task_name", &task_name)]);
}
pub fn task_ack(&mut self, task_resp: TaskResponse) {
// println!("PipelineActor.task_resp: {:?}", task_resp);
// update pending msg states
// mark edge visited
// move to the next task (if necessary, release aggregate holds)
// determine if we have a timeout error
match task_resp {
TaskResponse::Ack(msg_id, edge, index, task_result) => {
let ack_name = &edge.1[..];
// grab the list of descendants for this edge
let mut descendants = &vec![];
match self.pipeline.descendants.get(ack_name) {
Some(names) => descendants = names,
None => {}
};
// println!("Ack name: {:?}, descendants: {:?}", &ack_name, &descendants);
// store messages in aggregate hold
if let Some(msgs) = task_result {
// println!("Aggregate {} msgs for descendants", msgs.len());
// We need to clone these message for all downstream descendants
for name in descendants.iter() {
self.aggregate
.hold(&name.to_string(), msg_id.clone(), msgs.clone());
}
}
// What's the PipelineInflightStatus for this msg id?
let status = self.inflight.ack(&msg_id, &edge, index);
// println!("Inflight status: {:?} {:?}", &msg_id, &status);
match status {
PipelineInflightStatus::AckEdge(task_visited) => {
if task_visited {
// all ancestor edges are complete...
// time to release all aggregate messages siting in the
// holding pen to the descendant tasks
let mut ack_source = false;
for name in descendants.iter() {
// take the aggregate holding msgs
// wrap them in TaskMsg and move them to the holding
// queues
let next_edge = (ack_name.to_string(), name.to_string());
match self.aggregate.remove(&name.to_string(), &msg_id) {
Some(msgs) => {
// println!("Release msgs: {:?}=>{}", &next_edge, msgs.len());
// we need to update the inflight msg state here
if let Some((_ts, msg_state)) =
self.inflight.get_mut(&msg_id)
{
msg_state.edge_start(next_edge.clone(), msgs.len());
} else {
// TODO:
// We might not have a msg_state if the source msg timed out
// and we cleaned up... in this case we should skip moving to
// to the available queues
}
for (index, msg) in msgs.iter().enumerate() {
let task_msg = TaskMsg {
source_id: msg_id.clone(),
edge: next_edge.clone(),
index: index,
msg: msg.to_vec(),
};
self.available.push(&name.to_string(), task_msg);
}
}
None => {
// what happens if we reach this?
// mark this next_edge as visited
self.inflight.ack_dead_end(
&msg_id,
&next_edge,
&self.pipeline,
);
// if this put the msg_)id into a finished state...
// we need to set the ack source flag
if self.inflight.finished(&msg_id) {
ack_source = true;
// if this msg_id is finished...
// do we really need to keep going here?
break;
}
}
}
}
if ack_source {
debug!(
target: TARGET_PIPELINE_ACTOR,
"ack_deadend triggered force ack source for this msg_id: {:?}",
&msg_id
);
let topology = TopologyActor::from_registry();
if !topology.connected() {
// TODO: determine the implications here
error!(target: TARGET_PIPELINE_ACTOR, "TopologyActor isn't connected, skipping PipelineMsg::SourceMsgAck");
return;
}
topology.do_send(PipelineMsg::SourceMsgAck(msg_id));
}
} else {
// nothing to do but wait...
}
}
PipelineInflightStatus::AckSource => {
// println!("AckSource: {:?}", &msg_id);
let topology = TopologyActor::from_registry();
if !topology.connected() {
error!(
target: TARGET_PIPELINE_ACTOR,
"TopologyActor isn't connected, skipping PipelineMsg::SourceMsgAck"
);
return;
}
// Cleanup after msg_id
self.cleanup(&msg_id);
topology.do_send(PipelineMsg::SourceMsgAck(msg_id));
}
PipelineInflightStatus::PendingEdge => {
// Nothing to do but wait for this edge to finish processing
// message for the edge
debug!(
target: TARGET_PIPELINE_ACTOR,
"PendingEdge: waiting to finish msg state: {:?}", &msg_id
);
}
PipelineInflightStatus::Removed => {
// This msg_id no longer exists in the inflight messages
// assume the cleanup process already took care of this...
// Call cleanup again to remove anything related
// to this message id
debug!(
target: TARGET_PIPELINE_ACTOR,
"PipelineInflightStatus::Removed {:?}", &msg_id
);
self.cleanup(&msg_id);
}
PipelineInflightStatus::Timeout => {
let topology = TopologyActor::from_registry();
if !topology.connected() {
error!(
target: TARGET_PIPELINE_ACTOR,
"TopologyActor isn't connected, skipping PipelineMsg::SourceMsgTimeout"
);
return;
}
self.cleanup(&msg_id);
topology.do_send(PipelineMsg::SourceMsgTimeout(msg_id));
}
}
}
TaskResponse::Error(msg_id, ..) => {
let topology = TopologyActor::from_registry();
if !topology.connected() {
error!(
target: TARGET_PIPELINE_ACTOR,
"TopologyActor isn't connected, skipping PipelineMsg::SourceMsgError"
);
return;
}
self.cleanup(&msg_id);
topology.do_send(PipelineMsg::SourceMsgError(msg_id));
}
}
}
pub fn cleanup(&mut self, msg_id: &MsgId) {
self.inflight.clean_msg_id(msg_id);
self.aggregate.clean_msg_id(msg_id);
}
}
/// Handle PipelineMsg for PipelineActor
impl Handler<PipelineMsg> for PipelineActor {
type Result = ();
fn handle(&mut self, msg: PipelineMsg, _ctx: &mut Context<Self>) {
match msg {
PipelineMsg::TaskRoot(src_msg) => {
debug!(
target: TARGET_PIPELINE_ACTOR,
"PipelineMsg::TaskRoot(src_msg) = {:?}", &src_msg
);
self.task_root(src_msg);
}
PipelineMsg::TaskAck(task_resp) => {
// this should return a list of PipelineMsg's
// for sending back up through TopologyActor
// if we're done processing the original message
// An Option(None) means we're still not ready
// for Source Ack yet...
debug!(
target: TARGET_PIPELINE_ACTOR,
"PipelineMsg::TaskAck(task_resp) = {:?}", &task_resp
);
self.task_ack(task_resp);
}
PipelineMsg::TaskError(task_resp) => {
// update available & aggregate (if necessary)
// and send PipelineMsg::Ack to topology_addr
debug!(
target: TARGET_PIPELINE_ACTOR,
"PipelineMsg::TaskError(task_resp) unimplemented"
);
self.task_ack(task_resp);
}
_ => {
// not implemented here
warn!(
target: TARGET_PIPELINE_ACTOR,
"Handler<PipelineMsg> for PipelineMsg reach match unimplemented match arm for msg: {:?}",
&msg
);
}
}
}
}
impl Handler<TaskRequest> for PipelineActor {
type Result = ();
fn handle(&mut self, msg: TaskRequest, _ctx: &mut Context<Self>) {
match msg {
TaskRequest::GetAvailable(session_id, name, count) => {
let topology = TopologyActor::from_registry();
if !topology.connected() {
error!(
target: TARGET_PIPELINE_ACTOR,
"TopologyActor isn't connected, skipping TaskRequest::GetAvailable"
);
return;
}
trace!(
target: TARGET_PIPELINE_ACTOR,
"TaskRequest::GetAvailable(session_id, name, count): {}, {}, {:?}",
&session_id,
&name,
&count
);
let tasks = self.available.pop(&name, count);
topology.do_send(TaskRequest::GetAvailableResponse(session_id, name, tasks));
}
_ => {
warn!(
target: TARGET_PIPELINE_ACTOR,
"Handler<TaskRequest> for TaskRequest only implements TaskRequest::GetAvailable"
);
}
}
}
}
impl Handler<metric::backend::Flush> for PipelineActor {
type Result = ();
fn handle(&mut self, _msg: metric::backend::Flush, _ctx: &mut Context<Self>) {
// Mark available,
self.metrics
.gauge(vec!["inflight"], self.inflight.size() as isize);
let stats1 = self.available.stats();
trace!("Available len {}", &stats1.len());
for (task, size) in stats1 {
self.metrics
.gauge_labels(vec!["available"], size, vec![("task", &task)]);
}
let stats2 = self.aggregate.stats();
trace!("aggregate stats len {}", &stats2.len());
for (task, size) in stats2 {
self.metrics
.gauge_labels(vec!["aggregate"], size, vec![("task", &task)]);
}
self.metrics.flush();
}
}