pinot-client 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 828dd3e3c441143fb0754adbcb1b50de4a070e777ad3a158c51dfabf91a3f877
-  data.tar.gz: 6c4a3f0ae7e703ae0d3ff18fd473030710e5a1954b9624207e0b2c6e944d2365
+  metadata.gz: 2ea9db0f69b7fb8d963190553d6a92201f4d63d5d6a07a975f862d00e43aa30a
+  data.tar.gz: c3b968737e6b7650c57bb79ef42153eb6870df22521939f885e5332fe4a2b7eb
 SHA512:
-  metadata.gz: ca183a5d10a9b87a18cb61725e6810f1446cd70b627e6a6a8320a3db9b2ec27981bf7d282e684f2c2cca94c2a87be2fb1595c2c178d378465bb77628cf501bb7
-  data.tar.gz: 715e0acb71c456409c999da0207c4c2c1aac310d27024dae6d9154996811d51b1f4c665686b609d598128b031f766ae06ee18c111c6ef0f6801b69cd523b5c82
+  metadata.gz: b5809f8a9245ff2b13cd6a487499aff37ad9f879d4c5537570f61b1c34da6fe702817bb3ced5d6c812f8b38b9283bafb1bb3a16f2ae1f9279436e9cf86f274ae
+  data.tar.gz: 78c2573048ced129a60d9186092acba394456304cc343f1fca56cce1fa0bc8e3417c8748b3bd50a97f6dcd5f05f32caaf2c0f2a12e153e5685876e06aa033f31

data/README.md

@@ -277,6 +277,10 @@ Environment variables:
 | `BROKER_HOST` | `127.0.0.1` | Pinot broker hostname   |
 | `BROKER_PORT` | `8000`      | Pinot broker HTTP port  |
 
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a full history of releases.
+
 ## License
 
 Apache License 2.0 — see [LICENSE](LICENSE).

data/lib/pinot/config.rb

@@ -20,23 +20,26 @@ module Pinot
   end
 
   class ClientConfig
-    attr_accessor :broker_list, :http_timeout, :extra_http_header,
+    attr_accessor :broker_list, :http_timeout, :query_timeout_ms, :extra_http_header,
                   :use_multistage_engine, :controller_config, :logger, :tls_config,
-                  :grpc_config, :zookeeper_config
+                  :grpc_config, :zookeeper_config, :query_timeout_ms
 
     def initialize(
       broker_list: [],
       http_timeout: nil,
+      query_timeout_ms: nil,
       extra_http_header: {},
       use_multistage_engine: false,
       controller_config: nil,
       logger: nil,
       tls_config: nil,
       grpc_config: nil,
-      zookeeper_config: nil
+      zookeeper_config: nil,
+      query_timeout_ms: nil
     )
       @broker_list = broker_list
       @http_timeout = http_timeout
+      @query_timeout_ms = query_timeout_ms
       @extra_http_header = extra_http_header
       @use_multistage_engine = use_multistage_engine
       @controller_config = controller_config
@@ -44,6 +47,30 @@ module Pinot
       @tls_config = tls_config
       @grpc_config = grpc_config
       @zookeeper_config = zookeeper_config
+      @query_timeout_ms = query_timeout_ms
+    end
+
+    def validate!
+      sources = [
+        !broker_list.empty?,
+        !controller_config.nil?,
+        !zookeeper_config.nil?,
+        !grpc_config.nil?
+      ].count(true)
+
+      if sources == 0
+        raise ConfigurationError, "ClientConfig requires at least one of: broker_list, controller_config, zookeeper_config, or grpc_config"
+      end
+
+      if !http_timeout.nil? && http_timeout <= 0
+        raise ConfigurationError, "http_timeout must be positive, got: #{http_timeout}"
+      end
+
+      if !query_timeout_ms.nil? && query_timeout_ms <= 0
+        raise ConfigurationError, "query_timeout_ms must be positive, got: #{query_timeout_ms}"
+      end
+
+      self
     end
   end
 end

data/lib/pinot/connection.rb

@@ -2,12 +2,15 @@ require "bigdecimal"
 
 module Pinot
   class Connection
-    def initialize(transport:, broker_selector:, use_multistage_engine: false, logger: nil)
+    attr_accessor :query_timeout_ms
+
+    def initialize(transport:, broker_selector:, use_multistage_engine: false, logger: nil, query_timeout_ms: nil)
       @transport = transport
       @broker_selector = broker_selector
       @use_multistage_engine = use_multistage_engine
       @trace = false
       @logger = logger
+      @query_timeout_ms = query_timeout_ms
     end
 
     def use_multistage_engine=(val)
