opentelemetry-exporter-otlp 0.12.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2e42d5832a5e55dd263643260de2a092d8143b3c575ce1dbb413d6deffefef3
-  data.tar.gz: 62dca89af13815894f58d9a8732bae13bba9bad76743a53cecd18eaa327a2e55
+  metadata.gz: 2f5b4d0796501a589f5835d0c45dde197615d480b215ba155def93e1bff5d262
+  data.tar.gz: c9059c510ffb3931d4d004b2eb74c6433c4fe353f2a10bfae0e51a6a9e10111f
 SHA512:
-  metadata.gz: 6c6c87c2f2d9c29ac6820724416eb5719069a9d77feb5610b1f35164e1a832163cc5f732434bd9936a44b9c03405fbdcf9e130badb61d4bf2f96ee6fa3404024
-  data.tar.gz: f8cb8d266ef97c6a7b51c8d08afa93df0632ecbe5f6ca82ec44e27b0904c2a8bfacf213536084ce6fb0ee390ee78012d3915bb685efb5f672f7a7d7ca99e9319
+  metadata.gz: 6f2118ca07a28c077f245310d32277aacda537a8b71be2a20d2f5a8763bc03be1ed2ad7ed13e0e99fe21738ac13f395ad2dcefd7b240b34c32f090576dfc4887
+  data.tar.gz: 6429cf61555ab6052a8cc667925933c40a552225209e829a4270cdec114ff94a0223c5f7459e32ae2447a8689f9817c221a0bf98f32d19ef99e7e04fc45769b5

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Release History: opentelemetry-exporter-otlp
 
+### 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)
+
+### v0.13.0 / 2021-01-29
+
+* BREAKING CHANGE: Spec compliance for OTLP exporter 
+
+* ADDED: Add untraced wrapper to common utils 
+* FIXED: Spec compliance for OTLP exporter 
+* FIXED: Conditionally append path to collector endpoint 
+* FIXED: OTLP path should be /v1/traces 
+* FIXED: Rename OTLP env vars SPAN -> TRACES 
+
 ### v0.12.1 / 2021-01-13
 
 * FIXED: Updated protobuf version dependency

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(
-        host: 'localhost', port: 55680
+      OpenTelemetry::Exporter::OTLP::Exporter.new(
+        endpoint: 'http://localhost:55680'
       )
     )
   )
@@ -69,7 +69,7 @@ For additional examples, see the [examples on github][examples-github].
 
 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
 
@@ -80,8 +80,8 @@ The `opentelemetry-exporter-otlp` gem is distributed under the Apache 2.0 licens
 [opentelemetry-home]: https://opentelemetry.io
 [bundler-home]: https://bundler.io
 [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
-[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/master/LICENSE
-[examples-github]: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/examples
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
+[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,32 +31,35 @@ 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_SPAN_ENDPOINT', 'OTEL_EXPORTER_OTLP_ENDPOINT', default: 'localhost:55681/v1/trace'), # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-                       insecure: config_opt('OTEL_EXPORTER_OTLP_SPAN_INSECURE', 'OTEL_EXPORTER_OTLP_INSECURE', default: false),
-                       certificate_file: config_opt('OTEL_EXPORTER_OTLP_SPAN_CERTIFICATE', 'OTEL_EXPORTER_OTLP_CERTIFICATE'),
-                       headers: config_opt('OTEL_EXPORTER_OTLP_SPAN_HEADERS', 'OTEL_EXPORTER_OTLP_HEADERS'), # TODO: what format is expected here?
-                       compression: config_opt('OTEL_EXPORTER_OTLP_SPAN_COMPRESSION', 'OTEL_EXPORTER_OTLP_COMPRESSION'),
-                       timeout: config_opt('OTEL_EXPORTER_OTLP_SPAN_TIMEOUT', 'OTEL_EXPORTER_OTLP_TIMEOUT', default: 10),
+        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
+                       certificate_file: config_opt('OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE', 'OTEL_EXPORTER_OTLP_CERTIFICATE'),
+                       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),
                        metrics_reporter: nil)
-          raise ArgumentError, "invalid url for OTLP::Exporter #{endpoint}" if invalid_url?("http://#{endpoint}")
+          raise ArgumentError, "invalid url for OTLP::Exporter #{endpoint}" if invalid_url?(endpoint)
           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)
+          raise ArgumentError, 'headers must be comma-separated k=v pairs or a Hash' unless valid_headers?(headers)
 
-          uri = URI "http://#{endpoint}"
-          @http = Net::HTTP.new(uri.host, uri.port)
-          @http.use_ssl = insecure.to_s.downcase == 'false'
+          @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.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 String then CSV.parse(headers, col_sep: '=', row_sep: ',').to_h
                      when Hash then headers
                      end
-          @timeout = timeout.to_f # TODO: use this as a default timeout when we implement timeouts in https://github.com/open-telemetry/opentelemetry-ruby/pull/341
+          @timeout = timeout.to_f
           @compression = compression
           @metrics_reporter = metrics_reporter || OpenTelemetry::SDK::Trace::Export::MetricsReporter
-
           @shutdown = false
         end
 
@@ -73,14 +76,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
@@ -97,7 +110,7 @@ module OpenTelemetry
           return true if headers.nil? || headers.is_a?(Hash)
           return false unless headers.is_a?(String)
 
-          CSV.parse(headers, col_sep: ':', row_sep: ',').to_h
+          CSV.parse(headers, col_sep: '=', row_sep: ',').to_h
           true
         rescue ArgumentError
           false
@@ -106,17 +119,28 @@ module OpenTelemetry
         def invalid_url?(url)
           return true if url.nil? || url.strip.empty?
 
-          uri = URI(url)
-          uri.path.nil? || uri.path.empty?
+          URI(url)
+          false
         rescue URI::InvalidURIError
           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
-          untraced do # rubocop:disable Metrics/BlockLength
+          around_request do # rubocop:disable Metrics/BlockLength
             request = Net::HTTP::Post.new(@path)
             request.body = if @compression == 'gzip'
                              request.add_field('Content-Encoding', 'gzip')
@@ -163,6 +187,9 @@ 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
           end
         ensure
           # Reset timeouts to defaults for the next call.
@@ -175,10 +202,6 @@ module OpenTelemetry
           # TODO: figure out destination and reinitialize @http and @path
         end
 
-        def untraced
-          OpenTelemetry::Trace.with_span(OpenTelemetry::Trace::Span.new) { yield }
-        end
-
         def measure_request_duration
           start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
           begin

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-exporter-otlp
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.17.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-13 00:00:00.000000000 Z
+date: 2021-04-23 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.12.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
 - !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.12.1/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/exporter/otlp
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-otlp/v0.17.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.12.1
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-otlp/v0.17.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