opentelemetry-exporter-jaeger 0.17.0 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26e202a0355f910f2a246337567c6ca9909f0c3b189accf5836f035d84b8170a
-  data.tar.gz: b11ac5dbde83535ae7fb2d71760ac18da00be55a82b1bccda0d3e029d3fbb151
+  metadata.gz: e25961929d74802efaba7a712ef802cba5cdd163d8dc92424be8bf0c76a15af3
+  data.tar.gz: ea1a83fdad402b0004d897a934b01e074a2b9dcacea1cb2462d451c369ffbc9e
 SHA512:
-  metadata.gz: df8ed6bf2f857b11cc5e0518f2023369abd834ea0f4470812e8c07a0015d21955205a9ef2340390fad962d9718ec92bc3fb0b5b6cfcc9b41fd2bc8505632b2b4
-  data.tar.gz: 2984207bd9210bdaf8b707ca979b03f9a1bb8ac379207cc2014e758c19bebd55b6348ea1fb0836ca1ca68585c06cf5c90cbc2403d2625ceb8d441d747290ddda
+  metadata.gz: 7c9afadbdc86573e0329b8fd9cd3699ec3ae53e3138073826880c9a21cd37daf3894d92a9d009cd725f0c5c8be3d64d03ccd19d3ce05e7aa679de7bd64b76229
+  data.tar.gz: 1d95d8396ca3f918d34884b830d9db6ba8e8a98f4808d5db050c8ba3209df6617f1cc76de78a77293da744f34060e5ff106d53b83af63ecd0b6eb88ad6945848

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Release History: opentelemetry-exporter-jaeger
 
+### v0.20.1 / 2021-09-29
+
+* (No significant changes)
+
+### v0.20.0 / 2021-08-12
+
+* ADDED: OTEL_EXPORTER_JAEGER_TIMEOUT env var 
+* DOCS: Update docs to rely more on environment variable configuration 
+
+### v0.19.0 / 2021-06-23
+
+* BREAKING CHANGE: Total order constraint on span.status= 
+
+* FIXED: Total order constraint on span.status= 
+
+### v0.18.0 / 2021-05-21
+
+* BREAKING CHANGE: Replace Time.now with Process.clock_gettime 
+
+* ADDED: Export to jaeger collectors w/ self-signed certs 
+* FIXED: Replace Time.now with Process.clock_gettime 
+* FIXED: Rename constant to hide warning message 
+* FIXED: Index a link trace_id in middle rather than end 
+
 ### v0.17.0 / 2021-04-22
 
 * ADDED: Add zipkin exporter 

data/README.md

@@ -31,18 +31,27 @@ Then, configure the SDK to use a Jaeger exporter as a span processor, and use th
 require 'opentelemetry/sdk'
 require 'opentelemetry/exporter/jaeger'
 
-# Configure the sdk with custom export
-OpenTelemetry::SDK.configure do |c|
-  c.add_span_processor(
-    OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
-      OpenTelemetry::Exporter::Jaeger::AgentExporter.new(host: '127.0.0.1', port: 6831)
-      # Alternatively, for the collector exporter:
-      # exporter: OpenTelemetry::Exporter::Jaeger::CollectorExporter.new(endpoint: 'http://192.168.0.1:14268/api/traces')
-    )
-  )
-  c.service_name = 'jaeger-example'
-  c.service_version = '0.6.0'
-end
+# Configure the sdk with the Jaeger collector exporter
+ENV['OTEL_TRACES_EXPORTER'] = 'jaeger'
+
+ENV['OTEL_SERVICE_NAME'] = 'jaeger-example'
+ENV['OTEL_SERVICE_VERSION'] = '0.6.0'
+
+# The exporter will connect to localhost:6381 by default. To change:
+# ENV['OTEL_EXPORTER_JAEGER_AGENT_HOST'] = 'some.other.host'
+# ENV['OTEL_EXPORTER_JAEGER_AGENT_PORT'] = 12345
+
+# The SDK reads the environment for configuration, so no additional configuration is needed:
+OpenTelemetry::SDK.configure
+
+# If you need to use the Jaeger Agent exporter, you will need to configure many things manually:
+# OpenTelemetry::SDK.configure do |c|
+#   c.add_span_processor(
+#     OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
+#       OpenTelemetry::Exporter::Jaeger::AgentExporter.new(host: '127.0.0.1', port: 6831)
+#     )
+#   )
+# end
 
 # To start a trace you need to get a Tracer from the TracerProvider
 tracer = OpenTelemetry.tracer_provider.tracer('my_app_or_gem', '0.1.0')
@@ -75,11 +84,15 @@ The agent exporter can be configured explicitly in code, as shown above, or via
 
 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_JAEGER_ENDPOINT` | `"http://localhost:14268"` |
-| `username:` | `OTEL_EXPORTER_JAEGER_USER`     | `nil`                      |
-| `password:` | `OTEL_EXPORTER_JAEGER_PASSWORD` | `nil`                      |
+| Parameter          | Environment variable                           | Default                    |
+| ------------------ | ---------------------------------------------- | -------------------------- |
+| `endpoint:`        | `OTEL_EXPORTER_JAEGER_ENDPOINT`                | `"http://localhost:14268"` |
+| `username:`        | `OTEL_EXPORTER_JAEGER_USER`                    | `nil`                      |
+| `password:`        | `OTEL_EXPORTER_JAEGER_PASSWORD`                | `nil`                      |
+| `ssl_verify_mode:` | `OTEL_RUBY_EXPORTER_JAEGER_SSL_VERIFY_PEER` or | `OpenSSL::SSL:VERIFY_PEER` |
+|                    | `OTEL_RUBY_EXPORTER_JAEGER_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?
 

data/lib/opentelemetry/exporter/jaeger/agent_exporter.rb

@@ -15,6 +15,7 @@ module OpenTelemetry
 
         def initialize(host: ENV.fetch('OTEL_EXPORTER_JAEGER_AGENT_HOST', 'localhost'),
                        port: ENV.fetch('OTEL_EXPORTER_JAEGER_AGENT_PORT', 6831),
+                       timeout: ENV.fetch('OTEL_EXPORTER_JAEGER_TIMEOUT', 10),
                        max_packet_size: 65_000)
           transport = Transport.new(host, port)
           protocol = ::Thrift::CompactProtocol.new(transport)
@@ -23,6 +24,7 @@ module OpenTelemetry
           @shutdown = false
           @sizing_transport = SizingTransport.new
           @sizing_protocol = ::Thrift::CompactProtocol.new(@sizing_transport)
+          @timeout = timeout.to_f
         end
 
         # Called to export sampled {OpenTelemetry::SDK::Trace::SpanData} structs.
@@ -35,7 +37,8 @@ module OpenTelemetry
         def export(span_data, timeout: nil)
           return FAILURE if @shutdown
 
-          start_time = Time.now
+          timeout ||= @timeout
+          start_time = OpenTelemetry::Common::Utilities.timeout_timestamp
           encoded_batches(span_data) do |batch|
             return FAILURE if @shutdown || OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)&.zero?
 

data/lib/opentelemetry/exporter/jaeger/collector_exporter.rb

@@ -15,13 +15,26 @@ module OpenTelemetry
         FAILURE = OpenTelemetry::SDK::Trace::Export::FAILURE
         private_constant(:SUCCESS, :FAILURE)
 
+        def self.ssl_verify_mode
+          if ENV.key?('OTEL_RUBY_EXPORTER_JAEGER_SSL_VERIFY_PEER')
+            OpenSSL::SSL::VERIFY_PEER
+          elsif ENV.key?('OTEL_RUBY_EXPORTER_JAEGER_SSL_VERIFY_NONE')
+            OpenSSL::SSL::VERIFY_NONE
+          else
+            OpenSSL::SSL::VERIFY_PEER
+          end
+        end
+
         def initialize(endpoint: ENV.fetch('OTEL_EXPORTER_JAEGER_ENDPOINT', 'http://localhost:14268/api/traces'),
                        username: ENV['OTEL_EXPORTER_JAEGER_USER'],
-                       password: ENV['OTEL_EXPORTER_JAEGER_PASSWORD'])
+                       password: ENV['OTEL_EXPORTER_JAEGER_PASSWORD'],
+                       timeout: ENV.fetch('OTEL_EXPORTER_JAEGER_TIMEOUT', 10),
+                       ssl_verify_mode: CollectorExporter.ssl_verify_mode)
           raise ArgumentError, "invalid url for Jaeger::CollectorExporter #{endpoint}" if invalid_url?(endpoint)
           raise ArgumentError, 'username and password should either both be nil or both be set' if username.nil? != password.nil?
 
