uptrace 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6fed520ea5aa64b60260f976f155c618852f95c36e0eacfca80dd3b0654cf00f
+  data.tar.gz: b93d8bb971d72e571b9f87c098779c0aede9157d698ea522ea360801d9f133e3
+SHA512:
+  metadata.gz: d6f4ae143df5432535606e745907a7dd8ac9e22d9ac08280826b457ad6fd15d9c16fc368baab5616ec655fa0d9a9596edb7dfd0c7802563fe70e1b4cad2aa70d
+  data.tar.gz: 29156234fe786b7ceefa118511153fea5afbc2e4fe7890cdc32eac0cb6d6274a40e6630a3c4fee95aa94203c876438434c17e87f8a443260f480c2b6d437b85a

data/.yardopts

@@ -0,0 +1,8 @@
+--no-private
+--title=Uptrace
+--markup=markdown
+--main=README.md
+./lib/uptrace/**/*.rb
+./lib/uptrace.rb
+-
+README.md

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2020 github.com/uptrace/uptrace-ruby Authors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+   * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+   * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,89 @@
+# Uptrace Ruby exporter for OpenTelemetry
+
+[![Build Status](https://travis-ci.org/uptrace/uptrace-ruby.svg?branch=master)](https://travis-ci.org/uptrace/uptrace-ruby)
+
+## Introduction
+
+uptrace-ruby is an exporter for [OpenTelemetry](https://opentelemetry.io/) that
+sends your traces/spans and metrics to [Uptrace.dev](https://uptrace.dev).
+Briefly the process is the following:
+
+- OpenTelemetry API is used to instrument your application with spans and
+  metrics.
+- OpenTelemetry SDK and this exporter send collected information to Uptrace.dev.
+- Uptrace.dev uses that information to help you pinpoint failures and find
+  performance bottlenecks.
+
+## Instrumenting code
+
+You instrument your application by wrapping potentially interesting operations
+with spans. Each span has:
+
+- an operation name;
+- a start time and end time;
+- a set of key/value attributes containing data about the operation;
+- a set of timed events representing events, errors, logs, etc.
+
+You create spans using a tracer:
+
+```ruby
+require 'opentelemetry'
+
+// Create a named tracer using your repo as an identifier.
+tracer = OpenTelemetry.tracer_provider.tracer('github.com/username/app-name', 'semver:1.0')
+```
+
+To create a span:
+
+```ruby
+tracer.in_span('operation-name') do |span|
+  do_some_work
+end
+```
+
+Internally that does roughly the following:
+
+```ruby
+// Create a span.
+span = tracer.start_span('operation-name')
+
+// Activate the span within the current context.
+tracer.with_span(span) do |span|
+  do_some_work
+end
+
+// Finish the span when operation is completed.
+span.finish
+```
+
+To get the active span from the context:
+
+```ruby
+span = tracer.current_span
+```
+
+Once you have a span you can start adding attributes:
+
+```ruby
+span.set_attribute('enduser.id', '123')
+span.set_attribute('enduser.role', 'admin')
+```
+
+or events:
+
+```ruby
+span.add_event(name: 'log', attributes: {
+  'log.severity': 'error',
+  'log.message': 'User not found',
+  'enduser.id': '123',
+})
+```
+
+To record an error use `record_error` which internally uses `add_event`. Note
+that `tracer.in_span` already records resqued exceptions.
+
+```ruby
+rescue Exception => e
+  span.record_error(e)
+end
+```

data/lib/uptrace.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+# Uptrace provides Uptrace exporters for OpenTelemetry.
+module Uptrace
+  extend self
+
+  attr_accessor :logger
+
+  self.logger = Logger.new(STDOUT)
+end
+
+require 'uptrace/version'
+require 'uptrace/trace'

data/lib/uptrace/metric.rb

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

data/lib/uptrace/trace.rb

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

data/lib/uptrace/trace/config.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Uptrace
+  module Trace
+    # Config is a configuration for Uptrace span exporter.
+    class Config
+      # @return [String] a data source name to connect to uptrace.dev.
+      # @api public
+      attr_accessor :dsn
+    end
+  end
+end

data/lib/uptrace/trace/exporter.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+require 'msgpack'
+require 'lz4-ruby'
+
+module Uptrace
+  module Trace
+    # @!visibility private
+    ExpoSpan = Struct.new(
+      :id,
+      :parentId,
+      :name,
+      :kind,
+      :startTime,
+      :endTime,
+      :statusCode,
+      :statusMessage,
+      :attrs,
+      :events,
+      :links,
+      :resource
+    )
+
+    # Exporter is a span exporter for OpenTelemetry.
+    class Exporter
+      ##
+      # @param [Config] cfg
+      #
+      def initialize(cfg)
+        @cfg = cfg
+
+        begin
+          @uri = URI.parse(cfg.dsn)
+        rescue URI::InvalidURIError => e
+          @disabled = true
+          Uptrace.logger.error("can't parse dsn=#{cfg.dsn}: #{e}")
+        else
+          @endpoint = "#{@uri.scheme}://#{@uri.host}/api/v1/tracing#{@uri.path}/spans"
+        end
+      end
+
+      def export(spans)
+        return if @disabled
+
+        traces = {}
+
+        spans.each do |span|
+          trace = traces[span.trace_id]
+
+          if trace.nil?
+            trace = []
+            traces[span.trace_id] = trace
+          end
+
+          expose = expo_span(span)
+          trace.push(expose)
+        end
+      end
+
+      private
+
+      def send(traces)
+        req = build_request(traces: traces)
+        connection.request(req)
+      end
+
+      ##
+      # @return [ExpoSpan]
+      #
+      def expo_span(span)
+        expose = ExpoSpan.new
+
+        expose.id = span.id
+        expose.parentId = span.parent_span_id
+
+        expose.name = span.name
+        expose.kind = span.kind
+        expose.startTime = span.start_timestamp.to_i
+        expose.endTime = span.end_timestamp.to_i
+        expose.statusCode = span.status.canonical_code
+        expose.statusMessage = span.status.description
+        expose.attrs = span.attributes
+
+        expose
+      end
+
+      ##
+      # @return [Net::HTTP]
+      #
+      def connection
+        unless @conn
+          @conn = Net::HTTP.new(@uri.host, @uri.port)
+          @conn.use_ssl = @uri.is_a?(URI::HTTPS)
+          @conn.open_timeout = 5
+          @conn.read_timeout = 5
+          @conn.keep_alive_timeout = 30
+        end
+
+        @conn
+      end
+
+      ##
+      # @param [Hash] data
+      # @return [Net::HTTP::Post]
+      #
+      def build_request(data)
+        data = data.to_msgpack
+        data = LZ4.compress data
+
+        req = Net::HTTP::Post.new(@endpoint)
+        req['Authorization'] = @uri.user
+        req['Content-Type'] = 'application/msgpack'
+        req['Content-Encoding'] = 'lz4'
+        req['Connection'] = 'keep-alive'
+        req.body = data
+
+        req
+      end
+    end
+  end
+end

data/lib/uptrace/version.rb

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

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: uptrace
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Uptrace Authors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lz4-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.73.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.73.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard-doctest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+description: Uptrace Ruby exporter for OpenTelemetry
+email:
+- support@uptrace.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- LICENSE
+- README.md
+- lib/uptrace.rb
+- lib/uptrace/metric.rb
+- lib/uptrace/trace.rb
+- lib/uptrace/trace/config.rb
+- lib/uptrace/trace/exporter.rb
+- lib/uptrace/version.rb
+homepage: https://github.com/uptrace/uptrace-ruby
+licenses:
+- BSD-2-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Uptrace Ruby exporter for OpenTelemetry
+test_files: []