lightstep 0.12.0 → 0.16.1

data/lib/lightstep/transport/base.rb

@@ -2,9 +2,6 @@ module LightStep
   module Transport
     # Base Transport type
     class Base
-      def initialize
-      end
-
       def report(_report)
         nil
       end

data/lib/lightstep/transport/http_json.rb

@@ -4,53 +4,104 @@ require 'lightstep/transport/base'
 module LightStep
   module Transport
     # HTTPJSON is a transport that sends reports via HTTP in JSON format.
-    # It is thread-safe, however it is *not* fork-safe. When forking, all items
-    # in the queue will be copied and sent in duplicate.
-    #
-    # When forking, you should first `disable` the tracer, then `enable` it from
-    # within the fork (and in the parent post-fork). See
-    # `examples/fork_children/main.rb` for an example.
+    # It is thread-safe.
     class HTTPJSON < Base
-      LIGHTSTEP_HOST = "collector.lightstep.com"
+      LIGHTSTEP_HOST = 'collector.lightstep.com'.freeze
       LIGHTSTEP_PORT = 443
 
-      ENCRYPTION_TLS = 'tls'
-      ENCRYPTION_NONE = 'none'
+      ENCRYPTION_TLS = 'tls'.freeze
+      ENCRYPTION_NONE = 'none'.freeze
 
+      REPORTS_API_ENDPOINT = '/api/v0/reports'.freeze
+      HEADER_ACCESS_TOKEN = 'LightStep-Access-Token'.freeze
+
+      ##
       # Initialize the transport
-      # @param host [String] host of the domain to the endpoind to push data
+      #
+      # @param host [String] host of the domain to the endpoint to push data
       # @param port [Numeric] port on which to connect
       # @param verbose [Numeric] verbosity level. Right now 0-3 are supported
       # @param encryption [ENCRYPTION_TLS, ENCRYPTION_NONE] kind of encryption to use
       # @param access_token [String] access token for LightStep server
-      # @return [HTTPJSON]
-      def initialize(host: LIGHTSTEP_HOST, port: LIGHTSTEP_PORT, verbose: 0, encryption: ENCRYPTION_TLS, access_token:)
+      # @param ssl_verify_peer [Boolean]
+      # @param open_timeout [Integer]
+      # @param read_timeout [Integer]
+      # @param continue_timeout [Integer]
+      # @param keep_alive_timeout [Integer]
+      # @param logger [Logger]
+      #
+      def initialize(
+        host: LIGHTSTEP_HOST,
+        port: LIGHTSTEP_PORT,
+        verbose: 0,
+        encryption: ENCRYPTION_TLS,
+        access_token:,
+        ssl_verify_peer: true,
+        open_timeout: 20,
+        read_timeout: 20,
+        continue_timeout: nil,
+        keep_alive_timeout: 2,
+        logger: nil
+      )
         @host = host
         @port = port
         @verbose = verbose
         @encryption = encryption
+        @ssl_verify_peer = ssl_verify_peer
+        @open_timeout = open_timeout.to_i
+        @read_timeout = read_timeout.to_i
+        @continue_timeout = continue_timeout
+        @keep_alive_timeout = keep_alive_timeout.to_i
 
-        raise Tracer::ConfigurationError, "access_token must be a string" unless String === access_token
-        raise Tracer::ConfigurationError, "access_token cannot be blank"  if access_token.empty?
+        raise Tracer::ConfigurationError, 'access_token must be a string' unless access_token.is_a?(String)
+        raise Tracer::ConfigurationError, 'access_token cannot be blank'  if access_token.empty?
         @access_token = access_token
+        @logger = logger || LightStep.logger
       end
 
+      ##
       # Queue a report for sending
+      #
       def report(report)
-        p report if @verbose >= 3
+        @logger.info report if @verbose >= 3
+
+        req = build_request(report)
+        res = connection.request(req)
+
+        @logger.info res.to_s if @verbose >= 3
+
+        nil
+      end
+
+      private
 
