feat: add gem for zero-code-instrumentation in otel-operator #1384

xuan-cao-swi · 2025-01-30T18:55:02Z

Description

This PR aims to contribute a script/gem that can load the necessary OpenTelemetry-related gems and initialize the SDK for the opentelemetry-operator. The script/gem also includes a resource detector as part of its features.

The main idea was inspired by new_relic, which prepends the bundler.require function and places the loading script at the end of the loading procedure. For apps or scripts that don't use Bundler or a Gemfile, more details on variations of app loading can be found in the README. Currently, the goal is to ensure that Rails apps can work, with future improvements in mind.

The reason behind creating this gem is to facilitate easy installation and dependency enforcement. Although for the OpenTelemetry-Operator Node.js, it puts the loading script directly in the src folder (and then copy over to binding volume), it still relies on the auto-instrumentation-node package to install all required packages (e.g., API/SDK and instrumentation packages).

The main purpose of the gem is to serve the OpenTelemetry-Operator, which requires more configuration changes (see the configuration section in the README). Users don't need to modify their Ruby app codebase while using the instrumentation from OpenTelemetry-Ruby, but anyone can still use it in any environment.

The gem name, file structure, and implementation need more suggestions to make them more reasonable. I have tested it with rails and sinatra (through rackup), and I currently still in the process of testing against the opentelemetry operator cluster locally. Once the operator testing done, I will mark the pr as ready.

xuan-cao-swi · 2025-02-26T19:14:43Z

We don't need to push to make the gem ready/release, but the script file need to get some review first.

github-actions · 2025-03-29T02:02:41Z

👋 This pull request has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep label to hold stale off permanently, or do nothing. If you do nothing this pull request will be closed eventually by the stale bot

github-actions · 2025-05-03T02:05:46Z

👋 This pull request has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep label to hold stale off permanently, or do nothing. If you do nothing this pull request will be closed eventually by the stale bot

zero-code-instrumentation/CHANGELOG.md

zero-code-instrumentation/README.md

zero-code-instrumentation/lib/zero-code-instrumentation.rb

arielvalentin · 2025-05-24T20:14:15Z

zero-code-instrumentation/test/zero-code-instrumentation_test.rb

+    _(registry.size).must_equal 1
+    _(registry.first.first.name).must_equal 'OpenTelemetry::Instrumentation::Net::HTTP'
+
+    ENV['OTEL_RUBY_ENABLED_INSTRUMENTATIONS'] = nil


Add this to the before or after block or in an ensure block to make sure that it is reset after every test

zero-code-instrumentation/zero-code-instrumentation.gemspec

zero-code-instrumentation/lib/version.rb

zero-code-instrumentation/CHANGELOG.md

zero-code-instrumentation/Gemfile

zero-code-instrumentation/README.md

zero-code-instrumentation/lib/zero-code-instrumentation.rb

Co-authored-by: Kayla Reopelle <[email protected]>

Co-authored-by: Ariel Valentin <[email protected]>

kaylareopelle

Thanks for making the updates, Xuan. I see some references to zero-code still in the content of the PR. What do you think about making updates to remove those references and replace them with auto-instrumentation?

opentelemetry-auto-instrumentation/README.md

kaylareopelle · 2025-07-16T22:55:25Z

.github/workflows/ci-contrib.yml

@@ -237,3 +237,40 @@ jobs:
        with:
          gem: "opentelemetry-sampler-${{ matrix.gem }}"
          ruby: "jruby-9.4.12.0"
+
+  zero-code-instrumentation:


Suggested change

zero-code-instrumentation:

auto-instrumentation:

kaylareopelle · 2025-07-16T22:55:38Z

.github/workflows/ci-contrib.yml

+      fail-fast: false
+      matrix:
+        gem:
+          - zero-code-instrumentation


Suggested change

- zero-code-instrumentation

- auto-instrumentation

kaylareopelle · 2025-07-16T22:56:26Z

.github/workflows/ci-contrib.yml

+      - uses: actions/checkout@v4
+      - name: "Test Ruby 3.3"
+        uses: ./.github/actions/test_gem
+        with:
+          gem: "${{ matrix.gem }}"
+          ruby: "3.3"


We should add a run for Ruby 3.4 as well

kaylareopelle · 2025-07-16T22:57:04Z

instrumentation/base/lib/opentelemetry/instrumentation/base.rb

