opentelemetry-exporter-otlp 0.6.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fb2bdcf07cb323140c330bf581d3fcd1a7202371a0be2d8ebe6df453b9ef880
-  data.tar.gz: 381a17d0a1428c56fde01fa1096b5716ab069d030ff0c9311a9a151ddac7ffb9
+  metadata.gz: d07dd6897e62a261598a0ca5319d678e6d996b800f3fc73f2467bcc0c6fa899b
+  data.tar.gz: b0dbee8a937d627bc025c650dfe8013cac4e92a78a382523cc796ca996b20676
 SHA512:
-  metadata.gz: 38a72e4e1112f5b0d4e706f0316e72d73ba6ae40301358843f51ba11938e6fed069a33598de3f8974f19168b4bfea9b8a90dd0d8354740f88b4e1de985a3551b
-  data.tar.gz: 2819b77a20f46dd9a7aaa872ff17487963bbcf5005b539a9092d1a7c21aef752028220fc3bf7f80178e6ee93266f46120c2f7f02bc9f8a7fdafe90e151204855
+  metadata.gz: b847b754f84f5c488b9cf0dde660f4f4fc8c14938f07ae0eadc420b95691a4c7fe304cfb7cc43e56a57c496882167cb1b53136ea64b203bfbb7ed072a9e8ad24
+  data.tar.gz: 67654cd2493a263bf804a30ff4edba3834ba312d27c003baa93e630b59f004b355668af65d687849ff395380183af0b70c918e628789eec3e80f290fe2fbd9ae

data/.yardopts

@@ -1,9 +1,9 @@
 --no-private
 --title=OpenTelemetry OTLP Exporter
 --markup=markdown
---main=OVERVIEW.md
+--main=README.md
 ./lib/opentelemetry/exporter/otlp/**/*.rb
 ./lib/opentelemetry/exporter/otlp.rb
 -
-OVERVIEW.md
+README.md
 CHANGELOG.md

data/CHANGELOG.md

@@ -1,5 +1,42 @@
 # Release History: opentelemetry-exporter-otlp
 
