uptrace 1.0.0.rc1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f9a4d977dcec234cd8810306f108488708ca23a30ce0836d71d52e5f759033b
-  data.tar.gz: 305152b04753b7febe844a76ff675f192f5d0f939f179b77dfb73a4fd21d71fe
+  metadata.gz: 6666340ea7b7556a09c06a41878efdd58bb10b4d05cdc711654189e01eec4011
+  data.tar.gz: 78c26e6a6f6e59e2ac01fd14a872a5c9c164e72431238d5c8d79322201fd1a20
 SHA512:
-  metadata.gz: c0593e88e857717b329f4f4d21278efddd605412e3ab63d617eccb3547bbabacaf98ff3f7c68630b90215eff7712cc824c7579e2c5edb78617931b3004b1930b
-  data.tar.gz: d8c976e2e80dbaa0eb323c8c71ee919cac0b53331bec52483b34e0e393dece72914ef21810d4d5c677a1ee8bc8902a6f210d2c814366a9afe940f456ee9fa5c9
+  metadata.gz: b3780a0f3fa9841f4883618f0a7b28f1ec86e046e0f99c90ab6a5ffc0bd7a6c3e2ab3a004c2c3f7f848a62afbea5c9d699ecb07105f4f398c4594c6ce52099bf
+  data.tar.gz: '08270a500502c272d6eda9f96eab25909ea26a834e070ba8d6c4cb7ab7ccfee428d2094c63a353402c1a720b03d11fe7a3f95dad8e09171ad879df96eb2e3466'

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## v1.0.1 - 2021-11-08
+
+- Updated OpenTelemetry to
+  [v1.0.1](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/sdk/CHANGELOG.md#v101--2021-10-29).
+
+## v1.0.0 - 2021-10-06
+
+- Updated OpenTelemetry to
+  [v1.0.0](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/api/CHANGELOG.md#v100--2021-09-29).
+
+## v1.0.0.rc3 - 2021-08-17
+
+- Updated OpenTelemetry to
+  [v1.0.0.rc3](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/api/CHANGELOG.md#v100rc3--2021-08-12).
+- Switched to using OTLP protocol.
+
 ## v1.0.0.rc1 - 2021-05-22
 
 - Updated OpenTelemetry to

data/README.md

@@ -1,16 +1,16 @@
 # Uptrace Ruby exporter for OpenTelemetry
 
 ![build workflow](https://github.com/uptrace/uptrace-ruby/actions/workflows/build.yml/badge.svg)
-[![Documentation](https://img.shields.io/badge/uptrace-documentation-informational)](https://docs.uptrace.dev/ruby/)
+[![Documentation](https://img.shields.io/badge/uptrace-documentation-informational)](https://docs.uptrace.dev/guide/ruby.html)
 
-<a href="https://docs.uptrace.dev/ruby/">
+<a href="https://docs.uptrace.dev/guide/ruby.html">
   <img src="https://docs.uptrace.dev/devicon/ruby-original.svg" height="200px" />
 </a>
 
 ## Introduction
 
 uptrace-ruby is an OpenTelemery distribution configured to export
-[traces](https://docs.uptrace.dev/tracing/#spans) to Uptrace.
+[traces](https://opentelemetry.uptrace.dev/guide/distributed-tracing.html) to Uptrace.
 
 ## Quickstart
 
@@ -30,33 +30,38 @@ require 'rubygems'
 require 'bundler/setup'
 require 'uptrace'
 
-OpenTelemetry::SDK.configure do |c|
+# Configure OpenTelemetry with sensible defaults.
+# Copy your project DSN here or use UPTRACE_DSN env var.
+Uptrace.configure_opentelemetry(dsn: '') do |c|
+  # c is OpenTelemetry::SDK::Configurator
   c.service_name = 'myservice'
   c.service_version = '1.0.0'
-
-  # Configure OpenTelemetry to export data to Uptrace.
-  # Copy your project DSN here or use UPTRACE_DSN env var.
-  Uptrace.configure_opentelemetry(c, dsn: '')
 end
 
+# Create a tracer. Usually, tracer is a global variable.
 tracer = OpenTelemetry.tracer_provider.tracer('my_app_or_gem', '0.1.0')
 
-tracer.in_span('main') do |span|
-  tracer.in_span('child1') do |child1|
+# Create a root span (a trace) to measure some operation.
+tracer.in_span('main-operation') do |main|
+  tracer.in_span('child1-of-main') do |child1|
     child1.set_attribute('key1', 'value1')
     child1.record_exception(ArgumentError.new('error1'))
   end
 
-  tracer.in_span('child2') do |child2|
+  tracer.in_span('child2-of-main') do |child2|
     child2.set_attribute('key2', '24')
     child2.set_attribute('key3', 123.456)
   end
 
-  puts("trace URL: #{Uptrace.trace_url(span)}")
+  puts("trace URL: #{Uptrace.trace_url(main)}")
 end
 
-# Send buffered spans.
+# Send buffered spans and free resources.
 OpenTelemetry.tracer_provider.shutdown
 ```
 
-Please see [uptrace-ruby documentation](https://docs.uptrace.dev/ruby/) for more details.
+## Links
+
+- [Examples](example)
+- [Documentation](https://docs.uptrace.dev/guide/ruby.html)
+- [Instrumentations](https://opentelemetry.uptrace.dev/instrumentations.html?lang=ruby)

data/lib/uptrace/client.rb

@@ -5,6 +5,8 @@ require 'opentelemetry/sdk'
 module Uptrace
   # Uptrace client that configures OpenTelemetry SDK to use Uptrace exporter.
   class Client
+    attr_reader :dsn
+
     # @param [string] dsn
     def initialize(dsn: '')
       dsn = ENV.fetch('UPTRACE_DSN', '') if dsn.empty?
@@ -27,21 +29,8 @@ module Uptrace
     # @return [String]
     def trace_url(span = nil)
       span = OpenTelemetry::Trace.current_span if span.nil?
-
-      host = @dsn.host.delete_prefix('api.')
       trace_id = span.context.hex_trace_id
-      "#{@dsn.scheme}://#{host}/search/#{@dsn.project_id}?q=#{trace_id}"
-    end
-
-    # @return [OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor]
-    def span_processor
-      exp = Uptrace::Trace::Exporter.new(@dsn)
-      OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
-        exp,
-        max_queue_size: 1000,
-        max_export_batch_size: 1000,
-        schedule_delay: 5_000
-      )
+      "#{@dsn.app_addr}/traces/#{trace_id}"
     end
   end
 end

data/lib/uptrace/dsn.rb

@@ -3,9 +3,7 @@
 module Uptrace
   # Uptrace DSN
   class DSN
-    KEYS = %w[scheme host project_id token].freeze
-
-    attr_reader :dsn, :port, *KEYS
+    attr_reader :dsn, :scheme, :host, :port, :project_id, :token
 
     def initialize(dsn)
       raise ArgumentError, "DSN can't be empty" if dsn.empty?
@@ -17,13 +15,21 @@ module Uptrace
       end
 
       @dsn = dsn
-      @project_id = uri.path.delete_prefix('/')
-      @token = uri.user
+      @scheme = uri.scheme
       @host = uri.host
       @port = uri.port
-      @scheme = uri.scheme
+      @project_id = uri.path.delete_prefix('/')
+      @token = uri.user
+
+      %w[scheme host].each do |k|
+        v = public_send(k)
+        raise ArgumentError, %(DSN=#{dsn.inspect} does not have a #{k}) if v.nil? || v.empty?
+      end
+
+      @host = 'uptrace.dev' if @host == 'api.uptrace.dev'
+      return if @host != 'uptrace.dev'
 
-      KEYS.each do |k|
+      %w[project_id token].each do |k|
         v = public_send(k)
         raise ArgumentError, %(DSN=#{dsn.inspect} does not have a #{k}) if v.nil? || v.empty?
       end
@@ -32,5 +38,17 @@ module Uptrace
     def to_s
       @dsn
     end
+
+    def app_addr
+      return 'https://app.uptrace.dev' if @host == 'uptrace.dev'
+
+      "#{@scheme}://#{@host}:#{@port}"
+    end
+
+    def otlp_addr
+      return 'https://otlp.uptrace.dev' if @host == 'uptrace.dev'
+
+      "#{@scheme}://#{@host}:#{@port}"
+    end
   end
 end

data/lib/uptrace/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uptrace
-  VERSION = '1.0.0.rc1'
+  VERSION = '1.0.2'
 end

data/lib/uptrace.rb

@@ -2,6 +2,8 @@
 
 require 'logger'
 
+require 'opentelemetry/exporter/otlp'
+
 # Uptrace provides Uptrace exporters for OpenTelemetry.
 module Uptrace
   extend self
@@ -19,7 +21,7 @@ module Uptrace
   # @param [optional OpenTelemetry::Trace::Span] span
   # @return [String]
   def trace_url(span = nil)
-    client.trace_url(span)
+    @client.trace_url(span)
   end
 
   # ConfigureOpentelemetry configures OpenTelemetry to export data to Uptrace.
@@ -31,14 +33,30 @@ module Uptrace
   def configure_opentelemetry(dsn: '')
     OpenTelemetry::SDK.configure do |c|
       @client = Client.new(dsn: dsn) unless dsn.empty?
-      c.add_span_processor(client.span_processor) unless client.disabled?
+      c.add_span_processor(span_processor(@client.dsn)) unless client.disabled?
 
       yield c if block_given?
     end
   end
+
+  private
+
+  def span_processor(dsn)
+    exporter = OpenTelemetry::Exporter::OTLP::Exporter.new(
+      endpoint: "#{dsn.otlp_addr}/v1/traces",
+      # Set the Uptrace DSN here or use UPTRACE_DSN env var.
+      headers: { 'uptrace-dsn': dsn.to_s },
+      compression: 'gzip'
+    )
+    OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
+      exporter,
+      max_queue_size: 1000,
+      max_export_batch_size: 1000,
+      schedule_delay: 5_000
+    )
+  end
 end
 
 require 'uptrace/version'
 require 'uptrace/dsn'
 require 'uptrace/client'
-require 'uptrace/trace'

metadata

@@ -1,71 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: uptrace
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.2
 platform: ruby
 authors:
 - Uptrace Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-22 00:00:00.000000000 Z
+date: 2021-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: msgpack
+  name: opentelemetry-exporter-otlp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.2
-- !ruby/object:Gem::Dependency
-  name: opentelemetry-sdk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: 0.20.5
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.20.5
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
-  name: zstd-ruby
+  name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.9.0
+        version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.9.0
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -86,56 +78,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.23.0
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.2
+        version: 0.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.2
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -179,14 +171,12 @@ files:
 - lib/uptrace.rb
 - lib/uptrace/client.rb
 - lib/uptrace/dsn.rb
-- lib/uptrace/metric.rb
-- lib/uptrace/trace.rb
-- lib/uptrace/trace/exporter.rb
 - lib/uptrace/version.rb
 homepage: https://github.com/uptrace/uptrace-ruby
 licenses:
 - BSD-2-Clause
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -198,9 +188,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.4
 signing_key: 

data/lib/uptrace/metric.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Uptrace
-  # Metric module provides metric exporter for OpenTelemetry.
-  module Metric
-  end
-end

data/lib/uptrace/trace/exporter.rb

@@ -1,224 +0,0 @@
-# frozen_string_literal: true
-
-require 'uri'
-require 'net/http'
-require 'json'
-
-require 'opentelemetry/sdk'
-require 'msgpack'
-require 'zstd-ruby'
-
-module Uptrace
-  module Trace
-    # Exporter is a span exporter for OpenTelemetry.
-    class Exporter
-      SUCCESS = OpenTelemetry::SDK::Trace::Export::SUCCESS
-      FAILURE = OpenTelemetry::SDK::Trace::Export::FAILURE
-      TIMEOUT = OpenTelemetry::SDK::Trace::Export::TIMEOUT
-      private_constant(:SUCCESS, :FAILURE, :TIMEOUT)
-
-      ##
-      # @param [Config] cfg
-      #
-      def initialize(dsn)
-        @dsn = dsn
-        @endpoint = "/api/v1/tracing/#{@dsn.project_id}/spans"
-
-        @http = Net::HTTP.new(@dsn.host, 443)
-        @http.use_ssl = true
-        @http.open_timeout = 5
-        @http.read_timeout = 5
-        @http.keep_alive_timeout = 30
-      end
-
-      # Called to export sampled {OpenTelemetry::SDK::Trace::SpanData} structs.
-      #
-      # @param [Enumerable<OpenTelemetry::SDK::Trace::SpanData>] spans 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(spans, timeout: nil)
-        return SUCCESS if @disabled
-        return FAILURE if @shutdown
-
-        out = []
-
-        spans.each do |span|
-          out.push(uptrace_span(span))
-        end
-
-        send({ spans: out }, timeout: timeout)
-      end
-
-      # 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) # rubocop:disable Lint/UnusedMethodArgument
-        SUCCESS
-      end
-
-      # Called when {OpenTelemetry::SDK::Trace::Tracer#shutdown} is called, if
-      # this exporter is registered to a {OpenTelemetry::SDK::Trace::Tracer}
-      # object.
-      #
-      # @param [optional Numeric] timeout An optional timeout in seconds.
-      def shutdown(timeout: nil) # rubocop:disable Lint/UnusedMethodArgument
-        @shutdown = true
-        @http.finish if @http.started?
-        SUCCESS
-      end
-
-      private
-
-      ##
-      # @return [hash]
-      #
-      def uptrace_span(span)
-        out = {
-          id: span.span_id.unpack1('Q'),
-          traceId: span.trace_id,
-
-          name: span.name,
-          kind: kind_as_str(span.kind),
-          startTime: span.start_timestamp,
-          endTime: span.end_timestamp,
-
-          resource: uptrace_resource(span.resource),
-          attrs: span.attributes
-        }
-
-        out[:parentId] = span.parent_span_id.unpack1('Q') if span.parent_span_id
-
-        out[:events] = uptrace_events(span.events) unless span.events.nil?
-        out[:links] = uptrace_links(span.links) unless span.links.nil?
-
-        status = span.status
-        out[:statusCode] = status_code_as_str(status.code)
-        out[:statusMessage] = status.description unless status.description.empty?
-
-        il = span.instrumentation_library
-        out[:tracerName] = il.name
-        out[:tracerVersion] = il.name unless il.version.empty?
-
-        out
-      end
-
-      def send(data, timeout: nil) # rubocop:disable Lint/UnusedMethodArgument
-        req = build_request(data)
-
-        begin
-          resp = @http.request(req)
-        rescue Net::OpenTimeout, Net::ReadTimeout
-          return FAILURE
-        end
-
-        case resp
-        when Net::HTTPOK
-          resp.body # Read and discard body
-          SUCCESS
-        when Net::HTTPBadRequest
-          data = JSON.parse(resp.body)
-          Uptrace.logger.error("status=#{data['status']}: #{data['message']}")
-          FAILURE
-        when Net::HTTPInternalServerError
-          resp.body
-          FAILURE
-        else
-          @http.finish
-          FAILURE
-        end
-      end
-
-      ##
-      # @param [Hash] data
-      # @return [Net::HTTP::Post]
-      #
-      def build_request(data)
-        data = MessagePack.pack(data)
-        data = Zstd.compress(data, 3)
-
-        req = Net::HTTP::Post.new(@endpoint)
-        req.add_field('Authorization', "Bearer #{@dsn.token}")
-        req.add_field('Content-Type', 'application/msgpack')
-        req.add_field('Content-Encoding', 'zstd')
-        req.add_field('Connection', 'keep-alive')
-        req.body = data
-
-        req
-      end
-
-      # @param [SpanKind] kind
-      # @return [String]
-      def kind_as_str(kind)
-        case kind
-        when OpenTelemetry::Trace::SpanKind::SERVER
-          'server'
-        when OpenTelemetry::Trace::SpanKind::CLIENT
-          'client'
-        when OpenTelemetry::Trace::SpanKind::PRODUCER
-          'producer'
-        when OpenTelemetry::Trace::SpanKind::CONSUMER
-          'consumer'
-        else
-          'internal'
-        end
-      end
-
-      ##
-      # @param [Integer] code
-      # @return [String]
-      #
-      def status_code_as_str(code)
-        case code
-        when OpenTelemetry::Trace::Status::OK
-          'ok'
-        when OpenTelemetry::Trace::Status::ERROR
-          'error'
-        else
-          'unset'
-        end
-      end
-
-      ##
-      # @param [OpenTelemetry::SDK::Resources::Resource] resource
-      # @return [Hash]
-      #
-      def uptrace_resource(resource)
-        out = {}
-        resource.attribute_enumerator.map { |key, value| out[key] = value }
-        out
-      end
-
-      def uptrace_events(events)
-        out = []
-        events.each do |event|
-          out.push(
-            {
-              name: event.name,
-              attrs: event.attributes,
-              time: event.timestamp
-            }
-          )
-        end
-        out
-      end
-
-      def uptrace_links(links)
-        out = []
-        links.each do |link|
-          out.push(
-            {
-              trace_id => link.span_context.trace_id,
-              span_id => link.span_context.span_id.unpack1('Q'),
-              attrs => link.attributes
-            }
-          )
-        end
-        out
-      end
-    end
-  end
-end

data/lib/uptrace/trace.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Uptrace
-  # Trace module provides trace exporter for OpenTelemetry.
-  module Trace
-  end
-end
-
-require 'uptrace/trace/exporter'