Elasticsearch数据迁移或者版本升级，如何快速提升迁移效率？

宋华美

2023-12-01

1.es数据迁移工具

2.1elasticdump 报SyntaxError: Unexpected identifier

1.es数据迁移工具

1.1.ElasticDump简介

ElasticDump是一个ElasticSearch的数据导入导出开源工具包，方便使用，有npm和docker两个版本。官方地址：https://github.com/taskrabbit/elasticsearch-dump

elasticdump是实现不同ElasticSearch集群之间索引迁移的工具。默认情况下，ITOA集群部署成功后，该工具存在于安装节点（客户端节点）上。elasticdump语法和常用参数选项如下：

elasticdump --input SOURCE --output DESTINATION [OPTIONS]

其中input/output表示索引数据源和数据目的地

SOURCE/ DESTINATION可以是ElasticSearch集群地址或者文件路径。

当SOURCE/ DESTINATION为ElasticSearch集群地址时格式如下：

格式: {protocol}://{host}:{port}/{index}

样例: http://127.0.0.1:9200/my_index

当SOURCE/ DESTINATION为文件路径时格式如下：

格式: {FilePath}

样例: /Users/evantahler/Desktop/dump.json

OPTIONS常用选项参数有：

--limit

用于限定每一批量操作时进行迁移的文档对象数目，默认值是100，也就是每一次从SOURCE到DESTINATION文档对象数量。

--quiet

只输出错误信息，该参数的默认值是false，如果该参数设置为true。控制台中关于数据迁移的进度信息不可见。

--type

数据迁移类型，可选值有analyzer, data, mapping三种。在ITOA由于统一版本的软件平台analyzer是相同的，所以进行索引迁移时，只需要迁移data, mapping两种类型的数据。该参数的默认选项是data

--ignore-errors

该参数用于控制数据迁移过程遇到错误数据的处理策略。默认情况下为false,表示遇到错误数据时，停止数据迁移。

--help

显示该工具使用时的帮助信息。

1.2.安装ElasticDump

elasticdump安装比较简单，安装如下步骤敲命令：

1) yum install epel-release  
2) yum install nodejs  
3) yum install nodejs npm  
4) npm install elasticdump  
5) cd node_modules/elasticdump/bin

执行 ./elasticdump --help，会返回版本及相关帮助信息，表示elasticdump部署正确。

如下例子：

[root@root bin]# ./elasticdump --help
elasticdump: Import and export tools for elasticsearch
version: 6.72.0

Usage: elasticdump --input SOURCE --output DESTINATION [OPTIONS]

--input
Source location (required)
--input-index
Source index and type
(default: all, example: index/type)
--output
Destination location (required)
--output-index
Destination index and type
(default: all, example: index/type)
--overwrite
Overwrite output file if it exists
(default: false)
--limit
How many objects to move in batch per operation
limit is approximate for file streams
(default: 100)

--size
How many objects to retrieve
(default: -1 -> no limit)

--concurrency
How many concurrent request is sent to a specified transport
(default: 1)

--concurrencyInterval
The length of time in milliseconds before the interval count resets. Must be finite.
(default: 5000)

--intervalCap
The max number of transport request in the given interval of time.
(default: 5)

--carryoverConcurrencyCount
Whether the task must finish in the given concurrencyInterval
(intervalCap will reset to the default whether the request is completed or not)
or will be carried over into the next interval count,
which will effectively reduce the number of new requests created in the next interval
i.e. intervalCap -= <num of carried over requests>
(default: true)

--throttleInterval
The length of time in milliseconds to delay between getting data from an inputTransport and sending it to an outputTransport
(default: 1)

--debug
Display the elasticsearch commands being used
(default: false)

--quiet
Suppress all messages except for errors
(default: false)

