Skip to content

Commit 40704bc

Browse files
committed
add a ring buffer
1 parent b27d32e commit 40704bc

5 files changed

Lines changed: 118 additions & 31 deletions

File tree

‎sentry-ruby/lib/sentry/scope.rb‎

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
require "sentry/breadcrumb_buffer"
55
require "sentry/propagation_context"
66
require "sentry/attachment"
7+
require "sentry/utils/ring_buffer"
78
require "etc"
89

910
module Sentry
@@ -33,9 +34,6 @@ class Scope
3334

3435
# Maximum number of feature flag evaluations kept on a scope.
3536
MAX_FLAGS = 100
36-
# Maximum number of feature flag evaluations recorded on a single span.
37-
MAX_FLAGS_PER_SPAN = 10
38-
SPAN_FLAG_ATTRIBUTE_PREFIX = "flag.evaluation."
3937

4038
attr_reader(*ATTRIBUTES)
4139

@@ -159,7 +157,7 @@ def dup
159157
copy.attachments = attachments.dup
160158
copy.event_processors = event_processors.dup
161159
copy.attributes = attributes.deep_dup
162-
copy.flags = flags.deep_dup
160+
copy.flags = flags.dup
163161
copy
164162
end
165163

@@ -179,7 +177,7 @@ def update_from_scope(scope)
179177
self.propagation_context = scope.propagation_context
180178
self.attachments = scope.attachments
181179
self.attributes = scope.attributes
182-
self.flags = scope.flags.deep_dup
180+
self.flags = scope.flags.dup
183181
end
184182

185183
# Updates the scope's data from the given options.
@@ -318,9 +316,7 @@ def add_feature_flag(name, result)
318316
return unless result == true || result == false
319317

320318
name = name.to_s
321-
flags.reject! { |flag| flag[:flag] == name }
322-
flags.shift if flags.size >= MAX_FLAGS
323-
flags << { flag: name, result: result }
319+
flags.set(name, result)
324320

325321
add_feature_flag_to_span(name, result)
326322
nil
@@ -420,17 +416,14 @@ def add_attachment(**opts)
420416
def add_feature_flag_to_span(name, result)
421417
return unless span
422418

423-
key = "#{SPAN_FLAG_ATTRIBUTE_PREFIX}#{name}"
424-
flag_count = span.data.count { |k, _| k.to_s.start_with?(SPAN_FLAG_ATTRIBUTE_PREFIX) }
425-
return if flag_count >= MAX_FLAGS_PER_SPAN && !span.data.key?(key)
426-
427-
span.set_data(key, result)
419+
span.set_flag(name, result)
428420
end
429421

430422
def apply_flags_to_event(event)
431-
return if flags.empty? || event.is_a?(TransactionEvent)
423+
return unless event.is_a?(ErrorEvent) && !flags.empty?
432424

433-
event.contexts[:flags] = { values: flags.map(&:dup) }
425+
values = flags.values.map { |flag, result| { flag: flag, result: result } }
426+
event.contexts[:flags] = { values: values }
434427
end
435428

436429
def set_default_value
@@ -448,7 +441,7 @@ def set_default_value
448441
@session = nil
449442
@attachments = []
450443
@attributes = {}
451-
@flags = []
444+
@flags = Utils::RingBuffer.new(MAX_FLAGS)
452445
generate_propagation_context
453446
set_new_breadcrumb_buffer
454447
end

‎sentry-ruby/lib/sentry/span.rb‎

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@ module DataConventions
7070
}
7171

7272
DEFAULT_SPAN_ORIGIN = "manual"
73+
MAX_FLAGS = 10
74+
SPAN_FLAG_ATTRIBUTE_PREFIX = "flag.evaluation."
7375

7476
# An uuid that can be used to identify a trace.
7577
# @return [String]
@@ -104,6 +106,9 @@ module DataConventions
104106
# Span data
105107
# @return [Hash]
106108
attr_reader :data
109+
# Feature flag data
110+
# @return [Hash]
111+
attr_reader :flags
107112
# Span origin that tracks what kind of instrumentation created a span
108113
# @return [String]
109114
attr_reader :origin
@@ -142,6 +147,7 @@ def initialize(
142147
@op = op
143148
@status = status
144149
@data = {}
150+
@flags = {}
145151
@tags = {}
146152
@origin = origin || DEFAULT_SPAN_ORIGIN
147153
end
@@ -187,7 +193,7 @@ def to_h
187193
op: @op,
188194
status: @status,
189195
tags: @tags,
190-
data: @data,
196+
data: serialized_data,
191197
origin: @origin
192198
}
193199
end
@@ -203,7 +209,7 @@ def get_trace_context
203209
op: @op,
204210
status: @status,
205211
origin: @origin,
206-
data: @data
212+
data: serialized_data
207213
}
208214
end
209215

@@ -293,6 +299,14 @@ def set_data(key, value)
293299
@data[key] = value
294300
end
295301

302+
# Sets a feature flag on the span.
303+
# @param name [String] the flag name
304+
# @param result [Boolean] the evaluation result
305+
def set_flag(name, result)
306+
flag = "#{SPAN_FLAG_ATTRIBUTE_PREFIX}#{name}"
307+
@flags[flag] = result if @flags.size < MAX_FLAGS
308+
end
309+
296310
# Sets a tag to the span.
297311
# @param key [String, Symbol]
298312
# @param value [String]
@@ -305,5 +319,13 @@ def set_tag(key, value)
305319
def set_origin(origin)
306320
@origin = origin
307321
end
322+
323+
private
324+
325+
def serialized_data
326+
return @data if @flags.empty?
327+
328+
@flags.merge(@data)
329+
end
308330
end
309331
end
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# frozen_string_literal: true
2+
3+
require "sentry/core_ext/object/deep_dup"
4+
5+
module Sentry
6+
module Utils
7+
class RingBuffer
8+
attr_reader :values
9+
10+
def initialize(capacity)
11+
raise ArgumentError, "capacity must be positive" unless capacity.positive?
12+
13+
@capacity = capacity
14+
@values = {}
15+
end
16+
17+
def set(key, value)
18+
@values.delete(key)
19+
@values[key] = value
20+
@values.shift if @values.size > @capacity
21+
end
22+
23+
def clear
24+
@values.clear
25+
end
26+
27+
def empty?
28+
@values.empty?
29+
end
30+
31+
def dup
32+
copy = self.class.new(@capacity)
33+
copy.values.merge!(@values)
34+
copy
35+
end
36+
end
37+
end
38+
end