@@ -23,9 +26,19 @@ module Pinot
     end
 
     def execute_sql(table, query)
-      logger.debug "Executing SQL on table=#{table}: #{query}"
+      Pinot::Instrumentation.instrument(table: table, query: query) do
+        logger.debug "Executing SQL on table=#{table}: #{query}"
+        broker = @broker_selector.select_broker(table)
+        @transport.execute(broker, build_request(query))
+      end
+    rescue => e
+      raise "unable to execute SQL on table #{table}: #{e.message}"
+    end
+
+    def execute_sql_with_timeout(table, query, timeout_ms)
+      logger.debug "Executing SQL with timeout=#{timeout_ms}ms on table=#{table}: #{query}"
       broker = @broker_selector.select_broker(table)
-      @transport.execute(broker, build_request(query))
+      @transport.execute(broker, build_request(query, timeout_ms: timeout_ms))
     rescue => e
       raise "unable to execute SQL on table #{table}: #{e.message}"
     end
@@ -93,8 +106,8 @@ module Pinot
       @logger || Pinot::Logging.logger
     end
 
-    def build_request(query)
-      Request.new("sql", query, @trace, @use_multistage_engine)
+    def build_request(query, timeout_ms: @query_timeout_ms)
+      Request.new("sql", query, @trace, @use_multistage_engine, timeout_ms)
     end
   end
 end

data/lib/pinot/connection_factory.rb

@@ -12,6 +12,8 @@ module Pinot
   end
 
   def self.from_config(config, http_client: nil)
+    config.validate!
+
     if config.grpc_config
       transport = GrpcTransport.new(config.grpc_config)
       selector  = SimpleBrokerSelector.new(config.grpc_config.broker_list)
@@ -61,7 +63,8 @@ module Pinot
       transport: transport,
       broker_selector: selector,
       use_multistage_engine: config.use_multistage_engine || false,
-      logger: config.logger
+      logger: config.logger,
+      query_timeout_ms: config.query_timeout_ms
     )
 
     selector.init

data/lib/pinot/instrumentation.rb

@@ -0,0 +1,36 @@
+module Pinot
+  module Instrumentation
+    # Called around every query execution.
+    # Implement by setting Pinot::Instrumentation.on_query = proc { |event| ... }
+    # event is a Hash:
+    #   :table        => String
+    #   :query        => String
+    #   :duration_ms  => Float
+    #   :success      => Boolean
+    #   :error        => Exception or nil
+
+    def self.on_query=(callback)
+      @on_query = callback
+    end
+
+    def self.on_query
+      @on_query
+    end
+
+    def self.instrument(table:, query:)
+      start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      result = yield
+      duration_ms = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start) * 1000
+      notify(table: table, query: query, duration_ms: duration_ms, success: true, error: nil)
+      result
+    rescue => e
+      duration_ms = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start) * 1000
+      notify(table: table, query: query, duration_ms: duration_ms, success: false, error: e)
+      raise
+    end
+
+    def self.notify(event)
+      @on_query&.call(event)
+    end
+  end
+end

data/lib/pinot/request.rb

@@ -1,3 +1,3 @@
 module Pinot
-  Request = Struct.new(:query_format, :query, :trace, :use_multistage_engine)
+  Request = Struct.new(:query_format, :query, :trace, :use_multistage_engine, :query_timeout_ms)
 end

data/lib/pinot/transport.rb

@@ -170,6 +170,7 @@ module Pinot
         if @timeout_ms && @timeout_ms > 0
           parts << "timeoutMs=#{@timeout_ms}"
         end
+        parts << "timeoutMs=#{request.query_timeout_ms}" if request.query_timeout_ms
       end
       parts.join(";")
     end

data/lib/pinot/version.rb

@@ -1,3 +1,3 @@
 module Pinot
-  VERSION = "1.4.0"
+  VERSION = "1.6.0"
 end

data/lib/pinot.rb

@@ -5,6 +5,7 @@ require "bigdecimal"
 require "securerandom"
 
 require_relative "pinot/errors"
+require_relative "pinot/instrumentation"
 require_relative "pinot/version"
 require_relative "pinot/logger"
 require_relative "pinot/config"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pinot-client
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Xiang Fu
@@ -84,6 +84,7 @@ files:
 - lib/pinot/errors.rb
 - lib/pinot/grpc_config.rb
 - lib/pinot/grpc_transport.rb
+- lib/pinot/instrumentation.rb
 - lib/pinot/logger.rb
 - lib/pinot/prepared_statement.rb
 - lib/pinot/proto/broker_service.proto