uptrace 0.2.5 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43f0392ed577dc7bd8e63985d033e8d8d89ccaa53ef76bbe32b9c7c28a5d5882
-  data.tar.gz: 12becd6950ec2bfd5bd81aa350a00dfdee9a91ce3034a4506b907edbe2213dff
+  metadata.gz: 3b0f7710f0eae6b7bcd64b9ba4cb6f8e8ea0d038288dc01f173381a1937639c9
+  data.tar.gz: 160bd219eb212e7e97561b758b1d76cf3a38672aa02e292c218c9694b8f27544
 SHA512:
-  metadata.gz: 1447f636c276d492e6eeedabbe0d6f825b11c7bdb69312f8f9c45ea02436edd22318812f80aba2211d3d93f2f3ba0c3f637e9b616cfb9acdffc0288170501560
-  data.tar.gz: 685dc638c8506fbd17bb01aaf00fe2831cec1a7be8852ad9f484e1964df4f933fbb73c20e1a2bb266f0f7a3c52b55f40f5fceb28ccc9065877f1b9c19f2b1f21
+  metadata.gz: e67923bceb81e39049b4dadf8d0a0740b114300d6c979fb9f720dd3a599adf83c0fb0adfe5b0fece036225863ab27ea05e738df2d547c82d2bff25b3e0c1a6fe
+  data.tar.gz: 39886118653a1e0f61d6d880c1adda437c337dcff2819f7ffd2d012561dccda10340565aece6b600f7bdcb741881413d925f65ed95cd9463d0502077cb11dfa2

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## v0.17.0 - 2021-04-24
+
+- Updated OpenTelemetry to
+  [v0.17.0](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/api/CHANGELOG.md#v0170--2021-04-22).
+
+## 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/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.5'
+  VERSION = '0.17.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uptrace
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.17.0
 platform: ruby
 authors:
 - Uptrace Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: zstd-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.5.0
+        version: 1.4.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.5.0
+        version: 1.4.9.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +172,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
+- CHANGELOG.md
 - LICENSE
 - README.md
 - RELEASE.md