opentelemetry-exporter-zipkin 0.20.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd0f6efbe1457e04c816f0e2be81ad8cf1ea5ab59a8c76a939429776cb46b9fa
-  data.tar.gz: 46067ad66e3b6b3c5121936f5f0fa74860d21a14c90abcdbf266f37ea8471e9d
+  metadata.gz: ce9a72f8ea654dd6f51d8066e93c0cf54833ef7ae7abd5f75420a14be4ff1827
+  data.tar.gz: 95abf49f858e331a719a5f1bd815c67637b8ebacc2ffdd35f432a223fcd42cc3
 SHA512:
-  metadata.gz: 50cc28cfa5da93f15b5f0e32ef10b003357dc06583638cd93ae9574f0fc187e5e3aff5694f6007b326f784e5aca2ba7adaf1da47b583f6cdf766c9aea1246142
-  data.tar.gz: 3418502a4f82b0e2e260bee0423f51aa28772f69ba7ea9233a54877bf76c3f77669caf6bafcdfd05bf8da47a2cd2835565714a9ff69ee3693460b1c5eead14bc
+  metadata.gz: 0feb421e2bde5ae20949be3955a155b643efcc438a6355f637cc4afc9cfd9b954a4ca498560f4ef85ddbc5b13df6889b31faa805a8f362e3133ce352bea4026a
+  data.tar.gz: 1ce234a51afb7d73826bf9fb27bd2e6cbc64296ef12bba7d2decabd188e8e1fd79ac9d932ac21fd0323310099286e9143c9f21f3f8e8678f495bb7ff4097bb74

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release History: opentelemetry-exporter-zipkin
 
+### v0.22.0 / 2023-05-30
+
+* ADDED: Custom  Metrics Reporter Support for Zipkin 
+
+### v0.21.0 / 2022-09-14
+
+* ADDED: Add dropped events/attributes/links counts to zipkin + jaeger exporters 
+* ADDED: Support InstrumentationScope, and update OTLP proto to 0.18.0 
+
 ### v0.20.0 / 2022-06-09
 
 * (No significant changes)

data/lib/opentelemetry/exporter/zipkin/exporter.rb

@@ -29,7 +29,8 @@ module OpenTelemetry
 
         def initialize(endpoint: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_ZIPKIN_ENDPOINT', default: 'http://localhost:9411/api/v2/spans'),
                        headers: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_ZIPKIN_TRACES_HEADERS', 'OTEL_EXPORTER_ZIPKIN_HEADERS'),
-                       timeout: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_ZIPKIN_TRACES_TIMEOUT', 'OTEL_EXPORTER_ZIPKIN_TIMEOUT', default: 10))
+                       timeout: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_ZIPKIN_TRACES_TIMEOUT', 'OTEL_EXPORTER_ZIPKIN_TIMEOUT', default: 10),
+                       metrics_reporter: nil)
           raise ArgumentError, "invalid url for Zipkin::Exporter #{endpoint}" unless OpenTelemetry::Common::Utilities.valid_url?(endpoint)
           raise ArgumentError, 'headers must be comma-separated k=v pairs or a Hash' unless valid_headers?(headers)
 
@@ -50,6 +51,7 @@ module OpenTelemetry
                      when Hash then headers
                      end
 
+          @metrics_reporter = metrics_reporter || OpenTelemetry::SDK::Trace::Export::MetricsReporter
           @shutdown = false
         end
 
@@ -66,6 +68,7 @@ module OpenTelemetry
           zipkin_spans = encode_spans(span_data)
           send_spans(zipkin_spans, timeout: timeout)
         rescue StandardError => e
+          @metrics_reporter.add_to_counter('otel.zipkin_exporter.failure', labels: { 'reason' => e.class.to_s })
           OpenTelemetry.handle_error(exception: e, message: 'unexpected error in Zipkin::Exporter#export')
           FAILURE
         end
@@ -112,7 +115,7 @@ module OpenTelemetry
           false
         end
 
