opentelemetry-instrumentation-base 0.20.0 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36880f3027db5ce9434787fc96f373497e7e4a0986bba01db8936abd6a6c6f60
-  data.tar.gz: 2b6e9ef13f8ccad67f9c3d1138343192b4ea9df5fc0393acea2351b3bc498cf4
+  metadata.gz: 68289a48e73f4b932c2bfec1ec6c41bd2762dd6c7a8801bd58f1f84307857335
+  data.tar.gz: f7897e296091d94828653e0696ab5321e3ee63f355e082228a0d608b34ab5494
 SHA512:
-  metadata.gz: 90af953fd300ccbf1dbde0381999279d3773d79a02297b97ad5148eb070ea6fab7cbcaf38b82f6f2f3b60e4256b49302f0f844e77cfecfcd7d9d4b11b05fe095
-  data.tar.gz: e58a221f4f846955c7d122b15766b2afba00007343ae54e8fa890346ad3d3ff56c08bdb9d297084ba0c84da6cd9152dba27b09e74850811737143181cd47c24f
+  metadata.gz: 2f49d6aa1665d9452a390d160df35b3d004e221621284aac29662d9b8c8d01c22a96fed65ccc4d15fd2d6a344afa68729c345a31ce98f0fcc7459f77157624a3
+  data.tar.gz: a18559b8b4ae2fb1d9ef12d132f2268089139594ac6c6f9e2326174b3930812307347e5961a051d4e7a6470ee54043847344850e9e12c3d1d4a0c6ef501a7cef

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release History: opentelemetry-instrumentation-base
 
+### v0.21.1 / 2023-01-14
+
+* DOCS: Fix gem homepage 
+* DOCS: More gem documentation fixes 
+
+### v0.21.0 / 2022-05-26
+
+* BREAKING CHANGE: This requires upgrading both the SDK and Instrumentation gem in tandem
+
+
 ### v0.20.0 / 2022-05-02
 
 * ADDED: Validate Using Enums 

data/README.md