--type
What are we exporting?
(default: data, options: [settings, analyzer, data, mapping, policy, alias, template, component_template, index_template])
--filterSystemTemplates
Whether to remove metrics-*-* and logs-*-* system templates
(default: true])
--templateRegex
Regex used to filter templates before passing to the output transport
(default: (metrics|logs|\\..+)(-.+)?)
--delete
Delete documents one-by-one from the input as they are
moved. Will not delete the source index
(default: false)
--headers
Add custom headers to Elastisearch requests (helpful when
your Elasticsearch instance sits behind a proxy)
(default: '{"User-Agent": "elasticdump"}')
--params
Add custom parameters to Elastisearch requests uri. Helpful when you for example
want to use elasticsearch preference
(default: null)
--searchBody
Preform a partial extract based on search results
(when ES is the input, default values are
if ES > 5
`'{"query": { "match_all": {} }, "stored_fields": ["*"], "_source": true }'`
else
`'{"query": { "match_all": {} }, "fields": ["*"], "_source": true }'`
[As of 6.68.0] If the searchBody is preceded by a @ symbol, elasticdump will perform a file lookup
in the location specified. NB: File must contain valid JSON
--searchWithTemplate
Enable to use Search Template when using --searchBody
If using Search Template then searchBody has to consist of "id" field and "params" objects
If "size" field is defined within Search Template, it will be overridden by --size parameter
See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html for
further information
(default: false)
--sourceOnly
Output only the json contained within the document _source
Normal: {"_index":"","_type":"","_id":"", "_source":{SOURCE}}
sourceOnly: {SOURCE}
(default: false)
--ignore-errors
Will continue the read/write loop on write error
(default: false)
--scrollId
The last scroll Id returned from elasticsearch.
This will allow dumps to be resumed used the last scroll Id &
`scrollTime` has not expired.
--scrollTime
Time the nodes will hold the requested search in order.
(default: 10m)
--scroll-with-post
Use a HTTP POST method to perform scrolling instead of the default GET
(default: false)
--maxSockets
How many simultaneous HTTP requests can we process make?
(default:
5 [node <= v0.10.x] /
Infinity [node >= v0.11.x] )
--timeout
Integer containing the number of milliseconds to wait for
a request to respond before aborting the request. Passed
directly to the request library. Mostly used when you don't
care too much if you lose some data when importing
but rather have speed.
--offset
Integer containing the number of rows you wish to skip
ahead from the input transport. When importing a large
index, things can go wrong, be it connectivity, crashes,
someone forgetting to `screen`, etc. This allows you
to start the dump again from the last known line written
(as logged by the `offset` in the output). Please be
advised that since no sorting is specified when the
dump is initially created, there's no real way to
guarantee that the skipped rows have already been
written/parsed. This is more of an option for when
you want to get most data as possible in the index
without concern for losing some rows in the process,
similar to the `timeout` option.
(default: 0)
--noRefresh
Disable input index refresh.
Positive:
1. Much increase index speed
2. Much less hardware requirements
Negative:
1. Recently added data may not be indexed
Recommended to use with big data indexing,
where speed and system health in a higher priority
than recently added data.
--inputTransport
Provide a custom js file to use as the input transport
--outputTransport
Provide a custom js file to use as the output transport
--toLog
When using a custom outputTransport, should log lines
be appended to the output stream?
(default: true, except for `$`)
--awsChain
Use [standard](https://aws.amazon.com/blogs/security/a-new-and-standardized-way-to-manage-credentials-in-the-aws-sdks/) location and ordering for resolving credentials including environment variables, config files, EC2 and ECS metadata locations
_Recommended option for use with AWS_
--awsAccessKeyId
--awsSecretAccessKey
When using Amazon Elasticsearch Service protected by
AWS Identity and Access Management (IAM), provide
your Access Key ID and Secret Access Key
--awsIniFileProfile
Alternative to --awsAccessKeyId and --awsSecretAccessKey,
loads credentials from a specified profile in aws ini file.
For greater flexibility, consider using --awsChain
and setting AWS_PROFILE and AWS_CONFIG_FILE
environment variables to override defaults if needed
--awsService
Sets the AWS service that the signature will be generated for
(default: calculated from hostname or host)
--awsRegion
Sets the AWS region that the signature will be generated for
(default: calculated from hostname or host)
--awsUrlRegex
Regular expression that defined valied AWS urls that should be signed
(default: ^https?:\\.*.amazonaws.com.*$)
--transform
A javascript, which will be called to modify documents
before writing it to destination. global variable 'doc'
is available.
Example script for computing a new field 'f2' as doubled
value of field 'f1':
doc._source["f2"] = doc._source.f1 * 2;

--httpAuthFile
When using http auth provide credentials in ini file in form
`user=<username>
password=<password>`

--support-big-int
Support big integer numbers
--retryAttempts
Integer indicating the number of times a request should be automatically re-attempted before failing
when a connection fails with one of the following errors `ECONNRESET`, `ENOTFOUND`, `ESOCKETTIMEDOUT`,
ETIMEDOUT`, `ECONNREFUSED`, `EHOSTUNREACH`, `EPIPE`, `EAI_AGAIN`
(default: 0)

--retryDelay
Integer indicating the back-off/break period between retry attempts (milliseconds)
(default : 5000)
--parseExtraFields
Comma-separated list of meta-fields to be parsed
--maxRows
supports file splitting. Files are split by the number of rows specified
--fileSize
supports file splitting. This value must be a string supported by the **bytes** module.
The following abbreviations must be used to signify size in terms of units
b for bytes
kb for kilobytes
mb for megabytes
gb for gigabytes
tb for terabytes

e.g. 10mb / 1gb / 1tb
Partitioning helps to alleviate overflow/out of memory exceptions by efficiently segmenting files
into smaller chunks that then be merged if needs be.
--fsCompress
gzip data before sending output to file.
On import the command is used to inflate a gzipped file
--s3AccessKeyId
AWS access key ID
--s3SecretAccessKey
AWS secret access key
--s3Region
AWS region
--s3Endpoint
AWS endpoint can be used for AWS compatible backends such as
OpenStack Swift and OpenStack Ceph
--s3SSLEnabled
Use SSL to connect to AWS [default true]

--s3ForcePathStyle Force path style URLs for S3 objects [default false]

--s3Compress
gzip data before sending to s3
--s3ServerSideEncryption
Enables encrypted uploads
--s3SSEKMSKeyId
KMS Id to be used with aws:kms uploads
--s3ACL
S3 ACL: private | public-read | public-read-write | authenticated-read | aws-exec-read |
bucket-owner-read | bucket-owner-full-control [default private]
--retryDelayBase
The base number of milliseconds to use in the exponential backoff for operation retries. (s3)
--customBackoff
Activate custom customBackoff function. (s3)
--tlsAuth
Enable TLS X509 client authentication
--cert, --input-cert, --output-cert
Client certificate file. Use --cert if source and destination are identical.
Otherwise, use the one prefixed with --input or --output as needed.
--key, --input-key, --output-key
Private key file. Use --key if source and destination are identical.
Otherwise, use the one prefixed with --input or --output as needed.
--pass, --input-pass, --output-pass
Pass phrase for the private key. Use --pass if source and destination are identical.
Otherwise, use the one prefixed with --input or --output as needed.
--ca, --input-ca, --output-ca
CA certificate. Use --ca if source and destination are identical.
Otherwise, use the one prefixed with --input or --output as needed.
--inputSocksProxy, --outputSocksProxy
Socks5 host address
--inputSocksPort, --outputSocksPort
Socks5 host port
--handleVersion
Tells elastisearch transport to handle the `_version` field if present in the dataset
(default : false)
--versionType
Elasticsearch versioning types. Should be `internal`, `external`, `external_gte`, `force`.
NB : Type validation is handle by the bulk endpoint and not elasticsearch-dump
--csvDelimiter
The delimiter that will separate columns.
(default : ',')
--csvFirstRowAsHeaders
If set to true the first row will be treated as the headers.
(default : true)
--csvRenameHeaders
If you want the first line of the file to be removed and replaced by the one provided in the `csvCustomHeaders` option
(default : true)
--csvCustomHeaders A comma-seperated listed of values that will be used as headers for your data. This param must
be used in conjunction with `csvRenameHeaders`
(default : null)
--csvWriteHeaders Determines if headers should be written to the csv file.
(default : true)
--csvIgnoreEmpty
Set to true to ignore empty rows.
(default : false)
--csvSkipLines
If number is > 0 the specified number of lines will be skipped.
(default : 0)
--csvSkipRows
If number is > 0 then the specified number of parsed rows will be skipped
(default : 0)
--csvTrim
Set to true to trim all white space from columns.
(default : false)
--csvRTrim
Set to true to right trim all columns.
(default : false)
--csvLTrim
Set to true to left trim all columns.
(default : false)
--csvHandleNestedData
Set to true to handle nested JSON/CSV data.
NB : This is a very optioninated implementaton !
(default : false)
--csvIdColumn
Name of the column to extract the record identifier (id) from
When exporting to CSV this column can be used to override the default id (@id) column name
(default : null)
--csvIndexColumn
Name of the column to extract the record index from
When exporting to CSV this column can be used to override the default index (@index) column name
(default : null)
--csvTypeColumn
Name of the column to extract the record type from
When exporting to CSV this column can be used to override the default type (@type) column name
(default : null)
--help
This page
Examples:

# Copy an index from production to staging with mappings:
elasticdump \
--input=http://production.es.com:9200/my_index \
--output=http://staging.es.com:9200/my_index \
--type=mapping
elasticdump \
--input=http://production.es.com:9200/my_index \
--output=http://staging.es.com:9200/my_index \
--type=data

# Backup index data to a file:
elasticdump \
--input=http://production.es.com:9200/my_index \
--output=/data/my_index_mapping.json \
--type=mapping
elasticdump \
--input=http://production.es.com:9200/my_index \
--output=/data/my_index.json \
--type=data

# Backup and index to a gzip using stdout:
elasticdump \
--input=http://production.es.com:9200/my_index \
--output=$ \
| gzip > /data/my_index.json.gz

# Backup the results of a query to a file
elasticdump \
--input=http://production.es.com:9200/my_index \
--output=query.json \
--searchBody "{\"query\":{\"term\":{\"username\": \"admin\"}}}"

------------------------------------------------------------------------------
Learn more @ https://github.com/taskrabbit/elasticsearch-dump

[root@root bin]#

1.3迁移工具使用

常用命令，直接用help中的example，如下：

# Backup and index to a gzip using stdout:
elasticdump \
--input=http://production.es.com:9200/my_index \
--output=$ \
| gzip > /data/my_index.json.gz

# Backup the results of a query to a file
elasticdump \
--input=http://production.es.com:9200/my_index \
--output=query.json \
--searchBody "{\"query\":{\"term\":{\"username\": \"admin\"}}}"

真实项目中的使用举例。

2个es间索引迁移

./elasticdump --input=http://192.168.1.10:9200/user --output=http://192.168.1.15:9200/user --type=mapping

2个es间数据迁移

./elasticdump --input=http://192.168.1.10:9200/user --output=http://192.168.1.15:9200/user --type=data

2个es间全量（包含索引和数据）迁移

./elasticdump  --input=http://192.168.1.10:9200/ --output=http://192.168.1.15:9200/ --all=true

1.4如何提供效率？

主要通过--limit参数来提高效率，--limit默认为100，例如

Sat, 17 Jun 2021 08:37:15 GMT | starting dump

Sat, 17 Jun 2021 08:37:15 GMT | got 100 objects from source file (offset: 0)

Sat, 17 Jun 2021 08:37:16 GMT | sent 100 objects to destination elasticsearch, wrote 100

优化后的2个es间数据同步的命令如下：

./elasticdump --limit 1000 --input=http://192.168.1.10:9200/user --output=http://192.168.1.15:9200/user --type=data

其中1000表示一次性同步的对象数，默认为100，可以根据对象大小做相应调整。

2.常见问题

2.1elasticdump 报SyntaxError: Unexpected identifier

【现象】

[root@i-o7bjq736 bin]# ./elasticdump --help

/opt/apps/es/node_modules/elasticdump/lib/processor.js:40

async _loop (limit, offset, totalWrites) {

^^^^^

SyntaxError: Unexpected identifier

at createScript (vm.js:56:10)

at Object.runInThisContext (vm.js:97:10)

at Module._compile (module.js:549:28)

at Object.Module._extensions..js (module.js:586:10)

at Module.load (module.js:494:32)

at tryModuleLoad (module.js:453:12)

at Function.Module._load (module.js:445:3)

at Module.require (module.js:504:17)

at require (internal/module.js:20:19)

at Object.<anonymous> (/opt/apps/es/node_modules/elasticdump/elasticdump.js:3:28)

【解决方法】

升级一下nodejs版本

npm install -g n
n stable

Elasticsearch数据迁移或者版本升级，如何快速提升迁移效率？

1.es数据迁移工具

1.1.ElasticDump简介

1.2.安装ElasticDump

1.3迁移工具使用

1.4如何提供效率？

2.常见问题

2.1elasticdump 报SyntaxError: Unexpected identifier

相关阅读

相关文章

相关问答

相关文档