stackdriver 0.13.0 → 0.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +97 -15
- data/lib/stackdriver/version.rb +1 -1
- metadata +15 -15
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7acb071838fe06830ded8d0a023ed2ded276330a8178114f4b421b1ea3f03260
|
4
|
+
data.tar.gz: f5a524219dfcea17b894bfc47e500a88b7629ecc45c7e9dadf70d54e33f723ae
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e428fad38ccde4b9b0b9d1f290341ed5b56a2d906edcc96f91ecaa7bd5889adc89f1d2d0c626350b4ce24c47faf581a1965bca9ac71b2523c3b3b73c9a3320b6
|
7
|
+
data.tar.gz: 9f5180332be347e27f8d6d14757360153d20894721a1b26690106360e05f461f935459ecd9e5451fae766767dd99436ce227448436c81b0726ecdb9fe4bcd699
|
data/README.md
CHANGED
@@ -1,32 +1,114 @@
|
|
1
1
|
# stackdriver
|
2
2
|
|
3
|
-
This gem instruments a Ruby web application for Stackdriver diagnostics. When
|
3
|
+
This gem instruments a Ruby web application for Stackdriver diagnostics. When
|
4
|
+
loaded, it integrates with Rails, Sinatra, or other Rack-based web frameworks
|
5
|
+
to collect application diagnostic and monitoring information for your
|
6
|
+
application.
|
7
|
+
|
8
|
+
Specifically, this gem is a convenience package that loads and automatically
|
9
|
+
activates the instrumentation features of the following gems:
|
10
|
+
|
11
|
+
* [google-cloud-debugger](../google-cloud-debugger) which enables remote
|
12
|
+
debugging using [Stackdriver Debugger](https://cloud.google.com/debugger/)
|
13
|
+
* [google-cloud-error_reporting](../google-cloud-error_reporting) which
|
14
|
+
reports unhandled exceptions and other errors to
|
15
|
+
[Stackdriver Error Reporting](https://cloud.google.com/error-reporting/)
|
16
|
+
* [google-cloud-logging](../google-cloud-logging) which collects application
|
17
|
+
logs in [Stackdriver logging](https://cloud.google.com/logging/)
|
18
|
+
* [google-cloud-trace](../google-cloud-trace) which reports distributed
|
19
|
+
latency traces to [Stackdriver Trace](https://cloud.google.com/trace/)
|
4
20
|
|
5
|
-
|
6
|
-
- [google-cloud-debugger](../google-cloud-debugger)
|
7
|
-
- [google-cloud-error_reporting](../google-cloud-error_reporting)
|
8
|
-
- [google-cloud-logging](../google-cloud-logging)
|
9
|
-
- [google-cloud-trace](../google-cloud-trace)
|
21
|
+
## Quick Start
|
10
22
|
|
11
|
-
|
23
|
+
### Install the gem
|
12
24
|
|
13
|
-
|
25
|
+
Add the `stackdriver` gem to your Gemfile:
|
14
26
|
|
15
|
-
```
|
16
|
-
|
27
|
+
```ruby
|
28
|
+
gem "stackdriver"
|
17
29
|
```
|
18
30
|
|
19
|
-
|
20
|
-
|
31
|
+
### Instrument your code
|
32
|
+
|
33
|
+
#### Using Ruby on Rails
|
34
|
+
|
35
|
+
If you are running Ruby on Rails, the `stackdriver` gem will automatically
|
36
|
+
install Railties that will instrument your application for basic diagnostics.
|
37
|
+
In most applications, the gem will initialize itself, and you will not need to
|
38
|
+
write any additional code.
|
39
|
+
|
40
|
+
If your Rails application has removed the `Bundler.require` line in the
|
41
|
+
`application.rb` initialization file, then you might need to require the gem
|
42
|
+
explicitly with:
|
43
|
+
|
21
44
|
```ruby
|
45
|
+
# In application.rb
|
22
46
|
require "stackdriver"
|
23
47
|
```
|
24
48
|
|
25
|
-
|
49
|
+
#### Other Rack-based frameworks
|
26
50
|
|
27
|
-
|
51
|
+
If you are running another Rack-based framework, such as Sinatra, you should
|
52
|
+
install the Rack Middleware provided by each library you want to use:
|
53
|
+
|
54
|
+
```ruby
|
55
|
+
# In your Rack middleware configuration code.
|
56
|
+
require "stackdriver"
|
57
|
+
use Google::Cloud::Logging::Middleware
|
58
|
+
use Google::Cloud::ErrorReporting::Middleware
|
59
|
+
use Google::Cloud::Trace::Middleware
|
60
|
+
use Google::Cloud::Debugger::Middleware
|
61
|
+
```
|
28
62
|
|
29
|
-
|
63
|
+
#### Advanced instrumentation
|
64
|
+
|
65
|
+
See the individual gem documentation for each gem for information on how to
|
66
|
+
customize the instrumentation, e.g. how to manually report errors or add custom
|
67
|
+
spans to latency traces.
|
68
|
+
|
69
|
+
### Viewing diagnostic reports
|
70
|
+
|
71
|
+
Logs, errors, traces, and other reports can be viewed on the Google Cloud
|
72
|
+
Console. If your app is hosted on Google Cloud (such as on Google App Engine,
|
73
|
+
Google Kubernetes Engine, or Google Compute Engine), you can use the same
|
74
|
+
project. Otherwise, if your application is hosted elsewhere, create a new
|
75
|
+
project on [Google Cloud](https://console.cloud.google.com/).
|
76
|
+
|
77
|
+
Make sure the
|
78
|
+
[Stackdriver Error Reporting API](https://console.cloud.google.com/apis/library/clouderrorreporting.googleapis.com)
|
79
|
+
is enabled on your Google Cloud project. (The other service APIs---debugging,
|
80
|
+
logging, and tracing---are enabled by default on all new projects.)
|
81
|
+
|
82
|
+
#### Authentication
|
83
|
+
|
84
|
+
Your app also needs to authenticate with the Stackdriver services in order to
|
85
|
+
send data.
|
86
|
+
|
87
|
+
* If you are running on **Google App Engine**, authentication happens
|
88
|
+
automatically. You do not need to do anything.
|
89
|
+
* If you are running on **Google Kubernetes Engine**, you must explicitly add
|
90
|
+
`https://www.googleapis.com/auth/cloud-platform` to the API access scopes
|
91
|
+
when creating the cluster. Authentication will then happen automatically.
|
92
|
+
* If you are running on **Google Compute Engine**, you must explicitly add
|
93
|
+
`https://www.googleapis.com/auth/cloud-platform` to the API access scopes
|
94
|
+
when creating the VM. Authentication will then happen automatically.
|
95
|
+
* If you are not running on a Google Cloud hosting environment, you must set
|
96
|
+
up a service account, and provide the Stackdriver library with the ID of
|
97
|
+
your Google Cloud project, and the service account credentials.
|
98
|
+
|
99
|
+
```ruby
|
100
|
+
# In your app initialization code
|
101
|
+
Google::Cloud.configure do |config|
|
102
|
+
config.project_id = "your-project-id"
|
103
|
+
config.credentials = "/path/to/servce-account-keyfile.json"
|
104
|
+
end
|
105
|
+
```
|
106
|
+
|
107
|
+
See the gem documentation for each individual gem for more information.
|
108
|
+
|
109
|
+
## Compatibility
|
110
|
+
|
111
|
+
This library is supported on Ruby 2.2+.
|
30
112
|
|
31
113
|
This library follows [Semantic Versioning](http://semver.org/).
|
32
114
|
|
data/lib/stackdriver/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: stackdriver
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.14.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Heng Xiong
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2018-02-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-cloud-debugger
|
@@ -16,56 +16,56 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - "~>"
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.
|
19
|
+
version: '0.31'
|
20
20
|
type: :runtime
|
21
21
|
prerelease: false
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
23
23
|
requirements:
|
24
24
|
- - "~>"
|
25
25
|
- !ruby/object:Gem::Version
|
26
|
-
version: 0.
|
26
|
+
version: '0.31'
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
28
|
name: google-cloud-error_reporting
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
30
30
|
requirements:
|
31
31
|
- - "~>"
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version: 0.
|
33
|
+
version: '0.30'
|
34
34
|
type: :runtime
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
38
|
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version: 0.
|
40
|
+
version: '0.30'
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
name: google-cloud-logging
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
44
44
|
requirements:
|
45
45
|
- - "~>"
|
46
46
|
- !ruby/object:Gem::Version
|
47
|
-
version: '1.
|
47
|
+
version: '1.5'
|
48
48
|
type: :runtime
|
49
49
|
prerelease: false
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
51
51
|
requirements:
|
52
52
|
- - "~>"
|
53
53
|
- !ruby/object:Gem::Version
|
54
|
-
version: '1.
|
54
|
+
version: '1.5'
|
55
55
|
- !ruby/object:Gem::Dependency
|
56
56
|
name: google-cloud-trace
|
57
57
|
requirement: !ruby/object:Gem::Requirement
|
58
58
|
requirements:
|
59
59
|
- - "~>"
|
60
60
|
- !ruby/object:Gem::Version
|
61
|
-
version: 0.
|
61
|
+
version: '0.31'
|
62
62
|
type: :runtime
|
63
63
|
prerelease: false
|
64
64
|
version_requirements: !ruby/object:Gem::Requirement
|
65
65
|
requirements:
|
66
66
|
- - "~>"
|
67
67
|
- !ruby/object:Gem::Version
|
68
|
-
version: 0.
|
68
|
+
version: '0.31'
|
69
69
|
- !ruby/object:Gem::Dependency
|
70
70
|
name: minitest
|
71
71
|
requirement: !ruby/object:Gem::Requirement
|
@@ -140,16 +140,16 @@ dependencies:
|
|
140
140
|
name: rubocop
|
141
141
|
requirement: !ruby/object:Gem::Requirement
|
142
142
|
requirements:
|
143
|
-
- - "
|
143
|
+
- - "~>"
|
144
144
|
- !ruby/object:Gem::Version
|
145
|
-
version: 0.
|
145
|
+
version: 0.50.0
|
146
146
|
type: :development
|
147
147
|
prerelease: false
|
148
148
|
version_requirements: !ruby/object:Gem::Requirement
|
149
149
|
requirements:
|
150
|
-
- - "
|
150
|
+
- - "~>"
|
151
151
|
- !ruby/object:Gem::Version
|
152
|
-
version: 0.
|
152
|
+
version: 0.50.0
|
153
153
|
- !ruby/object:Gem::Dependency
|
154
154
|
name: simplecov
|
155
155
|
requirement: !ruby/object:Gem::Requirement
|
@@ -238,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
238
238
|
version: '0'
|
239
239
|
requirements: []
|
240
240
|
rubyforge_project:
|
241
|
-
rubygems_version: 2.7.
|
241
|
+
rubygems_version: 2.7.6
|
242
242
|
signing_key:
|
243
243
|
specification_version: 4
|
244
244
|
summary: API Client library for Google Stackdriver
|