opentelemetry-common 0.19.2 → 0.19.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccd5d53613769dd8795434123d1c3b5d0c487831226174799c37cd160c5d594a
-  data.tar.gz: 487b2d429364fe80cc4bfcbb90b8e2ca242978ec12a95460fed9d83ceb6e0ce3
+  metadata.gz: 286a98f703c4c88fa99e50dc57c30aa2d49ca4eef437a7ea3151ff904ea16dfc
+  data.tar.gz: b6cbfd1808ff51e47600dc27e6093d903b42c7c04ca5333114ad8447a269563c
 SHA512:
-  metadata.gz: 3895f4fef1bdf2505ccee89a38c1769450733233f2e2e59ac5fa8a2b38205efd638809f65fb7335890ed5086cd0026b00361f62ccaad89240024680fb357ce53
-  data.tar.gz: be977cd4cf43b117b5004ed17946cd7c72412aac568e859738ab460db16be3fad2e9053ba6ae2c046483de3d609e23290060a3958c59f419a5732de4cb873bcf
+  metadata.gz: 694e7ed9f4a0c0ea9463c9bce044d16ea2ebdb6805d6d6cdb4c66dac1f5e1c2066951b4b30afd5455afd1bc49c2f7bd9804a50ac90ba873a133fedea5627a282
+  data.tar.gz: a3c5598137f319384f48196f529b2c627b4ed302d646dab2849c29db8171ed9f0c1f866b82751508da9a259b0fe73f85a8baf6c02bcfa171292a9152afe80920

data/CHANGELOG.md

@@ -1,4 +1,21 @@
+# Release History: opentelemetry-common
 
+### v0.19.6 / 2022-05-18
+
+* (No significant changes)
+
+### v0.19.5 / 2022-05-10
+
+* FIXED: Common changelog 
+
+### v0.19.4 / 2022-05-08
+
+* FIXED: Check that a variable is a string before truncating
+* FIXED: Attribute length limit. only truncate strings and strings in arrays
+
+### v0.19.3 / 2021-12-01
+
+* FIXED: Change net attribute names to match the semantic conventions spec for http 
 
 ### v0.19.2 / 2021-09-29
 

data/README.md

@@ -40,8 +40,8 @@ tracer.in_span(
     'http.method' => req.method,
     'http.scheme' => USE_SSL_TO_SCHEME[use_ssl?],
     'http.target' => req.path,
-    'peer.hostname' => @address,
-    'peer.port' => @port
+    'net.peer.name' => @address,
+    'net.peer.port' => @port
   ),
   kind: :client
 ) do |span|

data/lib/opentelemetry/common/http/client_context.rb

@@ -11,7 +11,7 @@ module OpenTelemetry
       module ClientContext
         extend self
 
-        CURRENT_ATTRIBUTES_HASH = Context.create_key('current-attributes-hash')
+        CURRENT_ATTRIBUTES_HASH = Context.create_key('http-client-context-attributes-hash')
 
         private_constant :CURRENT_ATTRIBUTES_HASH
 

data/lib/opentelemetry/common/propagation/rack_env_getter.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Common
+    module Propagation
+      # The RackEnvGetter class provides a common methods for reading
+      # keys from a rack environment. It abstracts away the rack-normalization
+      # process so that keys can be looked up without having to transform them
+      # first. With this class you can get +traceparent+ instead of
+      # +HTTP_TRACEPARENT+
+      class RackEnvGetter
+        # Converts key into a rack-normalized key and reads it from the carrier.
+        # Useful for extract operations.
+        def get(carrier, key)
+          carrier[to_rack_key(key)] || carrier[key]
+        end
+
+        # Reads all keys from a carrier and converts them from the rack-normalized
+        # form to the original. The resulting keys will be lowercase and
+        # underscores will be replaced with dashes.
+        def keys(carrier)
+          carrier.keys.map(&method(:from_rack_key))
+        end
+
+        private
+
+        def to_rack_key(key)
+          ret = 'HTTP_' + key
+          ret.tr!('-', '_')
+          ret.upcase!
+          ret
+        end
+
+        def from_rack_key(key)
+          start = key.start_with?('HTTP_') ? 5 : 0
+          ret = key[start..-1]
+          ret.tr!('_', '-')
+          ret.downcase!
+          ret
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/common/propagation/symbol_key_getter.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Common
+    module Propagation
+      # The SymbolKeyGetter class provides a common method for reading
+      # symbol keys from a hash.
+      class SymbolKeyGetter
+        # Converts key into a symbol and reads it from the carrier.
+        # Useful for extract operations.
+        def get(carrier, key)
+          carrier[key.to_sym]
+        end
+
+        # Reads all keys from a carrier
+        def keys(carrier)
+          carrier.keys.map(&:to_s)
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/common/propagation.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require_relative './propagation/rack_env_getter'
+require_relative './propagation/symbol_key_getter'
+
+module OpenTelemetry
+  module Common
+    # Propagation contains common helpers for context propagation.
+    module Propagation
+      extend self
+
+      RACK_ENV_GETTER = RackEnvGetter.new
+      SYMBOL_KEY_GETTER = SymbolKeyGetter.new
+      private_constant :RACK_ENV_GETTER, :SYMBOL_KEY_GETTER
+
+      # Returns a {RackEnvGetter} instance suitable for reading values from a
+      # Rack environment.
+      def rack_env_getter
+        RACK_ENV_GETTER
+      end
+
+      # Returns a {SymbolKeyGetter} instance for reading values from a
+      # symbol keyed hash.
+      def symbol_key_getter
+        SYMBOL_KEY_GETTER
+      end
+    end
+  end
+end

