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
|
# frozen_string_literal: true
# Released under the MIT License.
# Copyright, 2021-2025, by Samuel Williams.
require_relative "../context"
require "fiber"
Fiber.attr_accessor :traces_backend_context
module Traces
module Backend
# A backend which validates interface usage.
module Test
# A span which validates tag assignment.
class Span
# Initialize a new span.
# @parameter context [Context] The context in which the span is recorded.
def initialize(context)
@context = context
end
# @attribute [Context] The context in which the span is recorded.
attr :context
# Assign some metadata to the span.
# @parameter key [String] The metadata key.
# @parameter value [Object] The metadata value. Should be coercable to a string.
def []= key, value
unless key.is_a?(String) || key.is_a?(Symbol)
raise ArgumentError, "Invalid attribute key (must be String or Symbol): #{key.inspect}!"
end
begin
String(value)
rescue
raise ArgumentError, "Invalid attribute value (must be convertible to String): #{value.inspect}!"
end
end
end
# The test backend interface.
module Interface
# Trace the given block of code and validate the interface usage.
# @parameter name [String] A useful name/annotation for the recorded span.
# @parameter resource [String] The context in which the trace operation is occuring.
# @parameter attributes [Hash] Metadata for the recorded span.
def trace(name, attributes: nil, &block)
unless block_given?
raise ArgumentError, "No block given!"
end
unless name.is_a?(String)
raise ArgumentError, "Invalid name (must be String): #{name.inspect}!"
end
context = Context.nested(Fiber.current.traces_backend_context)
span = Span.new(context)
# Ensure the attributes are valid and follow the requirements:
attributes&.each do |key, value|
span[key] = value
end
Fiber.current.traces_backend_context = context
if block.arity.zero?
yield
else
yield span
end
end
# Assign a trace context to the current execution scope.
def trace_context= context
Fiber.current.traces_backend_context = context
end
# Get a trace context from the current execution scope.
def trace_context
Fiber.current.traces_backend_context
end
# @returns [Boolean] Whether there is an active trace.
def active?
!!Fiber.current.traces_backend_context
end
end
end
Interface = Test::Interface
end
end
|
