uptrace 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a05b7c62ea6f2a2fb078f3b8272951c1d114f8062ff833c14c3b5a9183524cb1
-  data.tar.gz: 2876c7b4803b791d5955665a5fb8e97754355f9929c2a6b5ea39b511a839f54c
+  metadata.gz: 43f0392ed577dc7bd8e63985d033e8d8d89ccaa53ef76bbe32b9c7c28a5d5882
+  data.tar.gz: 12becd6950ec2bfd5bd81aa350a00dfdee9a91ce3034a4506b907edbe2213dff
 SHA512:
-  metadata.gz: 9ce7612b3d87b3a32605996de564ce4f44821590bca24af38c6ef267d0a5c7c3d141a8241042bb36f86e532e4e38d971d3f82c9a096f69a1a58af5262efbd0af
-  data.tar.gz: b9b4d42c52cdfac6ae3444a3d782c83c7d410941a8b4a63aaf05d318863fa229d30e588484746df86a60358d57c5eefc718611bc94987987c5082bd8017887a1
+  metadata.gz: 1447f636c276d492e6eeedabbe0d6f825b11c7bdb69312f8f9c45ea02436edd22318812f80aba2211d3d93f2f3ba0c3f637e9b616cfb9acdffc0288170501560
+  data.tar.gz: 685dc638c8506fbd17bb01aaf00fe2831cec1a7be8852ad9f484e1964df4f933fbb73c20e1a2bb266f0f7a3c52b55f40f5fceb28ccc9065877f1b9c19f2b1f21

data/RELEASE.md

@@ -0,0 +1,7 @@
+Bump version and then run:
+
+```shell
+gem build uptrace.gemspec
+bundle install
+gem push uptrace-0.2.0.gem
+```

data/lib/uptrace.rb

@@ -7,8 +7,28 @@ module Uptrace
   extend self
 
   attr_accessor :logger
+  attr_writer :client
 
   self.logger = Logger.new($stdout)
+
+  # @return [Object, Client] registered client or a default no-op implementation of the client.
+  def client
+    @client ||= Client.new
+  end
+
+  def trace_url(span)
+    client.trace_url(span)
+  end
+
+  def configure_tracing(c, dsn: '')
+    upclient = if dsn.empty?
+                 client
+               else
+                 Client.new(dsn: dsn)
+               end
+
+    c.add_span_processor(upclient.span_processor) unless upclient.disabled?
+  end
 end
 
 require 'uptrace/version'

data/lib/uptrace/client.rb

@@ -5,53 +5,41 @@ require 'opentelemetry/sdk'
 module Uptrace
   # Uptrace client that configures OpenTelemetry SDK to use Uptrace exporter.
   class Client
-    ##
-    # @yieldparam config [Uptrace::Config]
-    # @return [void]
-    #
-    def initialize
-      @cfg = Uptrace::Trace::Config.new
-      yield @cfg if block_given?
+    # @param [string] dsn
+    def initialize(dsn: '')
+      dsn = ENV.fetch('UPTRACE_DSN', '') if dsn.empty?
 
       begin
-        @cfg.dsno
+        @dsn = DSN.new(dsn)
       rescue ArgumentError => e
-        Uptrace.logger.error(e.message)
-        @cfg.disabled = true
+        Uptrace.logger.error("Uptrace is disabled: #{e.message}")
+        @disabled = true
 
-        @cfg.dsn = 'https://TOKEN@api.uptrace.dev/PROJECT_ID'
+        @dsn = DSN.new('https://TOKEN@api.uptrace.dev/PROJECT_ID')
       end
-
-      setup_tracing unless @cfg.disabled
     end
 
-    # @param [optional Numeric] timeout An optional timeout in seconds.
-    def shutdown(timeout: nil)
-      return if @cfg.disabled
-
-      OpenTelemetry.tracer_provider.shutdown(timeout: timeout)
+    def disabled?
+      @disabled
     end
 
-    # @return [OpenTelemetry::Trace::Span]
+    # @param [OpenTelemetry::Trace::Span] span
+    # @return [String]
     def trace_url(span)
-      dsn = @cfg.dsno
-      host = dsn.host.delete_prefix('api.')
+      host = @dsn.host.delete_prefix('api.')
       trace_id = span.context.hex_trace_id
-      "#{dsn.scheme}://#{host}/#{dsn.project_id}/search?q=#{trace_id}"
+      "#{@dsn.scheme}://#{host}/search/#{@dsn.project_id}?q=#{trace_id}"
     end
 
-    private
-
-    def setup_tracing
-      exp = Uptrace::Trace::Exporter.new(@cfg)
-
-      OpenTelemetry::SDK.configure do |c|
-        bsp = OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(exporter: exp, max_queue_size: 1000, max_export_batch_size: 1000, schedule_delay: 5_000)
-        c.add_span_processor(bsp)
-
-        c.service_name = @cfg.service_name
-        c.service_version = @cfg.service_version
-      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
+      )
     end
   end
 end

data/lib/uptrace/dsn.rb

@@ -8,12 +8,12 @@ module Uptrace
     attr_reader :dsn, :port, *KEYS
 
     def initialize(dsn)