data/lib/opentelemetry/common/utilities.rb

@@ -72,6 +72,17 @@ module OpenTelemetry
         string.size > size ? "#{string[0...size - 3]}..." : string
       end
 
+      def truncate_attribute_value(value, limit)
+        case value
+        when Array
+          value.map { |x| truncate_attribute_value(x, limit) }
+        when String
+          truncate(value, limit)
+        else
+          value
+        end
+      end
+
       def untraced
         OpenTelemetry::Trace.with_span(OpenTelemetry::Trace.non_recording_span(OpenTelemetry::Trace::SpanContext.new)) { yield }
       end
@@ -90,6 +101,32 @@ module OpenTelemetry
         url
       end
 
+      # Returns the first non nil environment variable requested,
+      # or the default value if provided.
+      #
+      # @param [String] env_vars The environment variable(s) to retrieve
+      # @param default The fallback value to return if the requested
+      #  env var(s) are not present
+      #
+      # @returns [String]
+      def config_opt(*env_vars, default: nil)
+        ENV.values_at(*env_vars).compact.fetch(0, default)
+      end
+
+      # Returns a true if the provided url is valid
+      #
+      # @param [String] url the URL string to test validity
+      #
+      # @return [boolean]
+      def valid_url?(url)
+        return false if url.nil? || url.strip.empty?
+
+        URI(url)
+        true
+      rescue URI::InvalidURIError
+        false
+      end
+
       # Returns true if exporter is a valid exporter.
       def valid_exporter?(exporter)
         exporter && %i[export shutdown force_flush].all? { |m| exporter.respond_to?(m) }

data/lib/opentelemetry/common/version.rb

@@ -6,6 +6,6 @@
 
 module OpenTelemetry
   module Common
-    VERSION = '0.19.2'
+    VERSION = '0.19.6'
   end
 end

data/lib/opentelemetry/common.rb

@@ -6,6 +6,7 @@
 
 require 'opentelemetry'
 require 'opentelemetry/common/http'
+require 'opentelemetry/common/propagation'
 require 'opentelemetry/common/utilities'
 require 'opentelemetry/common/version'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-common
 version: !ruby/object:Gem::Version
-  version: 0.19.2
+  version: 0.19.6
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2022-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-test-helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -137,17 +151,19 @@ files:
 - lib/opentelemetry/common.rb
 - lib/opentelemetry/common/http.rb
 - lib/opentelemetry/common/http/client_context.rb
-- lib/opentelemetry/common/test_helpers.rb
+- lib/opentelemetry/common/propagation.rb
+- lib/opentelemetry/common/propagation/rack_env_getter.rb
+- lib/opentelemetry/common/propagation/symbol_key_getter.rb
 - lib/opentelemetry/common/utilities.rb
 - lib/opentelemetry/common/version.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-common/v0.19.2/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-common/v0.19.6/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/common
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-common/v0.19.2
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-common/v0.19.6
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -156,7 +172,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/common/test_helpers.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-def with_env(new_env)
-  env_to_reset = ENV.select { |k, _| new_env.key?(k) }
-  keys_to_delete = new_env.keys - ENV.keys
-  new_env.each_pair { |k, v| ENV[k] = v }
-  yield
-ensure
-  env_to_reset.each_pair { |k, v| ENV[k] = v }
-  keys_to_delete.each { |k| ENV.delete(k) }
-end
-
-def exportable_timestamp(time = Time.now)
-  (time.to_r * 1_000_000_000).to_i
-end