Skip to content

Extract magic numbers as named constants in Instrumenter #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
johngallagher merged 1 commit into from
Mar 9, 2026
Merged

Extract magic numbers as named constants in Instrumenter #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions lib/observable/instrumenter.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@

module Observable
class Instrumenter
CALLER_STACK_LIMIT = 10
MAX_ARRAY_ITEMS = 10
DEFAULT_SERIALIZATION_DEPTH = 2

attr_reader :last_captured_namespace, :config

def initialize(tracer: nil, config: nil)
Expand Down Expand Up @@ -34,7 +38,7 @@ def extract_caller_information
end

def find_caller_location
locations = caller_locations(1, 10)
locations = caller_locations(1, CALLER_STACK_LIMIT)
raise InstrumentationError, "Unable to determine caller location" if locations.nil? || locations.empty?

instrumenter_file = __FILE__
Expand Down Expand Up @@ -190,11 +194,11 @@ def serialize_return_value(span, value)
when String, Numeric, TrueClass, FalseClass
span.set_attribute("code.return", value)
when Hash
serialize_hash(span, "code.return", value, 2)
serialize_hash(span, "code.return", value, DEFAULT_SERIALIZATION_DEPTH)
when Array
serialize_array(span, "code.return", value, 2)
serialize_array(span, "code.return", value, DEFAULT_SERIALIZATION_DEPTH)
else
serialize_object(span, "code.return", value, 2)
serialize_object(span, "code.return", value, DEFAULT_SERIALIZATION_DEPTH)
end
end

Expand Down Expand Up @@ -222,7 +226,7 @@ def serialize_hash_with_custom_depth(span, prefix, hash, custom_max_depth, depth
def serialize_array_with_custom_depth(span, prefix, array, custom_max_depth, depth = 0)
return if depth > custom_max_depth

items_to_process = [array.length, 10].min
items_to_process = [array.length, MAX_ARRAY_ITEMS].min
array.first(items_to_process).each_with_index do |item, index|
serialize_argument_with_custom_depth(span, "#{prefix}.#{index}", item, custom_max_depth, nil, depth + 1)
end
Expand Down Expand Up @@ -263,7 +267,7 @@ def serialize_array(span, prefix, array, depth = 0)
max_depth = get_serialization_depth_for_class("Array")
return if depth > max_depth

items_to_process = [array.length, 10].min
items_to_process = [array.length, MAX_ARRAY_ITEMS].min
array.first(items_to_process).each_with_index do |item, index|
serialize_argument(span, "#{prefix}.#{index}", item, nil, depth + 1)
end
Expand Down Expand Up @@ -316,7 +320,7 @@ def get_serialization_depth_for_class(class_name)
return @config.serialization_depth
end

@config.serialization_depth[class_name] || @config.serialization_depth[:default] || @config.serialization_depth["default"] || 2
@config.serialization_depth[class_name] || @config.serialization_depth[:default] || @config.serialization_depth["default"] || DEFAULT_SERIALIZATION_DEPTH
end

def should_filter_pii?(param_name)
Expand Down