uptrace 0.2.3 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cc81f964b6c014c38abbdfcf4250fa467ba0c8ef2dfd8077967d851bdd9f567
-  data.tar.gz: 5fb6975a0916e18d1603aa03ec78d7639b4e6a37de079e2ed72326a7db8c6ee0
+  metadata.gz: 3e04833f5ff0015d78af4774cc49272db2c0c10e3cd93ce5acbe6cfc3e9e3772
+  data.tar.gz: f027f68acd8f95b550bdbde26322307420f8e833447aff1a268d06ac57b00910
 SHA512:
-  metadata.gz: ba5ef3bc321a50fd4203a033a023bbfc491071d29a05edb9c9a93cd6a2c53a8a59ec6af2e97cc919d57695193993ecedbf42914b53cbda72a6ab80d9085b763c
-  data.tar.gz: e5a44d04828a788321193d00a6c7196fa38c92ce7aaa274636448f50609c3759410d11444360cd42f7d1ee066af020660e706732b2209686dc224da707d6ec33
+  metadata.gz: 1ef5879252c95a7ca008f042061ecc1d674f36822739e8f17bb19ae2385ef1f6cdc02bc2885edf3538da13d3f9d5f9feca849c3f553381de4b393f55aedf570d
+  data.tar.gz: ef03b0f10c6d992d81f5d64c0df4d9eb8c9590399c61fe9f3b9b8cc166492309940c2e2d6479f2366a9137d111caae6ce16b6c9f53c4f89f176b532345d94e2f

data/README.md

@@ -1,21 +1,62 @@
 # Uptrace Ruby exporter for OpenTelemetry
 
-[![Build Status](https://travis-ci.org/uptrace/uptrace-ruby.svg?branch=master)](https://travis-ci.org/uptrace/uptrace-ruby)
+![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/)
 
 <a href="https://docs.uptrace.dev/ruby/">
   <img src="https://docs.uptrace.dev/devicons/ruby-original.svg" height="200px" />
 </a>
 
-## Installation
+## Introduction
+
+uptrace-ruby is an OpenTelemery distribution configured to export
+[traces](https://docs.uptrace.dev/tracing/#spans) to Uptrace.
+
+## Quickstart
+
+Install uptrace-ruby:
 
 ```bash
 gem install uptrace
 ```
 
-## Introduction
+Run the [basic example](example/basic) below using the DSN from the Uptrace project settings page.
+
+```ruby
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler/setup'
+require 'uptrace'
 
-uptrace-ruby is the official Uptrace client for Ruby that sends your traces/spans and metrics to
-[Uptrace.dev](https://uptrace.dev).
+OpenTelemetry::SDK.configure do |c|
+  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
+
+tracer = OpenTelemetry.tracer_provider.tracer('my_app_or_gem', '0.1.0')
+
+tracer.in_span('main') do |span|
+  tracer.in_span('child1') do |child1|
+    child1.set_attribute('key1', 'value1')
+    child1.record_exception(ArgumentError.new('error1'))
+  end
+
+  tracer.in_span('child2') do |child2|
+    child2.set_attribute('key2', '24')
+    child2.set_attribute('key3', 123.456)
+  end
+
+  puts("trace URL: #{Uptrace.trace_url(span)}")
+end
+
+# Send buffered spans.
+OpenTelemetry.tracer_provider.shutdown
+```
 
-See [uptrace-ruby documentation](https://docs.uptrace.dev/ruby/) for details.
+Please see [uptrace-ruby documentation](https://docs.uptrace.dev/ruby/) for more details.

data/lib/uptrace.rb

@@ -1,14 +1,51 @@
 # frozen_string_literal: true
 
 require 'logger'
+require 'opentelemetry'
 
 # Uptrace provides Uptrace exporters for OpenTelemetry.
 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
+
+  # @param [optional OpenTelemetry::Trace::Span] span
+  # @return [String]
+  def trace_url(span = nil)
+    client.trace_url(span)
+  end
+
+  # ConfigureOpentelemetry configures OpenTelemetry to export data to Uptrace.
+  # By default it:
+  #   - creates tracer provider;
+  #   - registers Uptrace span exporter;
+  #   - sets tracecontext + baggage composite context propagator.
+  #
+  # @param [OpenTelemetry::SDK::Configurator] c
+  def configure_opentelemetry(c, dsn: '')
+    @client = Client.new(dsn: dsn) unless dsn.empty?
+
+    c.add_span_processor(client.span_processor) unless client.disabled?
+
+    if OpenTelemetry.propagation.nil?
+      c.injectors = [
+        OpenTelemetry::Trace::Propagation::TraceContext.text_map_injector,
+        OpenTelemetry::Baggage::Propagation.text_map_injector
+      ]
+      c.extractors = [
+        OpenTelemetry::Trace::Propagation::TraceContext.text_map_extractor,
+        OpenTelemetry::Baggage::Propagation.text_map_extractor
+      ]
+    end
+  end
 end
 
 require 'uptrace/version'

data/lib/uptrace/client.rb

@@ -5,43 +5,37 @@ 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?
-
-      @cfg.dsn = ENV.fetch('UPTRACE_DSN', '') if @cfg.dsn.nil? || @cfg.dsn.empty?
+    # @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("Uptrace is disabled: #{e.message}")
-        @cfg.disabled = true
+        @disabled = true
 
-        @cfg.dsn = 'https://TOKEN@api.uptrace.dev/PROJECT_ID'
+        @dsn = DSN.new('https://TOKEN@api.uptrace.dev/PROJECT_ID')
       end
     end
 
-    # @param [optional Numeric] timeout An optional timeout in seconds.
-    def close(timeout: nil)
-      return if @cfg.disabled
-
-      OpenTelemetry.tracer_provider.shutdown(timeout: timeout)
+    def disabled?
+      @disabled
     end
 
-    # @return [OpenTelemetry::Trace::Span]
-    def trace_url(span)
-      dsn = @cfg.dsno
-      host = dsn.host.delete_prefix('api.')
+    # @param [optional OpenTelemetry::Trace::Span] span
+    # @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}"
+      "#{@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(@cfg)
+      exp = Uptrace::Trace::Exporter.new(@dsn)
       OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
         exp,
         max_queue_size: 1000,

data/lib/uptrace/dsn.rb

@@ -25,7 +25,7 @@ module Uptrace
 
       KEYS.each do |k|
         v = public_send(k)
-        raise ArgumentError, %(DSN does not have #{k} (DSN=#{dsn.inspect})) if v.nil? || v.empty?
+        raise ArgumentError, %(DSN=#{dsn.inspect} does not have a #{k}) 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
@@ -53,6 +51,15 @@ module Uptrace
         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.
@@ -61,6 +68,7 @@ module Uptrace
       def shutdown(timeout: nil) # rubocop:disable Lint/UnusedMethodArgument
         @shutdown = true
         @http.finish if @http.started?
+        SUCCESS
       end
 
       private
@@ -133,7 +141,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')

data/lib/uptrace/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uptrace
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.16.1
 platform: ruby
 authors:
 - Uptrace Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: zstd-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -180,7 +180,6 @@ files:
 - 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,26 +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 dsno
-        @dsno ||= DSN.new(@dsn)
-      end
-    end
-  end
-end