opentelemetry-exporter-otlp 0.14.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34a61cff86886f8c7f613a563002bc1259278565cb95dfb5cc445790d17ddc0d
-  data.tar.gz: faa25394d4f4124c9a30dcf1d3b7b278c58642f6f3ac9182c04f19f8952767ec
+  metadata.gz: bf50130d2b4ab1fb492992a5b468988d1bbb404847f94820e46bd73b3beb9a25
+  data.tar.gz: dd4d624818f79259fe10c307e64441382d1e98e5304d89cf4ffac3d9290a42f2
 SHA512:
-  metadata.gz: 447e268c0a5c7e68d41a1686d8a9567e5de4eca855fcbdd45c1a3b98ff4dee7dff1988a4acb9915d53c0aa43ff46d31f2167405b1d8b8d1eac300484c2c96660
-  data.tar.gz: 37cd86ddea7a477a0f96b2050aacc39cd4e376c6983464069e177d54f34aa00ecb833b869afe04ba82f3de8ea35266a7c38ee27690e1fe530bdf27aac6555576
+  metadata.gz: e0f80a737f5afcde1670b73785043500eec3fbf7d6a37955485ed88b015a3d0dfef8ff52d4e6bc201b2b872bb3c2bf949edab618b4695296a139520486d1a546
+  data.tar.gz: 3c22ed15af7b272db9e09444af4aeeeea8ffedb19ec5fe7f35813ea357347166c6fc045820c1feb030f3901aa0520c047f858ee017a55d0d9726921d9c17d3d8

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Release History: opentelemetry-exporter-otlp
 
+### v0.19.0 / 2021-06-03
+
+* ADDED: Add a SSL verify mode option for the OTLP exporter 
+* FIXED: Handle OTLP exporter encoding exceptions 
+* DOCS: Remove the OTLP receiver legacy gRPC port(55680) references 
+
+### v0.18.0 / 2021-05-21
+
+* BREAKING CHANGE: Replace Time.now with Process.clock_gettime 
+
+* FIXED: Replace Time.now with Process.clock_gettime 
+* FIXED: Rescue missed otlp exporter network errors 
+
+### v0.17.0 / 2021-04-22
+
+* ADDED: Add zipkin exporter 
+
+### v0.16.0 / 2021-03-17
+
+* BREAKING CHANGE: Implement Exporter#force_flush 
+
+* ADDED: Implement Exporter#force_flush 
+* FIXED: Rescue socket err in otlp exporter to prevent failures unable to  connect 
+* DOCS: Replace Gitter with GitHub Discussions 
+
+### v0.15.0 / 2021-02-18
+
+* BREAKING CHANGE: Streamline processor pipeline 
+
+* ADDED: Add otlp exporter hooks 
+* FIXED: Streamline processor pipeline 
+
 ### v0.14.0 / 2021-02-03
 
 * (No significant changes)

data/README.md

@@ -39,8 +39,8 @@ require 'opentelemetry/exporter/otlp'
 OpenTelemetry::SDK.configure do |c|
   c.add_span_processor(
     OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
-      exporter: OpenTelemetry::Exporter::OTLP::Exporter.new(
-        endpoint: 'http://localhost:55680'
+      OpenTelemetry::Exporter::OTLP::Exporter.new(
+        compression: 'gzip'
       )
     )
   )
@@ -65,11 +65,27 @@ end
 
 For additional examples, see the [examples on github][examples-github].
 
