opencensus-stackdriver 0.1.0.pre1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +13 -0
- data/.rubocop.yml +51 -0
- data/.travis.yml +10 -0
- data/AUTHORS +1 -0
- data/CODE_OF_CONDUCT.md +43 -0
- data/CONTRIBUTING.md +34 -0
- data/Gemfile +4 -0
- data/LICENSE +201 -0
- data/README.md +119 -0
- data/Rakefile +21 -0
- data/lib/opencensus-stackdriver.rb +15 -0
- data/lib/opencensus/stackdriver.rb +25 -0
- data/lib/opencensus/stackdriver/version.rb +20 -0
- data/lib/opencensus/trace/exporters/stackdriver.rb +259 -0
- data/lib/opencensus/trace/exporters/stackdriver/converter.rb +356 -0
- data/opencensus-stackdriver.gemspec +38 -0
- metadata +228 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: ad5f1fcb7bd533d8a3a8e8eae93a0082e6aac5fe
|
4
|
+
data.tar.gz: d3d73e9ca8e8e1b0f47e6939cb5c1dab0112e9d3
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 99f5ae94e90715358509816321e348cc1dddcd736840a4215391d4f82625af1bc0efd09734ec1c8ee52e2fb75e416aaf68ed7953923ff2ed066b63e1465db951
|
7
|
+
data.tar.gz: a6c7c7861fd3fb17f0b1e1e1c6112b4b7307ad15d182cbdb71f9a1fa17e9e26f94af373460731bd2becea1b91f9acc30c55fd734b94d825b11e580511e984ac2
|
data/.gitignore
ADDED
data/.rubocop.yml
ADDED
@@ -0,0 +1,51 @@
|
|
1
|
+
AllCops:
|
2
|
+
Exclude:
|
3
|
+
- "acceptance/**/*"
|
4
|
+
- "integration/**/*"
|
5
|
+
- "opencensus-stackdriver.gemspec"
|
6
|
+
- "Rakefile"
|
7
|
+
- "support/**/*"
|
8
|
+
- "test/**/*"
|
9
|
+
- "docs/**/*"
|
10
|
+
- "tmp/**/*"
|
11
|
+
|
12
|
+
Documentation:
|
13
|
+
Enabled: false
|
14
|
+
|
15
|
+
Style/StringLiterals:
|
16
|
+
EnforcedStyle: double_quotes
|
17
|
+
Style/MethodDefParentheses:
|
18
|
+
EnforcedStyle: require_no_parentheses
|
19
|
+
Style/NumericLiterals:
|
20
|
+
Enabled: false
|
21
|
+
Layout/SpaceAroundOperators:
|
22
|
+
Enabled: false
|
23
|
+
Metrics/ClassLength:
|
24
|
+
Enabled: false
|
25
|
+
Layout/EmptyLines:
|
26
|
+
Enabled: false
|
27
|
+
Style/EmptyElse:
|
28
|
+
Enabled: false
|
29
|
+
Metrics/CyclomaticComplexity:
|
30
|
+
Max: 10
|
31
|
+
Metrics/PerceivedComplexity:
|
32
|
+
Max: 10
|
33
|
+
Metrics/AbcSize:
|
34
|
+
Max: 25
|
35
|
+
Metrics/MethodLength:
|
36
|
+
Max: 25
|
37
|
+
Metrics/ParameterLists:
|
38
|
+
Enabled: false
|
39
|
+
Style/RescueModifier:
|
40
|
+
Enabled: false
|
41
|
+
Style/ClassVars:
|
42
|
+
Enabled: false
|
43
|
+
Style/TrivialAccessors:
|
44
|
+
Enabled: false
|
45
|
+
Style/CaseEquality:
|
46
|
+
Enabled: false
|
47
|
+
Style/GuardClause:
|
48
|
+
Enabled: false
|
49
|
+
Naming/FileName:
|
50
|
+
Exclude:
|
51
|
+
- "lib/opencensus-stackdriver.rb"
|
data/.travis.yml
ADDED
data/AUTHORS
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
Google Inc.
|
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,34 @@
|
|
1
|
+
# How to become a contributor and submit your own code
|
2
|
+
|
3
|
+
## Contributor License Agreements
|
4
|
+
|
5
|
+
We'd love to accept your patches! Before we can take them, we
|
6
|
+
have to jump a couple of legal hurdles.
|
7
|
+
|
8
|
+
Please fill out either the individual or corporate Contributor License Agreement
|
9
|
+
(CLA).
|
10
|
+
|
11
|
+
* If you are an individual writing original source code and you're sure you
|
12
|
+
own the intellectual property, then you'll need to sign an [individual CLA]
|
13
|
+
(https://developers.google.com/open-source/cla/individual).
|
14
|
+
* If you work for a company that wants to allow you to contribute your work,
|
15
|
+
then you'll need to sign a [corporate CLA]
|
16
|
+
(https://developers.google.com/open-source/cla/corporate).
|
17
|
+
|
18
|
+
Follow either of the two links above to access the appropriate CLA and
|
19
|
+
instructions for how to sign and return it. Once we receive it, we'll be able to
|
20
|
+
accept your pull requests.
|
21
|
+
|
22
|
+
## Contributing A Patch
|
23
|
+
|
24
|
+
1. Submit an issue describing your proposed change to the repo in question.
|
25
|
+
1. The repo owner will respond to your issue promptly.
|
26
|
+
1. If your proposed change is accepted, and you haven't already done so, sign a
|
27
|
+
Contributor License Agreement (see details above).
|
28
|
+
1. Fork the desired repo, develop and test your code changes.
|
29
|
+
1. Ensure that your code adheres to the existing style in the sample to which
|
30
|
+
you are contributing. Refer to the
|
31
|
+
[Google Cloud Platform Samples Style Guide]
|
32
|
+
(https://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the
|
33
|
+
recommended coding standards for this organization.
|
34
|
+
1. Submit a pull request.
|
data/Gemfile
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 [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
ADDED
@@ -0,0 +1,119 @@
|
|
1
|
+
# Ruby Stackdriver Exporter for OpenCensus
|
2
|
+
|
3
|
+
This repository contains the source to the `opencensus-stackdriver` gem. This
|
4
|
+
library is a plugin for
|
5
|
+
[Ruby OpenCensus](https://github.com/census-instrumentation/opencensus-ruby)
|
6
|
+
that exports data to [Stackdriver](https://cloud.google.com/stackdriver/).
|
7
|
+
|
8
|
+
OpenCensus is a platform- and provider-agnostic framework for distributed
|
9
|
+
tracing and stats collection. For more information, see https://opencensus.io.
|
10
|
+
|
11
|
+
This library is in an alpha stage, and the API is subject to change.
|
12
|
+
|
13
|
+
## Quick Start
|
14
|
+
|
15
|
+
### Installation
|
16
|
+
|
17
|
+
Install the gem using Bundler:
|
18
|
+
|
19
|
+
1. Add the `opencensus-stackdriver` gem to your application's Gemfile:
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
gem "opencensus-stackdriver"
|
23
|
+
```
|
24
|
+
|
25
|
+
2. Use Bundler to install the gem:
|
26
|
+
|
27
|
+
```sh
|
28
|
+
$ bundle install
|
29
|
+
```
|
30
|
+
|
31
|
+
The core `opencensus` gem and the `google-cloud-trace` client library for the
|
32
|
+
Stackdriver API will be installed automatically as dependencies.
|
33
|
+
|
34
|
+
### Installing the plugin
|
35
|
+
|
36
|
+
The Stackdriver plugin can be installed using OpenCensus configuration.
|
37
|
+
Insert the following code in your application's initialization:
|
38
|
+
|
39
|
+
```ruby
|
40
|
+
OpenCensus.configure do |c|
|
41
|
+
c.trace.exporter = OpenCensus::Trace::Exporters::Stackdriver.new
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
If you are using **Ruby on Rails**, you can equivalently include this code in
|
46
|
+
your Rails config:
|
47
|
+
|
48
|
+
```ruby
|
49
|
+
config.opencensus.trace.exporter = OpenCensus::Trace::Exporters::Stackdriver.new
|
50
|
+
```
|
51
|
+
|
52
|
+
See the documentation for
|
53
|
+
[OpenCensus::Trace::Exporters::Stackdriver](http://www.rubydoc.info/gems/opencensus-stackdriver/OpenCensus/Trace/Exporters/Stackdriver)
|
54
|
+
for information on the configuration options for the Stackdriver exporter.
|
55
|
+
|
56
|
+
You can find more general information on using OpenCensus from Ruby, including
|
57
|
+
configuring automatic trace capture and adding custom spans, in the
|
58
|
+
[core `opencensus` README](https://github.com/census-instrumentation/opencensus-ruby).
|
59
|
+
|
60
|
+
### Connecting to Stackdriver
|
61
|
+
|
62
|
+
If you do not have a Google Cloud project, create one from the
|
63
|
+
[cloud console](https://console.cloud.google.com/).
|
64
|
+
|
65
|
+
The Stackdriver plugin needs credentials for your project in order to export
|
66
|
+
traces to the Stackdriver backend. If your application is running in Google
|
67
|
+
Cloud Platform hosting (i.e.
|
68
|
+
[Google App Engine](https://cloud.google.com/appengine/),
|
69
|
+
[Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/), or
|
70
|
+
[Google Compute Engine](https://cloud.google.com/compute/)), then the plugin
|
71
|
+
can generally retrieve the needed credentials automatically from the runtime
|
72
|
+
environment. See
|
73
|
+
[this section](https://github.com/GoogleCloudPlatform/google-cloud-ruby/tree/master/google-cloud-trace#running-on-google-cloud-platform)
|
74
|
+
from the `google-cloud-trace` README for details.
|
75
|
+
|
76
|
+
If you are running the application locally, in self-hosted VMs, or a third
|
77
|
+
party hosting service, you will need to provide the project ID and credentials
|
78
|
+
(keyfile) to the Google Cloud client library. See
|
79
|
+
[this section](https://github.com/GoogleCloudPlatform/google-cloud-ruby/tree/master/google-cloud-trace#running-locally-and-elsewhere)
|
80
|
+
for details.
|
81
|
+
|
82
|
+
Either way, once you have the Stackdriver exporter configured, you can view
|
83
|
+
traces on the [Google Cloud Console](https://console.cloud.google.com/traces).
|
84
|
+
|
85
|
+
## About the library
|
86
|
+
|
87
|
+
### Supported Ruby Versions
|
88
|
+
|
89
|
+
This library is supported on Ruby 2.2+.
|
90
|
+
|
91
|
+
However, Ruby 2.3 or later is strongly recommended, as earlier releases have
|
92
|
+
reached or are nearing end-of-life. After June 1, 2018, OpenCensus will provide
|
93
|
+
official support only for Ruby versions that are considered current and
|
94
|
+
supported by Ruby Core (that is, Ruby versions that are either in normal
|
95
|
+
maintenance or in security maintenance).
|
96
|
+
See https://www.ruby-lang.org/en/downloads/branches/ for further details.
|
97
|
+
|
98
|
+
### Versioning
|
99
|
+
|
100
|
+
This library follows [Semantic Versioning](http://semver.org/).
|
101
|
+
|
102
|
+
It is currently in major version zero (0.y.z), which means that anything may
|
103
|
+
change at any time, and the public API should not be considered stable.
|
104
|
+
|
105
|
+
## Contributing
|
106
|
+
|
107
|
+
Contributions to this library are always welcome and highly encouraged.
|
108
|
+
|
109
|
+
See the [Contributing Guide](CONTRIBUTING.md) for more information on how to get
|
110
|
+
started.
|
111
|
+
|
112
|
+
Please note that this project is released with a Contributor Code of Conduct. By
|
113
|
+
participating in this project you agree to abide by its terms. See
|
114
|
+
[Code of Conduct](CODE_OF_CONDUCT.md) for more information.
|
115
|
+
|
116
|
+
## License
|
117
|
+
|
118
|
+
This library is licensed under Apache 2.0. Full license text is available in
|
119
|
+
[LICENSE](LICENSE).
|