-      raise ArgumentError, "uptrace: DSN can't be empty" if dsn.empty?
+      raise ArgumentError, "DSN can't be empty" if dsn.empty?
 
       begin
         uri = URI.parse(dsn)
       rescue URI::InvalidURIError => e
-        raise ArgumentError, %(uptrace: can't parse DSN=#{dsn.inspect}: #{e})
+        raise ArgumentError, %(can't parse DSN=#{dsn.inspect}: #{e})
       end
 
       @dsn = dsn
@@ -25,7 +25,7 @@ module Uptrace
 
       KEYS.each do |k|
         v = public_send(k)
-        raise ArgumentError, %(uptrace: DSN does not have #{k} (DSN=#{dsn.inspect})) if v.nil? || v.empty?
+        raise ArgumentError, %(DSN does not have #{k} (DSN=#{dsn.inspect})) if v.nil? || v.empty?
       end
     end
 

data/lib/uptrace/trace.rb

@@ -6,5 +6,4 @@ module Uptrace
   end
 end
 
-require 'uptrace/trace/config'
 require 'uptrace/trace/exporter'

data/lib/uptrace/trace/exporter.rb

@@ -20,13 +20,11 @@ module Uptrace
       ##
       # @param [Config] cfg
       #
-      def initialize(cfg)
-        @cfg = cfg
+      def initialize(dsn)
+        @dsn = dsn
+        @endpoint = "/api/v1/tracing/#{@dsn.project_id}/spans"
 
-        dsn = @cfg.dsno
-        @endpoint = "/api/v1/tracing/#{dsn.project_id}/spans"
-
-        @http = Net::HTTP.new(dsn.host, 443)
+        @http = Net::HTTP.new(@dsn.host, 443)
         @http.use_ssl = true
         @http.open_timeout = 5
         @http.read_timeout = 5
@@ -79,18 +77,21 @@ module Uptrace
           endTime: as_unix_nano(span.end_timestamp),
 
           resource: uptrace_resource(span.resource),
-          attrs: span.attributes,
+          attrs: span.attributes
+        }
 
-          statusCode: status_code_as_str(span.status.code),
-          statusMessage: span.status.description,
+        out[:parentId] = span.parent_span_id.unpack1('Q') if span.parent_span_id
 
-          tracer: uptrace_tracer(span.instrumentation_library)
-        }
+        out[:events] = uptrace_events(span.events) unless span.events.nil?
+        out[:links] = uptrace_links(span.links) unless span.links.nil?
 
-        out['parentId'] = span.parent_span_id.unpack1('Q') if span.parent_span_id
+        status = span.status
+        out[:statusCode] = status_code_as_str(status.code)
+        out[:statusMessage] = status.description unless status.description.empty?
 
-        out['events'] = uptrace_events(span.events) unless span.events.nil?
-        out['links'] = uptrace_links(span.links) unless span.links.nil?
+        il = span.instrumentation_library
+        out[:tracerName] = il.name
+        out[:tracerVersion] = il.name unless il.version.empty?
 
         out
       end
@@ -130,7 +131,7 @@ module Uptrace
         data = Zstd.compress(data, 3)
 
         req = Net::HTTP::Post.new(@endpoint)
-        req.add_field('Authorization', "Bearer #{@cfg.dsno.token}")
+        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')
@@ -216,17 +217,6 @@ module Uptrace
         end
         out
       end
-
-      ##
-      # @param [OpenTelemetry::SDK::InstrumentationLibrary] il
-      # @return [Hash]
-      #
-      def uptrace_tracer(il)
-        {
-          name: il.name,
-          version: il.version
-        }
-      end
     end
   end
 end

data/lib/uptrace/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uptrace
-  VERSION = '0.2.0'
+  VERSION = '0.2.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uptrace
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5
 platform: ruby
 authors:
 - Uptrace Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: zstd-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -174,12 +174,12 @@ files:
 - ".yardopts"
 - LICENSE
 - README.md
+- RELEASE.md
 - lib/uptrace.rb
 - lib/uptrace/client.rb
 - lib/uptrace/dsn.rb
 - lib/uptrace/metric.rb
 - lib/uptrace/trace.rb
-- lib/uptrace/trace/config.rb
 - lib/uptrace/trace/exporter.rb
 - lib/uptrace/version.rb
 homepage: https://github.com/uptrace/uptrace-ruby

data/lib/uptrace/trace/config.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require 'uptrace/dsn'
-
-module Uptrace
-  module Trace
-    # Config is a configuration for Uptrace span exporter.
-    class Config
-      # @return [string] a data source name to connect to uptrace.dev.
-      attr_accessor :dsn
-
-      # @return [string] `service.name` resource attribute.
-      attr_accessor :service_name
-
-      # @return [string] `service.name` resource attribute.
-      attr_accessor :service_version
-
-      # @return [boolean] disables the exporter.
-      attr_accessor :disabled
-
-      def initialize
-        @dsn = ENV.fetch('UPTRACE_DSN', '')
-      end
-
-      def dsno
-        @dsno ||= DSN.new(@dsn)
-      end
-    end
-  end
-end