opentelemetry-common 0.14.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dcc91a5cff7866e5f3a083305bf12db4853c15c907e7e46644045cd1fc8578c
-  data.tar.gz: 35261314130175ed09723633373238b1c9718e6e603e9c98aeec728416075b57
+  metadata.gz: 60edcde9894cb1557d7520894daeb80885ca09f88d1f7afa4b42fc42ca215e09
+  data.tar.gz: e7133c891b98460419438509074931b647e987a099704f0da47f98d1a90182ec
 SHA512:
-  metadata.gz: 40e5f48d5576429a3f8dd3d777de7039bcc94ca20298d6be7d8daac766fa7b992ff05db367ff9cfb8b53de95f8078e72673fa63411bd86cab869bd7fde851c05
-  data.tar.gz: c09f7152fda0d8c260e426356f5ee3200a075736b2091b408341eddbec42443f8dc23f1f9696d59c690ea767c6313572594c822b5d914af1cc07321b59f986ef
+  metadata.gz: 41de8ff040c84ef6ec156c168426e72f46e215aaeacacf089b9bbcaad7efd69903fe15e62593d7726dd0bc0def2abd6be05b4cfedb849b99008fc69d2bf8bc3a
+  data.tar.gz: fa0ba69125bc824dd794154d207e1c8d95b6b00dcff9f60a3fbf07eda6933bb52ded8b3c7370cab9412a6011b3d5fa43e6dcb9e2c6404863674580ccb252c68b

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 
 
+### v0.19.0 / 2021-06-23
+
+* ADDED: Add Tracer.non_recording_span to API 
+
+### v0.18.0 / 2021-05-21
+
+* BREAKING CHANGE: Replace Time.now with Process.clock_gettime 
+
+* FIXED: Replace Time.now with Process.clock_gettime 
+
+### v0.17.0 / 2021-04-22
+
+* ADDED: Add zipkin exporter 
+* ADDED: Processors validate exporters on init. 
+
+### v0.16.0 / 2021-03-17
+
+* ADDED: Instrument lmdb gem 
+* FIXED: Remove passwords from http.url 
+* DOCS: Replace Gitter with GitHub Discussions 
+
+### v0.15.0 / 2021-02-18
+
+* (No significant changes)
+
 ### v0.14.0 / 2021-02-03
 
 * (No significant changes)

data/README.md

@@ -53,8 +53,10 @@ end
 
 The `opentelemetry-common` gem source is on github, along with related gems.
 
-The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our gitter channel or attending our weekly meeting. See the meeting calendar for dates and times. For more information on this and other language SIGs, see the OpenTelemetry community page.
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the meeting calendar for dates and times. For more information on this and other language SIGs, see the OpenTelemetry community page.
 
 ## License
 
 The `opentelemetry-common` gem is distributed under the Apache 2.0 license. See LICENSE for more information.
+
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

data/lib/opentelemetry/common/test_helpers.rb

@@ -0,0 +1,19 @@
+# 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

data/lib/opentelemetry/common/utilities.rb

@@ -14,13 +14,29 @@ module OpenTelemetry
 
       # Returns nil if timeout is nil, 0 if timeout has expired,
       # or the remaining (positive) time left in seconds.
+      #
+      # @param [Numeric] timeout The timeout in seconds. May be nil.
+      # @param [Numeric] start_time Start time for timeout returned
+      #   by {timeout_timestamp}.
+      #
+      # @return [Numeric] remaining (positive) time left in seconds.
+      #   May be nil.
       def maybe_timeout(timeout, start_time)
         return nil if timeout.nil?
 
-        timeout -= (Time.now - start_time)
+        timeout -= (timeout_timestamp - start_time)
         timeout.positive? ? timeout : 0
       end
 
+      # Returns a timestamp suitable to pass as the start_time
+      # argument to {maybe_timeout}. This has no meaning outside
+      # of the current process.
+      #
+      # @return [Numeric]
+      def timeout_timestamp
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+
       # Encodes a string in utf8
       #
       # @param [String] string The string to be utf8 encoded
@@ -46,8 +62,37 @@ module OpenTelemetry
         placeholder
       end
 
+      # Truncates a string if it exceeds the size provided.
+      #
+      # @param [String] string The string to be truncated
+      # @param [Integer] size The max size of the string
+      #
+      # @return [String]
+      def truncate(string, size)
+        string.size > size ? "#{string[0...size - 3]}..." : string
+      end
+
       def untraced
-        OpenTelemetry::Trace.with_span(OpenTelemetry::Trace::Span.new) { yield }
+        OpenTelemetry::Trace.with_span(OpenTelemetry::Trace.non_recording_span(OpenTelemetry::Trace::SpanContext.new)) { yield }
+      end
+
+      # Returns a URL string with userinfo removed.
+      #
+      # @param [String] url The URL string to cleanse.
+      #
+      # @return [String] the cleansed URL.
+      def cleanse_url(url)
+        cleansed_url = URI.parse(url)
+        cleansed_url.password = nil
+        cleansed_url.user = nil
+        cleansed_url.to_s
+      rescue URI::Error
+        url
+      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) }
       end
     end
   end

data/lib/opentelemetry/common/version.rb

@@ -6,6 +6,6 @@
 
 module OpenTelemetry
   module Common
-    VERSION = '0.14.0'
+    VERSION = '0.19.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-common
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.19.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-03 00:00:00.000000000 Z
+date: 2021-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.0.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -137,16 +137,17 @@ 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/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.14.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-common/v0.19.0/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.14.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-common/v0.19.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -162,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Common helpers for OpenTelemetry