‎sentry-ruby/spec/sentry/scope/feature_flags_spec.rb‎

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,20 @@
2121
it "ignores non-boolean results" do
2222
scope.add_feature_flag("a", "yes")
2323
scope.add_feature_flag("b", nil)
24-
expect(scope.flags).to be_empty
24+
expect(scope.flags.values).to be_empty
2525
end
2626

2727
it "moves a re-evaluated flag to the end with its new result" do
2828
scope.add_feature_flag("a", true)
2929
scope.add_feature_flag("b", true)
3030
scope.add_feature_flag("a", false)
31-
expect(scope.flags).to eq([{ flag: "b", result: true }, { flag: "a", result: false }])
31+
expect(scope.flags.values).to eq("b" => true, "a" => false)
3232
end
3333

3434
it "evicts the oldest flag beyond the limit" do
3535
(Sentry::Scope::MAX_FLAGS + 1).times { |i| scope.add_feature_flag("f#{i}", true) }
36-
expect(scope.flags.size).to eq(Sentry::Scope::MAX_FLAGS)
37-
expect(scope.flags.first[:flag]).to eq("f1")
36+
expect(scope.flags.values.size).to eq(Sentry::Scope::MAX_FLAGS)
37+
expect(scope.flags.values.first.first).to eq("f1")
3838
end
3939

4040
it "does not add flags to transaction events" do
@@ -44,20 +44,27 @@
4444
expect(event.contexts).not_to have_key(:flags)
4545
end
4646

47+
it "does not add flags to check-in events" do
48+
scope.add_feature_flag("a", true)
49+
event = Sentry::CheckInEvent.new(configuration: Sentry.configuration, slug: "foo", status: :ok)
50+
scope.apply_to_event(event)
51+
expect(event.contexts).not_to have_key(:flags)
52+
end
53+
4754
it "is isolated in duplicated and updated scopes and cleared by #clear" do
4855
scope.add_feature_flag("a", true)
4956
copy = scope.dup
5057
copy.add_feature_flag("b", true)
51-
copy.flags.first[:result] = false
52-
expect(scope.flags).to eq([{ flag: "a", result: true }])
58+
copy.add_feature_flag("a", false)
59+
expect(scope.flags.values).to eq("a" => true)
5360

5461
updated = described_class.new
5562
updated.update_from_scope(scope)
5663
updated.add_feature_flag("b", true)
57-
expect(scope.flags).to eq([{ flag: "a", result: true }])
64+
expect(scope.flags.values).to eq("a" => true)
5865

5966
scope.clear
60-
expect(scope.flags).to be_empty
67+
expect(scope.flags.values).to be_empty
6168
end
6269

6370
context "with an active span" do
@@ -66,22 +73,22 @@
6673

6774
it "records flag.evaluation.* span data, capped per span" do
6875
scope.add_feature_flag("a", true)
69-
expect(span.data["flag.evaluation.a"]).to eq(true)
76+
expect(span.to_h[:data]["flag.evaluation.a"]).to eq(true)
7077

7178
12.times { |i| scope.add_feature_flag("g#{i}", true) }
72-
keys = span.data.keys.select { |k| k.start_with?("flag.evaluation.") }
73-
expect(keys.size).to eq(Sentry::Scope::MAX_FLAGS_PER_SPAN)
79+
keys = span.to_h[:data].keys.select { |k| k.start_with?("flag.evaluation.") }
80+
expect(keys.size).to eq(Sentry::Span::MAX_FLAGS)
7481

7582
scope.add_feature_flag("a", false)
76-
expect(span.data["flag.evaluation.a"]).to eq(false)
83+
expect(span.to_h[:data]["flag.evaluation.a"]).to eq(true)
7784
end
7885
end
7986
end
8087

8188
describe "Sentry.add_feature_flag" do
8289
it "adds to the current scope" do
8390
Sentry.add_feature_flag("x", true)
84-
expect(Sentry.get_current_scope.flags).to eq([{ flag: "x", result: true }])
91+
expect(Sentry.get_current_scope.flags.values).to eq("x" => true)
8592
end
8693
end
8794
end
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# frozen_string_literal: true
2+
3+
require "spec_helper"
4+
5+
RSpec.describe Sentry::Utils::RingBuffer do
6+
subject(:buffer) { described_class.new(2) }
7+
8+
it "keeps the most recent unique values" do
9+
buffer.set("a", 1)
10+
buffer.set("b", 2)
11+
buffer.set("a", 3)
12+
buffer.set("c", 4)
13+
14+
expect(buffer.values).to eq("a" => 3, "c" => 4)
15+
end
16+
17+
it "copies and clears independently" do
18+
buffer.set("a", 1)
19+
copy = buffer.dup
20+
21+
copy.set("b", 2)
22+
copy.clear
23+
24+
expect(buffer.values).to eq("a" => 1)
25+
expect(copy).to be_empty
26+
end
27+
end

0 commit comments

Comments
 (0)