search_flip 3.0.0.beta4 → 3.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddb0dadc9a92281c24b5ce7f5ba911cf97a9a7d81caecc1da23febf6c497bf91
-  data.tar.gz: b0da1b7250010cdd555af7d4cc57ffd388bb2bb8d9b077d8660f2172d7ad15e8
+  metadata.gz: 4fae82bf67967306afbb6bfb0f2f321b8993fa364710b24dc7b3860f2bb6ace0
+  data.tar.gz: a060faa2ea3b06233dc132b65df0e4c2bc18ab51ea5cfe92eadd96aaa7c8ddbf
 SHA512:
-  metadata.gz: 00775bd514c07e991476927bafe5b9ba3696c6edda268188f2f54f8d08ce74456c2ecda08f66aaa510f21559428f35806d6311d7a5e16384cff68869feccd52c
-  data.tar.gz: b6eb35784a8c3f54c537340ca3ba7d33b81e683a59c9aa1356bddb1e2bcafe9052ccbc19b15628d19971ca0035fa34a28f1c05b75806b3347ab330d73a4ee28c
+  metadata.gz: 15aa25cab455dfadead099deb59594580f9c09f71476818f28d483a7d7e8cb3decfd7c4126ecfaf438b92ed19ded8edfe01566d4cffcd1a03394608b66db9ebb
+  data.tar.gz: 3a57bc2cecc98641c32f33c688576c7c808482bde3e3f9901590c7241102ef8a01d22f1dd875bd56d60c32fc9d38d4f97fd95e2f54249ccb2699c1ddc35a1e06

data/CHANGELOG.md

@@ -23,6 +23,7 @@
 * Added `SearchFlip::Result.from_hit`
 * Added support for `source`, `sort`, `page`, `per`, `paginate`, `explain`, and
   `highlight` to aggregations
+* Added support for instrumentation
 
 ## v2.3.1
 

data/README.md

