revision

Author: xuan-cao-swi

zero-code-instrumentation/README.md

@@ -126,13 +126,13 @@ These environment variables are not standard OpenTelemetry environment variables
 
 | Environment Variable | Description | Default | Example |
 |----------------------|-------------|---------|---------|
-| `REQUIRE_BUNDLER` | Set to `true` if you are using Bundler to install gems but without `Bundler.require` in your script during initialization. | nil | N/A |
-| `USE_BUNDLE_EXEC` | Set to `true` if initializing through `bundle exec`. | nil | N/A |
-| `ADDITIONAL_GEM_PATH` | Intended to be used for the OpenTelemetry Operator environment if you install `zero-code-instrumentation` to a customized path. | nil | N/A |
-| `OTEL_OPERATOR` | Set to `true` to set the binding path for the OpenTelemetry Operator. | `/otel-auto-instrumentation-ruby` | N/A |
+| `OTEL_RUBY_REQUIRE_BUNDLER` | Set to `true` if you are using Bundler to install gems but without `Bundler.require` in your script during initialization. | nil | N/A |
+| `OTEL_RUBY_ADDITIONAL_GEM_PATH` | Intended to be used for the OpenTelemetry Operator environment if you install `zero-code-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` |
-| `ZERO_CODE_DEBUG` | Set to `true` if want to see some debug information. This to avoid preload logger gem | nil | N/A |
+| `OTEL_RUBY_ZERO_CODE_DEBUG` | Set to `true` if want to see some debug information. This to avoid preload logger gem | nil | N/A |
+| `OTEL_RUBY_UNLOAD_LIBRARY` | Use OTEL_RUBY_UNLOAD_LIBRARY to avoid certain gem preload (esp. google protobuf) | nil | N/A |
 
 ## How can I get involved?
 

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

@@ -77,7 +77,7 @@ def detect_resource_from_env
   def determine_enabled_instrumentation
     env = ENV['OTEL_RUBY_ENABLED_INSTRUMENTATIONS'].to_s
 
-    env.split(',').map { |instrumentation| OTEL_INSTRUMENTATION_MAP[instrumentation] }
+    env.split(',').each_with_object({}) { |instrumentation, config| config[OTEL_INSTRUMENTATION_MAP[instrumentation]] = {} }
   end
 
   def require_otel
@@ -90,13 +90,7 @@ def require_otel
 
       OpenTelemetry::SDK.configure do |c|
         c.resource = detect_resource_from_env
-        if required_instrumentation.empty?
-          c.use_all # enables all instrumentation!
-        else
-          required_instrumentation.each do |instrumentation|
-            c.use instrumentation
-          end
-        end
+        c.use_all(required_instrumentation)
       end
       OpenTelemetry.logger.info { 'Auto-instrumentation initialized' }
     rescue StandardError => e
@@ -113,27 +107,30 @@ def require_otel
 
 # set OTEL_OPERATOR to false if not in autoinstrumentation-ruby image, default to /otel-auto-instrumentation-ruby
 # /otel-auto-instrumentation-ruby is set in opentelemetry-operator ruby.go
-operator_gem_path = (ENV['OTEL_OPERATOR'].nil? || ENV['OTEL_OPERATOR'] == 'true') ? '/otel-auto-instrumentation-ruby' : nil
-additional_gem_path = operator_gem_path || ENV['ADDITIONAL_GEM_PATH'] || Gem.dir
-puts "Loading the additional gem path from #{additional_gem_path}" if ENV['ZERO_CODE_DEBUG'] == 'true'
+operator_gem_path = (ENV['OTEL_RUBY_OPERATOR'].nil? || ENV['OTEL_RUBY_OPERATOR'] == 'true') ? '/otel-auto-instrumentation-ruby' : nil
+additional_gem_path = operator_gem_path || ENV['OTEL_RUBY_ADDITIONAL_GEM_PATH'] || Gem.dir
+puts "Loading the additional gem path from #{additional_gem_path}" if ENV['OTEL_RUBY_ZERO_CODE_DEBUG'] == 'true'
 
-# use UNLOAD_LIBRARY to avoid certain gem preload (esp. google protobuf)
-# e.g export UNLOAD_LIBRARY=google-protobuf;googleapis-common-protos-types
-unload_libraries = ENV['UNLOAD_LIBRARY'].to_s.split(';')
+# use OTEL_RUBY_UNLOAD_LIBRARY to avoid certain gem preload (esp. google protobuf)
+# e.g export OTEL_RUBY_UNLOAD_LIBRARY=google-protobuf;googleapis-common-protos-types
+unload_libraries = ENV['OTEL_RUBY_UNLOAD_LIBRARY'].to_s.split(';')
 loaded_library_file_path = Array.new
 
 Dir.glob("#{additional_gem_path}/gems/*").each do |file_path|
   gem_name = file_path.match(/\/gems\/([^\/]+)-\d/)[1]