+## How can I configure the OTLP exporter?
+
+The collector exporter can be configured explicitly in code, as shown above, or via environment variables. The configuration parameters, environment variables, and defaults are shown below.
+
+| Parameter           | Environment variable                         | Default                             |
+| ------------------- | -------------------------------------------- | ----------------------------------- |
+| `endpoint:`         | `OTEL_EXPORTER_OTLP_ENDPOINT`                | `"http://localhost:4317/v1/traces"` |
+| `certificate_file: `| `OTEL_EXPORTER_OTLP_CERTIFICATE`             |                                     |
+| `headers:`          | `OTEL_EXPORTER_OTLP_HEADERS`                 |                                     |
+| `compression:`      | `OTEL_EXPORTER_OTLP_COMPRESSION`             |                                     |
+| `timeout:`          | `OTEL_EXPORTER_OTLP_TIMEOUT`                 | `10`                                |
+| `ssl_verify_mode:`  | `OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_PEER` or | `OpenSSL::SSL:VERIFY_PEER`          |
+|                     | `OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_NONE`    |                                     |
+
+`ssl_verify_mode:` parameter values should be flags for server certificate verification: `OpenSSL::SSL:VERIFY_PEER` and `OpenSSL::SSL:VERIFY_NONE` are acceptable. These values can also be set using the appropriately named environment variables as shown where `VERIFY_PEER` will take precedence over `VERIFY_NONE`.  Please see [the Net::HTTP docs](https://ruby-doc.org/stdlib-2.5.1/libdoc/net/http/rdoc/Net/HTTP.html#verify_mode) for more information about these flags.
+
 ## How can I get involved?
 
 The `opentelemetry-exporter-otlp` gem source is [on github][repo-github], along with related gems including `opentelemetry-sdk`.
 
-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][ruby-gitter] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+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][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
 
 ## License
 
@@ -84,4 +100,4 @@ The `opentelemetry-exporter-otlp` gem is distributed under the Apache 2.0 licens
 [examples-github]: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/examples
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
-[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

data/lib/opentelemetry/exporter/otlp/exporter.rb

@@ -31,8 +31,19 @@ module OpenTelemetry
         WRITE_TIMEOUT_SUPPORTED = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6')
         private_constant(:KEEP_ALIVE_TIMEOUT, :RETRY_COUNT, :WRITE_TIMEOUT_SUPPORTED)
 
-        def initialize(endpoint: config_opt('OTEL_EXPORTER_OTLP_TRACES_ENDPOINT', 'OTEL_EXPORTER_OTLP_ENDPOINT', default: 'https://localhost:4317/v1/traces'), # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        def self.ssl_verify_mode
+          if ENV.key?('OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_PEER')
+            OpenSSL::SSL::VERIFY_PEER
+          elsif ENV.key?('OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_NONE')
+            OpenSSL::SSL::VERIFY_NONE
+          else
+            OpenSSL::SSL::VERIFY_PEER
+          end
+        end
+
+        def initialize(endpoint: config_opt('OTEL_EXPORTER_OTLP_TRACES_ENDPOINT', 'OTEL_EXPORTER_OTLP_ENDPOINT', default: 'https://localhost:4317/v1/traces'), # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
                        certificate_file: config_opt('OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE', 'OTEL_EXPORTER_OTLP_CERTIFICATE'),
+                       ssl_verify_mode: Exporter.ssl_verify_mode,
                        headers: config_opt('OTEL_EXPORTER_OTLP_TRACES_HEADERS', 'OTEL_EXPORTER_OTLP_HEADERS'),
                        compression: config_opt('OTEL_EXPORTER_OTLP_TRACES_COMPRESSION', 'OTEL_EXPORTER_OTLP_COMPRESSION'),
                        timeout: config_opt('OTEL_EXPORTER_OTLP_TRACES_TIMEOUT', 'OTEL_EXPORTER_OTLP_TIMEOUT', default: 10),
@@ -41,18 +52,19 @@ module OpenTelemetry
           raise ArgumentError, "unsupported compression key #{compression}" unless compression.nil? || compression == 'gzip'
           raise ArgumentError, 'headers must be comma-separated k=v pairs or a Hash' unless valid_headers?(headers)
 
-          uri = if endpoint == ENV['OTEL_EXPORTER_OTLP_ENDPOINT']
-                  URI("#{endpoint}/v1/traces")
-                else
-                  URI(endpoint)
-                end
+          @uri = if endpoint == ENV['OTEL_EXPORTER_OTLP_ENDPOINT']
+                   URI("#{endpoint}/v1/traces")
+                 else
+                   URI(endpoint)
+                 end
 
-          @http = Net::HTTP.new(uri.host, uri.port)
-          @http.use_ssl = uri.scheme == 'https'
+          @http = Net::HTTP.new(@uri.host, @uri.port)
+          @http.use_ssl = @uri.scheme == 'https'
+          @http.verify_mode = ssl_verify_mode
           @http.ca_file = certificate_file unless certificate_file.nil?
           @http.keep_alive_timeout = KEEP_ALIVE_TIMEOUT
 
-          @path = uri.path
+          @path = @uri.path
           @headers = case headers
                      when String then CSV.parse(headers, col_sep: '=', row_sep: ',').to_h
                      when Hash then headers
@@ -60,7 +72,6 @@ module OpenTelemetry
           @timeout = timeout.to_f
           @compression = compression
           @metrics_reporter = metrics_reporter || OpenTelemetry::SDK::Trace::Export::MetricsReporter
-
           @shutdown = false
         end
 
@@ -77,14 +88,24 @@ module OpenTelemetry
           send_bytes(encode(span_data), timeout: timeout)
         end
 
-        # Called when {OpenTelemetry::SDK::Trace::Tracer#shutdown} is called, if
-        # this exporter is registered to a {OpenTelemetry::SDK::Trace::Tracer}
+        # Called when {OpenTelemetry::SDK::Trace::TracerProvider#force_flush} is called, if
+        # this exporter is registered to a {OpenTelemetry::SDK::Trace::TracerProvider}
+        # object.
+        #
+        # @param [optional Numeric] timeout An optional timeout in seconds.
+        def force_flush(timeout: nil)
+          SUCCESS
+        end
+
+        # Called when {OpenTelemetry::SDK::Trace::TracerProvider#shutdown} is called, if
+        # this exporter is registered to a {OpenTelemetry::SDK::Trace::TracerProvider}
         # object.
         #
         # @param [optional Numeric] timeout An optional timeout in seconds.
         def shutdown(timeout: nil)
           @shutdown = true
           @http.finish if @http.started?
+          SUCCESS
         end
 
         private
@@ -116,11 +137,22 @@ module OpenTelemetry
           true
         end
 
+        # The around_request is a private method that provides an extension
+        # point for the exporters network calls. The default behaviour
+        # is to not trace these operations.
+        #
+        # An example use case would be to prepend a patch, or extend this class
+        # and override this method's behaviour to explicitly trace the HTTP request.
+        # This would allow you to trace your export pipeline.
+        def around_request
+          OpenTelemetry::Common::Utilities.untraced { yield }
+        end
+
         def send_bytes(bytes, timeout:) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
           retry_count = 0
           timeout ||= @timeout
-          start_time = Time.now
-          OpenTelemetry::Common::Utilities.untraced do # rubocop:disable Metrics/BlockLength
+          start_time = OpenTelemetry::Common::Utilities.timeout_timestamp
+          around_request do # rubocop:disable Metrics/BlockLength
             request = Net::HTTP::Post.new(@path)
             request.body = if @compression == 'gzip'
                              request.add_field('Content-Encoding', 'gzip')
@@ -167,6 +199,15 @@ module OpenTelemetry
           rescue Net::OpenTimeout, Net::ReadTimeout
             retry if backoff?(retry_count: retry_count += 1, reason: 'timeout')
             return FAILURE
+          rescue SocketError
+            retry if backoff?(retry_count: retry_count += 1, reason: 'socket_error')
+            return FAILURE
+          rescue SystemCallError => e
+            retry if backoff?(retry_count: retry_count += 1, reason: e.class.name)
+            return FAILURE
+          rescue EOFError
+            retry if backoff?(retry_count: retry_count += 1, reason: 'eof_error')
+            return FAILURE
           end
         ensure
           # Reset timeouts to defaults for the next call.
@@ -254,13 +295,13 @@ module OpenTelemetry
             parent_span_id: span_data.parent_span_id == OpenTelemetry::Trace::INVALID_SPAN_ID ? nil : span_data.parent_span_id,
             name: span_data.name,
             kind: as_otlp_span_kind(span_data.kind),
-            start_time_unix_nano: as_otlp_timestamp(span_data.start_timestamp),
-            end_time_unix_nano: as_otlp_timestamp(span_data.end_timestamp),
+            start_time_unix_nano: span_data.start_timestamp,
+            end_time_unix_nano: span_data.end_timestamp,
             attributes: span_data.attributes&.map { |k, v| as_otlp_key_value(k, v) },
             dropped_attributes_count: span_data.total_recorded_attributes - span_data.attributes&.size.to_i,
             events: span_data.events&.map do |event|
               Opentelemetry::Proto::Trace::V1::Span::Event.new(
-                time_unix_nano: as_otlp_timestamp(event.timestamp),
+                time_unix_nano: event.timestamp,
                 name: event.name,
                 attributes: event.attributes&.map { |k, v| as_otlp_key_value(k, v) }
                 # TODO: track dropped_attributes_count in Span#append_event
@@ -287,10 +328,6 @@ module OpenTelemetry
           )
         end
 
-        def as_otlp_timestamp(timestamp)
-          (timestamp.to_r * 1_000_000_000).to_i
-        end
-
         def as_otlp_span_kind(kind)
           case kind
           when :internal then Opentelemetry::Proto::Trace::V1::Span::SpanKind::INTERNAL
@@ -304,6 +341,9 @@ module OpenTelemetry
 
         def as_otlp_key_value(key, value)
           Opentelemetry::Proto::Common::V1::KeyValue.new(key: key, value: as_otlp_any_value(value))
+        rescue Encoding::UndefinedConversionError => e
+          OpenTelemetry.handle_error(exception: e, message: "encoding error for key #{key} and value #{value}")
+          Opentelemetry::Proto::Common::V1::KeyValue.new(key: key, value: as_otlp_any_value('Encoding Error'))
         end
 
         def as_otlp_any_value(value)

data/lib/opentelemetry/exporter/otlp/version.rb

@@ -8,7 +8,7 @@ module OpenTelemetry
   module Exporter
     module OTLP
       ## Current OpenTelemetry OTLP exporter version
-      VERSION = '0.14.0'
+      VERSION = '0.19.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-exporter-otlp
 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-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -30,28 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -201,10 +215,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-otlp/v0.14.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-otlp/v0.19.0/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/exporter/otlp
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-otlp/v0.14.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-otlp/v0.19.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -220,7 +234,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: OTLP exporter for the OpenTelemetry framework