Skip to content

Commit bbad870

Browse files
ollymkaylareopelledazuma
authored andcommitted
feat: added google_cloud_trace_context propagator (open-telemetry#1408)
* added google_cloud_platform propagator * leftover naming * make regex const and remove unnecessary downcase * Update CHANGELOG.md Co-authored-by: Kayla Reopelle <[email protected]> * Update Gemfile Co-authored-by: Kayla Reopelle <[email protected]> * Update README.md Co-authored-by: Kayla Reopelle <[email protected]> * Update version.rb Co-authored-by: Kayla Reopelle <[email protected]> * requested changes * refactor: Define a single ruby required version * Update opentelemetry-propagator-google_cloud_platform.gemspec * rename to GoogleCloudTraceContext * requested changes * fix tests * misunderstood * whitespace * Update README.md * try fix ci * Update version.rb * Copy gemfile from xray * fix rubocop issues * Update Gemfile --------- Co-authored-by: Kayla Reopelle <[email protected]> Co-authored-by: Daniel Azuma <[email protected]>
1 parent af47acd commit bbad870

File tree

19 files changed

+835
-0
lines changed

19 files changed

+835
-0
lines changed

.cspell.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,3 +82,4 @@ words:
8282
- webmocks
8383
- Xuan
8484
- yardoc
85+
- traceparent

.github/workflows/ci-contrib.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ jobs:
6969
- ottrace
7070
- vitess
7171
- xray
72+
- google_cloud_trace_context
7273
os:
7374
- ubuntu-latest
7475
name: "propagator-${{ matrix.gem }} / ${{ matrix.os }}"

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ This repository contains multiple Ruby gems:
7171
* Various resource detector gems located in subdirectories of `resources`
7272
* `opentelemetry-propagator-xray` located in the `propagator/xray` directory
7373
* `opentelemetry-propagator-ottrace` located in the `propagator/ottrace` directory
74+
* `opentelemetry-propagator-google_cloud_trace_context` located in the `propagator/google_cloud_trace_context` directory
7475

7576
Each of these gems has its configuration and tests.
7677

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
inherit_from: ../../.rubocop.yml
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
--no-private
2+
--title=OpenTelemetry Propagator Google Cloud Trace Context
3+
--markup=markdown
4+
--main=README.md
5+
./lib/opentelemetry/propagator/google_cloud_trace_context/**/*.rb
6+
./lib/opentelemetry/propagator/google_cloud_trace_context.rb
7+
-
8+
README.md
9+
CHANGELOG.md
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Release History: opentelemetry-propagator-google_cloud_trace_context
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# frozen_string_literal: true
2+
3+
source 'https://rubygems.org'
4+
5+
gemspec
6+
7+
group :test do
8+
gem 'bundler', '~> 2.4'
9+
gem 'minitest', '~> 5.0'
10+
gem 'rake', '~> 13.0'
11+
gem 'rubocop', '~> 1.75.1'
12+
gem 'rubocop-performance', '~> 1.24.0'
13+
gem 'simplecov', '~> 0.22.0'
14+
gem 'yard', '~> 0.9'
15+
if RUBY_VERSION >= '3.4'
16+
gem 'base64'
17+
gem 'mutex_m'
18+
end
19+
end
Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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.
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# opentelemetry-propagator-google_cloud_trace_context
2+
3+
The `opentelemetry-propagator-google_cloud_trace_context` gem contains injectors and extractors for the
4+
[Google Cloud X-Cloud-Trace-Context format][gcp-spec].
5+
6+
## X-Cloud-Trace-Context header
7+
8+
The `X-Cloud-Trace-Context` header that is used by Google Cloud predates the W3C specification. For backwards compatibility, some Google Cloud services continue to accept, generate, and propagate the `X-Cloud-Trace-Context` header. However, it is likely that these systems also support the traceparent header.
9+
10+
For example Google's Cloud Load Balancers (which do not support the traceparent header)[https://issuetracker.google.com/issues/253419736], instead will only propagate `X-Cloud-Trace-Context` which this gem helps resolve.
11+
12+
The `X-Cloud-Trace-Context` header has the following format:
13+
14+
```yaml
15+
X-Cloud-Trace-Context: TRACE_ID/SPAN_ID;o=OPTIONS
16+
```
17+
18+
The fields of header are defined as follows:
19+
20+
- `TRACE_ID` is a 32-character hexadecimal value representing a 128-bit number.
21+
- `SPAN_ID` is a 64-bit decimal representation of the unsigned span ID.
22+
- `OPTIONS` supports 0 (parent not sampled) and 1 (parent was sampled).
23+
24+
## What is OpenTelemetry?
25+
26+
[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.
27+
28+
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.
29+
30+
## How does this gem fit in?
31+
32+
This gem can be used with any OpenTelemetry SDK implementation. This can be the official `opentelemetry-sdk` gem or any other concrete implementation.
33+
34+
## How do I get started?
35+
36+
Install the gem using:
37+
38+
```console
39+
gem install opentelemetry-propagator-google_cloud_trace_context
40+
```
41+
42+
Or, if you use [bundler][bundler-home], include `opentelemetry-propagator-google_cloud_trace_context` in your `Gemfile`.
43+
44+
Configure your application to use this propagator by setting the following [environment variable][envars]:
45+
46+
```console
47+
OTEL_PROPAGATORS=google_cloud_trace_context
48+
```
49+
50+
## How can I get involved?
51+
52+
The `opentelemetry-propagator-google_cloud_trace_context` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
53+
54+
The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our [GitHub Discussions][discussions-url], [Slack Channel][slack-channel] 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].
55+
56+
## License
57+
58+
The `opentelemetry-propagator-google_cloud_trace_context` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
59+
60+
[opentelemetry-home]: https://opentelemetry.io
61+
[bundler-home]: https://bundler.io
62+
[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
63+
[license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
64+
[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
65+
[community-meetings]: https://github.com/open-telemetry/community#community-meetings
66+
[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY
67+
[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
68+
[gcp-spec]: https://cloud.google.com/appengine/docs/standard/writing-application-logs
69+
[rfc7230-url]: https://tools.ietf.org/html/rfc7230#section-3.2
70+
[fields-spec-url]: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/context/api-propagators.md#fields
71+
[envars]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/sdk-environment-variables.md#general-sdk-configuration
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# frozen_string_literal: true
2+
3+
# Copyright The OpenTelemetry Authors
4+
#
5+
# SPDX-License-Identifier: Apache-2.0
6+
7+
require 'bundler/gem_tasks'
8+
require 'rake/testtask'
9+
require 'yard'
10+
require 'rubocop/rake_task'
11+
12+
RuboCop::RakeTask.new
13+
14+
Rake::TestTask.new :test do |t|
15+
t.libs << 'test'
16+
t.libs << 'lib'
17+
t.test_files = FileList['test/**/*_test.rb']
18+
end
19+
20+
YARD::Rake::YardocTask.new do |t|
21+
t.stats_options = ['--list-undoc']
22+
end
23+
24+
if RUBY_ENGINE == 'truffleruby'
25+
task default: %i[test]
26+
else
27+
task default: %i[test rubocop yard]
28+
end

0 commit comments

Comments
 (0)