-  include_file = (file_path.include?('opentelemetry') || file_path.include?('google')) && !unload_libraries.include? gem_name
+  include_file = (file_path.include?('opentelemetry') || file_path.include?('google')) && !unload_libraries.include?(gem_name)
   loaded_library_file_path << file_path if include_file
 end
 
-puts loaded_library_file_path.to_s if ENV['ZERO_CODE_DEBUG'] == 'true'
-
 loaded_library_file_path.each do |file_path|
   $LOAD_PATH.unshift("#{file_path}/lib")
 end
 
+if ENV['OTEL_RUBY_ZERO_CODE_DEBUG'] == 'true'
+  puts loaded_library_file_path.to_s
+  puts "$LOAD_PATH #{$LOAD_PATH}"
+end
+
 require 'opentelemetry-sdk'
 require 'opentelemetry-instrumentation-all'
 require 'opentelemetry-helpers-mysql'
@@ -146,4 +143,4 @@ def require_otel
 
 Bundler::Runtime.prepend(OTelBundlerPatch)
 
-Bundler.require if ENV['REQUIRE_BUNDLER'].to_s == 'true'
+Bundler.require if ENV['OTEL_RUBY_REQUIRE_BUNDLER'].to_s == 'true'

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

@@ -19,6 +19,8 @@
     OTelBundlerPatch.send(:undef_method, :require)
     OpenTelemetry::Instrumentation::Net::HTTP::Instrumentation.instance_variable_get(:@instance).instance_variable_set(:@installed, false)
     OpenTelemetry::Instrumentation::Rake::Instrumentation.instance_variable_get(:@instance).instance_variable_set(:@installed, false)
+
+    ENV['OTEL_RUBY_ENABLED_INSTRUMENTATIONS'] = nil
   end
 
   it 'simple_load_test' do
@@ -64,7 +66,6 @@
     _(registry.size).must_equal 1
     _(registry.first.first.name).must_equal 'OpenTelemetry::Instrumentation::Net::HTTP'
 
-    ENV['OTEL_RUBY_ENABLED_INSTRUMENTATIONS'] = nil
   end
 
   it 'simple_load_with_additional_resource' do

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

@@ -26,15 +26,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 3.1'
 
-  spec.add_dependency 'opentelemetry-api', '1.4.0'
-  spec.add_dependency 'opentelemetry-exporter-otlp', '0.29.1'
-  spec.add_dependency 'opentelemetry-helpers-mysql', '0.2.0'
-  spec.add_dependency 'opentelemetry-helpers-sql-obfuscation', '0.3.0'
-  spec.add_dependency 'opentelemetry-instrumentation-all', '0.72.0'
-  spec.add_dependency 'opentelemetry-resource-detector-azure', '0.2.0'
-  spec.add_dependency 'opentelemetry-resource-detector-container', '0.2.0'
-  spec.add_dependency 'opentelemetry-resource-detector-google_cloud_platform', '0.2.0'
-  spec.add_dependency 'opentelemetry-sdk', '1.6.0'
+  spec.add_dependency 'opentelemetry-api', '~> 1.4.0'
+  spec.add_dependency 'opentelemetry-exporter-otlp', '~> 0.29.1'
+  spec.add_dependency 'opentelemetry-helpers-mysql', '~> 0.2.0'
+  spec.add_dependency 'opentelemetry-helpers-sql-obfuscation', '~> 0.3.0'
+  spec.add_dependency 'opentelemetry-instrumentation-all', '~> 0.72.0'
+  spec.add_dependency 'opentelemetry-resource-detector-azure', '~> 0.2.0'
+  spec.add_dependency 'opentelemetry-resource-detector-container', '~> 0.2.0'
+  spec.add_dependency 'opentelemetry-resource-detector-google_cloud_platform', '~> 0.2.0'
+  spec.add_dependency 'opentelemetry-sdk', '~> 1.6.0'
 
   spec.add_development_dependency 'bundler', '~> 2.4'
   spec.add_development_dependency 'minitest', '~> 5.0'
@@ -51,5 +51,5 @@ Gem::Specification.new do |spec|
     spec.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{spec.name}/#{spec.version}"
   end
 
-  spec.post_install_message = File.read(File.expand_path('../POST_INSTALL_MESSAGE', __dir__))
+  # spec.post_install_message = File.read(File.expand_path('../POST_INSTALL_MESSAGE', __dir__))
 end