opentelemetry-common 0.19.1 → 0.19.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec9e692d58a21b093de31eaea17d7ec972cf3716efb580658fd0f8a284addc0d
-  data.tar.gz: d6ecdd5414c4e8edea8acd1efb21ceb0dbc1d749beddeb29ec5143bad7b5b161
+  metadata.gz: 58a2d895adece2c6a96be7355362c2bc630da33eced02fad36f25ccb6f9dd543
+  data.tar.gz: 1db1cbe0cd4f566e7f96e475f25de913d639780a44bce94b3e40875fd813cc92
 SHA512:
-  metadata.gz: 73907cd010768cbe5ae6db720c7f3d830239c585b542d6a61f9e64b8d06c39d07bab5b87494225a44de3a68cdd13d64c2ca2225efcbcc3f8406f2bc7566a9caf
-  data.tar.gz: 65bb01c8d9dcab774ac65be62683a48eb2a1c2defcd8ad0736e64999451230fb284674f45ef82a1c276b2991158d39e2c4890aa36beb7a96fdb30ff5528f6dd1
+  metadata.gz: 836efd569b9efae0067951776782942b1d378232d80f29c7c8ddb7319f1d786b06b3f08cf741eb821adc0463bb09269249d656d9db5c63be1956bb7a2d850791
+  data.tar.gz: b42f204f66bb84eb28302ecff3135c0dea6c462e78e6e7b5a6e7244440a8aa6818d274b933995b4fba397ef6db4b52e706198dbadf13507a5df431e0d4aa8f01

data/CHANGELOG.md

@@ -1,4 +1,21 @@
+# Release History: opentelemetry-common
 
+### 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
+
+* (No significant changes)
 
 ### v0.19.1 / 2021-08-12
 

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

data/lib/opentelemetry/common/version.rb

@@ -6,6 +6,6 @@
 
 module OpenTelemetry
   module Common
-    VERSION = '0.19.1'
+    VERSION = '0.19.5'
   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.1
+  version: 0.19.5
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2022-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -137,17 +137,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.1/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-common/v0.19.5/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.1
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-common/v0.19.5
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -156,7 +158,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