configdirector-server-sdk 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.yardopts +2 -0
- data/CHANGELOG.md +254 -0
- data/LICENSE +21 -0
- data/README.md +230 -0
- data/lib/configdirector/client_hooks.rb +46 -0
- data/lib/configdirector/config_director_client.rb +322 -0
- data/lib/configdirector/config_evaluated_event.rb +10 -0
- data/lib/configdirector/config_evaluation.rb +51 -0
- data/lib/configdirector/config_state.rb +39 -0
- data/lib/configdirector/configs_updated_event.rb +23 -0
- data/lib/configdirector/connection_error_event.rb +11 -0
- data/lib/configdirector/connection_options.rb +60 -0
- data/lib/configdirector/context.rb +53 -0
- data/lib/configdirector/errors.rb +29 -0
- data/lib/configdirector/internal/client/client_connection.rb +119 -0
- data/lib/configdirector/internal/client/client_factory.rb +104 -0
- data/lib/configdirector/internal/client/client_options_validation.rb +53 -0
- data/lib/configdirector/internal/client/config_read.rb +31 -0
- data/lib/configdirector/internal/client/config_reader.rb +55 -0
- data/lib/configdirector/internal/client/connection_intake.rb +59 -0
- data/lib/configdirector/internal/client/connection_options_validation.rb +94 -0
- data/lib/configdirector/internal/client/context_admission.rb +48 -0
- data/lib/configdirector/internal/client/context_attributes.rb +78 -0
- data/lib/configdirector/internal/client/context_kind.rb +24 -0
- data/lib/configdirector/internal/client/evaluated_read.rb +9 -0
- data/lib/configdirector/internal/client/event_handlers.rb +114 -0
- data/lib/configdirector/internal/client/event_tracking.rb +39 -0
- data/lib/configdirector/internal/client/live_client_connections.rb +58 -0
- data/lib/configdirector/internal/client/number_of_seconds.rb +21 -0
- data/lib/configdirector/internal/client/registrations.rb +43 -0
- data/lib/configdirector/internal/client/restart_in_forked_processes.rb +25 -0
- data/lib/configdirector/internal/client/served_configs.rb +83 -0
- data/lib/configdirector/internal/client/serving_state.rb +102 -0
- data/lib/configdirector/internal/client/watches.rb +51 -0
- data/lib/configdirector/internal/client/what_follows_a_fork.rb +24 -0
- data/lib/configdirector/internal/connection/condition_parser.rb +74 -0
- data/lib/configdirector/internal/connection/config_definition.rb +37 -0
- data/lib/configdirector/internal/connection/http_session.rb +15 -0
- data/lib/configdirector/internal/connection/in_memory_connection.rb +134 -0
- data/lib/configdirector/internal/connection/json_post_request.rb +24 -0
- data/lib/configdirector/internal/connection/not_a_server_sdk_payload.rb +9 -0
- data/lib/configdirector/internal/connection/offline_mode_connection.rb +96 -0
- data/lib/configdirector/internal/connection/offline_values_file.rb +49 -0
- data/lib/configdirector/internal/connection/payloads_delivered_in_turn.rb +46 -0
- data/lib/configdirector/internal/connection/polling_interval.rb +21 -0
- data/lib/configdirector/internal/connection/request_deadline.rb +45 -0
- data/lib/configdirector/internal/connection/retry_after_header.rb +24 -0
- data/lib/configdirector/internal/connection/server_sdk_payload.rb +37 -0
- data/lib/configdirector/internal/connection/server_sdk_payload_parser.rb +89 -0
- data/lib/configdirector/internal/connection/targeting_rules_parser.rb +70 -0
- data/lib/configdirector/internal/connection/test_client_initializations.rb +111 -0
- data/lib/configdirector/internal/connection/test_client_values.rb +53 -0
- data/lib/configdirector/internal/connection/unreadable_definition.rb +9 -0
- data/lib/configdirector/internal/connection/wire_fields.rb +59 -0
- data/lib/configdirector/internal/evaluation/array_comparison.rb +25 -0
- data/lib/configdirector/internal/evaluation/assigned_percentage.rb +21 -0
- data/lib/configdirector/internal/evaluation/attribute_condition.rb +48 -0
- data/lib/configdirector/internal/evaluation/config_evaluator.rb +29 -0
- data/lib/configdirector/internal/evaluation/datetime_comparison.rb +93 -0
- data/lib/configdirector/internal/evaluation/evaluation_context.rb +17 -0
- data/lib/configdirector/internal/evaluation/number_comparison.rb +119 -0
- data/lib/configdirector/internal/evaluation/rapidhash.rb +124 -0
- data/lib/configdirector/internal/evaluation/rollout_share.rb +9 -0
- data/lib/configdirector/internal/evaluation/rule.rb +70 -0
- data/lib/configdirector/internal/evaluation/scalar_text.rb +70 -0
- data/lib/configdirector/internal/evaluation/segment.rb +17 -0
- data/lib/configdirector/internal/evaluation/segment_condition.rb +26 -0
- data/lib/configdirector/internal/evaluation/semver_comparison.rb +49 -0
- data/lib/configdirector/internal/evaluation/served_value.rb +9 -0
- data/lib/configdirector/internal/evaluation/share.rb +9 -0
- data/lib/configdirector/internal/evaluation/targeting_rules.rb +18 -0
- data/lib/configdirector/internal/evaluation/text_comparison.rb +32 -0
- data/lib/configdirector/internal/evaluation/trait_pointer.rb +42 -0
- data/lib/configdirector/internal/evaluation.rb +21 -0
- data/lib/configdirector/internal/identity/sdk_identity.rb +39 -0
- data/lib/configdirector/internal/identity/wrapper.rb +48 -0
- data/lib/configdirector/internal/logging/client_log.rb +37 -0
- data/lib/configdirector/internal/logging/default_logger.rb +34 -0
- data/lib/configdirector/internal/polling/poll_answer.rb +111 -0
- data/lib/configdirector/internal/polling/poll_request.rb +106 -0
- data/lib/configdirector/internal/polling/poll_timing.rb +25 -0
- data/lib/configdirector/internal/polling/polling_endpoint.rb +36 -0
- data/lib/configdirector/internal/polling/polling_mode_connection.rb +53 -0
- data/lib/configdirector/internal/polling/polling_session.rb +99 -0
- data/lib/configdirector/internal/polling/polling_transport.rb +74 -0
- data/lib/configdirector/internal/polling/refusal_detail.rb +36 -0
- data/lib/configdirector/internal/server_sent_events/event_stream_limit_exceeded.rb +9 -0
- data/lib/configdirector/internal/server_sent_events/event_stream_parser.rb +95 -0
- data/lib/configdirector/internal/server_sent_events/server_sent_event.rb +9 -0
- data/lib/configdirector/internal/stoppable_thread.rb +69 -0
- data/lib/configdirector/internal/streaming/heartbeats.rb +51 -0
- data/lib/configdirector/internal/streaming/reconnecting_stream.rb +82 -0
- data/lib/configdirector/internal/streaming/reconnection_delay.rb +29 -0
- data/lib/configdirector/internal/streaming/stream_connection.rb +86 -0
- data/lib/configdirector/internal/streaming/stream_end.rb +69 -0
- data/lib/configdirector/internal/streaming/stream_endpoint.rb +43 -0
- data/lib/configdirector/internal/streaming/stream_timing.rb +33 -0
- data/lib/configdirector/internal/streaming/streaming_mode_connection.rb +60 -0
- data/lib/configdirector/internal/streaming/streaming_transport.rb +42 -0
- data/lib/configdirector/internal/telemetry/aggregated_wire_entries.rb +26 -0
- data/lib/configdirector/internal/telemetry/collected_telemetry.rb +98 -0
- data/lib/configdirector/internal/telemetry/compact_json_text.rb +64 -0
- data/lib/configdirector/internal/telemetry/discarded_telemetry.rb +31 -0
- data/lib/configdirector/internal/telemetry/event_reporter.rb +47 -0
- data/lib/configdirector/internal/telemetry/invalid_context_submissions.rb +76 -0
- data/lib/configdirector/internal/telemetry/report_answer.rb +31 -0
- data/lib/configdirector/internal/telemetry/report_schedule.rb +66 -0
- data/lib/configdirector/internal/telemetry/report_timing.rb +20 -0
- data/lib/configdirector/internal/telemetry/reported_context.rb +28 -0
- data/lib/configdirector/internal/telemetry/reported_details.rb +71 -0
- data/lib/configdirector/internal/telemetry/reported_evaluation.rb +82 -0
- data/lib/configdirector/internal/telemetry/reported_telemetry.rb +127 -0
- data/lib/configdirector/internal/telemetry/reported_text.rb +13 -0
- data/lib/configdirector/internal/telemetry/reported_time.rb +13 -0
- data/lib/configdirector/internal/telemetry/reported_value.rb +35 -0
- data/lib/configdirector/internal/telemetry/telemetry_endpoint.rb +54 -0
- data/lib/configdirector/internal/telemetry/telemetry_report.rb +50 -0
- data/lib/configdirector/internal/telemetry/test_client_telemetry.rb +37 -0
- data/lib/configdirector/internal/telemetry/tracked_event_admission.rb +72 -0
- data/lib/configdirector/internal/telemetry/tracked_event_entry.rb +27 -0
- data/lib/configdirector/internal/telemetry/tracked_event_queue.rb +47 -0
- data/lib/configdirector/internal/telemetry/tracked_event_warning.rb +28 -0
- data/lib/configdirector/internal/telemetry/value_id.rb +23 -0
- data/lib/configdirector/internal/telemetry/written_json.rb +9 -0
- data/lib/configdirector/internal/unchangeable_copy.rb +38 -0
- data/lib/configdirector/internal/value/encoded_native_value.rb +45 -0
- data/lib/configdirector/internal/value/hash_keys.rb +34 -0
- data/lib/configdirector/internal/value/in_code_default_value.rb +33 -0
- data/lib/configdirector/internal/value/json_contents.rb +81 -0
- data/lib/configdirector/internal/value/json_position.rb +27 -0
- data/lib/configdirector/internal/value/native_values.rb +41 -0
- data/lib/configdirector/internal/value/parsed_json.rb +79 -0
- data/lib/configdirector/internal/value/plain_decimal_text.rb +36 -0
- data/lib/configdirector/internal/value/served_text.rb +76 -0
- data/lib/configdirector/internal/value/typed_value.rb +9 -0
- data/lib/configdirector/internal/value/unservable_value.rb +9 -0
- data/lib/configdirector/internal/value/utf8_text.rb +19 -0
- data/lib/configdirector/internal.rb +9 -0
- data/lib/configdirector/metadata.rb +26 -0
- data/lib/configdirector/subscription.rb +34 -0
- data/lib/configdirector/telemetry_options.rb +28 -0
- data/lib/configdirector/testing/test_client.rb +122 -0
- data/lib/configdirector/testing/tracked_event.rb +46 -0
- data/lib/configdirector/testing.rb +44 -0
- data/lib/configdirector/variation.rb +21 -0
- data/lib/configdirector/version.rb +7 -0
- data/lib/configdirector-server-sdk.rb +3 -0
- data/lib/configdirector.rb +164 -0
- data/sig/configdirector/internal/client.rbs +518 -0
- data/sig/configdirector/internal/connection.rbs +389 -0
- data/sig/configdirector/internal/evaluation.rbs +364 -0
- data/sig/configdirector/internal/identity.rbs +51 -0
- data/sig/configdirector/internal/logging.rbs +33 -0
- data/sig/configdirector/internal/polling.rbs +240 -0
- data/sig/configdirector/internal/server_sent_events.rbs +51 -0
- data/sig/configdirector/internal/streaming.rbs +266 -0
- data/sig/configdirector/internal/telemetry.rbs +556 -0
- data/sig/configdirector/internal/value.rbs +159 -0
- data/sig/configdirector/testing.rbs +70 -0
- data/sig/configdirector.rbs +465 -0
- metadata +231 -0
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ConfigDirector
|
|
4
|
+
module Internal
|
|
5
|
+
module Telemetry
|
|
6
|
+
class ReportedTelemetry
|
|
7
|
+
COLLECTS_BY_REPORTING = {
|
|
8
|
+
not_started: true,
|
|
9
|
+
on_the_schedule: true,
|
|
10
|
+
stopped_by_a_refusal: false,
|
|
11
|
+
closed: false
|
|
12
|
+
}.freeze
|
|
13
|
+
|
|
14
|
+
private_constant :COLLECTS_BY_REPORTING
|
|
15
|
+
|
|
16
|
+
def self.for_a_client_with(
|
|
17
|
+
server_sdk_key:, metadata:, connection_options:, telemetry_options:, sdk_identity:, logger:
|
|
18
|
+
)
|
|
19
|
+
reporting_to(
|
|
20
|
+
url: connection_options.url, server_sdk_key: server_sdk_key, metadata: metadata,
|
|
21
|
+
sdk_identity: sdk_identity, event_queue_limit: telemetry_options.event_queue_limit,
|
|
22
|
+
timing: ReportTiming.of_a_client_reporting_every(telemetry_options.flush_interval), logger: logger
|
|
23
|
+
)
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def self.reporting_to(url:, server_sdk_key:, metadata:, sdk_identity:, event_queue_limit:, timing:, logger:)
|
|
27
|
+
endpoint = TelemetryEndpoint.new(
|
|
28
|
+
url: url, server_sdk_key: server_sdk_key, metadata: metadata, sdk_identity: sdk_identity,
|
|
29
|
+
seconds_a_report_may_take: timing.seconds_a_report_may_take
|
|
30
|
+
)
|
|
31
|
+
|
|
32
|
+
new(
|
|
33
|
+
reporter: EventReporter.new(endpoint, logger),
|
|
34
|
+
collected_telemetry: CollectedTelemetry.new(event_queue_limit), schedule: ReportSchedule.new(timing),
|
|
35
|
+
logger: logger
|
|
36
|
+
)
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
def initialize(reporter:, collected_telemetry:, schedule:, logger:)
|
|
40
|
+
@reporter = reporter
|
|
41
|
+
@collected_telemetry = collected_telemetry
|
|
42
|
+
@schedule = schedule
|
|
43
|
+
@log = Logging::ClientLog.new(logger, component: "TelemetryEventCollector")
|
|
44
|
+
@lock = Mutex.new
|
|
45
|
+
@reporting = :not_started
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
def record_evaluation(evaluated_read)
|
|
49
|
+
@lock.synchronize do
|
|
50
|
+
@collected_telemetry.add_evaluation(evaluated_read) if COLLECTS_BY_REPORTING.fetch(@reporting)
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
def record_tracked_event(admission)
|
|
55
|
+
@lock.synchronize do
|
|
56
|
+
COLLECTS_BY_REPORTING.fetch(@reporting) ? @collected_telemetry.add_tracked_event(admission) : []
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
def count_invalid_context(kind_sample)
|
|
61
|
+
@lock.synchronize { @collected_telemetry.count_invalid_context(kind_sample) }
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
def start_reporting
|
|
65
|
+
@lock.synchronize do
|
|
66
|
+
@reporting = :on_the_schedule if @reporting == :not_started
|
|
67
|
+
start_the_schedule_when_reporting_on_it
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
def choose_the_reporter_of_what_the_parent_process_collected(forked_through)
|
|
72
|
+
@collected_telemetry.choose_the_reporter_of_what_the_parent_process_collected(forked_through)
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
def restart_in_a_forked_process
|
|
76
|
+
@lock.synchronize { start_the_schedule_when_reporting_on_it }
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
def close
|
|
80
|
+
last_report = @lock.synchronize do
|
|
81
|
+
report = COLLECTS_BY_REPORTING.fetch(@reporting) ? @collected_telemetry.taken_for_a_report : nil
|
|
82
|
+
@reporting = :closed
|
|
83
|
+
|
|
84
|
+
report
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
@schedule.stop
|
|
88
|
+
@schedule.wait_for_a_report_being_sent
|
|
89
|
+
send_to_the_endpoint(last_report) unless last_report.nil?
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
private
|
|
93
|
+
|
|
94
|
+
def start_the_schedule_when_reporting_on_it
|
|
95
|
+
@schedule.start { report_what_was_collected } if @reporting == :on_the_schedule
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
def report_what_was_collected
|
|
99
|
+
report = @lock.synchronize do
|
|
100
|
+
@reporting == :on_the_schedule ? @collected_telemetry.taken_for_a_report : nil
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
send_to_the_endpoint(report) unless report.nil?
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
def send_to_the_endpoint(report)
|
|
107
|
+
return if report.empty?
|
|
108
|
+
|
|
109
|
+
case @reporter.what_follows_delivering(report)
|
|
110
|
+
when :more_reports then nil
|
|
111
|
+
when :no_more_reports then stop_collecting
|
|
112
|
+
end
|
|
113
|
+
rescue StandardError => e
|
|
114
|
+
@log.warn("Error flushing telemetry events: #{e.class}: #{e.message.inspect}")
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
def stop_collecting
|
|
118
|
+
@lock.synchronize do
|
|
119
|
+
@reporting = :stopped_by_a_refusal if @reporting == :on_the_schedule
|
|
120
|
+
@collected_telemetry.discard_the_queued_events
|
|
121
|
+
end
|
|
122
|
+
@schedule.stop
|
|
123
|
+
end
|
|
124
|
+
end
|
|
125
|
+
end
|
|
126
|
+
end
|
|
127
|
+
end
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ConfigDirector
|
|
4
|
+
module Internal
|
|
5
|
+
module Telemetry
|
|
6
|
+
module ReportedValue
|
|
7
|
+
MAXIMUM_CHARACTERS_REPORTED_AS_TEXT = 500
|
|
8
|
+
JSON_CONFIG_TYPE = "json"
|
|
9
|
+
|
|
10
|
+
private_constant :MAXIMUM_CHARACTERS_REPORTED_AS_TEXT, :JSON_CONFIG_TYPE
|
|
11
|
+
|
|
12
|
+
def self.reported_by_the_value_id_sent_with_it?(value, config_type, value_id_sent_with_the_value)
|
|
13
|
+
return false if value_id_sent_with_the_value.nil?
|
|
14
|
+
|
|
15
|
+
json_value?(value, config_type) ||
|
|
16
|
+
(value.is_a?(String) && value.length > MAXIMUM_CHARACTERS_REPORTED_AS_TEXT)
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
def self.of(value, config_type)
|
|
20
|
+
return { valueId: ValueId.of(CompactJsonText.of(value)) } if json_value?(value, config_type)
|
|
21
|
+
|
|
22
|
+
text = ReportedText.of(Evaluation::ScalarText.of(value).to_s)
|
|
23
|
+
|
|
24
|
+
text.length <= MAXIMUM_CHARACTERS_REPORTED_AS_TEXT ? { value: text } : { valueId: ValueId.of(text) }
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
def self.json_value?(value, config_type)
|
|
28
|
+
config_type == JSON_CONFIG_TYPE || value.is_a?(Hash) || value.is_a?(Array)
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
private_class_method :json_value?
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "timeout"
|
|
4
|
+
require "uri"
|
|
5
|
+
|
|
6
|
+
module ConfigDirector
|
|
7
|
+
module Internal
|
|
8
|
+
module Telemetry
|
|
9
|
+
class TelemetryEndpoint
|
|
10
|
+
def initialize(url:, server_sdk_key:, metadata:, sdk_identity:, seconds_a_report_may_take:)
|
|
11
|
+
@telemetry_uri = URI("#{url.delete_suffix("/")}/server/telemetry/v1")
|
|
12
|
+
@server_sdk_key = server_sdk_key
|
|
13
|
+
@sdk_identity = sdk_identity
|
|
14
|
+
@meta_context = sdk_identity.meta_context_of_an_application_with(metadata)
|
|
15
|
+
@seconds_a_report_may_take = seconds_a_report_may_take
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
def answer_to(report)
|
|
19
|
+
json_post = json_post_of(report)
|
|
20
|
+
|
|
21
|
+
answer_before(Connection::RequestDeadline.on_the_clock_of_the_process(@seconds_a_report_may_take), json_post)
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
private
|
|
25
|
+
|
|
26
|
+
def answer_before(deadline, json_post)
|
|
27
|
+
ReportAnswer.with_status(Integer(response_to(json_post, deadline).code, 10))
|
|
28
|
+
rescue Timeout::Error
|
|
29
|
+
ReportAnswer.unanswered(deadline.description_of_having_passed)
|
|
30
|
+
rescue StandardError => e
|
|
31
|
+
ReportAnswer.unanswered("#{e.class}: #{e.message}")
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
def json_post_of(report)
|
|
35
|
+
Connection::JsonPostRequest.carrying(
|
|
36
|
+
CompactJsonText.of({ serverSdkKey: @server_sdk_key, metaContext: @meta_context, **report.wire_events }),
|
|
37
|
+
@telemetry_uri, @sdk_identity
|
|
38
|
+
)
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
def response_to(json_post, deadline)
|
|
42
|
+
http_session = Connection::HttpSession.to(@telemetry_uri)
|
|
43
|
+
deadline.ending_the_exchange_when_it_passes(http_session) do
|
|
44
|
+
http_session.start do
|
|
45
|
+
http_session.write_timeout = deadline.seconds_left
|
|
46
|
+
http_session.read_timeout = deadline.seconds_left
|
|
47
|
+
http_session.request(json_post) { |response| break response }
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
end
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ConfigDirector
|
|
4
|
+
module Internal
|
|
5
|
+
module Telemetry
|
|
6
|
+
TelemetryReport = Data.define(
|
|
7
|
+
:evaluations, :evaluations_collected_since, :evaluations_dropped, :captured_contexts,
|
|
8
|
+
:captured_contexts_dropped, :invalid_context_wire_entries, :tracked_events, :taken_at
|
|
9
|
+
)
|
|
10
|
+
|
|
11
|
+
class TelemetryReport
|
|
12
|
+
def empty?
|
|
13
|
+
evaluations.empty? && captured_contexts.empty? && invalid_context_wire_entries.empty? &&
|
|
14
|
+
tracked_events.empty? && evaluations_dropped.zero? && captured_contexts_dropped.zero?
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
def wire_events
|
|
18
|
+
{
|
|
19
|
+
discreteEvents: {
|
|
20
|
+
capturedContexts: captured_contexts.map(&:wire_context), trackedEvents: tracked_events.map(&:wire_entry)
|
|
21
|
+
},
|
|
22
|
+
aggregatedEvents: { evaluatedConfig: aggregated_evaluations, invalidContext: invalid_context_wire_entries },
|
|
23
|
+
droppedEvents: wire_counts_of_what_was_dropped
|
|
24
|
+
}
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
private
|
|
28
|
+
|
|
29
|
+
def wire_counts_of_what_was_dropped
|
|
30
|
+
{
|
|
31
|
+
evaluatedConfig: AggregatedWireEntries.count_the_sdk_server_reads(evaluations_dropped),
|
|
32
|
+
capturedContexts: AggregatedWireEntries.count_the_sdk_server_reads(captured_contexts_dropped)
|
|
33
|
+
}
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
def aggregated_evaluations
|
|
37
|
+
AggregatedWireEntries.of(
|
|
38
|
+
counts_by_wire_event, counted_since: evaluations_collected_since, counted_until: taken_at
|
|
39
|
+
)
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
def counts_by_wire_event
|
|
43
|
+
evaluations.tally.each_with_object(Hash.new(0)) do |(evaluation, count), counts|
|
|
44
|
+
counts[evaluation.wire_event] += count
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
end
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "json"
|
|
4
|
+
|
|
5
|
+
module ConfigDirector
|
|
6
|
+
module Internal
|
|
7
|
+
module Telemetry
|
|
8
|
+
class TestClientTelemetry < DiscardedTelemetry
|
|
9
|
+
attr_reader :tracked_events
|
|
10
|
+
|
|
11
|
+
def initialize
|
|
12
|
+
super
|
|
13
|
+
@tracked_events = []
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
def record_tracked_event(admission)
|
|
17
|
+
case admission
|
|
18
|
+
when AdmittedTrackedEvent then @tracked_events << tracked_event_recorded_from(admission)
|
|
19
|
+
when DroppedTrackedEvent then nil
|
|
20
|
+
end
|
|
21
|
+
admission.warnings.map { |warning| TrackedEventWarning.message_of(warning) }
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
private
|
|
25
|
+
|
|
26
|
+
def tracked_event_recorded_from(admission)
|
|
27
|
+
entry = admission.entry
|
|
28
|
+
|
|
29
|
+
Testing::TrackedEvent.new(
|
|
30
|
+
name: entry.name, context: admission.context, value: entry.value,
|
|
31
|
+
details: entry.details && JSON.parse(entry.details.text)
|
|
32
|
+
)
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ConfigDirector
|
|
4
|
+
module Internal
|
|
5
|
+
module Telemetry
|
|
6
|
+
AdmittedTrackedEvent = Data.define(:entry, :context, :warnings)
|
|
7
|
+
DroppedTrackedEvent = Data.define(:warnings)
|
|
8
|
+
|
|
9
|
+
module TrackedEventAdmission
|
|
10
|
+
NAME_MAXIMUM_CHARACTERS = 150
|
|
11
|
+
|
|
12
|
+
ReportedPart = Data.define(:reported, :warnings)
|
|
13
|
+
|
|
14
|
+
class ReportedPart
|
|
15
|
+
def self.not_given
|
|
16
|
+
new(reported: nil, warnings: [])
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
def self.of(reported)
|
|
20
|
+
new(reported: reported, warnings: [])
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
def self.left_out_with(warning)
|
|
24
|
+
new(reported: nil, warnings: [warning])
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
private_constant :ReportedPart
|
|
29
|
+
|
|
30
|
+
def self.of(name:, context:, value:, details:, happened_at:)
|
|
31
|
+
reported_name = reported_name_of(name)
|
|
32
|
+
return DroppedTrackedEvent.new(warnings: [:name_outside_the_character_limit]) if reported_name.nil?
|
|
33
|
+
|
|
34
|
+
value_part = reported_value_of(value)
|
|
35
|
+
details_part = reported_details_of(details)
|
|
36
|
+
entry = TrackedEventEntry.of(
|
|
37
|
+
name: reported_name, context: context, value: value_part.reported, details: details_part.reported,
|
|
38
|
+
happened_at: happened_at
|
|
39
|
+
)
|
|
40
|
+
warnings = value_part.warnings + details_part.warnings
|
|
41
|
+
AdmittedTrackedEvent.new(entry: entry, context: context, warnings: warnings)
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
def self.reported_name_of(name)
|
|
45
|
+
return nil unless name.is_a?(String) || name.is_a?(Symbol)
|
|
46
|
+
|
|
47
|
+
name_text = ReportedText.of(name.to_s)
|
|
48
|
+
name_text if name_text.length.between?(1, NAME_MAXIMUM_CHARACTERS)
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
def self.reported_value_of(value)
|
|
52
|
+
if value.nil?
|
|
53
|
+
ReportedPart.not_given
|
|
54
|
+
elsif (value.is_a?(Integer) || value.is_a?(Float)) && CompactJsonText.number_javascript_holds?(value)
|
|
55
|
+
ReportedPart.of(value)
|
|
56
|
+
else
|
|
57
|
+
ReportedPart.left_out_with(:value_not_a_finite_number)
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
def self.reported_details_of(details)
|
|
62
|
+
return ReportedPart.not_given if details.nil?
|
|
63
|
+
|
|
64
|
+
written_details = ReportedDetails.json_of(details)
|
|
65
|
+
written_details.nil? ? ReportedPart.left_out_with(:details_not_reportable) : ReportedPart.of(written_details)
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
private_class_method :reported_name_of, :reported_value_of, :reported_details_of
|
|
69
|
+
end
|
|
70
|
+
end
|
|
71
|
+
end
|
|
72
|
+
end
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ConfigDirector
|
|
4
|
+
module Internal
|
|
5
|
+
module Telemetry
|
|
6
|
+
TrackedEventEntry = Data.define(:name, :context_kind, :context_identifier, :value, :details, :happened_at)
|
|
7
|
+
|
|
8
|
+
class TrackedEventEntry
|
|
9
|
+
def self.of(name:, context:, value:, details:, happened_at:)
|
|
10
|
+
reported_context = ReportedContext.of(context)
|
|
11
|
+
|
|
12
|
+
new(
|
|
13
|
+
name: name, context_kind: reported_context&.kind, context_identifier: reported_context&.identifier,
|
|
14
|
+
value: value, details: details, happened_at: happened_at
|
|
15
|
+
)
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
def wire_entry
|
|
19
|
+
{
|
|
20
|
+
name: name, contextKind: context_kind, contextIdentifier: context_identifier, value: value,
|
|
21
|
+
details: details, happenedAt: ReportedTime.of(happened_at)
|
|
22
|
+
}.compact
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ConfigDirector
|
|
4
|
+
module Internal
|
|
5
|
+
module Telemetry
|
|
6
|
+
class TrackedEventQueue
|
|
7
|
+
EVENTS_PER_REPORT = 1_000
|
|
8
|
+
|
|
9
|
+
attr_reader :entries
|
|
10
|
+
|
|
11
|
+
def initialize
|
|
12
|
+
discard
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
def add(admission)
|
|
16
|
+
warnings_not_logged_for_this_report = keep(admission).reject do |warning|
|
|
17
|
+
@warnings_logged_for_this_report.include?(warning)
|
|
18
|
+
end
|
|
19
|
+
@warnings_logged_for_this_report.merge(warnings_not_logged_for_this_report)
|
|
20
|
+
|
|
21
|
+
warnings_not_logged_for_this_report.map do |warning|
|
|
22
|
+
"#{TrackedEventWarning.message_of(warning)} " \
|
|
23
|
+
"Further tracked events like it are not logged until the next telemetry batch is sent."
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
def discard
|
|
28
|
+
@entries = []
|
|
29
|
+
@warnings_logged_for_this_report = Set.new
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
private
|
|
33
|
+
|
|
34
|
+
def keep(admission)
|
|
35
|
+
case admission
|
|
36
|
+
when DroppedTrackedEvent then admission.warnings
|
|
37
|
+
when AdmittedTrackedEvent
|
|
38
|
+
return [:batch_already_full] if @entries.length >= EVENTS_PER_REPORT
|
|
39
|
+
|
|
40
|
+
@entries << admission.entry
|
|
41
|
+
admission.warnings
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ConfigDirector
|
|
4
|
+
module Internal
|
|
5
|
+
module Telemetry
|
|
6
|
+
module TrackedEventWarning
|
|
7
|
+
MESSAGE_BY_WARNING = {
|
|
8
|
+
name_outside_the_character_limit: "A tracked event was not reported because its name does not have 1 to " \
|
|
9
|
+
"#{TrackedEventAdmission::NAME_MAXIMUM_CHARACTERS} characters.",
|
|
10
|
+
value_not_a_finite_number: "A tracked event was reported without its value because the value is not a " \
|
|
11
|
+
"finite number.",
|
|
12
|
+
details_not_reportable: "A tracked event was reported without its details because they are not an " \
|
|
13
|
+
"object, have more than #{ReportedDetails::MOST_TOP_LEVEL_KEYS} top-level keys, " \
|
|
14
|
+
"are larger than #{ReportedDetails::MOST_JSON_BYTES} bytes as JSON, or cannot be " \
|
|
15
|
+
"written as JSON.",
|
|
16
|
+
batch_already_full: "A tracked event was not reported because #{TrackedEventQueue::EVENTS_PER_REPORT} " \
|
|
17
|
+
"tracked events are already waiting for the next telemetry batch."
|
|
18
|
+
}.freeze
|
|
19
|
+
|
|
20
|
+
private_constant :MESSAGE_BY_WARNING
|
|
21
|
+
|
|
22
|
+
def self.message_of(warning)
|
|
23
|
+
MESSAGE_BY_WARNING.fetch(warning)
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "digest"
|
|
4
|
+
|
|
5
|
+
module ConfigDirector
|
|
6
|
+
module Internal
|
|
7
|
+
module Telemetry
|
|
8
|
+
module ValueId
|
|
9
|
+
DIGEST_BYTES = 16
|
|
10
|
+
BASE62_DIGITS = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
|
|
11
|
+
LENGTH = 22
|
|
12
|
+
|
|
13
|
+
private_constant :DIGEST_BYTES, :BASE62_DIGITS, :LENGTH
|
|
14
|
+
|
|
15
|
+
def self.of(text)
|
|
16
|
+
number = Digest::SHA256.digest(text).byteslice(0, DIGEST_BYTES).to_s.unpack1("H*").to_s.to_i(16)
|
|
17
|
+
|
|
18
|
+
number.digits(BASE62_DIGITS.length).reverse.map { |digit| BASE62_DIGITS[digit] }.join.rjust(LENGTH, "0")
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ConfigDirector
|
|
4
|
+
module Internal
|
|
5
|
+
module UnchangeableCopy
|
|
6
|
+
MOST_LEVELS_THE_SDK_READS_OF_A_VALUE = 101
|
|
7
|
+
|
|
8
|
+
private_constant :MOST_LEVELS_THE_SDK_READS_OF_A_VALUE
|
|
9
|
+
|
|
10
|
+
def self.of(value)
|
|
11
|
+
nested_deeper_than?(MOST_LEVELS_THE_SDK_READS_OF_A_VALUE, value) ? value : copy_of(value)
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
def self.nested_deeper_than?(levels, value)
|
|
15
|
+
case value
|
|
16
|
+
when Hash then any_nested_deeper_than?(levels, value.keys + value.values)
|
|
17
|
+
when Array then any_nested_deeper_than?(levels, value)
|
|
18
|
+
else false
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
def self.any_nested_deeper_than?(levels, contents)
|
|
23
|
+
levels.zero? || contents.any? { |key_member_or_element| nested_deeper_than?(levels - 1, key_member_or_element) }
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def self.copy_of(value)
|
|
27
|
+
case value
|
|
28
|
+
when Hash then value.to_h { |key, member| [copy_of(key), copy_of(member)] }.freeze
|
|
29
|
+
when Array then value.map { |element| copy_of(element) }.freeze
|
|
30
|
+
when String then value.frozen? ? value : value.dup.freeze
|
|
31
|
+
else value
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
private_class_method :nested_deeper_than?, :any_nested_deeper_than?, :copy_of
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ConfigDirector
|
|
4
|
+
module Internal
|
|
5
|
+
module Value
|
|
6
|
+
EncodedNativeValue = Data.define(:config_type, :served_text)
|
|
7
|
+
|
|
8
|
+
class EncodedNativeValue
|
|
9
|
+
def self.of(value, config_key)
|
|
10
|
+
case value
|
|
11
|
+
when true then new(config_type: "boolean", served_text: "true")
|
|
12
|
+
when false then new(config_type: "boolean", served_text: "false")
|
|
13
|
+
when Integer then new(config_type: "integer", served_text: value.to_s)
|
|
14
|
+
when Float then encoded_float(value, config_key)
|
|
15
|
+
when String then new(config_type: "string", served_text: utf8_text_of(value, config_key))
|
|
16
|
+
when Hash, Array then new(config_type: "json", served_text: JsonContents.json_text_of(value, config_key))
|
|
17
|
+
else raise unservable_because_of_the_class_of(value, config_key)
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
def self.encoded_float(value, config_key)
|
|
22
|
+
unless value.finite?
|
|
23
|
+
raise UnservableValue, "Invalid value for '#{config_key}': #{value} is not a finite number."
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
new(config_type: "float", served_text: PlainDecimalText.of(value))
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
def self.utf8_text_of(value, config_key)
|
|
30
|
+
Utf8Text.of(value) ||
|
|
31
|
+
raise(UnservableValue, "Invalid value for '#{config_key}': the String is not valid UTF-8 text.")
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
def self.unservable_because_of_the_class_of(value, config_key)
|
|
35
|
+
UnservableValue.new(
|
|
36
|
+
"Invalid value for '#{config_key}': #{value.nil? ? "nil" : "an object of class #{value.class}"}. " \
|
|
37
|
+
"Use true or false, an Integer, a Float, a String, a Hash or an Array."
|
|
38
|
+
)
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
private_class_method :encoded_float, :utf8_text_of, :unservable_because_of_the_class_of
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ConfigDirector
|
|
4
|
+
module Internal
|
|
5
|
+
module Value
|
|
6
|
+
module HashKeys
|
|
7
|
+
def self.name_of(given_key)
|
|
8
|
+
case given_key
|
|
9
|
+
when String then given_key
|
|
10
|
+
when Symbol then given_key.name
|
|
11
|
+
end
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
def self.description_of_a_key_given_twice_in(given_keys, key_texts)
|
|
15
|
+
key_text_given_twice = key_texts.tally.find { |_key_text, count| count > 1 }&.first
|
|
16
|
+
return nil if key_text_given_twice.nil?
|
|
17
|
+
|
|
18
|
+
first_given, second_given = given_keys.zip(key_texts)
|
|
19
|
+
.select { |_given_key, key_text| key_text == key_text_given_twice }
|
|
20
|
+
.map(&:first)
|
|
21
|
+
"'#{key_text_given_twice}' is given twice, #{how_the_two_keys_differ(first_given, second_given)}"
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
def self.how_the_two_keys_differ(first_given, second_given)
|
|
25
|
+
return "in two encodings" if first_given.instance_of?(second_given.class)
|
|
26
|
+
|
|
27
|
+
"as a #{first_given.class} and as a #{second_given.class}"
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
private_class_method :how_the_two_keys_differ
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|