opentelemetry-sdk-experimental 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 810bad2b227d4e0345bab51445002ccae0dde9cc7a8651d05fc5c44c1bd7df6c
4
+ data.tar.gz: 53dd2c762679bda44159ec4936ae8beb6052a536a618d52e793eb25f187b68fd
5
+ SHA512:
6
+ metadata.gz: b48e7906d4250ff6cc7f01d32152e1c85ac0627993cba7171debb16514ef8b6a6af79d186098629cb66dbbf9c5b901f05c007144e2f7dcdc06b7b4b6f71a0c39
7
+ data.tar.gz: 3a861705fa43bfd6150c6441c4e6487dd95857acf85f2d6a21dafd14b32e66ff18eb312d3aa1e13cde5f5b971359de304852f05d34e073e28b0a40824bae97b4
data/.yardopts ADDED
@@ -0,0 +1,9 @@
1
+ --no-private
2
+ --title=OpenTelemetry SDK (experimental extensions)
3
+ --markup=markdown
4
+ --main=README.md
5
+ ./lib/opentelemetry/**/*.rb
6
+ ./lib/opentelemetry.rb
7
+ -
8
+ README.md
9
+ CHANGELOG.md
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ # Release History: opentelemetry-sdk-experimental
2
+
3
+ ### v0.1.0 / 2022-11-09
4
+
5
+ * Initial release.
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright The OpenTelemetry Authors
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,44 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ if !(%i[consistent_probability_based parent_consistent_probability_based] - OpenTelemetry::SDK::Trace::Samplers.singleton_methods).empty? &&
8
+ !OpenTelemetry::SDK::Trace::Samplers.const_defined?(:ConsistentProbabilityTraceState) &&
9
+ !OpenTelemetry::SDK::Trace::Samplers.const_defined?(:ParentConsistentProbabilityBased) &&
10
+ !OpenTelemetry::SDK::Trace::Samplers.const_defined?(:ConsistentProbabilityBased)
11
+ require 'opentelemetry/sdk/trace/samplers/consistent_probability_tracestate'
12
+ require 'opentelemetry/sdk/trace/samplers/consistent_probability_based'
13
+ require 'opentelemetry/sdk/trace/samplers/parent_consistent_probability_based'
14
+
15
+ module OpenTelemetry
16
+ module SDK
17
+ module Experimental
18
+ # The SamplersPatch module contains additional samplers for OpenTelemetry.
19
+ module SamplersPatch
20
+ # Returns a new sampler.
21
+ #
22
+ # @param [Numeric] ratio The desired sampling ratio.
23
+ # Must be within [0.0, 1.0].
24
+ # @raise [ArgumentError] if ratio is out of range
25
+ def consistent_probability_based(ratio)
26
+ raise ArgumentError, 'ratio must be in range [0.0, 1.0]' unless (0.0..1.0).include?(ratio)
27
+
28
+ OpenTelemetry::SDK::Trace::Samplers::ConsistentProbabilityBased.new(ratio)
29
+ end
30
+
31
+ # Returns a new sampler.
32
+ #
33
+ # @param [Sampler] root The sampler to which the sampling
34
+ # decision is delegated for spans with no parent (root spans).
35
+ def parent_consistent_probability_based(root:)
36
+ OpenTelemetry::SDK::Trace::Samplers::ParentConsistentProbabilityBased.new(root)
37
+ end
38
+ end
39
+ end
40
+ end
41
+ end
42
+
43
+ OpenTelemetry::SDK::Trace::Samplers.extend(OpenTelemetry::SDK::Experimental::SamplersPatch)
44
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module SDK
9
+ module Experimental
10
+ # Current OpenTelemetry experimental sdk version
11
+ VERSION = '0.1.0'
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module SDK
9
+ # The Experimental module contains experimental extensions to the OpenTelemetry reference
10
+ # implementation.
11
+ module Experimental
12
+ end
13
+ end
14
+ end
15
+
16
+ require 'opentelemetry/sdk/experimental/samplers_patch'
17
+ require 'opentelemetry/sdk/trace/propagation/trace_context/response_text_map_propagator'
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ unless OpenTelemetry::Trace::Propagation::TraceContext.const_defined?(:ResponseTextMapPropagator)
8
+ module OpenTelemetry
9
+ module Trace
10
+ module Propagation
11
+ module TraceContext
12
+ # Propagates trace response using the W3C Trace Context format
13
+ # https://w3c.github.io/trace-context/#traceresponse-header
14
+ class ResponseTextMapPropagator
15
+ TRACERESPONSE_KEY = 'traceresponse'
16
+ FIELDS = [TRACERESPONSE_KEY].freeze
17
+
18
+ private_constant :TRACERESPONSE_KEY, :FIELDS
19
+
20
+ # Inject trace context into the supplied carrier.
21
+ #
22
+ # @param [Carrier] carrier The mutable carrier to inject trace context into
23
+ # @param [Context] context The context to read trace context from
24
+ # @param [optional Setter] setter If the optional setter is provided, it
25
+ # will be used to write context into the carrier, otherwise the default
26
+ # text map setter will be used.
27
+ def inject(carrier, context: Context.current, setter: Context::Propagation.text_map_setter)
28
+ span_context = Trace.current_span(context).context
29
+ return unless span_context.valid?
30
+
31
+ setter.set(carrier, TRACERESPONSE_KEY, TraceParent.from_span_context(span_context).to_s)
32
+ nil
33
+ end
34
+
35
+ # Extract trace context from the supplied carrier. This is a no-op for
36
+ # this propagator, and will return the provided context.
37
+ #
38
+ # @param [Carrier] carrier The carrier to get the header from
39
+ # @param [optional Context] context Context to be updated with the trace context
40
+ # extracted from the carrier. Defaults to +Context.current+.
41
+ # @param [optional Getter] getter If the optional getter is provided, it
42
+ # will be used to read the header from the carrier, otherwise the default
43
+ # text map getter will be used.
44
+ #
45
+ # @return [Context] the original context.
46
+ def extract(carrier, context: Context.current, getter: Context::Propagation.text_map_getter)
47
+ context
48
+ end
49
+
50
+ # Returns the predefined propagation fields. If your carrier is reused, you
51
+ # should delete the fields returned by this method before calling +inject+.
52
+ #
53
+ # @return [Array<String>] a list of fields that will be used by this propagator.
54
+ def fields
55
+ FIELDS
56
+ end
57
+ end
58
+ end
59
+ end
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,89 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module SDK
9
+ module Trace
10
+ module Samplers
11
+ # @api private
12
+ #
13
+ # Implements consistent sampling based on a probability.
14
+ class ConsistentProbabilityBased
15
+ include ConsistentProbabilityTraceState
16
+
17
+ attr_reader :description
18
+
19
+ def initialize(probability)
20
+ if probability < 2e-62
21
+ @p_floor = 63
22
+ @p_ceil = @p_ceil_probability = 0
23
+ @description = 'ConsistentProbabilityBased{0}'
24
+ return
25
+ end
26
+
27
+ @p_floor = (Math.frexp(probability)[1] - 1).abs
28
+ @p_ceil = @p_floor + 1
29
+ floor = Math.ldexp(1.0, -@p_floor)
30
+ ceil = Math.ldexp(1.0, -@p_ceil)
31
+ @p_ceil_probability = (probability - floor) / (ceil - floor)
32
+ @description = format('ConsistentProbabilityBased{%.6f}', probability)
33
+ end
34
+
35
+ def ==(other)
36
+ @description == other.description
37
+ end
38
+
39
+ # @api private
40
+ #
41
+ # See {Samplers}.
42
+ def should_sample?(trace_id:, parent_context:, links:, name:, kind:, attributes:)
43
+ parent_span_context = OpenTelemetry::Trace.current_span(parent_context).context
44
+ p = probabilistic_p
45
+ if parent_span_context.valid?
46
+ tracestate = parent_span_context.tracestate
47
+ parse_ot_vendor_tag(tracestate) do |_, in_r, rest|
48
+ r = if in_r.nil? || in_r > 62
49
+ OpenTelemetry.logger.debug("ConsistentProbabilitySampler: potentially inconsistent trace detected - r: #{in_r.inspect}")
50
+ generate_r(trace_id)
51
+ else
52
+ in_r
53
+ end
54
+ if p <= r
55
+ Result.new(decision: Decision::RECORD_AND_SAMPLE, tracestate: update_tracestate(tracestate, p, r, rest))
56
+ else
57
+ Result.new(decision: Decision::DROP, tracestate: update_tracestate(tracestate, nil, r, rest))
58
+ end
59
+ end
60
+ else
61
+ r = generate_r(trace_id)
62
+ if p <= r
63
+ Result.new(decision: Decision::RECORD_AND_SAMPLE, tracestate: new_tracestate(p: p, r: r))
64
+ else
65
+ Result.new(decision: Decision::DROP, tracestate: new_tracestate(r: r))
66
+ end
67
+ end
68
+ end
69
+
70
+ private
71
+
72
+ def generate_r(trace_id)
73
+ x = trace_id[8, 8].unpack1('Q>') | 0x3
74
+ clz = 64 - x.bit_length
75
+ clz
76
+ end
77
+
78
+ def probabilistic_p
79
+ if Random.rand < @p_ceil_probability
80
+ @p_ceil
81
+ else
82
+ @p_floor
83
+ end
84
+ end
85
+ end
86
+ end
87
+ end
88
+ end
89
+ end
@@ -0,0 +1,82 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module SDK
9
+ module Trace
10
+ module Samplers
11
+ # @api private
12
+ #
13
+ # The ConsistentProbabilityTraceState module implements Tracestate parsing,
14
+ # validation and manipulation for the consistent probability-based samplers.
15
+ module ConsistentProbabilityTraceState
16
+ DECIMAL = /\A\d+\z/.freeze
17
+ MAX_LIST_LENGTH = 256 # Defined by https://www.w3.org/TR/trace-context/
18
+ private_constant(:DECIMAL, :MAX_LIST_LENGTH)
19
+
20
+ # parse_ot_vendor_tag parses the 'ot' vendor tag of the tracestate.
21
+ # It yields the parsed probability fields and the remaining tracestate.
22
+ # It returns the result of the block.
23
+ def parse_ot_vendor_tag(tracestate)
24
+ return yield(nil, nil, nil) if tracestate.empty?
25
+
26
+ ot = tracestate.value('ot')
27
+ return yield(nil, nil, nil) if ot.nil? || ot.length > MAX_LIST_LENGTH # TODO: warn that we're rejecting the tracestate
28
+
29
+ p = r = nil
30
+ rest = +''
31
+ ot.split(';').each do |field|
32
+ k, v = field.split(':', 2)
33
+ # TODO: "the used keys MUST be unique." - do we need to validate this?
34
+ case k
35
+ when 'p' then p = decimal(v)
36
+ when 'r' then r = decimal(v)
37
+ else
38
+ rest << ';' unless rest.empty?
39
+ rest << field
40
+ end
41
+ end
42
+ rest = nil if rest.empty?
43
+ yield(p, r, rest)
44
+ end
45
+
46
+ def update_tracestate(tracestate, p, r, rest) # rubocop:disable Naming/UncommunicativeMethodParamName
47
+ # This could be more efficient and allocate less, however it *should* only be used for root spans and sanitizing invalid tracestate
48
+ # in the most common configuration of parent_consistent_probability_based(root: consistent_probability_based(p)).
49
+ ps = "p:#{p}" unless p.nil?
50
+ rs = "r:#{r}" unless r.nil?
51
+ ot = [ps, rs, rest].compact.join(';')
52
+ if ot.empty?
53
+ tracestate.delete('ot')
54
+ else
55
+ tracestate.set_value('ot', ot)
56
+ end
57
+ end
58
+
59
+ def new_tracestate(p: nil, r: nil) # rubocop:disable Naming/UncommunicativeMethodParamName
60
+ if p.nil? && r.nil?
61
+ OpenTelemetry::Trace::Tracestate.DEFAULT
62
+ elsif p.nil?
63
+ OpenTelemetry::Trace::Tracestate.from_hash('ot' => "r:#{r}")
64
+ elsif r.nil?
65
+ OpenTelemetry::Trace::Tracestate.from_hash('ot' => "p:#{p}")
66
+ else
67
+ OpenTelemetry::Trace::Tracestate.from_hash('ot' => "p:#{p};r:#{r}")
68
+ end
69
+ end
70
+
71
+ def invariant(p, r, sampled) # rubocop:disable Naming/UncommunicativeMethodParamName
72
+ ((p <= r) == sampled) || (sampled && (p == 63))
73
+ end
74
+
75
+ def decimal(str)
76
+ str.to_i if !str.nil? && DECIMAL.match?(str)
77
+ end
78
+ end
79
+ end
80
+ end
81
+ end
82
+ end
@@ -0,0 +1,87 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module SDK
9
+ module Trace
10
+ module Samplers
11
+ # @api private
12
+ #
13
+ # The ParentConsistentProbabilityBased sampler is meant as an optional
14
+ # replacement for the ParentBased sampler. It is required to first validate
15
+ # the tracestate and then respect the sampled flag in the W3C traceparent.
16
+ #
17
+ # The ParentConsistentProbabilityBased Sampler constructor takes a single
18
+ # Sampler argument, which is the Sampler to use in case the
19
+ # ParentConsistentProbabilityBased Sampler is called for a root span.
20
+ class ParentConsistentProbabilityBased
21
+ include ConsistentProbabilityTraceState
22
+
23
+ def initialize(root)
24
+ @root = root
25
+ end
26
+
27
+ def ==(other)
28
+ @root == other.root
29
+ end
30
+
31
+ # @api private
32
+ #
33
+ # See {Samplers}.
34
+ def description
35
+ "ParentConsistentProbabilityBased{root=#{@root.description}}"
36
+ end
37
+
38
+ # @api private
39
+ #
40
+ # See {Samplers}.
41
+ def should_sample?(trace_id:, parent_context:, links:, name:, kind:, attributes:)
42
+ parent_span_context = OpenTelemetry::Trace.current_span(parent_context).context
43
+ if !parent_span_context.valid?
44
+ @root.should_sample?(trace_id: trace_id, parent_context: parent_context, links: links, name: name, kind: kind, attributes: attributes)
45
+ else
46
+ tracestate = sanitized_tracestate(parent_span_context)
47
+ if parent_span_context.trace_flags.sampled?
48
+ Result.new(decision: Decision::RECORD_AND_SAMPLE, tracestate: tracestate)
49
+ else
50
+ Result.new(decision: Decision::DROP, tracestate: tracestate)
51
+ end
52
+ end
53
+ end
54
+
55
+ protected
56
+
57
+ attr_reader :root
58
+
59
+ private
60
+
61
+ # sanitized_tracestate returns an OpenTelemetry Tracestate object with the
62
+ # tracestate sanitized according to the Context invariants defined in the
63
+ # tracestate probability sampling spec.
64
+ #
65
+ # @param span_context [OpenTelemetry::Trace::SpanContext] the parent span context
66
+ # @return [OpenTelemetry::Trace::Tracestate] the sanitized tracestate
67
+ def sanitized_tracestate(span_context)
68
+ sampled = span_context.trace_flags.sampled?
69
+ tracestate = span_context.tracestate
70
+ parse_ot_vendor_tag(tracestate) do |p, r, rest|
71
+ if !r.nil? && r > 62
72
+ p = r = nil
73
+ elsif !p.nil? && p > 63
74
+ p = nil
75
+ elsif !p.nil? && !r.nil? && !invariant(p, r, sampled)
76
+ p = nil
77
+ else
78
+ return tracestate
79
+ end
80
+ update_tracestate(tracestate, p, r, rest)
81
+ end
82
+ end
83
+ end
84
+ end
85
+ end
86
+ end
87
+ end
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ require 'opentelemetry/sdk'
8
+ require 'opentelemetry/sdk/experimental'
metadata ADDED
@@ -0,0 +1,226 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: opentelemetry-sdk-experimental
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - OpenTelemetry Authors
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2022-11-09 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: opentelemetry-api
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.1'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.1'
27
+ - !ruby/object:Gem::Dependency
28
+ name: opentelemetry-sdk
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.2'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.2'
41
+ - !ruby/object:Gem::Dependency
42
+ name: benchmark-ipsa
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 0.2.0
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 0.2.0
55
+ - !ruby/object:Gem::Dependency
56
+ name: bundler
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '1.17'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '1.17'
69
+ - !ruby/object:Gem::Dependency
70
+ name: faraday
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '0.13'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '0.13'
83
+ - !ruby/object:Gem::Dependency
84
+ name: minitest
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '5.0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '5.0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: opentelemetry-test-helpers
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: rake
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '12.0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '12.0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: rubocop
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: 0.73.0
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: 0.73.0
139
+ - !ruby/object:Gem::Dependency
140
+ name: simplecov
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: '0.17'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: '0.17'
153
+ - !ruby/object:Gem::Dependency
154
+ name: yard
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: '0.9'
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: '0.9'
167
+ - !ruby/object:Gem::Dependency
168
+ name: yard-doctest
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - "~>"
172
+ - !ruby/object:Gem::Version
173
+ version: 0.1.6
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - "~>"
179
+ - !ruby/object:Gem::Version
180
+ version: 0.1.6
181
+ description: A stats collection and distributed tracing framework
182
+ email:
183
+ - cncf-opentelemetry-contributors@lists.cncf.io
184
+ executables: []
185
+ extensions: []
186
+ extra_rdoc_files: []
187
+ files:
188
+ - ".yardopts"
189
+ - CHANGELOG.md
190
+ - LICENSE
191
+ - lib/opentelemetry-sdk-experimental.rb
192
+ - lib/opentelemetry/sdk/experimental.rb
193
+ - lib/opentelemetry/sdk/experimental/samplers_patch.rb
194
+ - lib/opentelemetry/sdk/experimental/version.rb
195
+ - lib/opentelemetry/sdk/trace/propagation/trace_context/response_text_map_propagator.rb
196
+ - lib/opentelemetry/sdk/trace/samplers/consistent_probability_based.rb
197
+ - lib/opentelemetry/sdk/trace/samplers/consistent_probability_tracestate.rb
198
+ - lib/opentelemetry/sdk/trace/samplers/parent_consistent_probability_based.rb
199
+ homepage: https://github.com/open-telemetry/opentelemetry-ruby
200
+ licenses:
201
+ - Apache-2.0
202
+ metadata:
203
+ changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk-experimental/v0.1.0/file.CHANGELOG.html
204
+ source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/api
205
+ bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
206
+ documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk-experimental/v0.1.0
207
+ post_install_message:
208
+ rdoc_options: []
209
+ require_paths:
210
+ - lib
211
+ required_ruby_version: !ruby/object:Gem::Requirement
212
+ requirements:
213
+ - - ">="
214
+ - !ruby/object:Gem::Version
215
+ version: 2.6.0
216
+ required_rubygems_version: !ruby/object:Gem::Requirement
217
+ requirements:
218
+ - - ">="
219
+ - !ruby/object:Gem::Version
220
+ version: '0'
221
+ requirements: []
222
+ rubygems_version: 3.1.6
223
+ signing_key:
224
+ specification_version: 4
225
+ summary: A stats collection and distributed tracing framework
226
+ test_files: []