elastic-util 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 65b4319be21549be3a86ed896834f464f1d36542
-  data.tar.gz: 40d05eb1c8f6db2d98b5606f14ab5fe26eda6a2d
+SHA256:
+  metadata.gz: af7028b9a21af54dc8f66849ce7a22e9739dbf0a2b7d8d2fd4091144337b3fda
+  data.tar.gz: 8caf084b468de28607516b1c8d8643de9373732a5d1628db4618307f6b7dac64
 SHA512:
-  metadata.gz: 72cfa5a35d7746aeea475972a132966b120ea9571a3176d218d5c138a13a6661085900856b02ec41a1b10dc7f886c136f4d274d5e2c4e40c33258c8539379b40
-  data.tar.gz: 96da3e80ab3dfa74f214e6d5d27cd7ec5e3b0b2523faa664ec3894a4eea631d8d2bd005d7ef398f72f0aef09afc20395ba1ae61f52352b520f92085ff5182e1d
+  metadata.gz: 07ce1c430cd062388456fc8d19717546457aba8bd20952a54697d17192a36e63367d66a37f78f8fc08d48d0feb89fd5c26c53fccc32a0f5df26e65e31278bc73
+  data.tar.gz: bb50a5ada50644ee7edaf831af2d1966d4610515d268310084a01c0d0f278c2679c3a6757fc62ee6c6863c5f53c03842a2190335ed807037c97d7cd2eb004a38

data/bin/elastic-util

@@ -23,6 +23,15 @@ when "backup"
     opts.on('--exclude-fields x,y,z', Array, "The fields to exclude from backup. Default is '_id'.") do |val|
       options[:exclude_fields] = val.collect {|it| it.strip }
     end
+    opts.on('--replace-types type1:_doc,type2:_doc', Array, "Replace certain types with a different type.") do |val|
+      options[:replace_types] = {}
+      val.each  do |it| 
+        pair = it.split(":").collect {|p| p.strip }
+        if pair.size == 2
+          options[:replace_types][pair[0]] = pair[1]
+        end
+      end
+    end
     opts.on( '-s', '--size NUMBER', "The size api parameter. This dicates the size of the files and api payloads. Default is 1000." ) do |val|
       options[:size] = val.to_i
     end
@@ -100,6 +109,8 @@ when "restore"
     exit 1
   end
 
+when "-v"
+  puts ElasticUtil::VERSION
 else
   $stderr.puts usage
   exit 1

data/lib/elastic_util.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 require 'net/http'
+require 'openssl'
 require 'json'
 require 'fileutils'
 
@@ -12,7 +13,7 @@ require 'fileutils'
 #
 module ElasticUtil
 
-  VERSION = "0.1.2"
+  VERSION = "0.1.7"
 
   # The name of the data directory, relative to the user provided backup directory.
   DUMP_DIR = "es_data"
@@ -43,6 +44,7 @@ module ElasticUtil
   # @option opts [Array] :indices The indices to backup. Default is all.
   # @option opts [Array] :exclude_indices Exclude certain indexes.
   # @option opts [Array] :exclude_fields Exclude certain fields. Default is ['_id'].
+  # @option opts [Array] :replace_types Replace certain types with a different type, separated by a colon. eg. 'type1:type2' or 'stat:_doc'
   # @option opts [String] :scroll The scroll api parameter, Default is '5m'.
   # @option opts [Integer] :size The size api parameter. Default is 1000.
   # @option opts [true] :force Delete existing backup directory instead of erroring. Default is false.
@@ -52,19 +54,14 @@ module ElasticUtil
   #
   def self.backup(url, backup_dir, opts={})
     start_time = Time.now
+    url = url.strip.chomp("/")
     backup_dir = backup_dir.strip
     path = File.join(backup_dir.strip, DUMP_DIR)
     indices = []
-    
     # ping it first
+    response = nil
     uri = URI(url)
-    response = Net::HTTP.get_response(uri)
-    http = Net::HTTP.new(uri.host, uri.port)
-    http.read_timeout = 5
-    http.open_timeout = 5
-    response = http.start() {|http|
-      http.get("/")
-    }
+    response = api_get(uri)
     if !response.is_a?(Net::HTTPSuccess)
       raise Error, "Unable to reach elasticsearch at url '#{url}'!\n#{response.inspect}\n#{response.body.to_s}"
     end
@@ -73,8 +70,9 @@ module ElasticUtil
     if opts[:indices]
       indices = opts[:indices]
     else
+      response = nil
       uri = URI(url + "/_cat/indices?format=json")
-      response = Net::HTTP.get_response(uri)
+      response = api_get(uri)
       if !response.is_a?(Net::HTTPSuccess)
         raise Error, "HTTP request failure!\n#{response.inspect}\n#{response.body.to_s}"
       end
@@ -123,7 +121,7 @@ module ElasticUtil
       }
       uri.query = URI.encode_www_form(params)
       # puts "HTTP REQUEST #{uri.inspect}"
-      response = Net::HTTP.get_response(uri)
+      response = api_get(uri)
       if !response.is_a?(Net::HTTPSuccess)
         raise Error, "HTTP request failure!\n#{response.inspect}\n#{response.body.to_s}"
       end