-        def send_spans(zipkin_spans, timeout: nil) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+        def send_spans(zipkin_spans, timeout: nil) # rubocop:disable Metrics/MethodLength
           retry_count = 0
           timeout ||= @timeout
           start_time = OpenTelemetry::Common::Utilities.timeout_timestamp
@@ -130,7 +133,7 @@ module OpenTelemetry
             @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) }
             response.body # Read and discard body
             # in opentelemetry-js 200-399 is succcess, in opentelemetry-collector zipkin exporter,200-299 is a success
             # zipkin api docs list 202 as default success code
@@ -171,7 +174,7 @@ module OpenTelemetry
           # TODO: figure out destination and reinitialize @http and @path
         end
 
-        def backoff?(retry_after: nil, retry_count:, reason:)
+        def backoff?(retry_count:, reason:, retry_after: nil)
           return false if retry_count > RETRY_COUNT
 
           # TODO: metric exporter
@@ -197,6 +200,19 @@ module OpenTelemetry
           sleep(sleep_interval)
           true
         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.zipkin_exporter.request_duration',
+                                           value: duration_ms,
+                                           labels: { 'status' => response&.code || 'unknown' })
+          end
+        end
       end
     end
   end

data/lib/opentelemetry/exporter/zipkin/transformer.rb

@@ -46,7 +46,7 @@ module OpenTelemetry
             service_name = value if key == SERVICE_NAME_ATTRIBUTE_KEY
           end
 
-          add_il_tags(span_d, tags)
+          add_scope_tags(span_d, tags)
           add_status_tags(span_d, tags)
           tags = aggregate_span_tags(span_d, tags)
 
@@ -70,9 +70,12 @@ module OpenTelemetry
           zipkin_span
         end
 
-        def add_il_tags(span_data, tags)
-          tags['otel.library.name'] = span_data.instrumentation_library.name
-          tags['otel.library.version'] = span_data.instrumentation_library.version
+        def add_scope_tags(span_data, tags)
+          tags['otel.scope.name'] = span_data.instrumentation_scope.name
+          tags['otel.library.name'] = span_data.instrumentation_scope.name
+
+          tags['otel.scope.version'] = span_data.instrumentation_scope.version
+          tags['otel.library.version'] = span_data.instrumentation_scope.version
         end
 
         def add_status_tags(span_data, tags)
@@ -89,6 +92,13 @@ module OpenTelemetry
         end
 
         def add_conditional_tags(zipkin_span, span_data, tags, service_name)
+          dropped_attributes_count = span_data.total_recorded_attributes - span_data.attributes&.size.to_i
+          dropped_events_count = span_data.total_recorded_events - span_data.events&.size.to_i
+          dropped_links_count = span_data.total_recorded_links - span_data.links&.size.to_i
+          tags['otel.dropped_attributes_count'] = dropped_attributes_count.to_s if dropped_attributes_count.positive?
+          tags['otel.dropped_events_count'] = dropped_events_count.to_s if dropped_events_count.positive?
+          tags['otel.dropped_links_count'] = dropped_links_count.to_s if dropped_links_count.positive?
+
           zipkin_span['tags'] = tags unless tags.empty?
           zipkin_span['kind'] = KIND_MAP[span_data.kind] unless span_data.kind.nil?
           zipkin_span['parentId'] = span_data.hex_parent_span_id unless span_data.parent_span_id == OpenTelemetry::Trace::INVALID_SPAN_ID

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

@@ -8,7 +8,7 @@ module OpenTelemetry
   module Exporter
     module Zipkin
       ## Current OpenTelemetry Zipkin exporter version
-      VERSION = '0.20.0'
+      VERSION = '0.22.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-exporter-zipkin
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.22.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-09 00:00:00.000000000 Z
+date: 2023-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-semantic_conventions
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.51.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.51.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -226,10 +226,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-zipkin/v0.20.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-zipkin/v0.22.0/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/exporter/zipkin
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-zipkin/v0.20.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-zipkin/v0.22.0
 post_install_message: 
 rdoc_options: []
 require_paths: