opentelemetry-propagator-ottrace 0.16.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +9 -0
- data/CHANGELOG.md +5 -0
- data/LICENSE +201 -0
- data/README.md +81 -0
- data/lib/opentelemetry-propagator-ottrace.rb +8 -0
- data/lib/opentelemetry/propagator/ottrace.rb +46 -0
- data/lib/opentelemetry/propagator/ottrace/text_map_extractor.rb +103 -0
- data/lib/opentelemetry/propagator/ottrace/text_map_injector.rb +74 -0
- data/lib/opentelemetry/propagator/ottrace/version.rb +21 -0
- metadata +182 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 72a92304ef5e150187a19816b80c09a4b619b1c0ebcf15ea06fcf242f07355cf
|
4
|
+
data.tar.gz: a520eff87efdcb38cfb4f6d904bc7c1f96e5f2feb8e19f4c587377f1200e0b46
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 971279dcf6f405363d25f6e1215557300a0caa5d6c757da54883acbaf04a5212241e37acfa222185758b05246e769663d088e1abf6745c2cc21f958e61747fa3
|
7
|
+
data.tar.gz: 6119312dec5fad82e0b8e741455c8cdfd554f2936cbac63ae822135b887a3c16d3646a7e723586e45a4fc7dcfcd2d99204033e2c75f41ed77266cbfc0a4e83a1
|
data/.yardopts
ADDED
data/CHANGELOG.md
ADDED
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.
|
data/README.md
ADDED
@@ -0,0 +1,81 @@
|
|
1
|
+
# opentelemetry-propagator-ottrace
|
2
|
+
|
3
|
+
The `opentelemetry-propagator-ottrace` gem contains injectors and extractors for the
|
4
|
+
[OTTrace context propagation format][ottrace-spec].
|
5
|
+
|
6
|
+
## OT Trace Format
|
7
|
+
|
8
|
+
| Header Name | Description | Required |
|
9
|
+
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
|
10
|
+
| `ot-tracer-traceid` | uint64 encoded as a string of 16 hex characters | yes |
|
11
|
+
| `ot-tracer-spanid` | uint64 encoded as a string of 16 hex characters | yes |
|
12
|
+
| `ot-tracer-sampled` | boolean encoded as a string with the values `'true'` or `'false'` | no |
|
13
|
+
| `ot-baggage-*` | repeated string to string key-value baggage items; keys are prefixed with `ot-baggage-` and the corresponding value is the raw string. | if baggage is present |
|
14
|
+
|
15
|
+
### Interop and trace ids
|
16
|
+
|
17
|
+
The OT trace propagation format expects trace ids to be 64-bits. In order to
|
18
|
+
interop with OpenTelemetry, trace ids need to be truncated to 64-bits before
|
19
|
+
sending them on the wire. When truncating, the least significant (right-most)
|
20
|
+
bits MUST be retained. For example, a trace id of
|
21
|
+
`3c3039f4d78d5c02ee8e3e41b17ce105` would be truncated to `ee8e3e41b17ce105`.
|
22
|
+
|
23
|
+
### Baggage Notes
|
24
|
+
|
25
|
+
Baggage keys and values are validated according to [rfc7230][rfc7230-url]. Any
|
26
|
+
keys or values that would result in invalid HTTP headers will be silently
|
27
|
+
dropped during inject.
|
28
|
+
|
29
|
+
OT Baggage is represented as multiple headers where the
|
30
|
+
names are carrier dependent. For this reason, they are omitted from the `fields`
|
31
|
+
method. This behavior should be taken into account if your application relies
|
32
|
+
on the `fields` functionality. See the [specification][fields-spec-url] for
|
33
|
+
more details.
|
34
|
+
|
35
|
+
## What is OpenTelemetry?
|
36
|
+
|
37
|
+
[OpenTelemetry][opentelemetry-home] is an open source observability framework, providing a general-purpose API, SDK, and related tools required for the instrumentation of cloud-native software, frameworks, and libraries.
|
38
|
+
|
39
|
+
OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces and metrics from your application. You can analyze them using Prometheus, Jaeger, and other observability tools.
|
40
|
+
|
41
|
+
## How does this gem fit in?
|
42
|
+
|
43
|
+
This gem can be used with any OpenTelemetry SDK implementation. This can be the official `opentelemetry-sdk` gem or any other concrete implementation.
|
44
|
+
|
45
|
+
## How do I get started?
|
46
|
+
|
47
|
+
Install the gem using:
|
48
|
+
|
49
|
+
```
|
50
|
+
gem install opentelemetry-propagator-ottrace
|
51
|
+
```
|
52
|
+
|
53
|
+
Or, if you use [bundler][bundler-home], include `opentelemetry-propagator-ottrace` in your `Gemfile`.
|
54
|
+
|
55
|
+
Configure your application to use this propagator by setting the following [environment variable][envars]:
|
56
|
+
|
57
|
+
```
|
58
|
+
OTEL_PROPAGATORS=ottrace
|
59
|
+
```
|
60
|
+
|
61
|
+
## How can I get involved?
|
62
|
+
|
63
|
+
The `opentelemetry-propagator-ottrace` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
|
64
|
+
|
65
|
+
The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
|
66
|
+
|
67
|
+
## License
|
68
|
+
|
69
|
+
The `opentelemetry-propagator-ottrace` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
|
70
|
+
|
71
|
+
[opentelemetry-home]: https://opentelemetry.io
|
72
|
+
[bundler-home]: https://bundler.io
|
73
|
+
[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
|
74
|
+
[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
|
75
|
+
[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
|
76
|
+
[community-meetings]: https://github.com/open-telemetry/community#community-meetings
|
77
|
+
[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
|
78
|
+
[ottrace-spec]: https://github.com/opentracing/specification/blob/master/rfc/trace_identifiers.md
|
79
|
+
[rfc7230-url]: https://tools.ietf.org/html/rfc7230#section-3.2
|
80
|
+
[fields-spec-url]: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/context/api-propagators.md#fields
|
81
|
+
[envars]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#general-sdk-configuration
|
@@ -0,0 +1,46 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright The OpenTelemetry Authors
|
4
|
+
#
|
5
|
+
# SPDX-License-Identifier: Apache-2.0
|
6
|
+
|
7
|
+
require 'opentelemetry-api'
|
8
|
+
require 'opentelemetry/propagator/ottrace/version'
|
9
|
+
|
10
|
+
# OpenTelemetry is an open source observability framework, providing a
|
11
|
+
# general-purpose API, SDK, and related tools required for the instrumentation
|
12
|
+
# of cloud-native software, frameworks, and libraries.
|
13
|
+
#
|
14
|
+
# The OpenTelemetry module provides global accessors for telemetry objects.
|
15
|
+
# See the documentation for the `opentelemetry-api` gem for details.
|
16
|
+
module OpenTelemetry
|
17
|
+
# Namespace for OpenTelemetry propagator extension libraries
|
18
|
+
module Propagator
|
19
|
+
# Namespace for OpenTelemetry OTTrace propagation
|
20
|
+
module OTTrace
|
21
|
+
extend self
|
22
|
+
|
23
|
+
TRACE_ID_HEADER = 'ot-tracer-traceid'
|
24
|
+
SPAN_ID_HEADER = 'ot-tracer-spanid'
|
25
|
+
SAMPLED_HEADER = 'ot-tracer-sampled'
|
26
|
+
BAGGAGE_HEADER_PREFIX = 'ot-baggage-'
|
27
|
+
|
28
|
+
# https://github.com/open-telemetry/opentelemetry-specification/blob/14d123c121b6caa53bffd011292c42a181c9ca26/specification/context/api-propagators.md#textmap-propagator0
|
29
|
+
VALID_BAGGAGE_HEADER_NAME_CHARS = /^[\^_`a-zA-Z\-0-9!#$%&'*+.|~]+$/.freeze
|
30
|
+
INVALID_BAGGAGE_HEADER_VALUE_CHARS = /[^\t\u0020-\u007E\u0080-\u00FF]/.freeze
|
31
|
+
|
32
|
+
## Returns an extractor that extracts context from OTTrace carrier
|
33
|
+
def text_map_extractor
|
34
|
+
TextMapExtractor.new
|
35
|
+
end
|
36
|
+
|
37
|
+
## Returns an injector that injects context into a carrier
|
38
|
+
def text_map_injector
|
39
|
+
TextMapInjector.new
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
require_relative './ottrace/text_map_injector'
|
46
|
+
require_relative './ottrace/text_map_extractor'
|
@@ -0,0 +1,103 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright The OpenTelemetry Authors
|
4
|
+
#
|
5
|
+
# SPDX-License-Identifier: Apache-2.0
|
6
|
+
|
7
|
+
# OpenTelemetry is an open source observability framework, providing a
|
8
|
+
# general-purpose API, SDK, and related tools required for the instrumentation
|
9
|
+
# of cloud-native software, frameworks, and libraries.
|
10
|
+
#
|
11
|
+
# The OpenTelemetry module provides global accessors for telemetry objects.
|
12
|
+
# See the documentation for the `opentelemetry-api` gem for details.
|
13
|
+
module OpenTelemetry
|
14
|
+
# Namespace for OpenTelemetry propagator extension libraries
|
15
|
+
module Propagator
|
16
|
+
# Namespace for OpenTelemetry OTTrace propagation
|
17
|
+
module OTTrace
|
18
|
+
# Extracts context from carriers using OTTrace header format
|
19
|
+
class TextMapExtractor
|
20
|
+
PADDING = '0' * 16
|
21
|
+
VALID_TRACE_ID_REGEX = /^[0-9a-f]{32}$/.freeze
|
22
|
+
VALID_SPAN_ID_REGEX = /^[0-9a-f]{16}$/.freeze
|
23
|
+
|
24
|
+
# Returns a new TextMapExtractor that extracts OTTrace context using the
|
25
|
+
# specified getter
|
26
|
+
#
|
27
|
+
# @param [optional Getter] default_getter The default getter used to read
|
28
|
+
# headers from a carrier during extract. Defaults to a
|
29
|
+
# {OpenTelemetry::Context:Propagation::TextMapGetter} instance.
|
30
|
+
# @return [TextMapExtractor]
|
31
|
+
def initialize(default_getter: Context::Propagation.text_map_getter)
|
32
|
+
@default_getter = default_getter
|
33
|
+
end
|
34
|
+
|
35
|
+
# Extract OTTrace context from the supplied carrier and set the active span
|
36
|
+
# in the given context. The original context will be returned if OTTrace
|
37
|
+
# cannot be extracted from the carrier.
|
38
|
+
#
|
39
|
+
# @param [Carrier] carrier The carrier to get the header from.
|
40
|
+
# @param [Context] context The context to be updated with extracted context
|
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
|
+
# getter will be used.
|
44
|
+
# @return [Context] Updated context with active span derived from the header, or the original
|
45
|
+
# context if parsing fails.
|
46
|
+
def extract(carrier, context, getter = nil)
|
47
|
+
getter ||= default_getter
|
48
|
+
trace_id = optionally_pad_trace_id(getter.get(carrier, TRACE_ID_HEADER))
|
49
|
+
span_id = getter.get(carrier, SPAN_ID_HEADER)
|
50
|
+
sampled = getter.get(carrier, SAMPLED_HEADER)
|
51
|
+
|
52
|
+
return context unless valid?(trace_id: trace_id, span_id: span_id)
|
53
|
+
|
54
|
+
span_context = Trace::SpanContext.new(
|
55
|
+
trace_id: Array(trace_id).pack('H*'),
|
56
|
+
span_id: Array(span_id).pack('H*'),
|
57
|
+
trace_flags: sampled == 'true' ? Trace::TraceFlags::SAMPLED : Trace::TraceFlags::DEFAULT,
|
58
|
+
remote: true
|
59
|
+
)
|
60
|
+
|
61
|
+
span = Trace::Span.new(span_context: span_context)
|
62
|
+
Trace.context_with_span(span, parent_context: set_baggage(carrier: carrier, context: context, getter: getter))
|
63
|
+
end
|
64
|
+
|
65
|
+
private
|
66
|
+
|
67
|
+
attr_reader :default_getter
|
68
|
+
|
69
|
+
def valid?(trace_id:, span_id:)
|
70
|
+
!(VALID_TRACE_ID_REGEX !~ trace_id || VALID_SPAN_ID_REGEX !~ span_id)
|
71
|
+
end
|
72
|
+
|
73
|
+
def optionally_pad_trace_id(trace_id)
|
74
|
+
if trace_id&.length == 16
|
75
|
+
"#{PADDING}#{trace_id}"
|
76
|
+
else
|
77
|
+
trace_id
|
78
|
+
end
|
79
|
+
end
|
80
|
+
|
81
|
+
def set_baggage(carrier:, context:, getter:)
|
82
|
+
baggage.build(context: context) do |builder|
|
83
|
+
prefix = OTTrace::BAGGAGE_HEADER_PREFIX
|
84
|
+
getter.keys(carrier).each do |carrier_key|
|
85
|
+
baggage_key = carrier_key.start_with?(prefix) && carrier_key[prefix.length..-1]
|
86
|
+
next unless baggage_key
|
87
|
+
next unless VALID_BAGGAGE_HEADER_NAME_CHARS =~ baggage_key
|
88
|
+
|
89
|
+
value = getter.get(carrier, carrier_key)
|
90
|
+
next unless INVALID_BAGGAGE_HEADER_VALUE_CHARS !~ value
|
91
|
+
|
92
|
+
builder.set_value(baggage_key, value)
|
93
|
+
end
|
94
|
+
end
|
95
|
+
end
|
96
|
+
|
97
|
+
def baggage
|
98
|
+
OpenTelemetry.baggage
|
99
|
+
end
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|
@@ -0,0 +1,74 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright The OpenTelemetry Authors
|
4
|
+
#
|
5
|
+
# SPDX-License-Identifier: Apache-2.0
|
6
|
+
|
7
|
+
# OpenTelemetry is an open source observability framework, providing a
|
8
|
+
# general-purpose API, SDK, and related tools required for the instrumentation
|
9
|
+
# of cloud-native software, frameworks, and libraries.
|
10
|
+
#
|
11
|
+
# The OpenTelemetry module provides global accessors for telemetry objects.
|
12
|
+
# See the documentation for the `opentelemetry-api` gem for details.
|
13
|
+
module OpenTelemetry
|
14
|
+
# Namespace for OpenTelemetry propagator extension libraries
|
15
|
+
module Propagator
|
16
|
+
# Namespace for OpenTelemetry OTTrace propagation
|
17
|
+
module OTTrace
|
18
|
+
# Injects context into carriers using the OTTrace format
|
19
|
+
class TextMapInjector
|
20
|
+
TRACE_ID_64_BIT_WIDTH = 64 / 4
|
21
|
+
|
22
|
+
# Returns a new TextMapInjector that injects context using the specified setter
|
23
|
+
#
|
24
|
+
# @param [optional Setter] default_setter The default setter used to
|
25
|
+
# write context into a carrier during inject. Defaults to a
|
26
|
+
# {OpenTelemetry::Context:Propagation::TextMapSetter} instance.
|
27
|
+
# @return [TextMapInjector]
|
28
|
+
def initialize(default_setter: Context::Propagation.text_map_setter)
|
29
|
+
@default_setter = default_setter
|
30
|
+
end
|
31
|
+
|
32
|
+
# @param [Object] carrier to update with context.
|
33
|
+
# @param [Context] context The active Context.
|
34
|
+
# @param [optional Setter] setter If the optional setter is provided, it
|
35
|
+
# will be used to write context into the carrier, otherwise the default
|
36
|
+
# setter will be used.
|
37
|
+
def inject(carrier, context, setter = nil)
|
38
|
+
setter ||= default_setter
|
39
|
+
span_context = Trace.current_span(context).context
|
40
|
+
return unless span_context.valid?
|
41
|
+
|
42
|
+
inject_span_context(span_context: span_context, carrier: carrier, setter: setter)
|
43
|
+
inject_baggage(context: context, carrier: carrier, setter: setter)
|
44
|
+
|
45
|
+
nil
|
46
|
+
end
|
47
|
+
|
48
|
+
private
|
49
|
+
|
50
|
+
attr_reader :default_setter
|
51
|
+
|
52
|
+
def inject_span_context(span_context:, carrier:, setter:)
|
53
|
+
setter.set(carrier, TRACE_ID_HEADER, span_context.hex_trace_id[TRACE_ID_64_BIT_WIDTH, TRACE_ID_64_BIT_WIDTH])
|
54
|
+
setter.set(carrier, SPAN_ID_HEADER, span_context.hex_span_id)
|
55
|
+
setter.set(carrier, SAMPLED_HEADER, span_context.trace_flags.sampled?.to_s)
|
56
|
+
end
|
57
|
+
|
58
|
+
def inject_baggage(context:, carrier:, setter:)
|
59
|
+
baggage.values(context: context)
|
60
|
+
.select { |key, value| valid_baggage_entry?(key, value) }
|
61
|
+
.each { |key, value| setter.set(carrier, "#{BAGGAGE_HEADER_PREFIX}#{key}", value) }
|
62
|
+
end
|
63
|
+
|
64
|
+
def valid_baggage_entry?(key, value)
|
65
|
+
VALID_BAGGAGE_HEADER_NAME_CHARS =~ key && INVALID_BAGGAGE_HEADER_VALUE_CHARS !~ value
|
66
|
+
end
|
67
|
+
|
68
|
+
def baggage
|
69
|
+
OpenTelemetry.baggage
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
73
|
+
end
|
74
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright The OpenTelemetry Authors
|
4
|
+
#
|
5
|
+
# SPDX-License-Identifier: Apache-2.0
|
6
|
+
|
7
|
+
# OpenTelemetry is an open source observability framework, providing a
|
8
|
+
# general-purpose API, SDK, and related tools required for the instrumentation
|
9
|
+
# of cloud-native software, frameworks, and libraries.
|
10
|
+
#
|
11
|
+
# The OpenTelemetry module provides global accessors for telemetry objects.
|
12
|
+
# See the documentation for the `opentelemetry-api` gem for details.
|
13
|
+
module OpenTelemetry
|
14
|
+
# Namespace for OpenTelemetry propagator extension libraries
|
15
|
+
module Propagator
|
16
|
+
# Namespace for OpenTelemetry OTTrace propagation
|
17
|
+
module OTTrace
|
18
|
+
VERSION = '0.16.0'
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
metadata
ADDED
@@ -0,0 +1,182 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: opentelemetry-propagator-ottrace
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.16.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- OpenTelemetry Authors
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2021-03-22 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: 0.16.0
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 0.16.0
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.17'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.17'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: minitest
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '5.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '5.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: opentelemetry-sdk
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: 0.16.0
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: 0.16.0
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rake
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '12.0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '12.0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: rubocop
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: 0.73.0
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: 0.73.0
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: simplecov
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - "~>"
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: 0.17.1
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - "~>"
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: 0.17.1
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: yard
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - "~>"
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0.9'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - "~>"
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0.9'
|
125
|
+
- !ruby/object:Gem::Dependency
|
126
|
+
name: yard-doctest
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - "~>"
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: 0.1.6
|
132
|
+
type: :development
|
133
|
+
prerelease: false
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - "~>"
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: 0.1.6
|
139
|
+
description: OTTrace Context Propagation Extension for the OpenTelemetry framework
|
140
|
+
email:
|
141
|
+
- cncf-opentelemetry-contributors@lists.cncf.io
|
142
|
+
executables: []
|
143
|
+
extensions: []
|
144
|
+
extra_rdoc_files: []
|
145
|
+
files:
|
146
|
+
- ".yardopts"
|
147
|
+
- CHANGELOG.md
|
148
|
+
- LICENSE
|
149
|
+
- README.md
|
150
|
+
- lib/opentelemetry-propagator-ottrace.rb
|
151
|
+
- lib/opentelemetry/propagator/ottrace.rb
|
152
|
+
- lib/opentelemetry/propagator/ottrace/text_map_extractor.rb
|
153
|
+
- lib/opentelemetry/propagator/ottrace/text_map_injector.rb
|
154
|
+
- lib/opentelemetry/propagator/ottrace/version.rb
|
155
|
+
homepage: https://github.com/open-telemetry/opentelemetry-ruby
|
156
|
+
licenses:
|
157
|
+
- Apache-2.0
|
158
|
+
metadata:
|
159
|
+
changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-ottrace/v0.16.0/file.CHANGELOG.html
|
160
|
+
source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/propagator/ottrace
|
161
|
+
bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
|
162
|
+
documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-ottrace/v0.16.0
|
163
|
+
post_install_message:
|
164
|
+
rdoc_options: []
|
165
|
+
require_paths:
|
166
|
+
- lib
|
167
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
168
|
+
requirements:
|
169
|
+
- - ">="
|
170
|
+
- !ruby/object:Gem::Version
|
171
|
+
version: 2.5.0
|
172
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
173
|
+
requirements:
|
174
|
+
- - ">="
|
175
|
+
- !ruby/object:Gem::Version
|
176
|
+
version: '0'
|
177
|
+
requirements: []
|
178
|
+
rubygems_version: 3.1.4
|
179
|
+
signing_key:
|
180
|
+
specification_version: 4
|
181
|
+
summary: OTTrace Context Propagation Extension for the OpenTelemetry framework
|
182
|
+
test_files: []
|