@@ -214,6 +214,7 @@ def initialize(name, version, install_blk, present_blk,
      #
      # @param [Hash] config The config for this instrumentation
      def install(config = {})
+        puts "name: #{@name}"


Was this intended for debugging?

kaylareopelle · 2025-07-16T23:02:52Z

opentelemetry-auto-instrumentation/README.md

+
+Instrument Rails application with `bundle exec`:
+
+Since installing the `opentelemetry-auto-instrumentation` gem through `gem install`, anything related to the OpenTelemetry gem won't be stored in Bundler's gem path. Therefore, users need to add an additional gem path that contains these gems prior to initialization.


Suggested change

Since installing the `opentelemetry-auto-instrumentation` gem through `gem install`, anything related to the OpenTelemetry gem won't be stored in Bundler's gem path. Therefore, users need to add an additional gem path that contains these gems prior to initialization.

Since the `opentelemetry-auto-instrumentation` gem should be installed through `gem install`, anything related to the OpenTelemetry gem won't be stored in Bundler's gem path. Therefore, users need to add an additional gem path that contains these gems prior to initialization.

kaylareopelle · 2025-07-16T23:04:17Z

opentelemetry-auto-instrumentation/README.md

+| `OTEL_RUBY_OPERATOR` | Set to `true` to set the binding path for the OpenTelemetry Operator. | `/otel-auto-instrumentation-ruby` | N/A |
+| `OTEL_RUBY_RESOURCE_DETECTORS` | Determine what kind of resource detector is needed. Currently supports `container`, `azure`, and `google_cloud_platform`. Use commas to separate multiple detectors. | nil | `container,azure` |
+| `OTEL_RUBY_ENABLED_INSTRUMENTATIONS` | Shortcut used when you only want to instrument one or a couple of particular libraries. | nil | `redis,active_record` |
+| `OTEL_RUBY_AUTO_INSTRUMENTATION_DEBUG` | Set to `true` if want to see some debug information. This to avoid preload logger gem | nil | N/A |


Suggested change

| `OTEL_RUBY_AUTO_INSTRUMENTATION_DEBUG` | Set to `true` if want to see some debug information. This to avoid preload logger gem | nil | N/A |

| `OTEL_RUBY_AUTO_INSTRUMENTATION_DEBUG` | Set to `true` if want to see some debug information. This to avoid preloading the logger gem | nil | N/A |

kaylareopelle · 2025-07-16T23:06:54Z

opentelemetry-auto-instrumentation/README.md

+opentelemetry-resource-detector-azure
+opentelemetry-resource-detector-container
+```
+


I feel like the next section kind of warrants its own header. What do you think about this?

Suggested change

### Example installation strategies

kaylareopelle · 2025-07-16T23:13:56Z

opentelemetry-auto-instrumentation/lib/opentelemetry-auto-instrumentation.rb

+  end
+
+  # this is used for case when user particularly want to enable single instrumentation
+  OTEL_INSTRUMENTATION_MAP = {


Do we need to update this list every time we add a new gem? If so, is this something we could add to the instrumentation generator?

kaylareopelle · 2025-07-16T23:27:46Z

opentelemetry-auto-instrumentation/README.md

+| `OTEL_RUBY_ADDITIONAL_GEM_PATH` | Intended to be used for the OpenTelemetry Operator environment if you install `opentelemetry-auto-instrumentation` to a customized path. | nil | N/A |
+| `OTEL_RUBY_OPERATOR` | Set to `true` to set the binding path for the OpenTelemetry Operator. | `/otel-auto-instrumentation-ruby` | N/A |
+| `OTEL_RUBY_RESOURCE_DETECTORS` | Determine what kind of resource detector is needed. Currently supports `container`, `azure`, and `google_cloud_platform`. Use commas to separate multiple detectors. | nil | `container,azure` |
+| `OTEL_RUBY_ENABLED_INSTRUMENTATIONS` | Shortcut used when you only want to instrument one or a couple of particular libraries. | nil | `redis,active_record` |


xuan-cao-swi added 8 commits January 29, 2025 14:59

feat: init commit for zero-code instrumentation

9d13c5a

lint

444959a

rubocop

4c0c97b

enforce the dependencies version

8a2fadd

assume use bundle exec all the time

f96a637

merge

ef5f348

update readme

60a3ab2

cspell

3512225

xuan-cao-swi marked this pull request as ready for review February 26, 2025 19:13

xuan-cao-swi requested review from fbogsany, mwear, robertlaurin, dazuma, ericmustin, arielvalentin, ahayworth, plantfansam, robbkidd, simi, kaylareopelle and a team as code owners February 26, 2025 19:13

xuan-cao-swi mentioned this pull request Mar 3, 2025

Autoinstrumentation for opentelemetry ruby open-telemetry/opentelemetry-operator#3762

Open

github-actions bot added the stale Marks an issue/PR stale label Mar 29, 2025

kaylareopelle removed the stale Marks an issue/PR stale label Apr 2, 2025

update the script

2c880da

github-actions bot added the stale Marks an issue/PR stale label May 3, 2025

kaylareopelle added keep Ensures stale-bot keeps this issue/PR open and removed stale Marks an issue/PR stale labels May 6, 2025

arielvalentin reviewed May 24, 2025

View reviewed changes

zero-code-instrumentation/CHANGELOG.md Outdated Show resolved Hide resolved

arielvalentin reviewed May 24, 2025

View reviewed changes

zero-code-instrumentation/README.md Outdated Show resolved Hide resolved

arielvalentin reviewed May 24, 2025

View reviewed changes

zero-code-instrumentation/lib/zero-code-instrumentation.rb Outdated Show resolved Hide resolved

arielvalentin reviewed May 24, 2025

View reviewed changes

zero-code-instrumentation/zero-code-instrumentation.gemspec Outdated Show resolved Hide resolved

kaylareopelle reviewed May 27, 2025

View reviewed changes

merge

834855d

arielvalentin reviewed Jun 4, 2025

View reviewed changes

zero-code-instrumentation/lib/zero-code-instrumentation.rb Outdated Show resolved Hide resolved

zero-code-instrumentation/lib/zero-code-instrumentation.rb Outdated Show resolved Hide resolved

zero-code-instrumentation/lib/zero-code-instrumentation.rb Outdated Show resolved Hide resolved

xuan-cao-swi and others added 12 commits June 4, 2025 11:22

Update zero-code-instrumentation/lib/version.rb

76f6d0e

Co-authored-by: Kayla Reopelle <[email protected]>

Update zero-code-instrumentation/CHANGELOG.md

90995f7

Co-authored-by: Kayla Reopelle <[email protected]>

Update zero-code-instrumentation/README.md

917cb33

Co-authored-by: Kayla Reopelle <[email protected]>

Update zero-code-instrumentation/README.md

072c44a

Co-authored-by: Kayla Reopelle <[email protected]>

Update zero-code-instrumentation/README.md

dd16883

Co-authored-by: Kayla Reopelle <[email protected]>

Update zero-code-instrumentation/README.md

d4de6d0

Co-authored-by: Kayla Reopelle <[email protected]>

Update zero-code-instrumentation/README.md

342084f

Co-authored-by: Kayla Reopelle <[email protected]>

Update zero-code-instrumentation/lib/zero-code-instrumentation.rb

e1e4d20

Co-authored-by: Ariel Valentin <[email protected]>

Update zero-code-instrumentation/lib/zero-code-instrumentation.rb

2c2b9f8

Co-authored-by: Ariel Valentin <[email protected]>

revision

01a8779

revision

f432544

change gem name

5104dd8

kaylareopelle reviewed Jun 13, 2025

View reviewed changes

opentelemetry-auto-instrumentation/README.md Outdated Show resolved Hide resolved

remove zero as reference name

1e8c2b2

kaylareopelle approved these changes Jun 17, 2025

View reviewed changes

Merge branch 'main' into auto-instrumentation

d0d7534

xuan-cao-swi requested a review from arielvalentin June 17, 2025 17:56

xuan-cao-swi mentioned this pull request Jun 17, 2025

[autoinstrumentation] add ruby autoinstrumentation open-telemetry/opentelemetry-operator#3756

Open

Merge branch 'main' into auto-instrumentation

7f285d2

kaylareopelle reviewed Jul 17, 2025

View reviewed changes


		Instrument Rails application with `bundle exec`:

		Since installing the `opentelemetry-auto-instrumentation` gem through `gem install`, anything related to the OpenTelemetry gem won't be stored in Bundler's gem path. Therefore, users need to add an additional gem path that contains these gems prior to initialization.

	Since installing the `opentelemetry-auto-instrumentation` gem through `gem install`, anything related to the OpenTelemetry gem won't be stored in Bundler's gem path. Therefore, users need to add an additional gem path that contains these gems prior to initialization.
	Since the `opentelemetry-auto-instrumentation` gem should be installed through `gem install`, anything related to the OpenTelemetry gem won't be stored in Bundler's gem path. Therefore, users need to add an additional gem path that contains these gems prior to initialization.

	\| `OTEL_RUBY_AUTO_INSTRUMENTATION_DEBUG` \| Set to `true` if want to see some debug information. This to avoid preload logger gem \| nil \| N/A \|
	\| `OTEL_RUBY_AUTO_INSTRUMENTATION_DEBUG` \| Set to `true` if want to see some debug information. This to avoid preloading the logger gem \| nil \| N/A \|

	\| `OTEL_RUBY_ENABLED_INSTRUMENTATIONS` \| Shortcut used when you only want to instrument one or a couple of particular libraries. \| nil \| `redis,active_record` \|
	\| `OTEL_RUBY_ENABLED_INSTRUMENTATIONS` \| Configuration used when you only want to install instrumentation for specific libraries. \| nil \| `redis,active_record` \|

feat: add gem for zero-code-instrumentation in otel-operator #1384

Are you sure you want to change the base?

feat: add gem for zero-code-instrumentation in otel-operator #1384

Conversation

xuan-cao-swi commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

xuan-cao-swi commented Feb 26, 2025

Uh oh!

github-actions bot commented Mar 29, 2025

Uh oh!

github-actions bot commented May 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kaylareopelle left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

xuan-cao-swi commented Jan 30, 2025 •

edited

Loading