@@ -131,7 +129,7 @@ module ElasticUtil
       raise Error, "No scroll_id returned in response:\n#{response.inspect}" unless json_response['_scroll_id']
       scroll_id = json_response['_scroll_id']
       hits = json_response['hits']['hits']
-      save_bulk_data(path, hits)
+      save_bulk_data(path, hits, nil, opts)
       
       file_index = 1
       # scroll requests
@@ -143,7 +141,7 @@ module ElasticUtil
         }
         uri.query = URI.encode_www_form(params)
         # puts "HTTP REQUEST #{uri.inspect}"
-        response = Net::HTTP.get_response(uri)
+        response = api_get(uri)
         if !response.is_a?(Net::HTTPSuccess)
           raise Error, "HTTP request failure!\n#{response.inspect}\n#{response.body.to_s}"
         end
@@ -151,11 +149,7 @@ module ElasticUtil
         raise Error, "No scroll_id returned in response:\n#{response.inspect}\n#{response.body.to_s}" unless json_response['_scroll_id']
         scroll_id = json_response['_scroll_id']
         hits = json_response['hits']['hits']
-        if file_index > 0
-          save_bulk_data(path, hits, file_index)
-        else
-          save_bulk_data(path, hits)
-        end
+        save_bulk_data(path, hits, file_index, opts)
         file_index += 1
       end
     end
@@ -190,14 +184,7 @@ module ElasticUtil
 
     # ping it first
     uri = URI(url)
-    response = Net::HTTP.get_response(uri)
-    http = Net::HTTP.new(uri.host, uri.port)
-    http.read_timeout = 5
-    http.open_timeout = 5
-    response = http.start() {|http|
-      http.get("/")
-    }
-
+    response = api_get(uri)
     if !response.is_a?(Net::HTTPSuccess)
       raise Error, "Unable to reach elasticsearch at url '#{url}'!\n#{response.inspect}\n#{response.body.to_s}"
     end
@@ -214,9 +201,8 @@ module ElasticUtil
     found_files.each_with_index do |file, i|
       puts "(#{i+1}/#{found_files.size}) bulk importing file #{file}" unless opts[:quiet]
       payload = File.read(file)
-      # uri = URI(url)
-      http = Net::HTTP.new(uri.host, uri.port)
-      response = http.post("/_bulk", payload)
+      uri = URI(url + "/_bulk")
+      response = api_post(uri, payload, {:headers => {"Content-Type" => "application/x-ndjson"} })
       if !response.is_a?(Net::HTTPSuccess)
         raise Error, "HTTP request failure!\n#{response.inspect}\n#{response.body.to_s}"
       end
@@ -235,8 +221,12 @@ module ElasticUtil
         FileUtils.mkdir_p(dir_name)
         file_name = File.join(dir_name, index_type) + (file_index ? "_#{file_index}" : "") + ".json.data"
         # prepare record for bulk api injection
+        doc_type = hit['_type']
+        if opts[:replace_types] && opts[:replace_types][doc_type]
+          doc_type = opts[:replace_types][doc_type]
+        end
         action_json = {'index' => {
-          '_index' => hit['_index'], '_type' => hit['_type'], '_id' => hit['_id']
+          '_index' => hit['_index'], '_type' => doc_type, '_id' => hit['_id']
         } }
         source_json = hit['_source']
         if opts[:exclude_fields] && source_json
@@ -244,6 +234,7 @@ module ElasticUtil
             source_json.delete(field)
           end
         end
+
         File.open(file_name, 'a') do |file|
           file.write JSON.generate(action_json) + "\n" + JSON.generate(source_json) + "\n"
         end
@@ -251,4 +242,51 @@ module ElasticUtil
     end
   end
 
+  def self.api_get(uri, opts={})
+    http = Net::HTTP.new(uri.host, uri.port)
+    if uri.scheme == 'https'
+      http.use_ssl = true
+      # todo: always ignore ssl errors for now, but this should be an option
+      # http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+    http.read_timeout = opts[:read_timeout] || (60*15)
+    http.open_timeout = opts[:open_timeout] || 5
+    request = Net::HTTP::Get.new uri.request_uri
+    if opts[:headers]
+      opts[:headers].each do |k,v|
+        request[k] = v
+      end
+    end
+    if uri.user
+      request.basic_auth uri.user, uri.password
+    end
+    response = http.request(request)
+    return response
+  end
+
+  def self.api_post(uri, payload, opts={})
+    http = Net::HTTP.new(uri.host, uri.port)
+    if uri.scheme == 'https'
+      http.use_ssl = true
+      # todo: always ignore ssl errors for now, but this should be an option
+      # http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+    http.read_timeout = opts[:read_timeout] || (60*15)
+    http.open_timeout = opts[:open_timeout] || 5
+    request = Net::HTTP::Post.new uri.request_uri
+    if opts[:headers]
+      opts[:headers].each do |k,v|
+        request[k] = v
+      end
+    end
+    if uri.user
+      request.basic_auth uri.user, uri.password
+    end
+    request.body = payload
+    response = http.request(request)
+    return response
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-util
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - James Dickson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-08 00:00:00.000000000 Z
+date: 2020-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Provides backup and restore for ElasticSearch data