opentelemetry-instrumentation-grpc 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26efaa070d7b860b93a139d4f4b09914537a084a3e209f2758895ea8afd6fc50
-  data.tar.gz: 43f1a935e75e418f27ca7eb494e9582ef4c12c4a9232165057842a0d2998ccd1
+  metadata.gz: 106bb721c80bd4f015121faa25170d612f17961b143b4eb93a7f25a8891bf509
+  data.tar.gz: c7b9ba9665050c4f53b0384fa1a32960f2e2ec2fb136b61f114d720b6cf9be21
 SHA512:
-  metadata.gz: 8dd98ebe3d2e55426129068208c4fc89b0d9f943eca69bd5198fd2938e392b343a93bfb06c42c3dd8b8a7565b7a6a91139e25e0d648a11030c7bfa77e33cb1c4
-  data.tar.gz: 8a2543040e4cbd6fcf8306235e149ec888fa297290f325489f5c71cf81d344e1d1476570a6bd2b3e850c2f56494b7f8af1c6641f2e3221b7f9901eefa0b158b5
+  metadata.gz: e1b00d575b674d07193e607208862ebb5eb610e2bbec6b145cdebb0444be81d436be7c08ff83bd14bccbc887c1f101c8d8123679f541b4fbc08839cd243591c4
+  data.tar.gz: b471fee6843acebf756a0415b3e89e7c7e33fa9106a8fff29dc333957393dffea5916eca581ee80b924805e767d0bd0e6c9d54ed11b66095ed6dc650c7503b2c

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_from: ../../.rubocop.yml
+
+AllCops:
+  Exclude:
+    - 'test/support/proto/*.rb'
+    - 'example/proto/*.rb'

data/Appraisals

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+appraise 'grpc-1.68' do
+  gem 'grpc', '~> 1.68.0'
+end
+
+appraise 'grpc-latest' do
+  gem 'grpc'
+end

data/CHANGELOG.md

@@ -1,18 +1,24 @@
-## [Unreleased]
+# Release History: opentelemetry-instrumentation-grpc
 
-## [0.1.3] - 2024-09-11
+### v0.2.0 / 2025-04-02
 
