uptrace 0.2.6 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eaccd23f9b8a866577eb6ef2c81589306a4930280bedbed67340b8d908339c4
-  data.tar.gz: fe2bce7cfb97c14318f2cf63d65aa102d6e74ac6f01f12a600d2822856abf15c
+  metadata.gz: 5f9a4d977dcec234cd8810306f108488708ca23a30ce0836d71d52e5f759033b
+  data.tar.gz: 305152b04753b7febe844a76ff675f192f5d0f939f179b77dfb73a4fd21d71fe
 SHA512:
-  metadata.gz: a6f15e1110e43582d2aba18a19ef16aa6844a85584d101c9c4c72de0f072941d31c9a42deae5b42802f03b7da3050b7279e3a5b07b9ba9a3d4e76251d9293d24
-  data.tar.gz: 72fbe0da3afe6979150c16f5944fe140439ea552009aef1c84164d9cebed73d40a5639ed346e4e57029ba8c39087f78af7358f121d36084ed1715d7a96e3fb4d
+  metadata.gz: c0593e88e857717b329f4f4d21278efddd605412e3ab63d617eccb3547bbabacaf98ff3f7c68630b90215eff7712cc824c7579e2c5edb78617931b3004b1930b
+  data.tar.gz: d8c976e2e80dbaa0eb323c8c71ee919cac0b53331bec52483b34e0e393dece72914ef21810d4d5c677a1ee8bc8902a6f210d2c814366a9afe940f456ee9fa5c9

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## v1.0.0.rc1 - 2021-05-22
+
+- Updated OpenTelemetry to
+  [v1.0.0.rc1](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/api/CHANGELOG.md#v100rc1--2021-05-21).
+
+## 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" />
+  <img src="https://docs.uptrace.dev/devicon/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,14 +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_opentelemetry(c, dsn: '')
-    @client = Client.new(dsn: dsn) unless dsn.empty?
-
-    c.add_span_processor(client.span_processor) unless client.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
@@ -73,8 +83,8 @@ module Uptrace
 
           name: span.name,
           kind: kind_as_str(span.kind),
-          startTime: as_unix_nano(span.start_timestamp),
-          endTime: as_unix_nano(span.end_timestamp),
+          startTime: span.start_timestamp,
+          endTime: span.end_timestamp,
 
           resource: uptrace_resource(span.resource),
           attrs: span.attributes
@@ -157,14 +167,6 @@ module Uptrace
         end
       end
 
-      ##
-      # @param [Integer] timestamp
-      # @return [Integer]
-      #
-      def as_unix_nano(timestamp)
-        (timestamp.to_r * 1_000_000_000).to_i
-      end
-
       ##
       # @param [Integer] code
       # @return [String]
@@ -197,7 +199,7 @@ module Uptrace
             {
               name: event.name,
               attrs: event.attributes,
-              time: as_unix_nano(event.timestamp)
+              time: event.timestamp
             }
           )
         end

data/lib/uptrace/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uptrace
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Uptrace Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-19 00:00:00.000000000 Z
+date: 2021-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -16,56 +16,56 @@ 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: 1.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 1.0.0.rc1
 - !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
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +172,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
+- CHANGELOG.md
 - LICENSE
 - README.md
 - RELEASE.md
@@ -197,9 +198,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: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.4
 signing_key: