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
|
# frozen_string_literal: true
module Aws
module Telemetry
# Base for `TelemetryProvider` classes.
# They are used to emit telemetry data. It needs the
# following class implementations to function:
# * {TracerProviderBase} - A provider that returns a tracer
# instance. Then, a tracer will create spans and those
# spans will contain information in that given moment.
# * {ContextManagerBase} - Manages context and used to
# return the current context within a trace.
class TelemetryProviderBase
# @param [Aws::Telemetry::TracerBase] tracer_provider A provider
# that returns a tracer instance.
# @param [Aws::Telemetry::ContextManagerBase] context_manager Manages
# context and used to return the current context.
def initialize(tracer_provider: nil, context_manager: nil)
@tracer_provider = tracer_provider
@context_manager = context_manager
end
# @return [Aws::Telemetry::TracerProviderBase]
attr_reader :tracer_provider
# @return [Aws::Telemetry::ContextManagerBase]
attr_reader :context_manager
end
# Base for `TracerProvider` classes.
class TracerProviderBase
# Returns a Tracer instance.
#
# @param [String] name Tracer name
# @return [Aws::Telemetry::TracerBase]
def tracer(name = nil)
raise NotImplementedError
end
end
# Base for `Tracer` classes.
class TracerBase
# Used when a caller wants to manage the activation/deactivation and
# lifecycle of the Span and its parent manually.
#
# @param [String] name Span name
# @param [Object] with_parent Parent Context
# @param [Hash] attributes Attributes to attach to the span
# @param [Aws::Telemetry::SpanKind] kind Type of Span
# @return [Aws::Telemetry::SpanBase]
def start_span(name, with_parent: nil, attributes: nil, kind: nil)
raise NotImplementedError
end
# A helper for the default use-case of extending the current trace
# with a span.
# On exit, the Span that was active before calling this method will
# be reactivated. If an exception occurs during the execution of the
# provided block, it will be recorded on the span and re-raised.
#
# @param [String] name Span name
# @param [Hash] attributes Attributes to attach to the span
# @param [Aws::Telemetry::SpanKind] kind Type of Span
# @return [Aws::Telemetry::SpanBase]
def in_span(name, attributes: nil, kind: nil)
raise NotImplementedError
end
# Returns the current active span.
#
# @return [Aws::Telemetry::SpanBase]
def current_span
raise NotImplementedError
end
end
# Base for `Span` classes.
class SpanBase
# Set attribute.
#
# @param [String] key
# @param [String, Boolean, Numeric, Array<String, Numeric, Boolean>] value
# Value must be non-nil and (array of) string, boolean or numeric type.
# Array values must not contain nil elements and all elements must be of
# the same basic type (string, numeric, boolean)
# @return [self] returns itself
def set_attribute(key, value)
raise NotImplementedError
end
alias []= set_attribute
# Add attributes.
#
# @param [Hash{String => String, Numeric, Boolean, Array<String, Numeric,
# Boolean>}] attributes Values must be non-nil and (array of) string,
# boolean or numeric type. Array values must not contain nil elements
# and all elements must be of the same basic type (string, numeric,
# boolean)
# @return [self] returns itself
def add_attributes(attributes)
raise NotImplementedError
end
# Add event to a Span.
#
# @param [String] name Name of the event
# @param [Hash{String => String, Numeric, Boolean, Array<String,
# Numeric, Boolean>}] attributes Values must be non-nil and (array of)
# string, boolean or numeric type. Array values must not contain nil
# elements and all elements must be of the same basic type (string,
# numeric, boolean)
# @return [self] returns itself
def add_event(name, attributes: nil)
raise NotImplementedError
end
# Sets the Span status.
#
# @param [Aws::Telemetry::SpanStatus] status The new status, which
# overrides the default Span status, which is `OK`
# @return [void]
def status=(status)
raise NotImplementedError
end
# Finishes the Span.
#
# @param [Time] end_timestamp End timestamp for the span.
# @return [self] returns itself
def finish(end_timestamp: nil)
raise NotImplementedError
end
# Record an exception during the execution of this span. Multiple
# exceptions can be recorded on a span.
#
# @param [Exception] exception The exception to be recorded
# @param [Hash{String => String, Numeric, Boolean, Array<String,
# Numeric, Boolean>}] attributes One or more key:value pairs, where the
# keys must be strings and the values may be (array of) string, boolean
# or numeric type.
# @return [void]
def record_exception(exception, attributes: nil)
raise NotImplementedError
end
end
# Base for all `ContextManager` classes.
class ContextManagerBase
# Returns current context.
#
# @return [Context]
def current
raise NotImplementedError
end
# Associates a Context with the caller’s current execution unit.
# Returns a token to be used with the matching call to detach.
#
# @param [Object] context The new context
# @return [Object] token A token to be used when detaching
def attach(context)
raise NotImplementedError
end
# Restore the previous Context associated with the current
# execution unit to the value it had before attaching a
# specified Context.
#
# @param [Object] token The token provided by matching the call to attach
# @return [Boolean] `True` if the calls matched, `False` otherwise
def detach(token)
raise NotImplementedError
end
end
end
end
|