+### v0.11.0 / 2020-12-11
+
+* BREAKING CHANGE: Implement tracestate 
+
+* ADDED: Implement tracestate 
+* ADDED: Metrics reporting from trace export 
+* FIXED: Copyright comments to not reference year 
+
+### v0.10.0 / 2020-12-03
+
+* (No significant changes)
+
+### v0.9.0 / 2020-11-27
+
+* BREAKING CHANGE: Add timeout for force_flush and shutdown 
+
+* ADDED: Add timeout for force_flush and shutdown 
+* FIXED: Remove unused kwarg from otlp exporter retry 
+
+### v0.8.0 / 2020-10-27
+
+* BREAKING CHANGE: Move context/span methods to Trace module 
+* BREAKING CHANGE: Remove 'canonical' from status codes 
+* BREAKING CHANGE: Assorted SpanContext fixes 
+
+* FIXED: Move context/span methods to Trace module 
+* FIXED: Remove 'canonical' from status codes 
+* FIXED: Add gzip support to OTLP exporter 
+* FIXED: Assorted SpanContext fixes 
+
+### v0.7.0 / 2020-10-07
+
+* FIXED: OTLP parent_span_id should be nil for root 
+* DOCS: Fix use of add_event in OTLP doc 
+* DOCS: Standardize toplevel docs structure and readme 
+* DOCS: Use BatchSpanProcessor in examples 
+
 ### v0.6.0 / 2020-09-10
 
 * Initial release.

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 OpenTelemetry Authors
+   Copyright The OpenTelemetry Authors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -38,8 +38,8 @@ require 'opentelemetry/exporter/otlp'
 # Configure the sdk with custom export
 OpenTelemetry::SDK.configure do |c|
   c.add_span_processor(
-    OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(
-      OpenTelemetry::Exporter::OTLP::Exporter.new(
+    OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
+      exporter: OpenTelemetry::Exporter::OTLP::Exporter.new(
         host: 'localhost', port: 55680
       )
     )
@@ -54,7 +54,7 @@ tracer.in_span('foo') do |span|
   # set an attribute
   span.set_attribute('platform', 'osx')
   # add an event
-  span.add_event(name: 'event in bar')
+  span.add_event('event in bar')
   # create bar as child of foo
   tracer.in_span('bar') do |child_span|
     # inspect the span

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

@@ -4,9 +4,11 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'opentelemetry/common'
 require 'opentelemetry/sdk'
 require 'net/http'
 require 'csv'
+require 'zlib'
 
 require 'opentelemetry/proto/common/v1/common_pb'
 require 'opentelemetry/proto/resource/v1/resource_pb'
@@ -20,23 +22,24 @@ module OpenTelemetry
       class Exporter # rubocop:disable Metrics/ClassLength
         SUCCESS = OpenTelemetry::SDK::Trace::Export::SUCCESS
         FAILURE = OpenTelemetry::SDK::Trace::Export::FAILURE
-        private_constant(:SUCCESS, :FAILURE)
+        TIMEOUT = OpenTelemetry::SDK::Trace::Export::TIMEOUT
+        private_constant(:SUCCESS, :FAILURE, :TIMEOUT)
 
         # Default timeouts in seconds.
         KEEP_ALIVE_TIMEOUT = 30
-        OPEN_TIMEOUT = 5
-        READ_TIMEOUT = 5
         RETRY_COUNT = 5
-        private_constant(:KEEP_ALIVE_TIMEOUT, :OPEN_TIMEOUT, :READ_TIMEOUT, :RETRY_COUNT)
+        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
+        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))
+                       timeout: config_opt('OTEL_EXPORTER_OTLP_SPAN_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, "unsupported compression key #{compression}" unless compression.nil?
+          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 = URI "http://#{endpoint}"
@@ -44,8 +47,6 @@ module OpenTelemetry
           @http.use_ssl = insecure.to_s.downcase == 'false'
           @http.ca_file = certificate_file unless certificate_file.nil?
           @http.keep_alive_timeout = KEEP_ALIVE_TIMEOUT
-          @http.open_timeout = OPEN_TIMEOUT
-          @http.read_timeout = READ_TIMEOUT
 
           @path = uri.path
           @headers = case headers
@@ -53,7 +54,8 @@ module OpenTelemetry
                      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
-          @tracer = OpenTelemetry.tracer_provider.tracer
+          @compression = compression
+          @metrics_reporter = metrics_reporter || OpenTelemetry::SDK::Trace::Export::MetricsReporter
 
           @shutdown = false
         end
@@ -63,17 +65,20 @@ module OpenTelemetry
         # @param [Enumerable<OpenTelemetry::SDK::Trace::SpanData>] span_data the
         #   list of recorded {OpenTelemetry::SDK::Trace::SpanData} structs to be
         #   exported.
+        # @param [optional Numeric] timeout An optional timeout in seconds.
         # @return [Integer] the result of the export.
-        def export(span_data)
+        def export(span_data, timeout: nil)
           return FAILURE if @shutdown
 
-          send_bytes(encode(span_data))
+          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}
         # object.
-        def shutdown
+        #
+        # @param [optional Numeric] timeout An optional timeout in seconds.
+        def shutdown(timeout: nil)
           @shutdown = true
           @http.finish if @http.started?
         end
@@ -107,18 +112,29 @@ module OpenTelemetry
           true
         end
 
-        def send_bytes(bytes) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+        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
             request = Net::HTTP::Post.new(@path)
-            request.body = bytes
+            request.body = if @compression == 'gzip'
+                             request.add_field('Content-Encoding', 'gzip')
+                             Zlib.gzip(bytes)
+                           else
+                             bytes
+                           end
             request.add_field('Content-Type', 'application/x-protobuf')
             @headers&.each { |key, value| request.add_field(key, value) }
-            # TODO: enable gzip when https://github.com/open-telemetry/opentelemetry-collector/issues/1344 is fixed.
-            # request.add_field('Content-Encoding', 'gzip')
 
+            remaining_timeout = OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)
+            return TIMEOUT if remaining_timeout.zero?
+
+            @http.open_timeout = remaining_timeout
+            @http.read_timeout = remaining_timeout
+            @http.write_timeout = remaining_timeout if WRITE_TIMEOUT_SUPPORTED
             @http.start unless @http.started?
-            response = @http.request(request)
+            response = measure_request_duration { @http.request(request) }
 
             case response
             when Net::HTTPOK
@@ -126,11 +142,11 @@ module OpenTelemetry
               SUCCESS
             when Net::HTTPServiceUnavailable, Net::HTTPTooManyRequests
               response.body # Read and discard body
-              redo if backoff?(retry_after: response['Retry-After'], retry_count: retry_count += 1)
+              redo if backoff?(retry_after: response['Retry-After'], retry_count: retry_count += 1, reason: response.code)
               FAILURE
             when Net::HTTPRequestTimeOut, Net::HTTPGatewayTimeOut, Net::HTTPBadGateway
               response.body # Read and discard body
-              redo if backoff?(retry_count: retry_count += 1)
+              redo if backoff?(retry_count: retry_count += 1, reason: response.code)
               FAILURE
             when Net::HTTPBadRequest, Net::HTTPClientError, Net::HTTPServerError
               # TODO: decode the body as a google.rpc.Status Protobuf-encoded message when https://github.com/open-telemetry/opentelemetry-collector/issues/1357 is fixed.
@@ -139,15 +155,20 @@ module OpenTelemetry
             when Net::HTTPRedirection
               @http.finish
               handle_redirect(response['location'])
-              redo if backoff?(retry_after: 0, retry_count: retry_count += 1)
+              redo if backoff?(retry_after: 0, retry_count: retry_count += 1, reason: response.code)
             else
               @http.finish
               FAILURE
             end
           rescue Net::OpenTimeout, Net::ReadTimeout
-            retry if backoff?(retry_count: retry_count += 1)
+            retry if backoff?(retry_count: retry_count += 1, reason: 'timeout')
             return FAILURE
           end
+        ensure
+          # Reset timeouts to defaults for the next call.
+          @http.open_timeout = @timeout
+          @http.read_timeout = @timeout
+          @http.write_timeout = @timeout if WRITE_TIMEOUT_SUPPORTED
         end
 
         def handle_redirect(location)
@@ -155,12 +176,27 @@ module OpenTelemetry
         end
 
         def untraced
-          @tracer.with_span(OpenTelemetry::Trace::Span.new) { yield }
+          OpenTelemetry::Trace.with_span(OpenTelemetry::Trace::Span.new) { yield }
+        end
+
+        def measure_request_duration
+          start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          begin
+            response = yield
+          ensure
+            stop = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+            duration_ms = 1000.0 * (stop - start)
+            @metrics_reporter.record_value('otel.otlp_exporter.request_duration',
+                                           value: duration_ms,
+                                           labels: { 'status' => response&.code || 'unknown' })
+          end
         end
 
         def backoff?(retry_after: nil, retry_count:, reason:)
           return false if retry_count > RETRY_COUNT
 
+          @metrics_reporter.add_to_counter('otel.otlp_exporter.failure', labels: { 'reason' => reason })
+
           sleep_interval = nil
           unless retry_after.nil?
             sleep_interval =
@@ -214,8 +250,8 @@ module OpenTelemetry
           Opentelemetry::Proto::Trace::V1::Span.new(
             trace_id: span_data.trace_id,
             span_id: span_data.span_id,
-            trace_state: span_data.tracestate,
-            parent_span_id: span_data.parent_span_id,
+            trace_state: span_data.tracestate.to_s,
+            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),
@@ -233,17 +269,18 @@ module OpenTelemetry
             dropped_events_count: span_data.total_recorded_events - span_data.events&.size.to_i,
             links: span_data.links&.map do |link|
               Opentelemetry::Proto::Trace::V1::Span::Link.new(
-                trace_id: link.context.trace_id,
-                span_id: link.context.span_id,
-                trace_state: link.context.tracestate,
+                trace_id: link.span_context.trace_id,
+                span_id: link.span_context.span_id,
+                trace_state: link.span_context.tracestate.to_s,
                 attributes: link.attributes&.map { |k, v| as_otlp_key_value(k, v) }
                 # TODO: track dropped_attributes_count in Span#trim_links
               )
             end,
             dropped_links_count: span_data.total_recorded_links - span_data.links&.size.to_i,
             status: span_data.status&.yield_self do |status|
+              # TODO: fix this based on spec update.
               Opentelemetry::Proto::Trace::V1::Status.new(
-                code: status.canonical_code,
+                code: status.code == OpenTelemetry::Trace::Status::ERROR ? Opentelemetry::Proto::Trace::V1::Status::StatusCode::UnknownError : Opentelemetry::Proto::Trace::V1::Status::StatusCode::Ok,
                 message: status.description
               )
             end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -8,7 +8,7 @@ module OpenTelemetry
   module Exporter
     module OTLP
       ## Current OpenTelemetry OTLP exporter version
-      VERSION = '0.6.0'
+      VERSION = '0.11.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-exporter-otlp
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.11.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -36,14 +36,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +206,11 @@ files:
 homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-otlp/v0.11.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/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.11.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -208,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: OTLP exporter for the OpenTelemetry framework