@@ -148,7 +148,7 @@ The `opentelemetry-instrumentation-base` gem is distributed under the Apache 2.0
 
 [bundler-home]: https://bundler.io
 [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
-[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
+[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
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

data/lib/opentelemetry/instrumentation/base.rb

@@ -72,9 +72,9 @@ module OpenTelemetry
 
         private_constant :NAME_REGEX, :VALIDATORS
 
-        private :new # rubocop:disable Style/AccessModifierDeclarations
+        private :new
 
-        def inherited(subclass)
+        def inherited(subclass) # rubocop:disable Lint/MissingSuper
           OpenTelemetry::Instrumentation.registry.register(subclass)
         end
 
@@ -193,6 +193,7 @@ module OpenTelemetry
 
       alias installed? installed
 
+      # rubocop:disable Metrics/ParameterLists
       def initialize(name, version, install_blk, present_blk,
                      compatible_blk, options)
         @name = name
@@ -205,6 +206,7 @@ module OpenTelemetry
         @options = options
         @tracer = OpenTelemetry::Trace::Tracer.new
       end
+      # rubocop:enable Metrics/ParameterLists
 
       # Install instrumentation with the given config. The present? and compatible?
       # will be run first, and install will return false if either fail. Will
@@ -266,7 +268,7 @@ module OpenTelemetry
       # Invalid configuration values are logged, and replaced by the default.
       #
       # @param [Hash] user_config The user supplied configuration hash
-      def config_options(user_config) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def config_options(user_config) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         @options ||= {}
         user_config ||= {}
         config_overrides = config_overrides_from_env
@@ -275,6 +277,7 @@ module OpenTelemetry
           config_value = user_config[option_name]
           config_override = coerce_env_var(config_overrides[option_name], option[:validation_type]) if config_overrides[option_name]
 
+          # rubocop:disable Lint/DuplicateBranch
           value = if config_value.nil? && config_override.nil?
                     option[:default]
                   elsif option[:validator].respond_to?(:include?) && option[:validator].include?(config_override)
@@ -292,6 +295,7 @@ module OpenTelemetry
                     )
                     option[:default]
                   end
+          # rubocop:enable Lint/DuplicateBranch
 
           h[option_name] = value
         rescue StandardError => e

data/lib/opentelemetry/instrumentation/version.rb

@@ -6,6 +6,6 @@
 
 module OpenTelemetry
   module Instrumentation
-    VERSION = '0.20.0'
+    VERSION = '0.21.1'
   end
 end

data/lib/opentelemetry/instrumentation.rb

@@ -5,19 +5,12 @@
 # SPDX-License-Identifier: Apache-2.0
 
 require 'opentelemetry'
-require 'opentelemetry/instrumentation/registry'
+require 'opentelemetry-registry'
 require 'opentelemetry/instrumentation/base'
 
 module OpenTelemetry
   # The instrumentation module contains functionality to register and install
   # instrumentation
   module Instrumentation
-    extend self
-
-    # @return [Registry] registry containing all known
-    #  instrumentation
-    def registry
-      @registry ||= Registry.new
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-base
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-02 00:00:00.000000000 Z
+date: 2023-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -24,20 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-registry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.41.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.41.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -150,16 +164,15 @@ files:
 - lib/opentelemetry-instrumentation-base.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/base.rb
-- lib/opentelemetry/instrumentation/registry.rb
 - lib/opentelemetry/instrumentation/version.rb
-homepage: https://github.com/open-telemetry/opentelemetry-ruby
+homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-base/v0.20.0/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/base
-  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-base/v0.20.0
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-base/0.21.1/file/CHANGELOG.md
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/base
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-base/0.21.1
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -168,7 +181,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/opentelemetry/instrumentation/registry.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Instrumentation
-    # The instrumentation Registry contains information about instrumentation
-    # available and facilitates discovery, installation and
-    # configuration. This functionality is primarily useful for SDK
-    # implementors.
-    class Registry
-      def initialize
-        @lock = Mutex.new
-        @instrumentation = []
-      end
-
-      # @api private
-      def register(instrumentation)
-        @lock.synchronize do
-          @instrumentation << instrumentation
-        end
-      end
-
-      # Lookup an instrumentation definition by name. Returns nil if +instrumentation_name+
-      # is not found.
-      #
-      # @param [String] instrumentation_name A stringified class name for an instrumentation
-      # @return [Instrumentation]
-      def lookup(instrumentation_name)
-        @lock.synchronize do
-          find_instrumentation(instrumentation_name)
-        end
-      end
-
-      # Install the specified instrumentation with optionally specified configuration.
-      #
-      # @param [Array<String>] instrumentation_names An array of instrumentation names to
-      #   install
-      # @param [optional Hash<String, Hash>] instrumentation_config_map A map of
-      #   instrumentation_name to config. This argument is optional and config can be
-      #   passed for as many or as few instrumentations as desired.
-      def install(instrumentation_names, instrumentation_config_map = {})
-        @lock.synchronize do
-          instrumentation_names.each do |instrumentation_name|
-            instrumentation = find_instrumentation(instrumentation_name)
-            if instrumentation.nil?
-              OpenTelemetry.logger.warn "Could not install #{instrumentation_name} because it was not found"
-            else
-              install_instrumentation(instrumentation, instrumentation_config_map[instrumentation.name])
-            end
-          end
-        end
-      end
-
-      # Install all instrumentation available and installable in this process.
-      #
-      # @param [optional Hash<String, Hash>] instrumentation_config_map A map of
-      #   instrumentation_name to config. This argument is optional and config can be
-      #   passed for as many or as few instrumentations as desired.
-      def install_all(instrumentation_config_map = {})
-        @lock.synchronize do
-          @instrumentation.map(&:instance).each do |instrumentation|
-            install_instrumentation(instrumentation, instrumentation_config_map[instrumentation.name])
-          end
-        end
-      end
-
-      private
-
-      def find_instrumentation(instrumentation_name)
-        @instrumentation.detect { |a| a.instance.name == instrumentation_name }
-                   &.instance
-      end
-
-      def install_instrumentation(instrumentation, config)
-        if instrumentation.install(config)
-          OpenTelemetry.logger.info "Instrumentation: #{instrumentation.name} was successfully installed with the following options #{instrumentation.config}"
-        else
-          OpenTelemetry.logger.warn "Instrumentation: #{instrumentation.name} failed to install"
-        end
-      rescue => e # rubocop:disable Style/RescueStandardError
-        OpenTelemetry.handle_error(exception: e, message: "Instrumentation: #{instrumentation.name} unhandled exception during install: #{e.backtrace}")
-      end
-    end
-  end
-end