-        https = Net::HTTP.new(@host, @port)
-        https.use_ssl = @encryption == ENCRYPTION_TLS
-        req = Net::HTTP::Post.new('/api/v0/reports')
-        req['LightStep-Access-Token'] = @access_token
+      ##
+      # @param [Hash] report
+      # @return [Net::HTTP::Post]
+      #
+      def build_request(report)
+        req = Net::HTTP::Post.new(REPORTS_API_ENDPOINT)
+        req[HEADER_ACCESS_TOKEN] = @access_token
         req['Content-Type'] = 'application/json'
         req['Connection'] = 'keep-alive'
         req.body = report.to_json
-        res = https.request(req)
-
-        puts res.to_s if @verbose >= 3
+        req
+      end
 
-        nil
+      ##
+      # @return [Net::HTTP]
+      #
+      def connection
+        unless @connection
+          @connection = ::Net::HTTP.new(@host, @port)
+          @connection.use_ssl = @encryption == ENCRYPTION_TLS
+          @connection.verify_mode = ::OpenSSL::SSL::VERIFY_NONE unless @ssl_verify_peer
+          @connection.open_timeout = @open_timeout
+          @connection.read_timeout = @read_timeout
+          @connection.continue_timeout = @continue_timeout
+          @connection.keep_alive_timeout = @keep_alive_timeout
+        end
+        @connection
       end
     end
   end

data/lib/lightstep/version.rb

@@ -1,3 +1,3 @@
 module LightStep
-  VERSION = '0.12.0'.freeze
+  VERSION = '0.16.1'.freeze
 end

data/lightstep.gemspec

@@ -6,7 +6,7 @@ require 'lightstep/version'
 Gem::Specification.new do |spec|
   spec.name          = 'lightstep'
   spec.version       = LightStep::VERSION
-  spec.authors       = ['bcronin']
+  spec.authors       = ['lightstep']
   spec.email         = ['support@lightstep.com']
 
   spec.summary       = 'LightStep OpenTracing Ruby bindings'
@@ -16,12 +16,16 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
+  spec.metadata    = {
+    "changelog_uri" => "https://github.com/lightstep/lightstep-tracer-ruby/blob/master/CHANGELOG.md",
+  }
+
   spec.add_dependency 'concurrent-ruby', '~> 1.0'
-  spec.add_dependency 'opentracing', '~> 0.3'
-  spec.add_development_dependency 'rake', '~> 11.3'
+  spec.add_dependency 'opentracing', '~> 0.5.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rack', '~> 2.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'bump', '~> 0.5'
-  spec.add_development_dependency 'simplecov', '~> 0.12.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'timecop', '~> 0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lightstep
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.16.1
 platform: ruby
 authors:
-- bcronin
-autorequire: 
+- lightstep
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-30 00:00:00.000000000 Z
+date: 2021-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -122,16 +122,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
-description: 
+description:
 email:
 - support@lightstep.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - Makefile
 - README.md
@@ -141,14 +146,18 @@ files:
 - benchmark/threading/thread_test.rb
 - bin/console
 - bin/setup
-- circle.yml
 - example.rb
 - examples/fork_children/main.rb
 - examples/rack/hello.rb
 - examples/rack/inject_extract.rb
 - lib/lightstep.rb
 - lib/lightstep/global_tracer.rb
+- lib/lightstep/propagation.rb
+- lib/lightstep/propagation/b3_propagator.rb
+- lib/lightstep/propagation/lightstep_propagator.rb
 - lib/lightstep/reporter.rb
+- lib/lightstep/scope.rb
+- lib/lightstep/scope_manager.rb
 - lib/lightstep/span.rb
 - lib/lightstep/span_context.rb
 - lib/lightstep/tracer.rb
@@ -162,8 +171,9 @@ files:
 homepage: https://github.com/lightstep/lightstep-tracer-ruby
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/lightstep/lightstep-tracer-ruby/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -178,9 +188,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: LightStep OpenTracing Ruby bindings
 test_files: []

data/circle.yml

@@ -1,3 +0,0 @@
-machine:
-  ruby:
-    version: 2.2.3