restclient-opentracing 0.1.0.pre
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 +7 -0
- data/README.md +65 -0
- data/Rakefile +8 -0
- data/lib/restclient/opentracing/instrument.rb +49 -0
- data/lib/restclient/opentracing/version.rb +7 -0
- data/lib/restclient/opentracing.rb +20 -0
- metadata +191 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: a1dff7609b8def9d6b2f5a15d583499cd214d52a300a039791402fc2f56db0c1
|
4
|
+
data.tar.gz: 4a7801b4bc93d10f9eb6ba91eb6d0d97f62f5b707192f663bbd33810ae319c8b
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 8ae6750c391f9e5ed60127fd72c38613a16410e999ce5fabea8823c9579368a2797c940e49cda3c9ebf2d9aef79a6cbe5be63c56f82222df27700f8d9a628057
|
7
|
+
data.tar.gz: 6f30b71a8c56b68583876536b49d853b43695b796997be347dc9829328a1d9110e83383825e3989fe8485a975a24780d98e40041dacbb64f30bd0559c0c03ac6
|
data/README.md
ADDED
@@ -0,0 +1,65 @@
|
|
1
|
+
|
2
|
+
[](https://travis-ci.com/foodiefm/restclient-opentracing)
|
3
|
+
[](https://coveralls.io/github/foodiefm/restclient-opentracing?branch=master)
|
4
|
+
|
5
|
+
# RestClient::Opentracing
|
6
|
+
|
7
|
+
|
8
|
+
Opentracing instrumentation for RestClient
|
9
|
+
|
10
|
+
|
11
|
+
TODO: publish the gem
|
12
|
+
|
13
|
+
## Installation
|
14
|
+
|
15
|
+
Add this line to your application's Gemfile:
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
gem 'restclient-opentracing'
|
19
|
+
```
|
20
|
+
|
21
|
+
And then execute:
|
22
|
+
|
23
|
+
$ bundle
|
24
|
+
|
25
|
+
Or install it yourself as:
|
26
|
+
|
27
|
+
$ gem install restclient-opentracing
|
28
|
+
|
29
|
+
## Usage
|
30
|
+
|
31
|
+
|
32
|
+
```
|
33
|
+
require 'restclient/opentracing'
|
34
|
+
|
35
|
+
RestClient::OpenTracing.instrument
|
36
|
+
```
|
37
|
+
|
38
|
+
disable passing traces down the wire:
|
39
|
+
|
40
|
+
```
|
41
|
+
require 'restclient/opentracing'
|
42
|
+
|
43
|
+
RestClient::OpenTracing.instrument do |config|
|
44
|
+
config.distributed_tracing = false
|
45
|
+
end
|
46
|
+
```
|
47
|
+
|
48
|
+
|
49
|
+
## Development
|
50
|
+
|
51
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
52
|
+
|
53
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
54
|
+
|
55
|
+
## Contributing
|
56
|
+
|
57
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/foodiefm/restclient-opentracing. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
58
|
+
|
59
|
+
## License
|
60
|
+
|
61
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
62
|
+
|
63
|
+
## Code of Conduct
|
64
|
+
|
65
|
+
Everyone interacting in the Redis::Opentracing project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/foodiefm/restclient-opentracing/blob/master/CODE_OF_CONDUCT.md).
|
data/Rakefile
ADDED
@@ -0,0 +1,49 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module RestClient
|
4
|
+
module OpenTracing
|
5
|
+
module Instrument
|
6
|
+
def execute(&block)
|
7
|
+
uri = URI.parse(url)
|
8
|
+
scope = ::OpenTracing.start_active_span([method.to_s.upcase, uri.host].join(' '),
|
9
|
+
tags: tags(uri))
|
10
|
+
span = scope.span
|
11
|
+
|
12
|
+
if RestClient::OpenTracing.config.distributed_tracing
|
13
|
+
::OpenTracing.inject(span.context, ::OpenTracing::FORMAT_RACK,
|
14
|
+
processed_headers)
|
15
|
+
end
|
16
|
+
|
17
|
+
response = super(&block)
|
18
|
+
|
19
|
+
if response.is_a?(::RestClient::Response)
|
20
|
+
span.set_tag('status', response.code)
|
21
|
+
end
|
22
|
+
|
23
|
+
response
|
24
|
+
rescue ::RestClient::ExceptionWithResponse => e
|
25
|
+
span.set_tag('error', true)
|
26
|
+
span.log_kv(key: 'error', value: e.to_s)
|
27
|
+
span.set_tag('status', e.http_code)
|
28
|
+
|
29
|
+
raise e
|
30
|
+
rescue Exception => e
|
31
|
+
span.set_tag('error', true)
|
32
|
+
span.log_kv(key: 'error', value: e.to_s)
|
33
|
+
raise e
|
34
|
+
ensure
|
35
|
+
scope.close
|
36
|
+
end
|
37
|
+
|
38
|
+
private
|
39
|
+
|
40
|
+
def tags(uri)
|
41
|
+
{
|
42
|
+
'path' => uri.path,
|
43
|
+
'host' => uri.host,
|
44
|
+
'port' => uri.port
|
45
|
+
}
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'restclient/opentracing/version'
|
4
|
+
require 'restclient/opentracing/instrument'
|
5
|
+
|
6
|
+
module RestClient
|
7
|
+
module OpenTracing
|
8
|
+
def self.instrument
|
9
|
+
@config ||= OpenStruct.new(distributed_tracing: true)
|
10
|
+
yield(@config) if block_given?
|
11
|
+
require 'rest-client'
|
12
|
+
::RestClient::Request.send(:prepend, Instrument)
|
13
|
+
self
|
14
|
+
end
|
15
|
+
|
16
|
+
def self.config
|
17
|
+
@config
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
metadata
ADDED
@@ -0,0 +1,191 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: restclient-opentracing
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0.pre
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- larte
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2019-08-30 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: rspec
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '3.0'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '3.0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: opentracing_test_tracer
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0.1'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0.1'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: appraisal
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '2'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '2'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rubocop
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: 0.71.0
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: 0.71.0
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rubocop-rspec
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: 1.33.0
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: 1.33.0
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: database_cleaner
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '1.7'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '1.7'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: coveralls
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: webmock
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - "~>"
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '3'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - "~>"
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '3'
|
125
|
+
- !ruby/object:Gem::Dependency
|
126
|
+
name: rest-client
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - "~>"
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: '2'
|
132
|
+
type: :runtime
|
133
|
+
prerelease: false
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - "~>"
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: '2'
|
139
|
+
- !ruby/object:Gem::Dependency
|
140
|
+
name: opentracing
|
141
|
+
requirement: !ruby/object:Gem::Requirement
|
142
|
+
requirements:
|
143
|
+
- - "~>"
|
144
|
+
- !ruby/object:Gem::Version
|
145
|
+
version: '0.4'
|
146
|
+
type: :runtime
|
147
|
+
prerelease: false
|
148
|
+
version_requirements: !ruby/object:Gem::Requirement
|
149
|
+
requirements:
|
150
|
+
- - "~>"
|
151
|
+
- !ruby/object:Gem::Version
|
152
|
+
version: '0.4'
|
153
|
+
description: Enable distributed tracing and intrumentation for restclient
|
154
|
+
email:
|
155
|
+
- larte@foodie.fm
|
156
|
+
executables: []
|
157
|
+
extensions: []
|
158
|
+
extra_rdoc_files: []
|
159
|
+
files:
|
160
|
+
- README.md
|
161
|
+
- Rakefile
|
162
|
+
- lib/restclient/opentracing.rb
|
163
|
+
- lib/restclient/opentracing/instrument.rb
|
164
|
+
- lib/restclient/opentracing/version.rb
|
165
|
+
homepage: https://github.com/foodie.fm/restclient-opentracing
|
166
|
+
licenses:
|
167
|
+
- MIT
|
168
|
+
metadata:
|
169
|
+
bug_tracker_uri: https://github.com/foodiefm/redisrb-opentracing/issues
|
170
|
+
homepage_uri: https://github.com/foodiefm/redisrb-opentracing
|
171
|
+
source_code_uri: https://github.com/foodiefm/redisrb-opentracing
|
172
|
+
post_install_message:
|
173
|
+
rdoc_options: []
|
174
|
+
require_paths:
|
175
|
+
- lib
|
176
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
177
|
+
requirements:
|
178
|
+
- - ">="
|
179
|
+
- !ruby/object:Gem::Version
|
180
|
+
version: '0'
|
181
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
182
|
+
requirements:
|
183
|
+
- - ">"
|
184
|
+
- !ruby/object:Gem::Version
|
185
|
+
version: 1.3.1
|
186
|
+
requirements: []
|
187
|
+
rubygems_version: 3.0.3
|
188
|
+
signing_key:
|
189
|
+
specification_version: 4
|
190
|
+
summary: Enable distributed tracing and intrumentation for restclient
|
191
|
+
test_files: []
|