Repository navigation
Expand file tree
/
Copy pathpluggable.py
More file actions
903 lines (774 loc) · 32.4 KB
/
Copy pathpluggable.py
File metadata and controls
903 lines (774 loc) · 32.4 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
"""Pluggable Storage classes."""
import logging
import json
import threading
from splitio.models import splits, segments
from splitio.models.impressions import Impression
from splitio.models.telemetry import MethodExceptions, MethodLatencies, TelemetryConfig, MAX_TAGS, get_latency_bucket_index
from splitio.storage import FlagSetsFilter
from splitio.storage import SplitStorage, SegmentStorage, ImpressionStorage, EventStorage, TelemetryStorage
from splitio.util.storage_helper import get_valid_flag_sets, combine_valid_flag_sets
_LOGGER = logging.getLogger(__name__)
class PluggableSplitStorage(SplitStorage):
"""InMemory implementation of feature flag storage."""
_FEATURE_FLAG_NAME_LENGTH = 19
def __init__(self, pluggable_adapter, prefix=None, config_flag_sets=[]):
"""
Class constructor.
:param pluggable_adapter: Storage client or compliant interface.
:type pluggable_adapter: TBD
:param prefix: optional, prefix to storage keys
:type prefix: str
"""
self._pluggable_adapter = pluggable_adapter
self._prefix = "SPLITIO.split.{feature_flag_name}"
self._traffic_type_prefix = "SPLITIO.trafficType.{traffic_type_name}"
self._feature_flag_till_prefix = "SPLITIO.splits.till"
self._flag_set_prefix = 'SPLITIO.flagSet.{flag_set}'
self.flag_set_filter = FlagSetsFilter(config_flag_sets)
if prefix is not None:
self._prefix = prefix + "." + self._prefix
self._traffic_type_prefix = prefix + "." + self._traffic_type_prefix
self._feature_flag_till_prefix = prefix + "." + self._feature_flag_till_prefix
self._flag_set_prefix = prefix + "." + self._flag_set_prefix
def get(self, feature_flag_name):
"""
Retrieve a feature flag.
:param feature_flag_name: Name of the feature to fetch.
:type feature_flag_name: str
:rtype: splitio.models.splits.Split
"""
try:
feature_flag = self._pluggable_adapter.get(self._prefix.format(feature_flag_name=feature_flag_name))
if not feature_flag:
return None
return splits.from_raw(feature_flag)
except Exception:
_LOGGER.error('Error getting feature flag from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
def fetch_many(self, feature_flag_names):
"""
Retrieve feature flags.
:param feature_flag_names: Names of the features to fetch.
:type feature_flag_name: list(str)
:return: A dict with split objects parsed from queue.
:rtype: dict(split_name, splitio.models.splits.Split)
"""
try:
prefix_added = [self._prefix.format(feature_flag_name=feature_flag_name) for feature_flag_name in feature_flag_names]
return {feature_flag['name']: splits.from_raw(feature_flag) for feature_flag in self._pluggable_adapter.get_many(prefix_added)}
except Exception:
_LOGGER.error('Error getting feature flag from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
def get_feature_flags_by_sets(self, flag_sets):
"""
Retrieve feature flags by flag set.
:param flag_sets: List of flag sets to fetch.
:type flag_sets: list(str)
:return: Feature flag names that are tagged with the flag set
:rtype: listt(str)
"""
try:
sets_to_fetch = get_valid_flag_sets(flag_sets, self.flag_set_filter)
if sets_to_fetch == []:
return []
keys = [self._flag_set_prefix.format(flag_set=flag_set) for flag_set in sets_to_fetch]
result_sets = []
[result_sets.append(set(key)) for key in self._pluggable_adapter.get_many(keys)]
return list(combine_valid_flag_sets(result_sets))
except Exception:
_LOGGER.error('Error fetching feature flag from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
def get_feature_flags_by_sets(self, flag_sets):
"""
Retrieve feature flags by flag set.
:param flag_set: Names of the flag set to fetch.
:type flag_set: str
:return: Feature flag names that are tagged with the flag set
:rtype: listt(str)
"""
try:
sets_to_fetch = get_valid_flag_sets(flag_sets, self.flag_set_filter)
if sets_to_fetch == []:
return []
keys = [self._flag_set_prefix.format(flag_set=flag_set) for flag_set in sets_to_fetch]
result_sets = []
[result_sets.append(set(key)) for key in self._pluggable_adapter.get_many(keys)]
return list(combine_valid_flag_sets(result_sets))
except Exception:
_LOGGER.error('Error fetching feature flag from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
# TODO: To be added when producer mode is supported
# def put_many(self, splits, change_number):
# """
# Store multiple splits.
#
# :param split: array of Split objects.
# :type split: splitio.models.split.Split[]
# """
# try:
# for split in splits:
# self.put(split)
# self._pluggable_adapter.set(self._split_till_prefix, change_number)
# except Exception:
# _LOGGER.error('Error storing splits in storage')
# _LOGGER.debug('Error: ', exc_info=True)
def update(self, to_add, to_delete, new_change_number):
"""
Update feature flag storage.
:param to_add: List of feature flags to add
:type to_add: list[splitio.models.splits.Split]
:param to_delete: List of feature flags to delete
:type to_delete: list[splitio.models.splits.Split]
:param new_change_number: New change number.
:type new_change_number: int
"""
pass
# TODO: To be added when producer mode is aupported
# def _remove(self, split_name):
"""
Remove a split from storage.
:param split_name: Name of the feature to remove.
:type split_name: str
:return: True if the split was found and removed. False otherwise.
:rtype: bool
"""
# pass
# try:
# split = self.get(split_name)
# if not split:
# _LOGGER.warning("Tried to delete nonexistant split %s. Skipping", split_name)
# return False
# self._pluggable_adapter.delete(self._prefix.format(split_name=split_name))
# self._decrease_traffic_type_count(split.traffic_type_name)
# return True
# except Exception:
# _LOGGER.error('Error removing split from storage')
# _LOGGER.debug('Error: ', exc_info=True)
# return False
def get_change_number(self):
"""
Retrieve latest feature flag change number.
:rtype: int
"""
try:
return self._pluggable_adapter.get(self._feature_flag_till_prefix)
except Exception:
_LOGGER.error('Error getting change number in feature flag storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
# TODO: To be added when producer mode is aupported
# def _set_change_number(self, new_change_number):
"""
Set the latest change number.
:param new_change_number: New change number.
:type new_change_number: int
"""
# pass
# try:
# self._pluggable_adapter.set(self._split_till_prefix, new_change_number)
# except Exception:
# _LOGGER.error('Error setting change number in split storage')
# _LOGGER.debug('Error: ', exc_info=True)
# return None
def get_split_names(self):
"""
Retrieve a list of all feature flag names.
:return: List of feature flag names.
:rtype: list(str)
"""
try:
return [feature_flag.name for feature_flag in self.get_all()]
except Exception:
_LOGGER.error('Error getting feature flag names from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
def get_all(self):
"""
Return all the feature flags.
:return: List of all the feature flags.
:rtype: list
"""
try:
return [splits.from_raw(self._pluggable_adapter.get(key)) for key in self._pluggable_adapter.get_keys_by_prefix(self._prefix[:-self._FEATURE_FLAG_NAME_LENGTH])]
except Exception:
_LOGGER.error('Error getting feature flag keys from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
def traffic_type_exists(self, traffic_type_name):
"""
Return whether the traffic type exists in at least one feature flag in cache.
:param traffic_type_name: Traffic type to validate.
:type traffic_type_name: str
:return: True if the traffic type is valid. False otherwise.
:rtype: bool
"""
try:
return self._pluggable_adapter.get(self._traffic_type_prefix.format(traffic_type_name=traffic_type_name)) != None
except Exception:
_LOGGER.error('Error getting traffic type info from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
def kill_locally(self, split_name, default_treatment, change_number):
"""
Local kill for split
:param split_name: name of the split to perform kill
:type split_name: str
:param default_treatment: name of the default treatment to return
:type default_treatment: str
:param change_number: change_number
:type change_number: int
"""
pass
# TODO: To be added when producer mode is aupported
# try:
# split = self.get(split_name)
# if not split:
# return
# if self.get_change_number() > change_number:
# return
# split.local_kill(default_treatment, change_number)
# self._pluggable_adapter.set(self._prefix.format(split_name=split_name), split.to_json())
# except Exception:
# _LOGGER.error('Error updating split in storage')
# _LOGGER.debug('Error: ', exc_info=True)
# TODO: To be added when producer mode is aupported
# def _increase_traffic_type_count(self, traffic_type_name):
# """
# Increase by one the count for a specific traffic type name.
#
# :param traffic_type_name: Traffic type to increase the count.
# :type traffic_type_name: str
#
# :return: existing count of traffic type
# :rtype: int
# """
# try:
# return self._pluggable_adapter.increment(self._traffic_type_prefix.format(traffic_type_name=traffic_type_name), 1)
# except Exception:
# _LOGGER.error('Error updating traffic type count in split storage')
# _LOGGER.debug('Error: ', exc_info=True)
# return None
# TODO: To be added when producer mode is aupported
# def _decrease_traffic_type_count(self, traffic_type_name):
# """
# Decrease by one the count for a specific traffic type name.
#
# :param traffic_type_name: Traffic type to decrease the count.
# :type traffic_type_name: str
#
# :return: existing count of traffic type
# :rtype: int
# """
# try:
# return_count = self._pluggable_adapter.decrement(self._traffic_type_prefix.format(traffic_type_name=traffic_type_name), 1)
# if return_count == 0:
# self._pluggable_adapter.delete(self._traffic_type_prefix.format(traffic_type_name=traffic_type_name))
# except Exception:
# _LOGGER.error('Error updating traffic type count in split storage')
# _LOGGER.debug('Error: ', exc_info=True)
# return None
def get_all_splits(self):
"""
Return all the feature flags.
:return: List of all the feature flags.
:rtype: list
"""
try:
return self.get_all()
except Exception:
_LOGGER.error('Error fetching feature flags from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
def is_valid_traffic_type(self, traffic_type_name):
"""
Return whether the traffic type exists in at least one feature flag in cache.
:param traffic_type_name: Traffic type to validate.
:type traffic_type_name: str
:return: True if the traffic type is valid. False otherwise.
:rtype: bool
"""
try:
return self.traffic_type_exists(traffic_type_name)
except Exception:
_LOGGER.error('Error getting traffic type info from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
# TODO: To be added when producer mode is aupported
# def _put(self, split):
"""
Store a split.
:param split: Split object.
:type split: splitio.models.split.Split
"""
# pass
# try:
# existing_split = self.get(split.name)
# self._pluggable_adapter.set(self._prefix.format(split_name=split.name), split.to_json())
# if existing_split is None:
# self._increase_traffic_type_count(split.traffic_type_name)
# return
#
# if existing_split is not None and existing_split.traffic_type_name != split.traffic_type_name:
# self._increase_traffic_type_count(split.traffic_type_name)
# self._decrease_traffic_type_count(existing_split.traffic_type_name)
# except Exception:
# _LOGGER.error('Error ADDING split to storage')
# _LOGGER.debug('Error: ', exc_info=True)
# return None
class PluggableSegmentStorage(SegmentStorage):
"""Pluggable implementation of segment storage."""
_SEGMENT_NAME_LENGTH = 14
_TILL_LENGTH = 4
def __init__(self, pluggable_adapter, prefix=None):
"""
Class constructor.
:param pluggable_adapter: Storage client or compliant interface.
:type pluggable_adapter: TBD
:param prefix: optional, prefix to storage keys
:type prefix: str
"""
self._pluggable_adapter = pluggable_adapter
self._prefix = "SPLITIO.segment.{segment_name}"
self._segment_till_prefix = "SPLITIO.segment.{segment_name}.till"
if prefix is not None:
self._prefix = prefix + "." + self._prefix
self._segment_till_prefix = prefix + "." + self._segment_till_prefix
def update(self, segment_name, to_add, to_remove, change_number=None):
"""
Update a segment. Create it if it doesn't exist.
:param segment_name: Name of the segment to update.
:type segment_name: str
:param to_add: Set of members to add to the segment.
:type to_add: set
:param to_remove: List of members to remove from the segment.
:type to_remove: Set
"""
pass
# TODO: To be added when producer mode is aupported
# try:
# if to_add is not None:
# self._pluggable_adapter.add_items(self._prefix.format(segment_name=segment_name), to_add)
# if to_remove is not None:
# self._pluggable_adapter.remove_items(self._prefix.format(segment_name=segment_name), to_remove)
# if change_number is not None:
# self._pluggable_adapter.set(self._segment_till_prefix.format(segment_name=segment_name), change_number)
# except Exception:
# _LOGGER.error('Error updating segment storage')
# _LOGGER.debug('Error: ', exc_info=True)
def set_change_number(self, segment_name, change_number):
"""
Store a segment change number.
:param segment_name: segment name
:type segment_name: str
:param change_number: change number
:type segment_name: int
"""
pass
# TODO: To be added when producer mode is aupported
# try:
# self._pluggable_adapter.set(self._segment_till_prefix.format(segment_name=segment_name), change_number)
# except Exception:
# _LOGGER.error('Error updating segment change number')
# _LOGGER.debug('Error: ', exc_info=True)
def get_change_number(self, segment_name):
"""
Get a segment change number.
:param segment_name: segment name
:type segment_name: str
:return: change number
:rtype: int
"""
try:
return self._pluggable_adapter.get(self._segment_till_prefix.format(segment_name=segment_name))
except Exception:
_LOGGER.error('Error fetching segment change number')
_LOGGER.debug('Error: ', exc_info=True)
return None
def get_segment_names(self):
"""
Get list of segment names.
:return: list of segment names
:rtype: str[]
"""
try:
keys = []
for key in self._pluggable_adapter.get_keys_by_prefix(self._prefix[:-self._SEGMENT_NAME_LENGTH]):
if key[-self._TILL_LENGTH:] != 'till':
keys.append(key[len(self._prefix[:-self._SEGMENT_NAME_LENGTH]):])
return keys
except Exception:
_LOGGER.error('Error getting segments')
_LOGGER.debug('Error: ', exc_info=True)
return None
# TODO: To be added in the future because this data is not being sent by telemetry in consumer/synchronizer mode
# def get_keys(self, segment_name):
# """
# Get keys of a segment.
#
# :param segment_name: segment name
# :type segment_name: str
#
# :return: list of segment keys
# :rtype: str[]
# """
# try:
# return list(self._pluggable_adapter.get(self._prefix.format(segment_name=segment_name)))
# except Exception:
# _LOGGER.error('Error getting segments keys')
# _LOGGER.debug('Error: ', exc_info=True)
# return None
def segment_contains(self, segment_name, key):
"""
Check if segment contains a key
:param segment_name: segment name
:type segment_name: str
:param key: key
:type key: str
:return: True if found, otherwise False
:rtype: bool
"""
try:
return self._pluggable_adapter.item_contains(self._prefix.format(segment_name=segment_name), key)
except Exception:
_LOGGER.error('Error checking segment key')
_LOGGER.debug('Error: ', exc_info=True)
return None
def get_segment_keys_count(self):
"""
Get count of all keys in segments.
:return: keys count
:rtype: int
"""
pass
# TODO: To be added when producer mode is aupported
# try:
# return sum([self._pluggable_adapter.get_items_count(key) for key in self._pluggable_adapter.get_keys_by_prefix(self._prefix)])
# except Exception:
# _LOGGER.error('Error getting segment keys')
# _LOGGER.debug('Error: ', exc_info=True)
# return None
def get(self, segment_name):
"""
Get a segment
:param segment_name: segment name
:type segment_name: str
:return: segment object
:rtype: splitio.models.segments.Segment
"""
try:
return segments.from_raw({'name': segment_name, 'added': self._pluggable_adapter.get_items(self._prefix.format(segment_name=segment_name)), 'removed': [], 'till': self._pluggable_adapter.get(self._segment_till_prefix.format(segment_name=segment_name))})
except Exception:
_LOGGER.error('Error getting segment')
_LOGGER.debug('Error: ', exc_info=True)
return None
def put(self, segment):
"""
Store a segment.
:param segment: Segment to store.
:type segment: splitio.models.segment.Segment
"""
pass
# TODO: To be added when producer mode is aupported
# try:
# self._pluggable_adapter.add_items(self._prefix.format(segment_name=segment.name), list(segment.keys))
# if segment.change_number is not None:
# self._pluggable_adapter.set(self._segment_till_prefix.format(segment_name=segment.name), segment.change_number)
# except Exception:
# _LOGGER.error('Error updating segment storage')
# _LOGGER.debug('Error: ', exc_info=True)
class PluggableImpressionsStorage(ImpressionStorage):
"""Pluggable Impressions storage class."""
IMPRESSIONS_KEY_DEFAULT_TTL = 3600
def __init__(self, pluggable_adapter, sdk_metadata, prefix=None):
"""
Class constructor.
:param pluggable_adapter: Storage client or compliant interface.
:type pluggable_adapter: TBD
:param sdk_metadata: SDK & Machine information.
:type sdk_metadata: splitio.client.util.SdkMetadata
:param prefix: optional, prefix to storage keys
:type prefix: str
"""
self._pluggable_adapter = pluggable_adapter
self._sdk_metadata = {
's': sdk_metadata.sdk_version,
'n': sdk_metadata.instance_name,
'i': sdk_metadata.instance_ip,
}
self._impressions_queue_key = 'SPLITIO.impressions'
if prefix is not None:
self._impressions_queue_key = prefix + "." + self._impressions_queue_key
def _wrap_impressions(self, impressions):
"""
Wrap impressions to be stored in storage
:param impressions: Impression to add to the queue.
:type impressions: splitio.models.impressions.Impression
:return: Processed impressions.
:rtype: list[splitio.models.impressions.Impression]
"""
bulk_impressions = []
for impression in impressions:
if isinstance(impression, Impression):
to_store = {
'm': self._sdk_metadata,
'i': {
'k': impression.matching_key,
'b': impression.bucketing_key,
'f': impression.feature_name,
't': impression.treatment,
'r': impression.label,
'c': impression.change_number,
'm': impression.time,
}
}
bulk_impressions.append(json.dumps(to_store))
return bulk_impressions
def put(self, impressions):
"""
Add an impression to the pluggable storage.
:param impressions: Impression to add to the queue.
:type impressions: splitio.models.impressions.Impression
:return: Whether the impression has been added or not.
:rtype: bool
"""
bulk_impressions = self._wrap_impressions(impressions)
try:
total_keys = self._pluggable_adapter.push_items(self._impressions_queue_key, *bulk_impressions)
self.expire_key(total_keys, len(bulk_impressions))
return True
except Exception:
_LOGGER.error('Something went wrong when trying to add impression to storage')
_LOGGER.error('Error: ', exc_info=True)
return False
def expire_key(self, total_keys, inserted):
"""
Set expire
:param total_keys: length of keys.
:type total_keys: int
:param inserted: added keys.
:type inserted: int
"""
if total_keys == inserted:
self._pluggable_adapter.expire(self._impressions_queue_key, self.IMPRESSIONS_KEY_DEFAULT_TTL)
def pop_many(self, count):
"""
Pop the oldest N events from storage.
:param count: Number of events to pop.
:type count: int
"""
raise NotImplementedError('Only consumer mode is supported.')
def clear(self):
"""
Clear data.
"""
raise NotImplementedError('Only consumer mode is supported.')
class PluggableEventsStorage(EventStorage):
"""Pluggable Event storage class."""
_EVENTS_KEY_DEFAULT_TTL = 3600
def __init__(self, pluggable_adapter, sdk_metadata, prefix=None):
"""
Class constructor.
:param pluggable_adapter: Storage client or compliant interface.
:type pluggable_adapter: TBD
:param sdk_metadata: SDK & Machine information.
:type sdk_metadata: splitio.client.util.SdkMetadata
:param prefix: optional, prefix to storage keys
:type prefix: str
"""
self._pluggable_adapter = pluggable_adapter
self._sdk_metadata = {
's': sdk_metadata.sdk_version,
'n': sdk_metadata.instance_name,
'i': sdk_metadata.instance_ip,
}
self._events_queue_key = 'SPLITIO.events'
if prefix is not None:
self._events_queue_key = prefix + "." + self._events_queue_key
def _wrap_events(self, events):
return [
json.dumps({
'e': {
'key': e.event.key,
'trafficTypeName': e.event.traffic_type_name,
'eventTypeId': e.event.event_type_id,
'value': e.event.value,
'timestamp': e.event.timestamp,
'properties': e.event.properties,
},
'm': self._sdk_metadata
})
for e in events
]
def put(self, events):
"""
Add an event to the redis storage.
:param event: Event to add to the queue.
:type event: splitio.models.events.Event
:return: Whether the event has been added or not.
:rtype: bool
"""
to_store = self._wrap_events(events)
try:
total_keys = self._pluggable_adapter.push_items(self._events_queue_key, *to_store)
self.expire_key(total_keys, len(to_store))
return True
except Exception:
_LOGGER.error('Something went wrong when trying to add event to redis')
_LOGGER.debug('Error: ', exc_info=True)
return False
def expire_key(self, total_keys, inserted):
"""
Set expire
:param total_keys: length of keys.
:type total_keys: int
:param inserted: added keys.
:type inserted: int
"""
if total_keys == inserted:
self._pluggable_adapter.expire(self._events_queue_key, self._EVENTS_KEY_DEFAULT_TTL)
def pop_many(self, count):
"""
Pop the oldest N events from storage.
:param count: Number of events to pop.
:type count: int
"""
raise NotImplementedError('Only redis-consumer mode is supported.')
def clear(self):
"""
Clear data.
"""
raise NotImplementedError('Not supported for redis.')
class PluggableTelemetryStorage(TelemetryStorage):
"""Pluggable telemetry storage class."""
_TELEMETRY_KEY_DEFAULT_TTL = 3600
def __init__(self, pluggable_adapter, sdk_metadata, prefix=None):
"""
Class constructor.
:param pluggable_adapter: Storage client or compliant interface.
:type pluggable_adapter: TBD
:param sdk_metadata: SDK & Machine information.
:type sdk_metadata: splitio.client.util.SdkMetadata
:param prefix: optional, prefix to storage keys
:type prefix: str
"""
self._lock = threading.RLock()
self._reset_config_tags()
self._pluggable_adapter = pluggable_adapter
self._sdk_metadata = sdk_metadata.sdk_version + '/' + sdk_metadata.instance_name + '/' + sdk_metadata.instance_ip
self._method_latencies = MethodLatencies()
self._method_exceptions = MethodExceptions()
self._tel_config = TelemetryConfig()
self._telemetry_config_key = 'SPLITIO.telemetry.init'
self._telemetry_latencies_key = 'SPLITIO.telemetry.latencies'
self._telemetry_exceptions_key = 'SPLITIO.telemetry.exceptions'
if prefix is not None:
self._telemetry_config_key = prefix + "." + self._telemetry_config_key
self._telemetry_latencies_key = prefix + "." + self._telemetry_latencies_key
self._telemetry_exceptions_key = prefix + "." + self._telemetry_exceptions_key
def _reset_config_tags(self):
"""Reset config tags."""
with self._lock:
self._config_tags = []
def add_config_tag(self, tag):
"""
Record tag string.
:param tag: tag to be added
:type tag: str
"""
with self._lock:
if len(self._config_tags) < MAX_TAGS:
self._config_tags.append(tag)
def record_config(self, config, extra_config, total_flag_sets, invalid_flag_sets):
"""
initilize telemetry objects
:param config: factory configuration parameters
:type config: Dict
:param extra_config: any extra configs
:type extra_config: Dict
"""
self._tel_config.record_config(config, extra_config, total_flag_sets, invalid_flag_sets)
def pop_config_tags(self):
"""Get and reset configs."""
with self._lock:
tags = self._config_tags
self._reset_config_tags()
return tags
def push_config_stats(self):
"""push config stats to storage."""
self._pluggable_adapter.set(self._telemetry_config_key + "::" + self._sdk_metadata, str(self._format_config_stats()))
def _format_config_stats(self):
"""format only selected config stats to json"""
config_stats = self._tel_config.get_stats()
return json.dumps({
'aF': config_stats['aF'],
'rF': config_stats['rF'],
'sT': config_stats['sT'],
'oM': config_stats['oM'],
't': self.pop_config_tags()
})
def record_active_and_redundant_factories(self, active_factory_count, redundant_factory_count):
"""
Record active and redundant factories.
:param active_factory_count: active factory count
:type active_factory_count: int
:param redundant_factory_count: redundant factory count
:type redundant_factory_count: int
"""
self._tel_config.record_active_and_redundant_factories(active_factory_count, redundant_factory_count)
def record_latency(self, method, bucket):
"""
record latency data
:param method: method name
:type method: string
:param latency: latency
:type latency: int64
"""
latency_key = self._telemetry_latencies_key + '::' + self._sdk_metadata + '/' + method.value + '/' + str(bucket)
result = self._pluggable_adapter.increment(latency_key, 1)
self.expire_keys(latency_key, self._TELEMETRY_KEY_DEFAULT_TTL, 1, result)
def record_exception(self, method):
"""
record an exception
:param method: method name
:type method: string
"""
except_key = self._telemetry_exceptions_key + "::" + self._sdk_metadata + '/' + method.value
result = self._pluggable_adapter.increment(except_key, 1)
self.expire_keys(except_key, self._TELEMETRY_KEY_DEFAULT_TTL, 1, result)
def record_not_ready_usage(self):
"""Not implemented"""
pass
def record_bur_time_out(self):
"""Not implemented"""
pass
def record_impression_stats(self, data_type, count):
"""Not implemented"""
pass
def expire_latency_keys(self, total_keys, inserted):
"""
Set expire ttl for a latency key in storage
:param total_keys: length of keys.
:type total_keys: int
:param inserted: added keys.
:type inserted: int
"""
self.expire_keys(self._telemetry_latencies_key, self._TELEMETRY_KEY_DEFAULT_TTL, total_keys, inserted)
def expire_keys(self, queue_key, key_default_ttl, total_keys, inserted):
"""
Set expire ttl for a key in storage if total keys equal inserted
:param queue_keys: key to be set
:type queue_keys: str
:param ey_default_ttl: ttl value
:type ey_default_ttl: int
:param total_keys: length of keys.
:type total_keys: int
:param inserted: added keys.
:type inserted: int
"""
if total_keys == inserted:
self._pluggable_adapter.expire(queue_key, key_default_ttl)