@@ -274,7 +274,7 @@ CommentIndex.create(Comment.first, { bulk_max_mb: 100 }, routing: "routing_key")
 CommentIndex.update(Comment.first, ...)
 ```
 
-Checkout the elasticsearch [Bulk API] docs for more info as well as
+Checkout the Elasticsearch [Bulk API] docs for more info as well as
 [SearchFlip::Bulk](http://www.rubydoc.info/github/mrkamel/search_flip/SearchFlip/Bulk)
 for a complete list of available options to control the bulk indexing of
 SearchFlip.
@@ -790,6 +790,30 @@ end
 
 These options will be passed whenever records get indexed, deleted, etc.
 
+## Instrumentation
+
+SearchFlip supports instrumentation for request execution via
+`ActiveSupport::Notifications` compatible instrumenters to e.g. allow global
+performance tracing, etc.
+
+To use instrumentation, configure the instrumenter:
+
+```ruby
+SearchFlip::Config[:instrumenter] = ActiveSupport::Notifications.notifier
+```
+
+Subsequently, you can subscribe to notifcations for `request.search_flip`:
+
+```ruby
+ActiveSupport::Notifications.subscribe("request.search_flip") do |name, start, finish, id, payload|
+  payload[:index] # the index class
+  payload[:request] # the request hash sent to Elasticsearch
+  payload[:response] # the SearchFlip::Response object or nil in case of errors
+end
+```
+
+A notification will be send for every request that is sent to Elasticsearch.
+
 ## Non-ActiveRecord models
 
 SearchFlip ships with built-in support for ActiveRecord models, but using

data/lib/search_flip/aggregation.rb

@@ -73,7 +73,8 @@ module SearchFlip
         unsupported_methods = [
           :profile_value, :failsafe_value, :terminate_after_value, :timeout_value, :scroll_args,
           :suggest_values, :includes_values, :preload_values, :eager_load_values, :post_must_values,
-          :post_must_not_values, :post_filter_values, :preference_value, :search_type_value, :routing_value
+          :post_must_not_values, :post_filter_values, :preference_value, :search_type_value,
+          :routing_value
         ]
 
         unsupported_methods.each do |unsupported_method|

data/lib/search_flip/config.rb

@@ -4,6 +4,7 @@ module SearchFlip
     base_url: "http://127.0.0.1:9200",
     bulk_limit: 1_000,
     bulk_max_mb: 100,
-    auto_refresh: false
+    auto_refresh: false,
+    instrumenter: NullInstrumenter.new
   }
 end

data/lib/search_flip/criteria.rb

@@ -219,45 +219,47 @@ module SearchFlip
     # @return [Hash] The generated request object
 
     def request
-      res = {}
-
-      if must_values || must_not_values || filter_values
-        res[:query] = {
-          bool: {
-            must: must_values.to_a,
-            must_not: must_not_values.to_a,
-            filter: filter_values.to_a
-          }.reject { |_, value| value.empty? }
-        }
-      end
+      @request ||= begin
+        res = {}
+
+        if must_values || must_not_values || filter_values
+          res[:query] = {
+            bool: {
+              must: must_values.to_a,
+              must_not: must_not_values.to_a,
+              filter: filter_values.to_a
+            }.reject { |_, value| value.empty? }
+          }
+        end
 
-      res.update(from: offset_value_with_default, size: limit_value_with_default)
-
-      res[:track_total_hits] = track_total_hits_value unless track_total_hits_value.nil?
-      res[:explain] = explain_value unless explain_value.nil?
-      res[:timeout] = timeout_value if timeout_value
-      res[:terminate_after] = terminate_after_value if terminate_after_value
-      res[:highlight] = highlight_values if highlight_values
-      res[:suggest] = suggest_values if suggest_values
-      res[:sort] = sort_values if sort_values
-      res[:aggregations] = aggregation_values if aggregation_values
-
-      if post_must_values || post_must_not_values || post_filter_values
-        res[:post_filter] = {
-          bool: {
-            must: post_must_values.to_a,
-            must_not: post_must_not_values.to_a,
-            filter: post_filter_values.to_a
-          }.reject { |_, value| value.empty? }
-        }
-      end
+        res.update(from: offset_value_with_default, size: limit_value_with_default)
+
+        res[:track_total_hits] = track_total_hits_value unless track_total_hits_value.nil?
+        res[:explain] = explain_value unless explain_value.nil?
+        res[:timeout] = timeout_value if timeout_value
+        res[:terminate_after] = terminate_after_value if terminate_after_value
+        res[:highlight] = highlight_values if highlight_values
+        res[:suggest] = suggest_values if suggest_values
+        res[:sort] = sort_values if sort_values
+        res[:aggregations] = aggregation_values if aggregation_values
+
+        if post_must_values || post_must_not_values || post_filter_values
+          res[:post_filter] = {
+            bool: {
+              must: post_must_values.to_a,
+              must_not: post_must_not_values.to_a,
+              filter: post_filter_values.to_a
+            }.reject { |_, value| value.empty? }
+          }
+        end
 
-      res[:_source] = source_value unless source_value.nil?
-      res[:profile] = true if profile_value
+        res[:_source] = source_value unless source_value.nil?
+        res[:profile] = true if profile_value
 
-      res.update(custom_value) if custom_value
+        res.update(custom_value) if custom_value
 
-      res
+        res
+      end
     end
 
     # Adds a suggestion section with the given name to the request.
@@ -520,30 +522,13 @@ module SearchFlip
 
     def execute
       @response ||= begin
-        http_request = connection.http_client.headers(accept: "application/json")
-
-        http_response =
-          if scroll_args && scroll_args[:id]
-            http_request.post(
-              "#{connection.base_url}/_search/scroll",
-              params: request_params,
-              json: { scroll: scroll_args[:timeout], scroll_id: scroll_args[:id] }
-            )
-          elsif scroll_args
-            http_request.post(
-              "#{target.type_url}/_search",
-              params: request_params.merge(scroll: scroll_args[:timeout]),
-              json: request
-            )
-          else
-            http_request.post("#{target.type_url}/_search", params: request_params, json: request)
-          end
-
-        SearchFlip::Response.new(self, http_response.parse)
-      rescue SearchFlip::ConnectionError, SearchFlip::ResponseError => e
-        raise e unless failsafe_value
-
-        SearchFlip::Response.new(self, "took" => 0, "hits" => { "total" => 0, "hits" => [] })
+        Config[:instrumenter].instrument("request.search_flip", index: target, request: request) do |payload|
+          response = execute!
+
+          payload[:response] = response
+
+          response
+        end
       end
     end
 
@@ -585,6 +570,7 @@ module SearchFlip
 
     def fresh
       dup.tap do |criteria|
+        criteria.instance_variable_set(:@request, nil)
         criteria.instance_variable_set(:@response, nil)
       end
     end
@@ -610,6 +596,33 @@ module SearchFlip
 
     private
 
+    def execute!
+      http_request = connection.http_client.headers(accept: "application/json")
+
+      http_response =
+        if scroll_args && scroll_args[:id]
+          http_request.post(
+            "#{connection.base_url}/_search/scroll",
+            params: request_params,
+            json: { scroll: scroll_args[:timeout], scroll_id: scroll_args[:id] }
+          )
+        elsif scroll_args
+          http_request.post(
+            "#{target.type_url}/_search",
+            params: request_params.merge(scroll: scroll_args[:timeout]),
+            json: request
+          )
+        else
+          http_request.post("#{target.type_url}/_search", params: request_params, json: request)
+        end
+
+      SearchFlip::Response.new(self, http_response.parse)
+    rescue SearchFlip::ConnectionError, SearchFlip::ResponseError => e
+      raise e unless failsafe_value
+
+      SearchFlip::Response.new(self, "took" => 0, "hits" => { "total" => 0, "hits" => [] })
+    end
+
     def yield_in_batches(options = {})
       return enum_for(:yield_in_batches, options) unless block_given?
 

data/lib/search_flip/null_instrumenter.rb

@@ -0,0 +1,21 @@
+module SearchFlip
+  class NullInstrumenter
+    def instrument(name, payload = {})
+      start(name, payload)
+
+      begin
+        yield(payload) if block_given?
+      ensure
+        finish(name, payload)
+      end
+    end
+
+    def start(_name, _payload)
+      true
+    end
+
+    def finish(_name, _payload)
+      true
+    end
+  end
+end

data/lib/search_flip/version.rb

@@ -1,3 +1,3 @@
 module SearchFlip
-  VERSION = "3.0.0.beta4"
+  VERSION = "3.0.0.beta5"
 end

data/lib/search_flip.rb

@@ -6,6 +6,7 @@ require "oj"
 require "set"
 
 require "search_flip/version"
+require "search_flip/null_instrumenter"
 require "search_flip/helper"
 require "search_flip/exceptions"
 require "search_flip/json"

data/spec/search_flip/criteria_spec.rb

@@ -1198,9 +1198,12 @@ RSpec.describe SearchFlip::Criteria do
 
       query = ProductIndex.criteria.tap(&:records)
 
+      expect(query.instance_variable_get(:@request)).not_to be_nil
       expect(query.instance_variable_get(:@response)).not_to be_nil
 
       expect(query.object_id).not_to eq(query.fresh.object_id)
+
+      expect(query.fresh.instance_variable_get(:@request)).to be_nil
       expect(query.fresh.instance_variable_get(:@response)).to be_nil
     end
   end
@@ -1234,10 +1237,49 @@ RSpec.describe SearchFlip::Criteria do
     end
   end
 
+  describe "#execute" do
+    around do |example|
+      default_instrumenter = SearchFlip::Config[:instrumenter]
+
+      SearchFlip::Config[:instrumenter] = ActiveSupport::Notifications.instrumenter
+
+      begin
+        example.run
+      ensure
+        SearchFlip::Config[:instrumenter] = default_instrumenter
+      end
+    end
+
+    let(:notifications) { [] }
+
+    let!(:subscriber) do
+      ActiveSupport::Notifications.subscribe("request.search_flip") do |*args|
+        notifications << args
+      end
+    end
+
+    after { ActiveSupport::Notifications.unsubscribe(subscriber) }
+
+    it "instruments the request" do
+      ProductIndex.match_all.execute
+
+      expect(notifications).to be_present
+    end
+
+    it "passes the index, request and response" do
+      ProductIndex.match_all.execute
+
+      expect(notifications.first[4][:index]).to eq(ProductIndex)
+      expect(notifications.first[4][:request]).to be_present
+      expect(notifications.first[4][:response]).to be_present
+    end
+  end
+
   describe "#track_total_hits" do
     it "is added to the request" do
       if ProductIndex.connection.version.to_i >= 7
         query = ProductIndex.track_total_hits(false)
+
         expect(query.request[:track_total_hits]).to eq(false)
         expect { query.execute }.not_to raise_error
       end

data/spec/search_flip/null_instrumenter_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path("../spec_helper", __dir__)
+
+RSpec.describe SearchFlip::NullInstrumenter do
+  subject { described_class.new }
+
+  describe "#instrument" do
+    it "calls start" do
+      allow(subject).to receive(:start)
+
+      subject.instrument("name", { key: "value" }) {}
+
+      expect(subject).to have_received(:start)
+    end
+
+    it "calls finish" do
+      allow(subject).to receive(:finish)
+
+      subject.instrument("name", { key: "value" }) {}
+
+      expect(subject).to have_received(:finish)
+    end
+
+    it "yields and passes the payload" do
+      yielded_payload = nil
+
+      subject.instrument("name", { key: "value" }) { |payload| yielded_payload = payload }
+
+      expect(yielded_payload).to eq(key: "value")
+    end
+  end
+
+  describe "#start" do
+    it "returns true" do
+      expect(subject.start("name", { key: "value" })).to eq(true)
+    end
+  end
+
+  describe "#finish" do
+    it "returns true" do
+      expect(subject.finish("name", { key: "value" })).to eq(true)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta4
+  version: 3.0.0.beta5
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-22 00:00:00.000000000 Z
+date: 2020-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -212,6 +212,7 @@ files:
 - lib/search_flip/index.rb
 - lib/search_flip/json.rb
 - lib/search_flip/model.rb
+- lib/search_flip/null_instrumenter.rb
 - lib/search_flip/paginatable.rb
 - lib/search_flip/post_filterable.rb
 - lib/search_flip/response.rb
@@ -229,6 +230,7 @@ files:
 - spec/search_flip/http_client_spec.rb
 - spec/search_flip/index_spec.rb
 - spec/search_flip/model_spec.rb
+- spec/search_flip/null_instrumenter_spec.rb
 - spec/search_flip/response_spec.rb
 - spec/search_flip/result_spec.rb
 - spec/search_flip/to_json_spec.rb
@@ -268,6 +270,7 @@ test_files:
 - spec/search_flip/http_client_spec.rb
 - spec/search_flip/index_spec.rb
 - spec/search_flip/model_spec.rb
+- spec/search_flip/null_instrumenter_spec.rb
 - spec/search_flip/response_spec.rb
 - spec/search_flip/result_spec.rb
 - spec/search_flip/to_json_spec.rb