uptrace 0.17.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b0f7710f0eae6b7bcd64b9ba4cb6f8e8ea0d038288dc01f173381a1937639c9
-  data.tar.gz: 160bd219eb212e7e97561b758b1d76cf3a38672aa02e292c218c9694b8f27544
+  metadata.gz: c320ccec5439c9c74f4127443eb875ad2426bdb3efb3e83ef246ac8f1a69d4e3
+  data.tar.gz: 88449bc895c39171505069b5d10574b807ebdcc3badc95a77792609ef7f63b90
 SHA512:
-  metadata.gz: e67923bceb81e39049b4dadf8d0a0740b114300d6c979fb9f720dd3a599adf83c0fb0adfe5b0fece036225863ab27ea05e738df2d547c82d2bff25b3e0c1a6fe
-  data.tar.gz: 39886118653a1e0f61d6d880c1adda437c337dcff2819f7ffd2d012561dccda10340565aece6b600f7bdcb741881413d925f65ed95cd9463d0502077cb11dfa2
+  metadata.gz: aed13462dbcefbceae6a239cc4cf206c46d69740f70a752c0317aac40c4b073d2ae965b413868af63f4520276bbdff39c46ee70cc9f22233d3699d9478c8435b
+  data.tar.gz: e8f8e3fd095d9fee1bea930870ca5b330f848510005504c31a5f3c9f610c2eb2897d451ce40a81392b9e50c7c62d66fa767664c290c37caff3dd64d43e82b832

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## v1.0.1 - 2021-11-08
+
+- Updated OpenTelemetry to
+  [v1.0.1](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/sdk/CHANGELOG.md#v101--2021-10-29).
+
+## v1.0.0 - 2021-10-06
+
+- Updated OpenTelemetry to
+  [v1.0.0](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/api/CHANGELOG.md#v100--2021-09-29).
+
+## v1.0.0.rc3 - 2021-08-17
+
+- Updated OpenTelemetry to
+  [v1.0.0.rc3](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/api/CHANGELOG.md#v100rc3--2021-08-12).
+- Switched to using OTLP protocol.
+
+## 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

data/README.md

@@ -1,16 +1,16 @@
 # Uptrace Ruby exporter for OpenTelemetry
 
 ![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/)
+[![Documentation](https://img.shields.io/badge/uptrace-documentation-informational)](https://docs.uptrace.dev/guide/ruby.html)
 
-<a href="https://docs.uptrace.dev/ruby/">
-  <img src="https://docs.uptrace.dev/devicons/ruby-original.svg" height="200px" />
+<a href="https://docs.uptrace.dev/guide/ruby.html">
+  <img src="https://docs.uptrace.dev/devicon/ruby-original.svg" height="200px" />
 </a>
 
 ## Introduction
 
 uptrace-ruby is an OpenTelemery distribution configured to export
-[traces](https://docs.uptrace.dev/tracing/#spans) to Uptrace.
+[traces](https://opentelemetry.uptrace.dev/guide/distributed-tracing.html) to Uptrace.
 
 ## Quickstart
 
@@ -30,33 +30,38 @@ require 'rubygems'
 require 'bundler/setup'
 require 'uptrace'
 
-OpenTelemetry::SDK.configure do |c|
+# Configure OpenTelemetry with sensible defaults.
+# Copy your project DSN here or use UPTRACE_DSN env var.
+Uptrace.configure_opentelemetry(dsn: '') do |c|
+  # c is OpenTelemetry::SDK::Configurator
   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
 
+# Create a tracer. Usually, tracer is a global variable.
 tracer = OpenTelemetry.tracer_provider.tracer('my_app_or_gem', '0.1.0')
 
-tracer.in_span('main') do |span|
-  tracer.in_span('child1') do |child1|
+# Create a root span (a trace) to measure some operation.
+tracer.in_span('main-operation') do |main|
+  tracer.in_span('child1-of-main') do |child1|
     child1.set_attribute('key1', 'value1')
     child1.record_exception(ArgumentError.new('error1'))
   end
 
-  tracer.in_span('child2') do |child2|
+  tracer.in_span('child2-of-main') do |child2|
     child2.set_attribute('key2', '24')
     child2.set_attribute('key3', 123.456)
   end
 
-  puts("trace URL: #{Uptrace.trace_url(span)}")
+  puts("trace URL: #{Uptrace.trace_url(main)}")
 end
 
-# Send buffered spans.
+# Send buffered spans and free resources.
 OpenTelemetry.tracer_provider.shutdown
 ```
 
-Please see [uptrace-ruby documentation](https://docs.uptrace.dev/ruby/) for more details.
+## Links
+
+- [Examples](example)
+- [Documentation](https://docs.uptrace.dev/guide/ruby.html)
+- [Instrumentations](https://opentelemetry.uptrace.dev/instrumentations.html?lang=ruby)

data/lib/uptrace/client.rb

@@ -5,6 +5,8 @@ require 'opentelemetry/sdk'
 module Uptrace
   # Uptrace client that configures OpenTelemetry SDK to use Uptrace exporter.
   class Client
+    attr_reader :dsn
+
     # @param [string] dsn
     def initialize(dsn: '')
       dsn = ENV.fetch('UPTRACE_DSN', '') if dsn.empty?
@@ -22,26 +24,5 @@ module Uptrace
     def disabled?
       @disabled
     end
-
-    # @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}"
-    end
-
-    # @return [OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor]
-    def span_processor
-      exp = Uptrace::Trace::Exporter.new(@dsn)
-      OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
-        exp,
-        max_queue_size: 1000,
-        max_export_batch_size: 1000,
-        schedule_delay: 5_000
-      )
-    end
   end
 end

data/lib/uptrace/version.rb

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

data/lib/uptrace.rb

@@ -2,6 +2,8 @@
 
 require 'logger'
 
+require 'opentelemetry/exporter/otlp'
+
 # Uptrace provides Uptrace exporters for OpenTelemetry.
 module Uptrace
   extend self
@@ -19,7 +21,9 @@ module Uptrace
   # @param [optional OpenTelemetry::Trace::Span] span
   # @return [String]
   def trace_url(span = nil)
-    client.trace_url(span)
+    span = OpenTelemetry::Trace.current_span if span.nil?
+    trace_id = span.context.hex_trace_id
+    "https://app.uptrace.dev/traces/#{trace_id}"
   end
 
   # ConfigureOpentelemetry configures OpenTelemetry to export data to Uptrace.
@@ -31,14 +35,30 @@ module Uptrace
   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?
+      c.add_span_processor(span_processor(@client.dsn.to_s)) unless client.disabled?
 
       yield c if block_given?
     end
   end
+
+  private
+
+  def span_processor(dsn)
+    exporter = OpenTelemetry::Exporter::OTLP::Exporter.new(
+      endpoint: 'https://otlp.uptrace.dev/v1/traces',
+      # Set the Uptrace DSN here or use UPTRACE_DSN env var.
+      headers: { 'uptrace-dsn': dsn },
+      compression: 'gzip'
+    )
+    OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
+      exporter,
+      max_queue_size: 1000,
+      max_export_batch_size: 1000,
+      schedule_delay: 5_000
+    )
+  end
 end
 
 require 'uptrace/version'
 require 'uptrace/dsn'
 require 'uptrace/client'
-require 'uptrace/trace'

metadata

@@ -1,71 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: uptrace
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Uptrace Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-24 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: msgpack
+  name: opentelemetry-exporter-otlp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 0.20.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 0.20.5
 - !ruby/object:Gem::Dependency
   name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
-- !ruby/object:Gem::Dependency
-  name: zstd-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.9.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.9.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -86,56 +72,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.22.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.22.3
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.2
+        version: 0.15.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.2
+        version: 0.15.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -179,9 +165,6 @@ files:
 - lib/uptrace.rb
 - lib/uptrace/client.rb
 - lib/uptrace/dsn.rb
-- lib/uptrace/metric.rb
-- lib/uptrace/trace.rb
-- lib/uptrace/trace/exporter.rb
 - lib/uptrace/version.rb
 homepage: https://github.com/uptrace/uptrace-ruby
 licenses:

data/lib/uptrace/metric.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Uptrace
-  # Metric module provides metric exporter for OpenTelemetry.
-  module Metric
-  end
-end

data/lib/uptrace/trace/exporter.rb

@@ -1,232 +0,0 @@
-# frozen_string_literal: true
-
-require 'uri'
-require 'net/http'
-require 'json'
-
-require 'opentelemetry/sdk'
-require 'msgpack'
-require 'zstd-ruby'
-
-module Uptrace
-  module Trace
-    # Exporter is a span exporter for OpenTelemetry.
-    class Exporter
-      SUCCESS = OpenTelemetry::SDK::Trace::Export::SUCCESS
-      FAILURE = OpenTelemetry::SDK::Trace::Export::FAILURE
-      TIMEOUT = OpenTelemetry::SDK::Trace::Export::TIMEOUT
-      private_constant(:SUCCESS, :FAILURE, :TIMEOUT)
-
-      ##
-      # @param [Config] cfg
-      #
-      def initialize(dsn)
-        @dsn = dsn
-        @endpoint = "/api/v1/tracing/#{@dsn.project_id}/spans"
-
-        @http = Net::HTTP.new(@dsn.host, 443)
-        @http.use_ssl = true
-        @http.open_timeout = 5
-        @http.read_timeout = 5
-        @http.keep_alive_timeout = 30
-      end
-
-      # Called to export sampled {OpenTelemetry::SDK::Trace::SpanData} structs.
-      #
-      # @param [Enumerable<OpenTelemetry::SDK::Trace::SpanData>] spans the
-      #   list of recorded {OpenTelemetry::SDK::Trace::SpanData} structs to be
-      #   exported.
-      # @param [optional Numeric] timeout An optional timeout in seconds.
-      # @return [Integer] the result of the export.
-      def export(spans, timeout: nil)
-        return SUCCESS if @disabled
-        return FAILURE if @shutdown
-
-        out = []
-
-        spans.each do |span|
-          out.push(uptrace_span(span))
-        end
-
-        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.
-      #
-      # @param [optional Numeric] timeout An optional timeout in seconds.
-      def shutdown(timeout: nil) # rubocop:disable Lint/UnusedMethodArgument
-        @shutdown = true
-        @http.finish if @http.started?
-        SUCCESS
-      end
-
-      private
-
-      ##
-      # @return [hash]
-      #
-      def uptrace_span(span)
-        out = {
-          id: span.span_id.unpack1('Q'),
-          traceId: span.trace_id,
-
-          name: span.name,
-          kind: kind_as_str(span.kind),
-          startTime: as_unix_nano(span.start_timestamp),
-          endTime: as_unix_nano(span.end_timestamp),
-
-          resource: uptrace_resource(span.resource),
-          attrs: span.attributes
-        }
-
-        out[:parentId] = span.parent_span_id.unpack1('Q') if span.parent_span_id
-
-        out[:events] = uptrace_events(span.events) unless span.events.nil?
-        out[:links] = uptrace_links(span.links) unless span.links.nil?
-
-        status = span.status
-        out[:statusCode] = status_code_as_str(status.code)
-        out[:statusMessage] = status.description unless status.description.empty?
-
-        il = span.instrumentation_library
-        out[:tracerName] = il.name
-        out[:tracerVersion] = il.name unless il.version.empty?
-
-        out
-      end
-
-      def send(data, timeout: nil) # rubocop:disable Lint/UnusedMethodArgument
-        req = build_request(data)
-
-        begin
-          resp = @http.request(req)
-        rescue Net::OpenTimeout, Net::ReadTimeout
-          return FAILURE
-        end
-
-        case resp
-        when Net::HTTPOK
-          resp.body # Read and discard body
-          SUCCESS
-        when Net::HTTPBadRequest
-          data = JSON.parse(resp.body)
-          Uptrace.logger.error("status=#{data['status']}: #{data['message']}")
-          FAILURE
-        when Net::HTTPInternalServerError
-          resp.body
-          FAILURE
-        else
-          @http.finish
-          FAILURE
-        end
-      end
-
-      ##
-      # @param [Hash] data
-      # @return [Net::HTTP::Post]
-      #
-      def build_request(data)
-        data = MessagePack.pack(data)
-        data = Zstd.compress(data, 3)
-
-        req = Net::HTTP::Post.new(@endpoint)
-        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')
-        req.body = data
-
-        req
-      end
-
-      # @param [SpanKind] kind
-      # @return [String]
-      def kind_as_str(kind)
-        case kind
-        when OpenTelemetry::Trace::SpanKind::SERVER
-          'server'
-        when OpenTelemetry::Trace::SpanKind::CLIENT
-          'client'
-        when OpenTelemetry::Trace::SpanKind::PRODUCER
-          'producer'
-        when OpenTelemetry::Trace::SpanKind::CONSUMER
-          'consumer'
-        else
-          'internal'
-        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]
-      #
-      def status_code_as_str(code)
-        case code
-        when OpenTelemetry::Trace::Status::OK
-          'ok'
-        when OpenTelemetry::Trace::Status::ERROR
-          'error'
-        else
-          'unset'
-        end
-      end
-
-      ##
-      # @param [OpenTelemetry::SDK::Resources::Resource] resource
-      # @return [Hash]
-      #
-      def uptrace_resource(resource)
-        out = {}
-        resource.attribute_enumerator.map { |key, value| out[key] = value }
-        out
-      end
-
-      def uptrace_events(events)
-        out = []
-        events.each do |event|
-          out.push(
-            {
-              name: event.name,
-              attrs: event.attributes,
-              time: as_unix_nano(event.timestamp)
-            }
-          )
-        end
-        out
-      end
-
-      def uptrace_links(links)
-        out = []
-        links.each do |link|
-          out.push(
-            {
-              trace_id => link.span_context.trace_id,
-              span_id => link.span_context.span_id.unpack1('Q'),
-              attrs => link.attributes
-            }
-          )
-        end
-        out
-      end
-    end
-  end
-end

data/lib/uptrace/trace.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Uptrace
-  # Trace module provides trace exporter for OpenTelemetry.
-  module Trace
-  end
-end
-
-require 'uptrace/trace/exporter'