-
-
Notifications
You must be signed in to change notification settings - Fork 484
/
transport.rb
211 lines (164 loc) · 5.59 KB
/
transport.rb
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
# frozen_string_literal: true
require "json"
require "sentry/envelope"
module Sentry
class Transport
PROTOCOL_VERSION = '7'
USER_AGENT = "sentry-ruby/#{Sentry::VERSION}"
CLIENT_REPORT_INTERVAL = 30
# https://develop.sentry.dev/sdk/client-reports/#envelope-item-payload
CLIENT_REPORT_REASONS = [
:ratelimit_backoff,
:queue_overflow,
:cache_overflow, # NA
:network_error,
:sample_rate,
:before_send,
:event_processor,
:insufficient_data,
:backpressure
]
include LoggingHelper
attr_reader :rate_limits, :discarded_events, :last_client_report_sent
# @deprecated Use Sentry.logger to retrieve the current logger instead.
attr_reader :logger
def initialize(configuration)
@logger = configuration.logger
@transport_configuration = configuration.transport
@dsn = configuration.dsn
@rate_limits = {}
@send_client_reports = configuration.send_client_reports
if @send_client_reports
@discarded_events = Hash.new(0)
@last_client_report_sent = Time.now
end
end
def send_data(data, options = {})
raise NotImplementedError
end
def send_event(event)
envelope = envelope_from_event(event)
send_envelope(envelope)
event
end
def send_envelope(envelope)
reject_rate_limited_items(envelope)
return if envelope.items.empty?
data, serialized_items = serialize_envelope(envelope)
if data
log_info("[Transport] Sending envelope with items [#{serialized_items.map(&:type).join(', ')}] #{envelope.event_id} to Sentry")
send_data(data)
end
end
def serialize_envelope(envelope)
serialized_items = []
serialized_results = []
envelope.items.each do |item|
result, oversized = item.serialize
if oversized
log_debug("Envelope item [#{item.type}] is still oversized after size reduction: {#{item.size_breakdown}}")
next
end
serialized_results << result
serialized_items << item
end
data = [JSON.generate(envelope.headers), *serialized_results].join("\n") unless serialized_results.empty?
[data, serialized_items]
end
def is_rate_limited?(data_category)
# check category-specific limit
category_delay = @rate_limits[data_category]
# check universal limit if not category limit
universal_delay = @rate_limits[nil]
delay =
if category_delay && universal_delay
if category_delay > universal_delay
category_delay
else
universal_delay
end
elsif category_delay
category_delay
else
universal_delay
end
!!delay && delay > Time.now
end
def any_rate_limited?
@rate_limits.values.any? { |t| t && t > Time.now }
end
def envelope_from_event(event)
# Convert to hash
event_payload = event.to_hash
event_id = event_payload[:event_id] || event_payload["event_id"]
item_type = event_payload[:type] || event_payload["type"]
envelope_headers = {
event_id: event_id,
dsn: @dsn.to_s,
sdk: Sentry.sdk_meta,
sent_at: Sentry.utc_now.iso8601
}
if event.is_a?(Event) && event.dynamic_sampling_context
envelope_headers[:trace] = event.dynamic_sampling_context
end
envelope = Envelope.new(envelope_headers)
envelope.add_item(
{ type: item_type, content_type: 'application/json' },
event_payload
)
if event.is_a?(TransactionEvent) && event.profile
envelope.add_item(
{ type: 'profile', content_type: 'application/json' },
event.profile
)
end
client_report_headers, client_report_payload = fetch_pending_client_report
envelope.add_item(client_report_headers, client_report_payload) if client_report_headers
envelope
end
def record_lost_event(reason, data_category)
return unless @send_client_reports
return unless CLIENT_REPORT_REASONS.include?(reason)
@discarded_events[[reason, data_category]] += 1
end
def flush
client_report_headers, client_report_payload = fetch_pending_client_report(force: true)
return unless client_report_headers
envelope = Envelope.new
envelope.add_item(client_report_headers, client_report_payload)
send_envelope(envelope)
end
private
def fetch_pending_client_report(force: false)
return nil unless @send_client_reports
return nil if !force && @last_client_report_sent > Time.now - CLIENT_REPORT_INTERVAL
return nil if @discarded_events.empty?
discarded_events_hash = @discarded_events.map do |key, val|
reason, category = key
{ reason: reason, category: category, quantity: val }
end
item_header = { type: 'client_report' }
item_payload = {
timestamp: Sentry.utc_now.iso8601,
discarded_events: discarded_events_hash
}
@discarded_events = Hash.new(0)
@last_client_report_sent = Time.now
[item_header, item_payload]
end
def reject_rate_limited_items(envelope)
envelope.items.reject! do |item|
if is_rate_limited?(item.data_category)
log_debug("[Transport] Envelope item [#{item.type}] not sent: rate limiting")
record_lost_event(:ratelimit_backoff, item.data_category)
true
else
false
end
end
end
end
end
require "sentry/transport/dummy_transport"
require "sentry/transport/http_transport"
require "sentry/transport/spotlight_transport"