opentelemetry-exporter-google_cloud_trace 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardopts +2 -4
- data/AUTHENTICATION.md +142 -0
- data/CHANGELOG.md +7 -1
- data/CODE_OF_CONDUCT.md +43 -0
- data/CONTRIBUTING.md +138 -0
- data/LICENSE +201 -0
- data/README.md +17 -4
- data/lib/opentelemetry/exporter/google_cloud_trace/translator.rb +1 -1
- data/lib/opentelemetry/exporter/google_cloud_trace/version.rb +1 -1
- data/opentelemetry-exporter-google_cloud_trace.gemspec +1 -0
- metadata +20 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dde7c2c47b221ddf40c006a38bb44ec95928163e96d7ed53477079a58ec5a943
|
4
|
+
data.tar.gz: cae17928647aea9e49f63d13899d63a4c8b09f88b3b7c9c92e0e9830cf3ba88e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c388e7a28405db97f1668bfddaeb11b7d321fa58eae9863e016118605c4fdd7efd135a16f782956f33c2fc211fff9958c8b8c566f25d8d526d0f18cb2b2a3780
|
7
|
+
data.tar.gz: 197a9f24498ceba6029ea99685afdf664cea81ebb41b13be390f9dbb8e4e239198c690578ef450aac47d2afb0ac3a8dedf80b21601333095465b2e2a564168ba
|
data/.yardopts
CHANGED
@@ -3,15 +3,13 @@
|
|
3
3
|
--exclude _pb\.rb$
|
4
4
|
--markup markdown
|
5
5
|
--markup-provider redcarpet
|
6
|
-
--
|
6
|
+
--readme README.md
|
7
7
|
|
8
8
|
./lib/**/*.rb
|
9
9
|
-
|
10
|
-
|
10
|
+
README.md
|
11
11
|
AUTHENTICATION.md
|
12
|
-
LOGGING.md
|
13
12
|
CONTRIBUTING.md
|
14
|
-
TROUBLESHOOTING.md
|
15
13
|
CHANGELOG.md
|
16
14
|
CODE_OF_CONDUCT.md
|
17
15
|
LICENSE
|
data/AUTHENTICATION.md
ADDED
@@ -0,0 +1,142 @@
|
|
1
|
+
# Authentication
|
2
|
+
|
3
|
+
In general, the library uses [Service
|
4
|
+
Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
|
5
|
+
credentials to connect to Google Cloud services. When running within [Google
|
6
|
+
Cloud Platform environments](#google-cloud-platform-environments)
|
7
|
+
the credentials will be discovered automatically. When running on other
|
8
|
+
environments, the Service Account credentials can be specified by providing the
|
9
|
+
path to the [JSON
|
10
|
+
keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
|
11
|
+
the account (or the JSON itself) in [environment
|
12
|
+
variables](#environment-variables). Additionally, Cloud SDK credentials can also
|
13
|
+
be discovered automatically, but this is only recommended during development.
|
14
|
+
|
15
|
+
## Quickstart
|
16
|
+
|
17
|
+
1. [Create a service account and credentials](#creating-a-service-account).
|
18
|
+
2. Set the [environment variable](#environment-variables).
|
19
|
+
|
20
|
+
```sh
|
21
|
+
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/json`
|
22
|
+
```
|
23
|
+
|
24
|
+
3. Initialize the exporter.
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
OpenTelemetry::Exporter::GoogleCloudTrace::CloudTraceSpanExporter.new
|
28
|
+
```
|
29
|
+
|
30
|
+
## Project and Credential Lookup
|
31
|
+
|
32
|
+
The library aims to make authentication as simple as
|
33
|
+
possible, and provides several mechanisms to configure your system
|
34
|
+
without providing **Project ID** and **Service Account Credentials** directly in
|
35
|
+
code.
|
36
|
+
|
37
|
+
**Project ID** is discovered in the following order:
|
38
|
+
|
39
|
+
1. Specify project ID in method arguments
|
40
|
+
2. Specify project ID in configuration
|
41
|
+
3. Discover project ID in environment variables
|
42
|
+
4. Discover GCE project ID
|
43
|
+
5. Discover project ID in credentials JSON
|
44
|
+
|
45
|
+
**Credentials** are discovered in the following order:
|
46
|
+
|
47
|
+
1. Specify credentials in method arguments
|
48
|
+
2. Specify credentials in configuration
|
49
|
+
3. Discover credentials path in environment variables
|
50
|
+
4. Discover credentials JSON in environment variables
|
51
|
+
5. Discover credentials file in the Cloud SDK's path
|
52
|
+
6. Discover GCE credentials
|
53
|
+
|
54
|
+
### Google Cloud Platform environments
|
55
|
+
|
56
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine (GCE),
|
57
|
+
Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud Functions
|
58
|
+
(GCF) and Cloud Run, the **Project ID** and **Credentials** and are discovered
|
59
|
+
automatically. Code should be written as if already authenticated.
|
60
|
+
|
61
|
+
### Environment Variables
|
62
|
+
|
63
|
+
The **Project ID** and **Credentials JSON** can be placed in environment
|
64
|
+
variables instead of declaring them directly in code.
|
65
|
+
The path to the **Credentials JSON** file can be stored in the
|
66
|
+
environment variable, or the **Credentials JSON** itself can be stored for
|
67
|
+
environments such as Docker containers where writing files is difficult or not
|
68
|
+
encouraged.
|
69
|
+
|
70
|
+
The environment variables that library checks for project ID are:
|
71
|
+
|
72
|
+
1. `GOOGLE_CLOUD_PROJECT`
|
73
|
+
|
74
|
+
The environment variables that library checks for credentials:
|
75
|
+
|
76
|
+
1. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
77
|
+
2. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
|
78
|
+
3. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
79
|
+
|
80
|
+
|
81
|
+
### Cloud SDK
|
82
|
+
|
83
|
+
This option allows for an easy way to authenticate during development. If
|
84
|
+
credentials are not provided in code or in environment variables, then Cloud SDK
|
85
|
+
credentials are discovered.
|
86
|
+
|
87
|
+
To configure your system for this, simply:
|
88
|
+
|
89
|
+
1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
|
90
|
+
2. Authenticate using OAuth 2.0 `$ gcloud auth login`
|
91
|
+
3. Write code as if already authenticated.
|
92
|
+
|
93
|
+
**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
|
94
|
+
*should* only be used during development.
|
95
|
+
|
96
|
+
[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
|
97
|
+
[dev-console]: https://console.cloud.google.com/project
|
98
|
+
|
99
|
+
[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
|
100
|
+
|
101
|
+
[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
|
102
|
+
[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
|
103
|
+
[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
|
104
|
+
|
105
|
+
## Creating a Service Account
|
106
|
+
|
107
|
+
Google Cloud requires a **Project ID** and **Service Account Credentials** to
|
108
|
+
connect to the APIs. You will use the **Project ID** and **JSON key file** to
|
109
|
+
connect to most services with the library.
|
110
|
+
|
111
|
+
If you are not running this client within [Google Cloud Platform
|
112
|
+
environments](#google-cloud-platform-environments), you need a Google
|
113
|
+
Developers service account.
|
114
|
+
|
115
|
+
1. Visit the [Google Developers Console][dev-console].
|
116
|
+
1. Create a new project or click on an existing project.
|
117
|
+
1. Activate the slide-out navigation tray and select **API Manager**. From
|
118
|
+
here, you will enable the APIs that your application requires.
|
119
|
+
|
120
|
+
![Enable the APIs that your application requires][enable-apis]
|
121
|
+
|
122
|
+
*Note: You may need to enable billing in order to use these services.*
|
123
|
+
|
124
|
+
1. Select **Credentials** from the side navigation.
|
125
|
+
|
126
|
+
You should see a screen like one of the following.
|
127
|
+
|
128
|
+
![Create a new service account][create-new-service-account]
|
129
|
+
|
130
|
+
![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
|
131
|
+
|
132
|
+
Find the "Add credentials" drop down and select "Service account" to be
|
133
|
+
guided through downloading a new JSON key file.
|
134
|
+
|
135
|
+
If you want to re-use an existing service account, you can easily generate a
|
136
|
+
new key file. Just select the account you wish to re-use, and click "Generate
|
137
|
+
new JSON key":
|
138
|
+
|
139
|
+
![Re-use an existing service account][reuse-service-account]
|
140
|
+
|
141
|
+
The key file you download will be used by this library to authenticate API
|
142
|
+
requests and should be stored in a secure location.
|
data/CHANGELOG.md
CHANGED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,43 @@
|
|
1
|
+
# Contributor Code of Conduct
|
2
|
+
|
3
|
+
As contributors and maintainers of this project,
|
4
|
+
and in the interest of fostering an open and welcoming community,
|
5
|
+
we pledge to respect all people who contribute through reporting issues,
|
6
|
+
posting feature requests, updating documentation,
|
7
|
+
submitting pull requests or patches, and other activities.
|
8
|
+
|
9
|
+
We are committed to making participation in this project
|
10
|
+
a harassment-free experience for everyone,
|
11
|
+
regardless of level of experience, gender, gender identity and expression,
|
12
|
+
sexual orientation, disability, personal appearance,
|
13
|
+
body size, race, ethnicity, age, religion, or nationality.
|
14
|
+
|
15
|
+
Examples of unacceptable behavior by participants include:
|
16
|
+
|
17
|
+
* The use of sexualized language or imagery
|
18
|
+
* Personal attacks
|
19
|
+
* Trolling or insulting/derogatory comments
|
20
|
+
* Public or private harassment
|
21
|
+
* Publishing other's private information,
|
22
|
+
such as physical or electronic
|
23
|
+
addresses, without explicit permission
|
24
|
+
* Other unethical or unprofessional conduct.
|
25
|
+
|
26
|
+
Project maintainers have the right and responsibility to remove, edit, or reject
|
27
|
+
comments, commits, code, wiki edits, issues, and other contributions
|
28
|
+
that are not aligned to this Code of Conduct.
|
29
|
+
By adopting this Code of Conduct,
|
30
|
+
project maintainers commit themselves to fairly and consistently
|
31
|
+
applying these principles to every aspect of managing this project.
|
32
|
+
Project maintainers who do not follow or enforce the Code of Conduct
|
33
|
+
may be permanently removed from the project team.
|
34
|
+
|
35
|
+
This code of conduct applies both within project spaces and in public spaces
|
36
|
+
when an individual is representing the project or its community.
|
37
|
+
|
38
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior
|
39
|
+
may be reported by opening an issue
|
40
|
+
or contacting one or more of the project maintainers.
|
41
|
+
|
42
|
+
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0,
|
43
|
+
available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
|
data/CONTRIBUTING.md
ADDED
@@ -0,0 +1,138 @@
|
|
1
|
+
# Contributing to OpenTelemetry operations Ruby
|
2
|
+
|
3
|
+
1. **Sign one of the contributor license agreements below.**
|
4
|
+
2. Fork the repo, develop and test your code changes.
|
5
|
+
3. Send a pull request.
|
6
|
+
|
7
|
+
## Contributor License Agreements
|
8
|
+
|
9
|
+
Before we can accept your pull requests you'll need to sign a Contributor
|
10
|
+
License Agreement (CLA):
|
11
|
+
|
12
|
+
- **If you are an individual writing original source code** and **you own the
|
13
|
+
intellectual property**, then you'll need to sign an [individual
|
14
|
+
CLA](https://developers.google.com/open-source/cla/individual).
|
15
|
+
- **If you work for a company that wants to allow you to contribute your work**,
|
16
|
+
then you'll need to sign a [corporate
|
17
|
+
CLA](https://developers.google.com/open-source/cla/corporate).
|
18
|
+
|
19
|
+
You can sign these electronically (just scroll to the bottom). After that, we'll
|
20
|
+
be able to accept your pull requests.
|
21
|
+
|
22
|
+
## Setup
|
23
|
+
|
24
|
+
This is a mono repo that will contain tools that will support OpenTelemetry instrumentation for Google Cloud using Ruby.
|
25
|
+
|
26
|
+
1. Install Ruby. OpenTelemetry operations Ruby requires Ruby 2.7+. You may choose to
|
27
|
+
manage your Ruby and gem installations with [RVM](https://rvm.io/),
|
28
|
+
[rbenv](https://github.com/rbenv/rbenv), or
|
29
|
+
[chruby](https://github.com/postmodern/chruby), or
|
30
|
+
[asdf](https://github.com/asdf-vm/asdf).
|
31
|
+
|
32
|
+
2. Install [Bundler](http://bundler.io/).
|
33
|
+
|
34
|
+
```sh
|
35
|
+
$ gem install bundler
|
36
|
+
```
|
37
|
+
|
38
|
+
3. Install the top-level project dependencies.
|
39
|
+
|
40
|
+
```sh
|
41
|
+
$ bundle install
|
42
|
+
```
|
43
|
+
|
44
|
+
4. Install the specific tool dependencies.
|
45
|
+
|
46
|
+
```sh
|
47
|
+
$ cd opentelemetry-exporter-google_cloud_trace/
|
48
|
+
$ bundle install
|
49
|
+
```
|
50
|
+
|
51
|
+
## GCP trace exporter tests
|
52
|
+
|
53
|
+
Tests are very important part of OpenTelemetry operations Ruby. All contributions
|
54
|
+
should include tests that ensure the contributed code behaves as expected.
|
55
|
+
|
56
|
+
To run the unit tests, documentation tests, and code style checks together for a
|
57
|
+
package:
|
58
|
+
|
59
|
+
``` sh
|
60
|
+
$ cd opentelemetry-exporter-google_cloud_trace/
|
61
|
+
$ bundle exec rake ci
|
62
|
+
```
|
63
|
+
|
64
|
+
To run the command above, plus all acceptance tests, use `rake ci:acceptance` or
|
65
|
+
its handy alias, `rake ci:a`.
|
66
|
+
|
67
|
+
### Unit Tests
|
68
|
+
|
69
|
+
|
70
|
+
The project uses the [minitest](https://github.com/seattlerb/minitest) library and
|
71
|
+
[mocks](https://github.com/seattlerb/minitest#mocks).
|
72
|
+
|
73
|
+
To run the unit tests:
|
74
|
+
|
75
|
+
``` sh
|
76
|
+
$ cd opentelemetry-exporter-google_cloud_trace/
|
77
|
+
$ bundle exec rake test
|
78
|
+
```
|
79
|
+
|
80
|
+
|
81
|
+
### Acceptance Tests
|
82
|
+
|
83
|
+
The acceptance tests interact with the live service API. Follow the
|
84
|
+
instructions in the {file:AUTHENTICATION.md Authentication Guide} for enabling
|
85
|
+
the required API. Occasionally, some API features may not yet be generally
|
86
|
+
available, making it difficult for some contributors to successfully run the
|
87
|
+
entire acceptance test suite. However, please ensure that you do successfully
|
88
|
+
run acceptance tests for any code areas covered by your pull request.
|
89
|
+
|
90
|
+
To run the acceptance tests, first create and configure a project in the Google
|
91
|
+
Developers Console, as described in the
|
92
|
+
{file:AUTHENTICATION.md Authentication Guide}. Be sure to download the JSON KEY
|
93
|
+
file. Make note of the PROJECT_ID and the KEYFILE location on your system.
|
94
|
+
|
95
|
+
|
96
|
+
#### Running the acceptance tests
|
97
|
+
|
98
|
+
To run the acceptance tests:
|
99
|
+
|
100
|
+
``` sh
|
101
|
+
$ cd opentelemetry-exporter-google_cloud_trace/
|
102
|
+
$ bundle exec rake acceptance[\\{my-project-id},\\{/path/to/keyfile.json}]
|
103
|
+
```
|
104
|
+
|
105
|
+
Or, if you prefer you can store the values in the `GCLOUD_TEST_PROJECT` and
|
106
|
+
`GCLOUD_TEST_KEYFILE` environment variables:
|
107
|
+
|
108
|
+
``` sh
|
109
|
+
$ cd opentelemetry-exporter-google_cloud_trace/
|
110
|
+
$ export GCLOUD_TEST_PROJECT=\\{my-project-id}
|
111
|
+
$ export GCLOUD_TEST_KEYFILE=\\{/path/to/keyfile.json}
|
112
|
+
$ bundle exec rake acceptance
|
113
|
+
```
|
114
|
+
|
115
|
+
|
116
|
+
## Coding Style
|
117
|
+
|
118
|
+
Please follow the established coding style in the library. The style is is
|
119
|
+
largely based on [The Ruby Style
|
120
|
+
Guide](https://github.com/bbatsov/ruby-style-guide) with a few exceptions based
|
121
|
+
on seattle-style:
|
122
|
+
|
123
|
+
* Avoid parenthesis when possible, including in method definitions.
|
124
|
+
* Always use double quotes strings. ([Option
|
125
|
+
B](https://github.com/bbatsov/ruby-style-guide#strings))
|
126
|
+
|
127
|
+
You can check your code against these rules by running Rubocop like so:
|
128
|
+
|
129
|
+
```sh
|
130
|
+
$ cd opentelemetry-exporter-google_cloud_trace/
|
131
|
+
$ bundle exec rake rubocop
|
132
|
+
```
|
133
|
+
|
134
|
+
## Code of Conduct
|
135
|
+
|
136
|
+
Please note that this project is released with a Contributor Code of Conduct. By
|
137
|
+
participating in this project you agree to abide by its terms. See the
|
138
|
+
{file:CODE_OF_CONDUCT.md Code of Conduct} for more information.
|
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 [yyyy] [name of copyright owner]
|
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
CHANGED
@@ -10,24 +10,37 @@ $ gem install opentelemetry-exporter-google_cloud_trace
|
|
10
10
|
|
11
11
|
## Usage
|
12
12
|
|
13
|
-
|
13
|
+
```
|
14
|
+
require 'opentelemetry/sdk'
|
15
|
+
require 'opentelemetry/instrumentation/all'
|
16
|
+
require 'opentelemetry/exporter/google_cloud_trace'
|
17
|
+
OpenTelemetry::SDK.configure do |c|
|
18
|
+
c.service_name = 'test_app'
|
19
|
+
c.add_span_processor(
|
20
|
+
OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
|
21
|
+
OpenTelemetry::Exporter::GoogleCloudTrace::SpanExporter.new
|
22
|
+
)
|
23
|
+
)
|
24
|
+
c.use_all() # enables all instrumentation!
|
25
|
+
end
|
26
|
+
```
|
14
27
|
|
15
28
|
## Contributing
|
16
29
|
|
17
30
|
Contributions to this library are always welcome and highly encouraged.
|
18
31
|
|
19
|
-
See the {file
|
32
|
+
See the {file:CONTRIBUTING.md Contributing Guide}
|
20
33
|
for more information on how to get started.
|
21
34
|
|
22
35
|
Please note that this project is released with a Contributor Code of Conduct. By
|
23
36
|
participating in this project you agree to abide by its terms.
|
24
|
-
See {file
|
37
|
+
See {file:CODE_OF_CONDUCT.md Code of Conduct}
|
25
38
|
for more information.
|
26
39
|
|
27
40
|
## License
|
28
41
|
|
29
42
|
This library is licensed under Apache 2.0. Full license text is available in
|
30
|
-
[LICENSE](
|
43
|
+
[LICENSE](LICENSE).
|
31
44
|
|
32
45
|
## Support
|
33
46
|
|
@@ -59,7 +59,7 @@ module OpenTelemetry
|
|
59
59
|
|
60
60
|
# Creates batch_write_spans_request from opentelemetry spans
|
61
61
|
#
|
62
|
-
# @param [Enumerable<OpenTelemetry::SDK::Trace::SpanData>]
|
62
|
+
# @param [Enumerable<OpenTelemetry::SDK::Trace::SpanData>] spans the
|
63
63
|
# list of recorded {OpenTelemetry::SDK::Trace::SpanData} structs to be
|
64
64
|
# exported.
|
65
65
|
# @return [Google::Cloud::Trace::V2::BatchWriteSpansRequest]
|
@@ -53,6 +53,7 @@ Gem::Specification.new do |spec|
|
|
53
53
|
spec.add_development_dependency "minitest-hooks"
|
54
54
|
spec.add_development_dependency "minitest-rg", "~> 5.2"
|
55
55
|
spec.add_development_dependency "opentelemetry-instrumentation-sinatra"
|
56
|
+
spec.add_development_dependency "redcarpet", "~> 3.0"
|
56
57
|
spec.add_development_dependency "sinatra"
|
57
58
|
spec.add_development_dependency "webrick"
|
58
59
|
spec.add_development_dependency "yard", "~> 0.9"
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: opentelemetry-exporter-google_cloud_trace
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Nivedha
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-07-
|
11
|
+
date: 2023-07-27 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-cloud-env
|
@@ -178,6 +178,20 @@ dependencies:
|
|
178
178
|
- - ">="
|
179
179
|
- !ruby/object:Gem::Version
|
180
180
|
version: '0'
|
181
|
+
- !ruby/object:Gem::Dependency
|
182
|
+
name: redcarpet
|
183
|
+
requirement: !ruby/object:Gem::Requirement
|
184
|
+
requirements:
|
185
|
+
- - "~>"
|
186
|
+
- !ruby/object:Gem::Version
|
187
|
+
version: '3.0'
|
188
|
+
type: :development
|
189
|
+
prerelease: false
|
190
|
+
version_requirements: !ruby/object:Gem::Requirement
|
191
|
+
requirements:
|
192
|
+
- - "~>"
|
193
|
+
- !ruby/object:Gem::Version
|
194
|
+
version: '3.0'
|
181
195
|
- !ruby/object:Gem::Dependency
|
182
196
|
name: sinatra
|
183
197
|
requirement: !ruby/object:Gem::Requirement
|
@@ -244,8 +258,12 @@ extra_rdoc_files: []
|
|
244
258
|
files:
|
245
259
|
- ".rubocop.yml"
|
246
260
|
- ".yardopts"
|
261
|
+
- AUTHENTICATION.md
|
247
262
|
- CHANGELOG.md
|
263
|
+
- CODE_OF_CONDUCT.md
|
264
|
+
- CONTRIBUTING.md
|
248
265
|
- Gemfile
|
266
|
+
- LICENSE
|
249
267
|
- README.md
|
250
268
|
- Rakefile
|
251
269
|
- acceptance/sinatra/gcp_trace_exporter_test.rb
|