uptrace 0.2.4 → 0.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 525b8e2ad45dd955af7095839bfdf024e29b11309e8a0103b36bddb7980f3c41
-  data.tar.gz: 0766a2822dad2acb536aeccba788ac898ce7474ae4d74de355577de544772a4b
+  metadata.gz: 6e560d02dc7fff00fe1417273235f621093fddf1dd2b89fec8eb26f25ec77137
+  data.tar.gz: f4425d572581c3b8863891e7f1df56c1acc2a8df19e96d56c5fadc138b147fd6
 SHA512:
-  metadata.gz: 36c69755595e07ffee78a62f3f1633fdd62def2d910b50876e8ffc4e2791800869d98f61b338bb2e30a01280610cc5fbeabe58a0f17214b5f2377031c2801f07
-  data.tar.gz: f33956036979a79d2f39e05f8a30f3008ffd967a828a048d88b187867e562bd013cecf9b0958584dc885142341633848739c3fc05dded624c8c16dc7ee8d7848
+  metadata.gz: f9d888b255f9b97deb19d115bfc0a16eca449a79df08c6262557be002f98460a3ba1db188caf5cf2266e7cbbe92aefd5fec1567a7c398ddcd04021f4315324e2
+  data.tar.gz: d831ec671858212f78caeadba72689d0735b0c85579af3bcec992e5df83c62d40af0a447dea647f0a28c993f277f8e3ecfbaa9aa9ef348734912523ecc947f26

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## v0.16.2 - 2021-03-28
+
+- Updated OpenTelemetry to
+  [v0.16.0](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/api/CHANGELOG.md#v0160--2021-03-17).

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

@@ -16,18 +16,25 @@ module Uptrace
     @client ||= Client.new
   end
 
-  def trace_url(span)
+  # @param [optional OpenTelemetry::Trace::Span] span
+  # @return [String]
+  def trace_url(span = nil)
     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?
+  # ConfigureOpentelemetry configures OpenTelemetry to export data to Uptrace.
+  # Specifically it configures and registers Uptrace span exporter.
+  #
+  # @param [optional String] dsn
+  # @yieldparam [OpenTelemetry::SDK::Configurator] c Yields a configurator to the
+  #   provided block
+  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?
+
+      yield c if block_given?
+    end
   end
 end
 

data/lib/uptrace/client.rb

@@ -23,9 +23,11 @@ module Uptrace
       @disabled
     end
 
-    # @param [OpenTelemetry::Trace::Span] span
+    # @param [optional OpenTelemetry::Trace::Span] span
     # @return [String]
-    def trace_url(span)
+    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}"

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

@@ -51,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.
@@ -59,6 +68,7 @@ module Uptrace
       def shutdown(timeout: nil) # rubocop:disable Lint/UnusedMethodArgument
         @shutdown = true
         @http.finish if @http.started?
+        SUCCESS
       end
 
       private

data/lib/uptrace/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uptrace
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.16.2
 platform: ruby
 authors:
 - Uptrace Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-03-28 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
@@ -172,6 +172,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
+- CHANGELOG.md
 - LICENSE
 - README.md
 - RELEASE.md