1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
# encoding: utf-8
require 'pathname'
require 'fileutils'
require 'multi_json'
begin
require 'oj'
rescue LoadError
warn('The "oj" gem could not be loaded. JSON parsing and serialization performance may not be optimal.')
end
begin
require 'patron'
rescue LoadError
warn('The "patron" gem could not be loaded. HTTP requests may not be performed optimally.')
end
require 'elasticsearch'
module Backup
module Database
# Integration with the Backup gem [http://backup.github.io/backup/v4/]
#
# This extension allows to backup Elasticsearch indices as flat JSON files on the disk.
#
# @example Use the Backup gem's DSL to configure the backup
#
# require 'elasticsearch/extensions/backup'
#
# Model.new(:elasticsearch_backup, 'Elasticsearch') do
#
# database Elasticsearch do |db|
# db.url = 'http://localhost:9200'
# db.indices = 'articles,people'
# db.size = 500
# db.scroll = '10m'
# end
#
# store_with Local do |local|
# local.path = '/tmp/backups'
# local.keep = 3
# end
#
# compress_with Gzip
# end
#
# Perform the backup with the Backup gem's command line utility:
#
# $ backup perform -t elasticsearch_backup
#
# The Backup gem can store your backup files on S3, Dropbox and other
# cloud providers, send notifications about the operation, and so on;
# read more in the gem documentation.
#
# @example Use the integration as a standalone script (eg. in a Rake task)
#
# require 'backup'
# require 'elasticsearch/extensions/backup'
#
# Backup::Logger.configure do
# logfile.enabled = true
# logfile.log_path = '/tmp/backups/log'
# end; Backup::Logger.start!
#
# backup = Backup::Model.new(:elasticsearch, 'Backup Elasticsearch') do
# database Backup::Database::Elasticsearch do |db|
# db.indices = 'test'
# end
#
# store_with Backup::Storage::Local do |local|
# local.path = '/tmp/backups'
# end
# end
#
# backup.perform!
#
# @example A simple recover script for the backup created in the previous examples
#
# PATH = '/path/to/backup/'
#
# require 'elasticsearch'
# client = Elasticsearch::Client.new log: true
# payload = []
#
# Dir[ File.join( PATH, '**', '*.json' ) ].each do |file|
# document = MultiJson.load(File.read(file))
# item = document.merge(data: document['_source'])
# document.delete('_source')
# document.delete('_score')
#
# payload << { index: item }
#
# if payload.size == 100
# client.bulk body: payload
# payload = []
# end
#
# client.bulk body: payload
# end
#
# @see http://backup.github.io/backup/v4/
#
class Elasticsearch < Base
class Error < ::Backup::Error; end
attr_accessor :url,
:indices,
:size,
:scroll
attr_accessor :mode
def initialize(model, database_id = nil, &block)
super
@url ||= 'http://localhost:9200'
@indices ||= '_all'
@size ||= 100
@scroll ||= '10m'
@mode ||= 'single'
instance_eval(&block) if block_given?
end
def perform!
super
case mode
when 'single'
__perform_single
else
raise Error, "Unsupported mode [#{mode}]"
end
log!(:finished)
end
def client
@client ||= ::Elasticsearch::Client.new url: url, logger: logger
end
def path
Pathname.new File.join(dump_path , dump_filename.downcase)
end
def logger
logger = Backup::Logger.__send__(:logger)
logger.instance_eval do
def debug(*args);end
# alias :debug :info
alias :fatal :warn
end
logger
end
def __perform_single
r = client.search index: indices, search_type: 'scan', scroll: scroll, size: size
raise Error, "No scroll_id returned in response:\n#{r.inspect}" unless r['_scroll_id']
while r = client.scroll(scroll_id: r['_scroll_id'], scroll: scroll) and not r['hits']['hits'].empty? do
r['hits']['hits'].each do |hit|
FileUtils.mkdir_p "#{path.join hit['_index'], hit['_type']}"
File.open("#{path.join hit['_index'], hit['_type'], __sanitize_filename(hit['_id'])}.json", 'w') do |file|
file.write MultiJson.dump(hit)
end
end
end
end
def __sanitize_filename name
name
.encode(Encoding::UTF_8, invalid: :replace, undef: :replace, replace: "�")
.strip
.tr("\u{202E}%$|:;/\t\r\n\\", "-")
end
end
end
end
::Backup::Config::DSL::Elasticsearch = ::Backup::Database::Elasticsearch
|
