uptrace 0.2.6 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eaccd23f9b8a866577eb6ef2c81589306a4930280bedbed67340b8d908339c4
-  data.tar.gz: fe2bce7cfb97c14318f2cf63d65aa102d6e74ac6f01f12a600d2822856abf15c
+  metadata.gz: d437c19b7fc3feb724d4fa895fb7ef5e9cfc8501931a16f53d598fb9ef5afddc
+  data.tar.gz: 6340b2ba9b3991f922777310e43d7e256384f621b18c6598e422332b1940efce
 SHA512:
-  metadata.gz: a6f15e1110e43582d2aba18a19ef16aa6844a85584d101c9c4c72de0f072941d31c9a42deae5b42802f03b7da3050b7279e3a5b07b9ba9a3d4e76251d9293d24
-  data.tar.gz: 72fbe0da3afe6979150c16f5944fe140439ea552009aef1c84164d9cebed73d40a5639ed346e4e57029ba8c39087f78af7358f121d36084ed1715d7a96e3fb4d
+  metadata.gz: cdb698a1ee148f598fbf2ecf93ddc47867d797fd0f72a33bdc44547dfe5cec846984eaaba71e69c198ce3423c64bfe8ff830313b770980624a8cff164b0b431d
+  data.tar.gz: 95c417612dd655203b05d3323188536f453fa03ba4f412e84491dc23bdca90397f9ae3d99cdfd1899f06e23632282efa6f74251a9e93da8436d1255aa74431df

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,7 +16,9 @@ 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
 

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.6'
+  VERSION = '0.16.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uptrace
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.16.0
 platform: ruby
 authors:
 - Uptrace Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-19 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