-          @transport = ::Thrift::HTTPClientTransport.new(endpoint)
+          transport_opts = { ssl_verify_mode: Integer(ssl_verify_mode) }
+          @transport = ::Thrift::HTTPClientTransport.new(endpoint, transport_opts)
           unless username.nil? || password.nil?
             authorization = Base64.strict_encode64("#{username}:#{password}")
             auth_header = { 'Authorization': "Basic #{authorization}" }

data/lib/opentelemetry/exporter/jaeger/encoder.rb

@@ -65,8 +65,8 @@ module OpenTelemetry
         end
 
         def encoded_span(span_data) # rubocop:disable Metrics/AbcSize
-          start_time = (span_data.start_timestamp.to_f * 1_000_000).to_i
-          duration = (span_data.end_timestamp.to_f * 1_000_000).to_i - start_time
+          start_time = span_data.start_timestamp / 1_000
+          duration = span_data.end_timestamp / 1_000 - start_time
 
           Thrift::Span.new(
             'traceIdLow' => int64(span_data.trace_id[8, 8]),
@@ -102,7 +102,7 @@ module OpenTelemetry
         def encoded_logs(events)
           events&.map do |event|
             Thrift::Log.new(
-              'timestamp' => (event.timestamp.to_f * 1_000_000).to_i,
+              'timestamp' => event.timestamp / 1_000,
               'fields' => encoded_tags(event.attributes) + encoded_tags('name' => event.name)
             )
           end
@@ -112,8 +112,8 @@ module OpenTelemetry
           links&.map do |link|
             Thrift::SpanRef.new(
               'refType' => Thrift::SpanRefType::FOLLOWS_FROM,
-              'traceIdLow' => int64(link.span_context.trace_id[16, 16]),
-              'traceIdHigh' => int64(link.span_context.trace_id[0, 16]),
+              'traceIdLow' => int64(link.span_context.trace_id[8, 8]),
+              'traceIdHigh' => int64(link.span_context.trace_id[0, 8]),
               'spanId' => int64(link.span_context.span_id)
             )
           end

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

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

data/thrift/gen-rb/jaeger_types.rb

@@ -77,11 +77,11 @@ module OpenTelemetry
         class Log
           include ::Thrift::Struct, ::Thrift::Struct_Union
           TIMESTAMP = 1
-          FIELDS = 2
+          FIELDS_LIST = 2
 
           FIELDS = {
             TIMESTAMP => {:type => ::Thrift::Types::I64, :name => 'timestamp'},
-            FIELDS => {:type => ::Thrift::Types::LIST, :name => 'fields', :element => {:type => ::Thrift::Types::STRUCT, :class => ::OpenTelemetry::Exporter::Jaeger::Thrift::Tag}}
+            FIELDS_LIST => {:type => ::Thrift::Types::LIST, :name => 'fields', :element => {:type => ::Thrift::Types::STRUCT, :class => ::OpenTelemetry::Exporter::Jaeger::Thrift::Tag}}
           }
 
           def struct_fields; FIELDS; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-exporter-jaeger
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.20.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2021-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.19.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.19.2
 - !ruby/object:Gem::Dependency
   name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: thrift
   requirement: !ruby/object:Gem::Requirement
@@ -223,10 +223,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-jaeger/v0.17.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-jaeger/v0.20.1/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/exporter/jaeger
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-jaeger/v0.17.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-jaeger/v0.20.1
 post_install_message: 
 rdoc_options: []
 require_paths: