stackdriver-core 1.3.1 → 1.3.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +30 -0
- data/CODE_OF_CONDUCT.md +40 -0
- data/CONTRIBUTING.md +128 -0
- data/OVERVIEW.md +5 -0
- data/lib/stackdriver/core/version.rb +1 -1
- metadata +6 -3
- data/README.md +0 -52
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c1cb8e069c53baee9ea5a4307745e705cd7c578a61a601fc91420624803757c9
|
|
4
|
+
data.tar.gz: e16532604b2344d8aa8a026f59ff13d28201b3d45c6e181838426d5da39e155d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 11b414993c7fd8f464a595cb58d4bccf9dc04ad540569e802fe95ab83f16b2fcf62081369bc039c9da4cc2590c44b7d25780d0d02cde560aef56a49f0dd7f002
|
|
7
|
+
data.tar.gz: 829f44bd0c7a193eda37123f8c171222988c98294e1ffd01cc72c00d60261637b6e65420240296f1ea95435c265466c80bc7bb56f43102f9e2758608f799d6b7
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Release History
|
|
2
|
+
|
|
3
|
+
### 1.3.2 / 2018-09-12
|
|
4
|
+
|
|
5
|
+
* Add missing documentation files to package.
|
|
6
|
+
|
|
7
|
+
### 1.3.1 / 2018-09-10
|
|
8
|
+
|
|
9
|
+
* Update documentation.
|
|
10
|
+
|
|
11
|
+
### 1.3.0 / 2018-02-27
|
|
12
|
+
|
|
13
|
+
* Use Google Cloud Shared Configuration.
|
|
14
|
+
|
|
15
|
+
### 1.2.0 / 2017-07-11
|
|
16
|
+
|
|
17
|
+
* Introduce `Stackdriver::Core::AsyncActor` module, used by stackdriver gems to perform asynchronous jobs.
|
|
18
|
+
|
|
19
|
+
### 1.1.0 / 2017-05-25
|
|
20
|
+
|
|
21
|
+
* Introduce new Stackdriver instrumentation configuration interface.
|
|
22
|
+
|
|
23
|
+
### 1.0.0 / 2017-03-31
|
|
24
|
+
|
|
25
|
+
* Release 1.0
|
|
26
|
+
|
|
27
|
+
### 0.21.0 / 2016-12-22
|
|
28
|
+
|
|
29
|
+
* Initial release of shared code for Stackdriver related client libraries.
|
|
30
|
+
* Provided trace context management code.
|
data/CODE_OF_CONDUCT.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Contributor Code of Conduct
|
|
2
|
+
|
|
3
|
+
As contributors and maintainers of this project, and in the interest of
|
|
4
|
+
fostering an open and welcoming community, we pledge to respect all people who
|
|
5
|
+
contribute through reporting issues, posting feature requests, updating
|
|
6
|
+
documentation, submitting pull requests or patches, and other activities.
|
|
7
|
+
|
|
8
|
+
We are committed to making participation in this project a harassment-free
|
|
9
|
+
experience for everyone, regardless of level of experience, gender, gender
|
|
10
|
+
identity and expression, sexual orientation, disability, personal appearance,
|
|
11
|
+
body size, race, ethnicity, age, religion, or nationality.
|
|
12
|
+
|
|
13
|
+
Examples of unacceptable behavior by participants include:
|
|
14
|
+
|
|
15
|
+
* The use of sexualized language or imagery
|
|
16
|
+
* Personal attacks
|
|
17
|
+
* Trolling or insulting/derogatory comments
|
|
18
|
+
* Public or private harassment
|
|
19
|
+
* Publishing other's private information, such as physical or electronic
|
|
20
|
+
addresses, without explicit permission
|
|
21
|
+
* Other unethical or unprofessional conduct.
|
|
22
|
+
|
|
23
|
+
Project maintainers have the right and responsibility to remove, edit, or reject
|
|
24
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
25
|
+
not aligned to this Code of Conduct. By adopting this Code of Conduct, project
|
|
26
|
+
maintainers commit themselves to fairly and consistently applying these
|
|
27
|
+
principles to every aspect of managing this project. Project maintainers who do
|
|
28
|
+
not follow or enforce the Code of Conduct may be permanently removed from the
|
|
29
|
+
project team.
|
|
30
|
+
|
|
31
|
+
This code of conduct applies both within project spaces and in public spaces
|
|
32
|
+
when an individual is representing the project or its community.
|
|
33
|
+
|
|
34
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
35
|
+
reported by opening an issue or contacting one or more of the project
|
|
36
|
+
maintainers.
|
|
37
|
+
|
|
38
|
+
This Code of Conduct is adapted from the [Contributor
|
|
39
|
+
Covenant](http://contributor-covenant.org), version 1.2.0, available at
|
|
40
|
+
[http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
|
data/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# Contributing to Google Cloud Stackdriver
|
|
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
|
+
In order to use the stackdriver console and run the project's tests,
|
|
25
|
+
there is a small amount of setup:
|
|
26
|
+
|
|
27
|
+
1. Install Ruby. stackdriver requires Ruby 2.3+. You may choose to
|
|
28
|
+
manage your Ruby and gem installations with [RVM](https://rvm.io/),
|
|
29
|
+
[rbenv](https://github.com/rbenv/rbenv), or
|
|
30
|
+
[chruby](https://github.com/postmodern/chruby).
|
|
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 Stackdriver dependencies.
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
$ cd stackdriver-core/
|
|
48
|
+
$ bundle exec rake bundleupdate
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Stackdriver Tests
|
|
52
|
+
|
|
53
|
+
Tests are very important part of stackdriver. 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 stackdriver-core/
|
|
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
|
+
### Stackdriver Unit Tests
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
The project uses the [minitest](https://github.com/seattlerb/minitest) library,
|
|
71
|
+
including [specs](https://github.com/seattlerb/minitest#specs),
|
|
72
|
+
[mocks](https://github.com/seattlerb/minitest#mocks) and
|
|
73
|
+
[minitest-autotest](https://github.com/seattlerb/minitest-autotest).
|
|
74
|
+
|
|
75
|
+
To run the Stackdriver unit tests:
|
|
76
|
+
|
|
77
|
+
``` sh
|
|
78
|
+
$ cd stackdriver-core/
|
|
79
|
+
$ bundle exec rake test
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Stackdriver Documentation Tests
|
|
83
|
+
|
|
84
|
+
The project tests the code examples in the gem's
|
|
85
|
+
[YARD](https://github.com/lsegal/yard)-based documentation.
|
|
86
|
+
|
|
87
|
+
The example testing functions in a way that is very similar to unit testing, and
|
|
88
|
+
in fact the library providing it,
|
|
89
|
+
[yard-doctest](https://github.com/p0deje/yard-doctest), is based on the
|
|
90
|
+
project's unit test library, [minitest](https://github.com/seattlerb/minitest).
|
|
91
|
+
|
|
92
|
+
To run the Stackdriver documentation tests:
|
|
93
|
+
|
|
94
|
+
``` sh
|
|
95
|
+
$ cd stackdriver-core/
|
|
96
|
+
$ bundle exec rake doctest
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
If you add, remove or modify documentation examples when working on a pull
|
|
100
|
+
request, you may need to update the setup for the tests. The stubs and mocks
|
|
101
|
+
required to run the tests are located in `support/doctest_helper.rb`. Please
|
|
102
|
+
note that much of the setup is matched by the title of the
|
|
103
|
+
[`@example`](http://www.rubydoc.info/gems/yard/file/docs/Tags.md#example) tag.
|
|
104
|
+
If you alter an example's title, you may encounter breaking tests.
|
|
105
|
+
|
|
106
|
+
## Coding Style
|
|
107
|
+
|
|
108
|
+
Please follow the established coding style in the library. The style is is
|
|
109
|
+
largely based on [The Ruby Style
|
|
110
|
+
Guide](https://github.com/bbatsov/ruby-style-guide) with a few exceptions based
|
|
111
|
+
on seattle-style:
|
|
112
|
+
|
|
113
|
+
* Avoid parenthesis when possible, including in method definitions.
|
|
114
|
+
* Always use double quotes strings. ([Option
|
|
115
|
+
B](https://github.com/bbatsov/ruby-style-guide#strings))
|
|
116
|
+
|
|
117
|
+
You can check your code against these rules by running Rubocop like so:
|
|
118
|
+
|
|
119
|
+
```sh
|
|
120
|
+
$ cd stackdriver-core/
|
|
121
|
+
$ bundle exec rake rubocop
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
## Code of Conduct
|
|
125
|
+
|
|
126
|
+
Please note that this project is released with a Contributor Code of Conduct. By
|
|
127
|
+
participating in this project you agree to abide by its terms. See
|
|
128
|
+
{file:CODE_OF_CONDUCT.md Code of Conduct} for more information.
|
data/OVERVIEW.md
ADDED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: stackdriver-core
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.3.
|
|
4
|
+
version: 1.3.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Daniel Azuma
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2018-09-
|
|
11
|
+
date: 2018-09-12 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: google-cloud-core
|
|
@@ -173,8 +173,11 @@ extensions: []
|
|
|
173
173
|
extra_rdoc_files: []
|
|
174
174
|
files:
|
|
175
175
|
- ".yardopts"
|
|
176
|
+
- CHANGELOG.md
|
|
177
|
+
- CODE_OF_CONDUCT.md
|
|
178
|
+
- CONTRIBUTING.md
|
|
176
179
|
- LICENSE
|
|
177
|
-
-
|
|
180
|
+
- OVERVIEW.md
|
|
178
181
|
- lib/stackdriver-core.rb
|
|
179
182
|
- lib/stackdriver/core.rb
|
|
180
183
|
- lib/stackdriver/core/async_actor.rb
|
data/README.md
DELETED
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
# stackdriver-core
|
|
2
|
-
|
|
3
|
-
This library contains shared types and utilities for Stackdriver-related
|
|
4
|
-
libraries. Please see the [GitHub
|
|
5
|
-
repository](https://github.com/GoogleCloudPlatform/google-cloud-ruby) for more
|
|
6
|
-
information about the individual google-cloud gems.
|
|
7
|
-
|
|
8
|
-
- [stackdriver-core API documentation](http://googlecloudplatform.github.io/google-cloud-ruby/docs/stackdriver-core/latest)
|
|
9
|
-
|
|
10
|
-
## Supported Ruby Versions
|
|
11
|
-
|
|
12
|
-
This library is supported on Ruby 2.3+.
|
|
13
|
-
|
|
14
|
-
Google provides official support for Ruby versions that are actively supported
|
|
15
|
-
by Ruby Core—that is, Ruby versions that are either in normal maintenance or in
|
|
16
|
-
security maintenance, and not end of life. Currently, this means Ruby 2.3 and
|
|
17
|
-
later. Older versions of Ruby _may_ still work, but are unsupported and not
|
|
18
|
-
recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
|
|
19
|
-
about the Ruby support schedule.
|
|
20
|
-
|
|
21
|
-
## Versioning
|
|
22
|
-
|
|
23
|
-
This library follows [Semantic Versioning](http://semver.org/).
|
|
24
|
-
|
|
25
|
-
It is currently in major version zero (0.y.z), which means that anything may
|
|
26
|
-
change at any time and the public API should not be considered stable.
|
|
27
|
-
|
|
28
|
-
## Contributing
|
|
29
|
-
|
|
30
|
-
Contributions to this library are always welcome and highly encouraged.
|
|
31
|
-
|
|
32
|
-
See the [Contributing
|
|
33
|
-
Guide](http://googlecloudplatform.github.io/google-cloud-ruby/docs/stackdriver-core/latest/file.CONTRIBUTING)
|
|
34
|
-
for more information on how to get started.
|
|
35
|
-
|
|
36
|
-
Please note that this project is released with a Contributor Code of Conduct. By
|
|
37
|
-
participating in this project you agree to abide by its terms. See [Code of
|
|
38
|
-
Conduct](http://googlecloudplatform.github.io/google-cloud-ruby/docs/stackdriver-core/latest/file.CODE_OF_CONDUCT)
|
|
39
|
-
for more information.
|
|
40
|
-
|
|
41
|
-
## License
|
|
42
|
-
|
|
43
|
-
This library is licensed under Apache 2.0. Full license text is available in
|
|
44
|
-
[LICENSE](http://googlecloudplatform.github.io/google-cloud-ruby/docs/stackdriver-core/latest/file.LICENSE).
|
|
45
|
-
|
|
46
|
-
## Support
|
|
47
|
-
|
|
48
|
-
Please [report bugs at the project on
|
|
49
|
-
Github](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues). Don't
|
|
50
|
-
hesitate to [ask
|
|
51
|
-
questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby)
|
|
52
|
-
about the client or APIs on [StackOverflow](http://stackoverflow.com).
|