splunk-tracer 0.1.0

data/lib/splunktracing/transport/base.rb

@@ -0,0 +1,10 @@
+module SplunkTracing
+  module Transport
+    # Base Transport type
+    class Base
+      def report(_report)
+        nil
+      end
+    end
+  end
+end

data/lib/splunktracing/transport/callback.rb

@@ -0,0 +1,16 @@
+require 'splunktracing/transport/base'
+
+module SplunkTracing
+  module Transport
+    class Callback < Base
+      def initialize(callback:)
+        @callback = callback
+      end
+
+      def report(report)
+        @callback.call(report)
+        nil
+      end
+    end
+  end
+end

data/lib/splunktracing/transport/http_json.rb

@@ -0,0 +1,144 @@
+require 'net/http'
+require 'openssl'
+require 'zlib'
+require 'splunktracing/transport/base'
+
+module SplunkTracing
+  module Transport
+    # HTTPJSON is a transport that sends reports via HTTP in JSON format.
+    # It is thread-safe.
+    class HTTPJSON < Base
+      SPLUNK_HEC_HOST = 'localhost'.freeze
+      SPLUNK_HEC_PORT = 8088
+
+      ENCRYPTION_TLS = 'tls'.freeze
+      ENCRYPTION_NONE = 'none'.freeze
+
+      REPORTS_API_ENDPOINT = '/services/collector'.freeze
+      HEADER_ACCESS_TOKEN = 'Authorization'.freeze
+
+      ##
+      # Initialize the transport
+      #
+      # @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 SplunkTracing server
+      # @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: SPLUNK_HEC_HOST,
+        port: SPLUNK_HEC_PORT,
+        verbose: 0,
+        encryption: ENCRYPTION_TLS,
+        access_token:,
+        ssl_verify_peer: false,
+        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 access_token.is_a?(String)
+        raise Tracer::ConfigurationError, 'access_token cannot be blank'  if access_token.empty?
+        @access_token = access_token
+        @logger = logger || SplunkTracing.logger
+      end
+
+      ##
+      # Queue a report for sending
+      #
+      def report(report)
+        @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
+
+      ##
+      # @param [String] report_string
+      # @return [Net::HTTP::Post]
+      #
+      def build_request(report)
+        gzip = Zlib::GzipWriter.new(StringIO.new)
+        gzip << convert_report_data(report)
+        req = Net::HTTP::Post.new(REPORTS_API_ENDPOINT)
+        req[HEADER_ACCESS_TOKEN] = 'Splunk ' + @access_token
+        req['Content-Type'] = 'application/json'
+        req['Content-Encoding'] = 'gzip'
+        req['Connection'] = 'keep-alive'
+        req.body = gzip.close.string
+        req
+      end
+
+      ##
+      # @param [Hash] report
+      # @return [String] report_string
+      #
+      def convert_report_data(report)
+        report_obj_array = Array.new
+        runtime_hash = report[:runtime]
+
+        if report[:span_records].any?
+          report[:span_records].each do |span|
+            span_hash = {:time => span[:timestamp], :sourcetype => "splunktracing:span" }
+            span_contents = span.merge(runtime_hash)
+            log_array = span_contents.delete(:log_records)
+            runtime_attrs = span_contents.delete(:attrs)
+            span_contents[:tags].merge(runtime_attrs)
+            span_hash["event"] = span_contents
+            report_obj_array.push(span_hash.to_json)
+            if log_array && log_array.any?
+              span_contents.delete(:timestamp)
+              span_contents.delete(:duration)
+              log_array.each do |log|
+                log_hash = {:time => log[:timestamp_micros]/1000000.0, :sourcetype => "splunktracing:log" , :event => log.merge(span_contents)}
+                report_obj_array.push(log_hash.to_json)
+              end
+            end
+          end
+        end
+        report_string = report_obj_array.join("\n")
+        report_string
+      end      
+
+      ##
+      # @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
+end

data/lib/splunktracing/transport/nil.rb

@@ -0,0 +1,9 @@
+require 'splunktracing/transport/base'
+
+module SplunkTracing
+  module Transport
+    # Empty transport, primarily for unit testing purposes
+    class Nil < Base
+    end
+  end
+end

data/lib/splunktracing/version.rb

@@ -0,0 +1,3 @@
+module SplunkTracing
+  VERSION = '0.1.0'.freeze
+end

data/scripts/version.rb

@@ -0,0 +1,5 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'splunktracing/version'
+
+print SplunkTracing::VERSION

data/splunktracing.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'splunktracing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'splunk-tracer'
+  spec.version       = SplunkTracing::VERSION
+  spec.authors       = ['splunk']
+  spec.email         = ['support@splunk.com']
+
+  spec.summary       = 'Splunk OpenTracing Ruby bindings'
+  spec.homepage      = 'https://github.com/splnkit/splunk-tracer-ruby'
+  spec.license       = 'MIT'
+
+  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/splnkit/splunk-tracer-ruby/blob/master/CHANGELOG.md",
+  }
+
+  spec.add_dependency 'concurrent-ruby', '~> 1.0'
+  spec.add_dependency 'opentracing', '~> 0.4.1'
+  spec.add_development_dependency 'rake', '~> 11.3'
+  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.16'
+  spec.add_development_dependency 'timecop', '~> 0.8.0'
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: splunk-tracer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- splunk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: 
+email:
+- support@splunk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- benchmark.rb
+- benchmark/bench.rb
+- 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/splunktracing.rb
+- lib/splunktracing/global_tracer.rb
+- lib/splunktracing/reporter.rb
+- lib/splunktracing/scope.rb
+- lib/splunktracing/scope_manager.rb
+- lib/splunktracing/span.rb
+- lib/splunktracing/span_context.rb
+- lib/splunktracing/tracer.rb
+- lib/splunktracing/transport/base.rb
+- lib/splunktracing/transport/callback.rb
+- lib/splunktracing/transport/http_json.rb
+- lib/splunktracing/transport/nil.rb
+- lib/splunktracing/version.rb
+- scripts/version.rb
+- splunktracing.gemspec
+homepage: https://github.com/splnkit/splunk-tracer-ruby
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/splnkit/splunk-tracer-ruby/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Splunk OpenTracing Ruby bindings
+test_files: []