grpc-opentracing 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 65faf0542513f6110b6e31258d941c4ea9295111
4
+ data.tar.gz: 8111df2ed4eb65a84edb6b073ab703f7683035ab
5
+ SHA512:
6
+ metadata.gz: 9b5541da9a2cbe537b4673591b48a5e09a4040b1787805832cad601498d2b3c220e28519d47f97b93199247b6e49800b881e08fc349ad4697d0328cf6d0e0cf6
7
+ data.tar.gz: fc86929fd83d2705592b6051183443a3933cece3532821d3bd600d22696a2810ae25ecd3d223e33d4428f4d8c667252e4f431211584e6d787978ee373a32045d
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1 @@
1
+ 2.3.4
@@ -0,0 +1,7 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.2
5
+ - 2.3
6
+ - 2.4
7
+ before_install: gem install bundler -v 1.15.4
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at bodziomista@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,11 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in grpc-opentracing.gemspec
6
+ gemspec
7
+
8
+ gem 'pry'
9
+ gem 'pry-stack_explorer'
10
+ gem 'pry-byebug'
11
+
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.
@@ -0,0 +1,139 @@
1
+ [![Build Status](https://travis-ci.org/iaintshine/ruby-grpc-opentracing.svg?branch=master)](https://travis-ci.org/iaintshine/ruby-grpc-opentracing)
2
+
3
+ # GRPC::OpenTracing
4
+
5
+ OpenTracing instrumentation for gRPC in Ruby.
6
+
7
+ It's expected that usage of gRPC libraries across different languages will be consistent. That's why I've based the API on [GRPC-Java OpenTracing](https://github.com/grpc-ecosystem/grpc-opentracing/tree/master/java) using Ruby idioms at the same time.
8
+
9
+ ## Installation
10
+
11
+ Add this line to your application's Gemfile:
12
+
13
+ ```ruby
14
+ gem 'grpc-opentracing'
15
+ ```
16
+
17
+ And then execute:
18
+
19
+ $ bundle
20
+
21
+ Or install it yourself as:
22
+
23
+ $ gem install grpc-opentracing
24
+
25
+ ## Usage
26
+
27
+ If you want to add basic tracing to your clients and servers, you can do so in a few short and simple steps, as shown below. These code snippets use the gRPC example's `GreeterGrpc`, generated by protocol buffers.
28
+
29
+ The gem exposes two tracing and wrapping interceptors:
30
+ * One for client side `GRPC::OpenTracing::ClientInterceptor`,
31
+ * and the other one for server side `GRPC::OpenTracing::ServerInterceptor`.
32
+
33
+ ## Client Tracing
34
+
35
+ Steps:
36
+ - Instantiate a tracer
37
+ - Instantiate a client
38
+ - Create a `GRPC::OpenTracing::ClientInterceptor`
39
+ - Intercept the client channel
40
+
41
+ ```ruby
42
+ require 'grpc'
43
+ require 'helloworld_services_pb'
44
+ require 'grpc-opentracing'
45
+
46
+ def build_client(host, creds)
47
+ tracing_interceptor = GRPC::OpenTracing::ClientInterceptor.new(tracer: OpenTracing.global_tracer)
48
+ client = Helloworld::Greeter::Stub.new(host, creds)
49
+ tracing_interceptor.intercept(client)
50
+ end
51
+
52
+ def main
53
+ stub = build_client('localhost:50051', :this_channel_is_insecure)
54
+ message = stub.say_hello(Helloworld::HelloRequest.new(name: 'world')).message
55
+ end
56
+
57
+ main
58
+ ```
59
+
60
+ ### Client Configuration Options
61
+
62
+ * `tracer: OpenTracing::Tracer` an OT compatible tracer. Default `OpenTracing.global_tracer`
63
+ * `active_span: Proc` an active span provider. Default: `nil`.
64
+ * `decorators: Array[SpanDecorator]` a lists of span decorators. Default to `[RequestReplySpanDecorator]`
65
+
66
+ ## Server Tracing
67
+
68
+ - Instantiate a tracer
69
+ - Create a `GRPC::OpenTracing::ServerInterceptor`
70
+ - Intercept a service
71
+
72
+ ```ruby
73
+ require 'grpc'
74
+ require 'helloworld_services_pb'
75
+ require 'grpc-opentracing'
76
+
77
+ class GreeterServer < Helloworld::Greeter::Service
78
+ def say_hello(hello_req, _unused_call)
79
+ Helloworld::HelloReply.new(message: "Hello #{hello_req.name}")
80
+ end
81
+ end
82
+
83
+ def main
84
+ tracing_interceptor = GRPC::OpenTracing::ServerInterceptor.new(tracer: OpenTracing.global_tracer)
85
+ s = GRPC::RpcServer.new
86
+ s.add_http2_port('0.0.0.0:50051', :this_port_is_insecure)
87
+ s.handle(tracing_interceptor.intercept(GreeterServer))
88
+ s.run_till_terminated
89
+ end
90
+
91
+ main
92
+ ```
93
+
94
+ ### Server Configuration Options
95
+
96
+ * `tracer: OpenTracing::Tracer` an OT compatible tracer. Default `OpenTracing.global_tracer`
97
+ * `active_span: Proc` an active span provider. Default: `nil`.
98
+ * `decorators: Array[SpanDecorator]` a lists of span decorators. Default to `[RequestReplySpanDecorator]`
99
+
100
+ ## Decorators
101
+
102
+ Traced spans can be customized through decorators - `SpanDecorator` class. They're called once the processing of a request is done, no matter if the processing has finished with success or failure.
103
+
104
+ You can provide a set of decorators during an interceptor creation e.g.
105
+
106
+ ```ruby
107
+ class RequestSpanDecorator
108
+ def self.call(span, method, request, response, error)
109
+ span.set_tag('grpc.request', request.to_json) if request
110
+ end
111
+ end
112
+
113
+ tracing_interceptor = GRPC::OpenTracing::ServerInterceptor.new(decorators: [RequestSpanDecorator])
114
+ tracing_interceptor = GRPC::OpenTracing::ClientInterceptor.new(decorators: [RequestSpanDecorator])
115
+ ```
116
+
117
+ Notice that by default `RequestReplySpanDecorator` is attached, so if you want to preserve the behaviour make sure to append it to the `decorators` list.
118
+
119
+ ### Decorator arguments
120
+
121
+ * `span: OpenTracing::Span` the current active span.
122
+ * `method: String` current method name in the `/service_name/method_name` form.
123
+ * `request` an instance of gRPC message class e.g. `Helloworld::HelloRequest`.
124
+ * `response` an instance of gRPC message class e.g. `Helloworld::HelloReply`.
125
+ * `error: Exception` an exception. Set in case of processing failure.
126
+
127
+ ## Development
128
+
129
+ 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.
130
+
131
+ 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).
132
+
133
+ ## Contributing
134
+
135
+ Bug reports and pull requests are welcome on GitHub at https://github.com/iaintshine/ruby-grpc-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.
136
+
137
+ ## Code of Conduct
138
+
139
+ Everyone interacting in the GRPC::OpenTracing project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/iaintshine/ruby-grpc-opentracing/blob/master/CODE_OF_CONDUCT.md).
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "grpc/opentracing"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,36 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "grpc/opentracing/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "grpc-opentracing"
8
+ spec.version = GRPC::OpenTracing::VERSION
9
+ spec.authors = ["iaintshine"]
10
+ spec.email = ["bodziomista@gmail.com"]
11
+
12
+ spec.summary = %q{OpenTracing instrumentation for gRPC in Ruby.}
13
+ spec.description = %q{}
14
+ spec.homepage = "https://github.com/iaintshine/ruby-grpc-opentracing"
15
+ spec.license = "Apache-2.0"
16
+
17
+ spec.required_ruby_version = ">= 2.2.0"
18
+
19
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
20
+ f.match(%r{^(test|spec|features)/})
21
+ end
22
+ spec.bindir = "exe"
23
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
24
+ spec.require_paths = ["lib"]
25
+
26
+ spec.add_dependency 'grpc'
27
+ spec.add_dependency "multi_json"
28
+ spec.add_dependency 'opentracing', '~> 0.3.1'
29
+ spec.add_dependency "method-tracer", "~> 1.1"
30
+
31
+ spec.add_development_dependency "test-tracer", "~> 1.0", ">= 1.2.1"
32
+ spec.add_development_dependency "tracing-matchers", "~> 1.0", ">= 1.3.0"
33
+ spec.add_development_dependency "bundler", "~> 1.15"
34
+ spec.add_development_dependency "rake", "~> 10.0"
35
+ spec.add_development_dependency "rspec", "~> 3.0"
36
+ end
@@ -0,0 +1 @@
1
+ require "grpc/opentracing"
@@ -0,0 +1,16 @@
1
+ require "grpc"
2
+ require "opentracing"
3
+ require "multi_json"
4
+ require "method-tracer"
5
+
6
+ require "grpc/opentracing/version"
7
+ require "grpc/opentracing/hpack_carrier"
8
+ require "grpc/opentracing/span_decorator"
9
+ require "grpc/opentracing/request_reply_span_decorator"
10
+ require "grpc/opentracing/client_interceptor"
11
+ require "grpc/opentracing/server_interceptor"
12
+
13
+ module GRPC
14
+ module OpenTracing
15
+ end
16
+ end
@@ -0,0 +1,62 @@
1
+ module GRPC
2
+ module OpenTracing
3
+ class ClientInterceptor
4
+ attr_reader :tracer, :active_span, :decorators
5
+
6
+ def initialize(tracer: ::OpenTracing.global_tracer, active_span: nil, decorators: [RequestReplySpanDecorator])
7
+ @tracer = tracer
8
+ @active_span = active_span
9
+ @decorators = decorators
10
+ end
11
+
12
+ def intercept(client)
13
+ client.instance_variable_set(:@tracer, tracer)
14
+ client.instance_variable_set(:@active_span, active_span)
15
+ client.instance_variable_set(:@decorators, decorators)
16
+
17
+ client.instance_eval do
18
+ class << self
19
+ alias_method :request_response_without_instrumentation, :request_response
20
+ end
21
+
22
+ def active_span
23
+ @active_span.respond_to?(:call) ? @active_span.call : @active_span
24
+ end
25
+
26
+ def request_response(method, req, marshal, unmarshal, metadata: {}, **fields)
27
+ tags = {
28
+ 'component' => 'gRPC',
29
+ 'span.kind' => 'client',
30
+ 'grpc.method_type' => 'request_response',
31
+ 'grpc.headers' => MultiJson.dump(metadata)
32
+ }
33
+ current_span = @tracer.start_span(method, child_of: active_span, tags: tags)
34
+
35
+ hpack_carrier = HPACKCarrier.new(metadata)
36
+ @tracer.inject(current_span.context, ::OpenTracing::FORMAT_TEXT_MAP, hpack_carrier)
37
+
38
+ response = request_response_without_instrumentation(method, req, marshal, unmarshal,
39
+ metadata: metadata, **fields)
40
+
41
+ response
42
+ rescue Exception => e
43
+ if current_span
44
+ current_span.set_tag('error', true)
45
+ current_span.log(event: 'error', :'error.object' => e)
46
+ end
47
+ raise
48
+ ensure
49
+ if @decorators
50
+ @decorators.each do |decorator|
51
+ decorator.call(current_span, method, req, response, e)
52
+ end
53
+ end
54
+ current_span.finish if current_span
55
+ end
56
+ end
57
+
58
+ client
59
+ end
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,23 @@
1
+ module GRPC
2
+ module OpenTracing
3
+ class HPACKCarrier
4
+ def initialize(wrapped)
5
+ @wrapped = wrapped
6
+ end
7
+
8
+ def [](key)
9
+ @wrapped[key.downcase]
10
+ end
11
+
12
+ def []=(key, value)
13
+ return unless value
14
+
15
+ @wrapped[key.downcase] = value
16
+ end
17
+
18
+ def each(&block)
19
+ @wrapped.each(&block)
20
+ end
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,12 @@
1
+ module GRPC
2
+ module OpenTracing
3
+ class RequestReplySpanDecorator
4
+ class << self
5
+ def call(span, method, request, response, error)
6
+ span.set_tag('grpc.request', request.to_json) if request
7
+ span.set_tag('grpc.reply', response.to_json) if response
8
+ end
9
+ end
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,82 @@
1
+ module GRPC
2
+ module OpenTracing
3
+ class ServerInterceptor
4
+ attr_reader :tracer, :decorators
5
+
6
+ def initialize(tracer: ::OpenTracing.global_tracer, decorators: [RequestReplySpanDecorator])
7
+ @tracer = tracer
8
+ @decorators = decorators
9
+ end
10
+
11
+ def intercept(service)
12
+ service_class = service.is_a?(Class) ? service : service.class
13
+ service_class.rpc_descs.each_pair do |name, desc|
14
+ route = "/#{service_class.service_name}/#{name}".to_sym
15
+ method_name = GRPC::GenericService.underscore(name.to_s).to_sym
16
+ method_name_without_instrumentation = "#{method_name}_without_instrumentation".to_sym
17
+ interceptor = self
18
+
19
+ service_class.class_eval do
20
+ @tracer = interceptor.tracer
21
+ @decorators = interceptor.decorators
22
+
23
+ class << self
24
+ attr_reader :tracer, :decorators
25
+ end
26
+
27
+ def tracer
28
+ self.class.tracer
29
+ end
30
+
31
+ def decorators
32
+ self.class.decorators
33
+ end
34
+ end
35
+
36
+ if desc.request_response?
37
+ service_class.class_eval do
38
+ if method_defined?(method_name_without_instrumentation)
39
+ alias_method method_name, method_name_without_instrumentation
40
+ remove_method method_name_without_instrumentation
41
+ end
42
+
43
+ alias_method method_name_without_instrumentation, method_name
44
+
45
+ define_method(method_name) do |req, active_call|
46
+ begin
47
+ tags = {
48
+ 'component' => 'gRPC',
49
+ 'span.kind' => 'server',
50
+ 'grpc.method_type' => 'request_response'
51
+ }
52
+ hpack_carrier = HPACKCarrier.new(active_call.metadata)
53
+ parent_span_context = tracer.extract(::OpenTracing::FORMAT_TEXT_MAP, hpack_carrier)
54
+ current_span = tracer.start_span(route.to_s, child_of: parent_span_context, tags: tags)
55
+
56
+ response = self.send(method_name_without_instrumentation, req, active_call)
57
+
58
+ response
59
+ rescue Exception => e
60
+ if current_span
61
+ current_span.set_tag('error', true)
62
+ current_span.log(event: 'error', :'error.object' => e)
63
+ end
64
+ raise
65
+ ensure
66
+ if decorators
67
+ decorators.each do |decorator|
68
+ decorator.call(current_span, route, req, response, e)
69
+ end
70
+ end
71
+ current_span.finish if current_span
72
+ end
73
+ end
74
+ end
75
+ end
76
+ end
77
+
78
+ service
79
+ end
80
+ end
81
+ end
82
+ end
@@ -0,0 +1,8 @@
1
+ module GRPC
2
+ module OpenTracing
3
+ class SpanDecorator
4
+ def call(span, method, request, response, error)
5
+ end
6
+ end
7
+ end
8
+ end
@@ -0,0 +1,5 @@
1
+ module GRPC
2
+ module OpenTracing
3
+ VERSION = "1.0.0"
4
+ end
5
+ end
metadata ADDED
@@ -0,0 +1,202 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: grpc-opentracing
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - iaintshine
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-09-24 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: grpc
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: multi_json
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: opentracing
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 0.3.1
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 0.3.1
55
+ - !ruby/object:Gem::Dependency
56
+ name: method-tracer
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.1'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.1'
69
+ - !ruby/object:Gem::Dependency
70
+ name: test-tracer
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '1.0'
76
+ - - ">="
77
+ - !ruby/object:Gem::Version
78
+ version: 1.2.1
79
+ type: :development
80
+ prerelease: false
81
+ version_requirements: !ruby/object:Gem::Requirement
82
+ requirements:
83
+ - - "~>"
84
+ - !ruby/object:Gem::Version
85
+ version: '1.0'
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: 1.2.1
89
+ - !ruby/object:Gem::Dependency
90
+ name: tracing-matchers
91
+ requirement: !ruby/object:Gem::Requirement
92
+ requirements:
93
+ - - "~>"
94
+ - !ruby/object:Gem::Version
95
+ version: '1.0'
96
+ - - ">="
97
+ - !ruby/object:Gem::Version
98
+ version: 1.3.0
99
+ type: :development
100
+ prerelease: false
101
+ version_requirements: !ruby/object:Gem::Requirement
102
+ requirements:
103
+ - - "~>"
104
+ - !ruby/object:Gem::Version
105
+ version: '1.0'
106
+ - - ">="
107
+ - !ruby/object:Gem::Version
108
+ version: 1.3.0
109
+ - !ruby/object:Gem::Dependency
110
+ name: bundler
111
+ requirement: !ruby/object:Gem::Requirement
112
+ requirements:
113
+ - - "~>"
114
+ - !ruby/object:Gem::Version
115
+ version: '1.15'
116
+ type: :development
117
+ prerelease: false
118
+ version_requirements: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - "~>"
121
+ - !ruby/object:Gem::Version
122
+ version: '1.15'
123
+ - !ruby/object:Gem::Dependency
124
+ name: rake
125
+ requirement: !ruby/object:Gem::Requirement
126
+ requirements:
127
+ - - "~>"
128
+ - !ruby/object:Gem::Version
129
+ version: '10.0'
130
+ type: :development
131
+ prerelease: false
132
+ version_requirements: !ruby/object:Gem::Requirement
133
+ requirements:
134
+ - - "~>"
135
+ - !ruby/object:Gem::Version
136
+ version: '10.0'
137
+ - !ruby/object:Gem::Dependency
138
+ name: rspec
139
+ requirement: !ruby/object:Gem::Requirement
140
+ requirements:
141
+ - - "~>"
142
+ - !ruby/object:Gem::Version
143
+ version: '3.0'
144
+ type: :development
145
+ prerelease: false
146
+ version_requirements: !ruby/object:Gem::Requirement
147
+ requirements:
148
+ - - "~>"
149
+ - !ruby/object:Gem::Version
150
+ version: '3.0'
151
+ description: ''
152
+ email:
153
+ - bodziomista@gmail.com
154
+ executables: []
155
+ extensions: []
156
+ extra_rdoc_files: []
157
+ files:
158
+ - ".gitignore"
159
+ - ".rspec"
160
+ - ".ruby-version"
161
+ - ".travis.yml"
162
+ - CODE_OF_CONDUCT.md
163
+ - Gemfile
164
+ - LICENSE
165
+ - README.md
166
+ - Rakefile
167
+ - bin/console
168
+ - bin/setup
169
+ - grpc-opentracing.gemspec
170
+ - lib/grpc-opentracing.rb
171
+ - lib/grpc/opentracing.rb
172
+ - lib/grpc/opentracing/client_interceptor.rb
173
+ - lib/grpc/opentracing/hpack_carrier.rb
174
+ - lib/grpc/opentracing/request_reply_span_decorator.rb
175
+ - lib/grpc/opentracing/server_interceptor.rb
176
+ - lib/grpc/opentracing/span_decorator.rb
177
+ - lib/grpc/opentracing/version.rb
178
+ homepage: https://github.com/iaintshine/ruby-grpc-opentracing
179
+ licenses:
180
+ - Apache-2.0
181
+ metadata: {}
182
+ post_install_message:
183
+ rdoc_options: []
184
+ require_paths:
185
+ - lib
186
+ required_ruby_version: !ruby/object:Gem::Requirement
187
+ requirements:
188
+ - - ">="
189
+ - !ruby/object:Gem::Version
190
+ version: 2.2.0
191
+ required_rubygems_version: !ruby/object:Gem::Requirement
192
+ requirements:
193
+ - - ">="
194
+ - !ruby/object:Gem::Version
195
+ version: '0'
196
+ requirements: []
197
+ rubyforge_project:
198
+ rubygems_version: 2.6.12
199
+ signing_key:
200
+ specification_version: 4
201
+ summary: OpenTracing instrumentation for gRPC in Ruby.
202
+ test_files: []