-- Fix error in handling of non-gRPC errors
-- Fix error in method signature for OpenTelemetry::Instrumentation::Grpc.client_interceptor [#1](https://github.com/hibachrach/opentelemetry-instrumentation-grpc/pull/1)
+* ADDED: Add gRPC trace demonstration
+* ADDED: Migrate gRPC instrumentation to OpenTelemetry tooling
+* ADDED: Transferred ownership of the gem from @hibachrach to OpenTelemetry
 
-## [0.1.2] - 2024-06-26
+### v0.1.3 / 2024-09-11
 
-- Align span naming with spec
+* FIXED: Fix error in handling of non-gRPC errors
+* FIXED: Fix error in method signature for OpenTelemetry::Instrumentation::Grpc.client_interceptor [#1](https://github.com/hibachrach/opentelemetry-instrumentation-grpc/pull/1)
 
-## [0.1.1] - 2024-06-26
+### v0.1.2 / 2024-06-26
 
-- Fix `uninitialized constant Interceptors` error
+* FIXED: Align span naming with spec
 
-## [0.1.0] - 2024-06-18
+### v0.1.1 / 2024-06-26
 
-- Initial release
+* FIXED: Fix `uninitialized constant Interceptors` error
+
+### v0.1.0 / 2024-06-18
+
+* Initial release

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright The OpenTelemetry Authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,66 +1,73 @@
-# OpenTelemetry::Instrumentation::Grpc
+# OpenTelemetry gRPC Instrumentation
 
 [![Gem Version](https://badge.fury.io/rb/opentelemetry-instrumentation-grpc.svg)](https://badge.fury.io/rb/opentelemetry-instrumentation-grpc)
 [![GitHub Actions CI Status](https://github.com/hibachrach/opentelemetry-instrumentation-grpc/actions/workflows/main.yml/badge.svg)](https://github.com/hibachrach/opentelemetry-instrumentation-grpc/actions?query=branch%3Amain)
 
-OpenTelemetry instrumentation for users of the `grpc` gem
+OpenTelemetry instrumentation for users of the [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) gem.
 
 > [!WARNING]
 > Right now, the gem only instruments outbound requests to gRPC services
 
-## Installation
+## How do I get started?
 
-Install the gem and add to the application's Gemfile by executing:
+Install the gem using:
 
-    $ bundle add opentelemetry-instrumentation-grpc
+```console
+gem install opentelemetry-instrumentation-grpc
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-grpc` to your `Gemfile`.
 
-    $ gem install opentelemetry-instrumentation-grpc
 
 ## Usage
 
 To use the instrumentation, call `use` with the name of the instrumentation:
 
 ```ruby
-OpenTelemetry::SDK.configure do |c|
-  c.use 'OpenTelemetry::Instrumentation::Grpc', {
-    peer_service: "Example",
-    allowed_metadata_headers: [],
-  }
-end
+  OpenTelemetry::SDK.configure do |c|
+    c.use 'OpenTelemetry::Instrumentation::Grpc', {
+      peer_service: "Example",
+      allowed_metadata_headers: [],
+    }
+  end
 ```
 
 Alternatively, you can also call `use_all` to install all the available
 instrumentation.
 
 ```ruby
-OpenTelemetry::SDK.configure do |c|
-  c.use_all
-end
+  OpenTelemetry::SDK.configure do |c|
+    c.use_all
+  end
 ```
 
-You *also* need to make sure your stubs are using the interceptor, e.g.
+## Examples
 
-```ruby
-otel = OpenTelemetry::Instrumentation::Grpc.client_interceptor
-SomeService::Stub.new(host, credentials, *args, **kwargs, interceptors: [otel])
-```
+Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/grpc/example/trace_demonstration.rb)
 
 ## Development
 
-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.
+Integration tests rely on a real gRPC server that is started by relevant tests. The proto definition is located in `test/support/proto/ping.proto`. Making changes to the proto definition requires re-creating gRPC-generated code. To do this, run the following command:
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```sh
+bundle exec grpc_tools_ruby_protoc --ruby_out=. --grpc_out=. test/support/proto/ping.proto
+```
 
-## Contributing
+## How can I get involved?
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/hibachrach/opentelemetry-instrumentation-grpc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/opentelemetry-instrumentation-grpc/blob/main/CODE_OF_CONDUCT.md).
+The `opentelemetry-instrumentation-grpc` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
 
-## License
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our [GitHub Discussions][discussions-url], [Slack Channel][slack-channel] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+## License
 
-## Code of Conduct
+The `opentelemetry-instrumentation-grpc` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
 
-Everyone interacting in the OpenTelemetry::Instrumentation::Grpc project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/opentelemetry-instrumentation-grpc/blob/main/CODE_OF_CONDUCT.md).
+[grpc-home]: https://github.com/grpc/grpc
+[bundler-home]: https://bundler.io
+[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
+[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
+[community-meetings]: https://github.com/open-telemetry/community#community-meetings
+[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

data/Rakefile

@@ -1,10 +1,28 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
 
-RSpec::Core::RakeTask.new(:spec)
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'yard'
+require 'rubocop/rake_task'
 
-require "standard/rake"
+RuboCop::RakeTask.new
 
-task default: %i[spec standard]
+Rake::TestTask.new :test do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.stats_options = ['--list-undoc']
+end
+
+if RUBY_ENGINE == 'truffleruby'
+  task default: %i[test]
+else
+  task default: %i[test rubocop yard]
+end

data/example/example_impl.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+class ExampleImpl < ::Proto::Example::ExampleAPI::Service
+  def example(_req, _call)
+    Proto::Example::ExampleResponse.new(response_name: 'Hello')
+  end
+end

data/example/proto/example_api.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+
+package proto.example;
+
+service ExampleAPI {
+  rpc Example(ExampleRequest) returns (ExampleResponse);
+}
+
+message ExampleRequest {
+  uint64 id = 1;
+  string name = 2;
+}
+
+message ExampleResponse {
+  string response_name = 1;
+}

data/example/proto/example_api_pb.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: proto/example_api.proto
+
+require 'google/protobuf'
+
+descriptor_data = "\n\x17proto/example_api.proto\x12\rproto.example\"*\n\x0e\x45xampleRequest\x12\n\n\x02id\x18\x01 \x01(\x04\x12\x0c\n\x04name\x18\x02 \x01(\t\"(\n\x0f\x45xampleResponse\x12\x15\n\rresponse_name\x18\x01 \x01(\t2V\n\nExampleAPI\x12H\n\x07\x45xample\x12\x1d.proto.example.ExampleRequest\x1a\x1e.proto.example.ExampleResponseb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Proto
+  module Example
+    ExampleRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup('proto.example.ExampleRequest').msgclass
+    ExampleResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup('proto.example.ExampleResponse').msgclass
+  end
+end

data/example/proto/example_api_services_pb.rb

@@ -0,0 +1,23 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: proto/example_api.proto for package 'proto.example'
+
+require 'grpc'
+require_relative 'example_api_pb'
+
+module Proto
+  module Example
+    module ExampleAPI
+      class Service
+        include ::GRPC::GenericService
+
+        self.marshal_class_method = :encode
+        self.unmarshal_class_method = :decode
+        self.service_name = 'proto.example.ExampleAPI'
+
+        rpc :Example, ::Proto::Example::ExampleRequest, ::Proto::Example::ExampleResponse
+      end
+
+      Stub = Service.rpc_stub_class
+    end
+  end
+end

data/example/trace_demonstration.rb

@@ -0,0 +1,35 @@
+require_relative './proto/example_api_services_pb'
+require_relative './example_impl'
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'grpc'
+  gem 'opentelemetry-api'
+  gem 'opentelemetry-common'
+  gem 'opentelemetry-instrumentation-grpc', path: '../'
+  gem 'opentelemetry-sdk'
+end
+
+ENV['OTEL_TRACES_EXPORTER'] = 'console'
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::Grpc'
+end
+
+
+# start the server
+@service = ExampleImpl.new
+server = GRPC::RpcServer.new(pool_size: 1, poll_period: 1)
+server_port = server.add_http2_port('localhost:0', :this_port_is_insecure)
+server.handle(ExampleImpl)
+server_thread = Thread.new { server.run }
+server.wait_till_running
+
+
+# make a request
+stub = Proto::Example::ExampleAPI::Stub.new("localhost:#{server_port}", :this_channel_is_insecure)
+stub.example(Proto::Example::ExampleRequest.new(id: 1, name: 'test!'))
+
+server.stop
+server_thread.join

data/lib/opentelemetry/instrumentation/grpc/instrumentation.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 module OpenTelemetry
   module Instrumentation
     module Grpc
@@ -7,6 +11,7 @@ module OpenTelemetry
       class Instrumentation < OpenTelemetry::Instrumentation::Base
         install do |_config|
           require_dependencies
+          patch
         end
 
         option :allowed_metadata_headers, default: [], validate: :array
@@ -18,8 +23,13 @@ module OpenTelemetry
 
         private
 
+        def patch
+          ::GRPC::ClientStub.prepend(Patches::ClientStub)
+        end
+
         def require_dependencies
-          require_relative "interceptors/client"
+          require_relative 'interceptors/client_tracer'
+          require_relative 'patches/client_stub'
         end
       end
     end

data/lib/opentelemetry/instrumentation/grpc/interceptors/{client.rb → client_tracer.rb}

@@ -1,24 +1,29 @@
 # frozen_string_literal: true
 
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 module OpenTelemetry
   module Instrumentation
     module Grpc
       module Interceptors
-        class Client < ::GRPC::ClientInterceptor
+        # ClientTracer is a gRPC client interceptor which instrument gRPC calls with OpenTelemetry tracing
+        class ClientTracer < ::GRPC::ClientInterceptor
           def request_response(request: nil, call: nil, method: nil, metadata: nil, &blk)
-            call(type: "request_response", requests: [request], call: call, method: method, metadata: metadata, &blk)
+            call(type: 'request_response', requests: [request], call: call, method: method, metadata: metadata, &blk)
           end
 
           def client_streamer(requests: nil, call: nil, method: nil, metadata: nil, &blk)
-            call(type: "client_streamer", requests: requests, call: call, method: method, metadata: metadata, &blk)
+            call(type: 'client_streamer', requests: requests, call: call, method: method, metadata: metadata, &blk)
           end
 
           def server_streamer(request: nil, call: nil, method: nil, metadata: nil, &blk)
-            call(type: "server_streamer", requests: [request], call: call, method: method, metadata: metadata, &blk)
+            call(type: 'server_streamer', requests: [request], call: call, method: method, metadata: metadata, &blk)
           end
 
           def bidi_streamer(requests: nil, call: nil, method: nil, metadata: nil, &blk)
-            call(type: "client_streamer", requests: requests, call: call, method: method, metadata: metadata, &blk)
+            call(type: 'client_streamer', requests: requests, call: call, method: method, metadata: metadata, &blk)
           end
 
           private
@@ -26,17 +31,17 @@ module OpenTelemetry
           def call(type:, requests: nil, call: nil, method: nil, metadata: nil)
             return yield if instrumentation_config.empty?
 
-            method_parts = method.to_s.split("/")
+            method_parts = method.to_s.split('/')
             service = method_parts[1]
             method_name = method_parts.last
 
             attributes = {
-              OpenTelemetry::SemanticConventions::Trace::RPC_SYSTEM => "grpc",
+              OpenTelemetry::SemanticConventions::Trace::RPC_SYSTEM => 'grpc',
               OpenTelemetry::SemanticConventions::Trace::RPC_SERVICE => service,
               OpenTelemetry::SemanticConventions::Trace::RPC_METHOD => method_name,
               OpenTelemetry::SemanticConventions::Trace::PEER_SERVICE => instrumentation_config[:peer_service],
-              "rpc.type" => type,
-              "net.sock.peer.addr" => call.instance_variable_get(:@wrapped)&.peer
+              'rpc.type' => type,
+              'net.sock.peer.addr' => call.instance_variable_get(:@wrapped)&.peer
             }.compact
 
             attributes.merge!(allowed_metadata_headers(metadata.transform_keys(&:to_s)))
@@ -44,7 +49,7 @@ module OpenTelemetry
             instrumentation_tracer.in_span(
               # The specification requires there be no leading slash
               # https://github.com/open-telemetry/semantic-conventions/blob/5a2836bbea0b6e105b98370f331a7661bcf19540/docs/rpc/rpc-spans.md?plain=1#L63-L69
-              method.to_s.delete_prefix("/"),
+              method.to_s.delete_prefix('/'),
               attributes: attributes,
               kind: OpenTelemetry::Trace::SpanKind::CLIENT
             ) do |span|

data/lib/opentelemetry/instrumentation/grpc/patches/client_stub.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Grpc
+      module Patches
+        # Module to be prepended to force gRPC to use the client interceptor by
+        # default so the user doesn't have to manually add it when initializing a client.
+        module ClientStub
+          def initialize(host, creds, **args)
+            interceptors = args[:interceptors] || []
+            interceptors.unshift(Interceptors::ClientTracer.new) unless interceptors.any?(Interceptors::ClientTracer)
+            args[:interceptors] = interceptors
+
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/grpc/version.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 module OpenTelemetry
   module Instrumentation
     module Grpc
-      VERSION = "0.1.3"
+      VERSION = '0.2.0'
     end
   end
 end

data/lib/opentelemetry/instrumentation/grpc.rb

@@ -1,24 +1,21 @@
 # frozen_string_literal: true
 
-require "opentelemetry"
-require "opentelemetry-instrumentation-base"
-require "active_support/inflector"
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry'
+require 'opentelemetry-instrumentation-base'
 
 module OpenTelemetry
   module Instrumentation
-    # Contains the OpenTelemetry instrumentation for the Gruf gem
+    # Contains the OpenTelemetry instrumentation for the gRPC gem
     module Grpc
       class Error < StandardError; end
-
-      module_function
-
-      def client_interceptor
-        Interceptors::Client.new
-      end
     end
   end
 end
 
-require_relative "grpc/instrumentation"
-require_relative "grpc/interceptors/client"
-require_relative "grpc/version"
+require_relative 'grpc/instrumentation'
+require_relative 'grpc/version'
+require_relative 'grpc/interceptors/client_tracer'

data/lib/opentelemetry/instrumentation.rb

@@ -1,8 +1,22 @@
 # frozen_string_literal: true
 
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# OpenTelemetry is an open source observability framework, providing a
+# general-purpose API, SDK, and related tools required for the instrumentation
+# of cloud-native software, frameworks, and libraries.
+#
+# The OpenTelemetry module provides global accessors for telemetry objects.
+# See the documentation for the `opentelemetry-api` gem for details.
 module OpenTelemetry
+  # "Instrumentation" are specified by
+  # https://github.com/open-telemetry/opentelemetry-specification/blob/784635d01d8690c8f5fcd1f55bdbc8a13cf2f4f2/specification/glossary.md#instrumentation-library
+  #
+  # Instrumentation should be able to handle the case when the library is not installed on a user's system.
   module Instrumentation
   end
 end
 
-require_relative "instrumentation/grpc"
+require_relative 'instrumentation/grpc'

data/lib/opentelemetry-instrumentation-grpc.rb

@@ -1,3 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "opentelemetry/instrumentation"
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require_relative 'opentelemetry/instrumentation'

metadata

@@ -1,85 +1,76 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-grpc
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
-- Hazel Bachrach
+- OpenTelemetry Authors
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2025-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: opentelemetry-instrumentation-base
+  name: opentelemetry-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.22.4
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.22.4
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: opentelemetry-api
+  name: opentelemetry-instrumentation-base
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 0.23.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4'
-description:
+        version: 0.23.0
+description: gRPC instrumentation for the OpenTelemetry framework
 email:
-- hbachrach@dropbox.com
+- cncf-opentelemetry-contributors@lists.cncf.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".standard.yml"
+- ".rubocop.yml"
+- Appraisals
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
+- example/example_impl.rb
+- example/proto/example_api.proto
+- example/proto/example_api_pb.rb
+- example/proto/example_api_services_pb.rb
+- example/trace_demonstration.rb
 - lib/opentelemetry-instrumentation-grpc.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/grpc.rb
 - lib/opentelemetry/instrumentation/grpc/instrumentation.rb
-- lib/opentelemetry/instrumentation/grpc/interceptors/client.rb
+- lib/opentelemetry/instrumentation/grpc/interceptors/client_tracer.rb
+- lib/opentelemetry/instrumentation/grpc/patches/client_stub.rb
 - lib/opentelemetry/instrumentation/grpc/version.rb
-- sig/opentelemetry/instrumentation/grpc.rbs
-homepage: https://github.com/hibachrach/opentelemetry-instrumentation-grpc
+homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
-- MIT
+- Apache-2.0
 metadata:
-  homepage_uri: https://github.com/hibachrach/opentelemetry-instrumentation-grpc
-  source_code_uri: https://github.com/hibachrach/opentelemetry-instrumentation-grpc
-  changelog_uri: https://github.com/hibachrach/opentelemetry-instrumentation-grpc/blob/main/CHANGELOG.md
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-grpc/v0.2.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/grpc
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-grpc/v0.2.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -88,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -98,5 +89,5 @@ requirements: []
 rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
-summary: OpenTelemetry instrumentation for the Ruby gem `grpc`
+summary: gRPC instrumentation for the OpenTelemetry framework
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.standard.yml

@@ -1,3 +0,0 @@
-# For available configuration options, see:
-#   https://github.com/standardrb/standard
-ruby_version: 3.0

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at hbachrach@dropbox.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 Hazel Bachrach
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/sig/opentelemetry/instrumentation/grpc.rbs

@@ -1,8 +0,0 @@
-module OpenTelemetry
-  module Instrumentation
-    module Grpc
-      VERSION: String
-      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-    end
-  end
-end