libhoney 1.17.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6719a46aa4b4c931245ac715b38067689a74bde968b7608eab89d893cecb3d5b
-  data.tar.gz: 599d25bebae44849f68745be004463a7d35d40d82620c625b81c6506bace3787
+  metadata.gz: 33a687ebf8ae87e69cf6a53b50c4e2cd926f9938af709635d42a209ec2e6c93e
+  data.tar.gz: fd3f558a15f872c9f63fc6451722c3e9e21b7cba5ebe8d7816ec0cb08064318b
 SHA512:
-  metadata.gz: 1497b4236a659be4a017c8206fc3ae04bb4f569335bdabd8c492e7429a94eb13943e96313bab302dd89e9011457c9f58cc7f004ee7ceac3c4c3d1ca347651d35
-  data.tar.gz: 02a9f65930f3be3d3ccb43817eab5a48c8bd0a5869bd65b7bc8de2b865283e575f35fe6fa88717afb197f514cfebe5196e37d1e293a8fa3d59a5fd0e4d0358f2
+  metadata.gz: 36efc5d9734e125cd141e21dd60edbc6cf23350334bf431dead264c375dfd11b54bcf286f5509d5e97633ee4ce2d4fc689ebf5033d472237d5b6e7e2f2d0cb81
+  data.tar.gz: 5d5147a6e9f3fc1055a94932943c5915c99f43ad550d4dd5f20955d2dad023c41a1939e6f8037b38856375a10dcdc51557b06e3d56b454296a1596c7dd62b74c

data/.rubocop.yml

@@ -16,6 +16,7 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 200
   Exclude:
+    - lib/libhoney/transmission.rb # Should this remain so large?
     - test/*
 
 Metrics/MethodLength:

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## changes pending release
 
+## 1.18.0
+
+### Improvements
+
+- replace HTTP client library to reduce external dependencies (#81)
+
+### Deprecations
+
+- `Libhoney::Client.new(proxy_config: _)`: the `proxy_config` parameter for client
+  creation will no longer accept an Array in the next major version. The recommended
+  way to configure the client for operation behind forwarding web proxies is to set
+  http/https/no_proxy environment variables appropriately.
+
 ## 1.17.0
 
 ### Fixes:

data/lib/libhoney/client.rb

@@ -1,6 +1,6 @@
+require 'addressable/uri'
 require 'time'
 require 'json'
-require 'http'
 require 'forwardable'
 
 require 'libhoney/null_transmission'
@@ -51,6 +51,13 @@ module Libhoney
     # @param block_on_responses [Boolean] if true, block if there is no thread reading from the response queue
     # @param pending_work_capacity [Fixnum] defaults to 1000. If the queue of
     #   pending events exceeds 1000, this client will start dropping events.
+    # @param proxy_config [String, Array, nil] proxy connection information
+    #   nil: (default, recommended) connection proxying will be determined from any http_proxy, https_proxy, and no_proxy environment
+    #     variables set for the process.
+    #   String: the value must be the URI for connecting to a forwarding web proxy. Must be parsable by stdlib URI.
+    #   Array: (deprecated, removal in v2.0) the value must have one and at most four elements: e.g. ['host', port, 'username', 'password'].
+    #     The assumption is that the TCP connection will be tunneled via HTTP, so the assumed scheme is 'http://'
+    #     'host' is required. 'port' is optional (default:80), unless a 'username' is included. 'password' is optional.
     # rubocop:disable Metrics/ParameterLists
     def initialize(writekey: nil,
                    dataset: nil,
@@ -102,7 +109,7 @@ module Libhoney
       @pending_work_capacity  = pending_work_capacity
       @responses              = SizedQueue.new(2 * @pending_work_capacity)
       @lock                   = Mutex.new
-      @proxy_config           = proxy_config
+      @proxy_config           = parse_proxy_config(proxy_config)
     end
 
     attr_reader :block_on_send, :block_on_responses, :max_batch_size,
@@ -224,5 +231,35 @@ module Libhoney
     def should_drop(sample_rate)
       rand(1..sample_rate) != 1
     end
+
+    private
+
+    # @api private
+    def parse_proxy_config(config)
+      case config
+      when nil then nil
+      when String
+        URI.parse(config)
+      when Array
+        warn <<-WARNING
+        DEPRECATION WARNING: #{self.class.name} the proxy_config parameter will require a String value, not an Array in libhoney 2.0.
+        To resolve:
+          + recommended: set http/https_proxy environment variables, which take precedence over any option set here, then remove proxy_config parameter from client initialization
+          + set proxy_config to a String containing the forwarding proxy URI (only used if http/https_proxy are not set)
+        WARNING
+        host, port, user, password = config
+
+        parsed_config = URI::HTTP.build(host: host, port: port).tap do |uri|
+          uri.userinfo = "#{user}:#{password}" if user
+        end
+        redacted_config = parsed_config.dup.tap do |uri|
+          uri.password = 'REDACTED' unless uri.password.nil? || uri.password.empty?
+        end
+        warn "The array config given has been assumed to mean: #{redacted_config}"
+        parsed_config
+      end
+    rescue URI::Error => e
+      warn "#{self.class.name}: unable to parse proxy_config. Detail: #{e.class}: #{e.message}"
+    end
   end
 end

data/lib/libhoney/response.rb

@@ -1,7 +1,15 @@
-require 'http'
+require 'http/response/status'
 
 module Libhoney
   class Response
+    # The response status from HTTP calls to a Honeycomb API endpoint.
+    #
+    # For most of the life of this client, this response object has been
+    # a pass-through to the underlying HTTP library's response object.
+    # This class in the Libhoney namespace now owns the interface for
+    # API responses.
+    class Status < HTTP::Response::Status; end
+
     attr_accessor :duration, :status_code, :metadata, :error
 
     def initialize(duration: 0,
@@ -9,7 +17,7 @@ module Libhoney
                    metadata: nil,
                    error: nil)
       @duration    = duration
-      @status_code = HTTP::Response::Status.new(status_code)
+      @status_code = Status.new(status_code)
       @metadata    = metadata
       @error       = error
     end

data/lib/libhoney/transmission.rb

@@ -1,3 +1,5 @@
+require 'addressable/uri'
+require 'excon'
 require 'json'
 require 'timeout'
 require 'libhoney/response'
@@ -93,7 +95,7 @@ module Libhoney
           }
 
           response = http.post(
-            "/1/batch/#{Addressable::URI.escape(dataset)}",
+            path: "/1/batch/#{Addressable::URI.escape(dataset)}",
             body: body,
             headers: headers
           )
@@ -103,6 +105,8 @@ module Libhoney
           # because this is effectively the top-level exception handler for the
           # sender threads, and we don't want those threads to die (leaving
           # nothing consuming the queue).
+          warn "#{self.class.name}: 💥 " + e.message if %w[debug trace].include?(ENV['LOG_LEVEL'])
+          warn e.backtrace.join("\n").to_s if ['trace'].include?(ENV['LOG_LEVEL'])
           begin
             batch.each do |event|
               # nil events in the batch should already have had an error
@@ -187,7 +191,7 @@ module Libhoney
 
     def process_response(http_response, before, batch)
       index = 0
-      http_response.parse.each do |event|
+      JSON.parse(http_response.body).each do |event|
         index += 1 while batch[index].nil? && index < batch.size
         break unless (batched_event = batch[index])
 
@@ -256,14 +260,19 @@ module Libhoney
 
     def build_http_clients
       Hash.new do |h, api_host|
-        client = HTTP.timeout(connect: @send_timeout, write: @send_timeout, read: @send_timeout)
-                     .persistent(api_host)
-                     .headers(
-                       'User-Agent' => @user_agent,
-                       'Content-Type' => 'application/json'
-                     )
-
-        client = client.via(*@proxy_config) unless @proxy_config.nil?
+        client = ::Excon.new(
+          api_host,
+          persistent: true,
+          read_timeout: @send_timeout,
+          write_timeout: @send_timeout,
+          connect_timeout: @send_timeout,
+          proxy: @proxy_config,
+          headers: {
+            'User-Agent' => @user_agent,
+            'Content-Type' => 'application/json'
+          }
+        )
+
         h[api_host] = client
       end
     end

data/lib/libhoney/version.rb

@@ -1,3 +1,3 @@
 module Libhoney
-  VERSION = '1.17.0'.freeze
+  VERSION = '1.18.0'.freeze
 end

data/libhoney.gemspec

@@ -34,5 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'yardstick', '~> 0.9'
   spec.add_dependency 'addressable', '~> 2.0'
+  spec.add_dependency 'excon'
   spec.add_dependency 'http', '>= 2.0', '< 5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libhoney
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.18.0
 platform: ruby
 authors:
 - The Honeycomb.io Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement