https://github.com/embulk/embulk-output-elasticsearch
https://github.com/embulk/embulk-output-elasticsearch
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/embulk/embulk-output-elasticsearch
- Owner: embulk
- License: apache-2.0
- Created: 2015-01-27T10:27:49.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-07-26T09:13:21.000Z (almost 2 years ago)
- Last Synced: 2025-04-02T23:13:47.587Z (about 1 year ago)
- Language: Java
- Size: 523 KB
- Stars: 32
- Watchers: 14
- Forks: 26
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Elasticsearch output plugin for Embulk
**Notice** This plugin doesn't positively support [Amazon(AWS) Elasticsearch Service](https://aws.amazon.com/elasticsearch-service/).
Actually, AWS Elasticsearch Service supported AWS VPC at Oct 2017 and user is able to access to Es from EC2 instances in VPC subnet without any authentication.
You can use this plugin for AWS ES at your own risk.
- *[Amazon Elasticsearch Service Limits](http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-limits.html)*
## Overview
* **Plugin type**: output
* **Rollback supported**: no
* **Resume supported**: no
* **Cleanup supported**: no
## Configuration
- **mode**: "insert" or "replace". See below(string, optional, default is insert)
- **nodes**: list of nodes. nodes are pairs of host and port (list, required)
- NOTE: This plugin uses HTTP/REST Clients and uses TCP:9200 as a default. TCP:9300 is usually used for Transport Client.
- **use_ssl** Use SSL encryption (boolean, default is false)
- **auth_method** (string, default is 'none') 'none'/'basic'. See also [Authentication](#authentication).
- **user** Username for basic authentication (string, default is null)
- **password** Password for above user (string, default is null)
- ~~**cluster_name**: name of the cluster (string, default is "elasticsearch")~~ Not used now. May use in the future
- **index**: index name (string, required)
- **index_type**: index type (string, required)
- **id**: document id column (string, default is null)
- **bulk_actions**: Sets when to flush a new bulk request based on the number of actions currently added. (int, default is 1000)
- **bulk_size**: Sets when to flush a new bulk request based on the size of actions currently added. (long, default is 5242880)
- **fill_null_for_empty_column**: Fill null value when column value is empty (boolean, optional, default is false)
- ~~**concurrent_requests**: concurrent_requests (int, default is 5)~~ Not used now. May use in the future
- **maximum_retries** Number of maximam retry times (int, optional, default is 7)
- **initial_retry_interval_millis** Initial interval between retries in milliseconds (int, optional, default is 1000)
- **maximum_retry_interval_millis** Maximum interval between retries in milliseconds (int, optional, default is 120000)
- **timeout_millis** timeout in milliseconds for each HTTP request(int, optional, default is 60000)
- **connect_timeout_millis** connection timeout in milliseconds for HTTP client(int, optional, default is 60000)
- **max_snapshot_waiting_secs** maximam waiting time in second when snapshot is just creating before delete index. works when `mode: replace` (int, optional, default is 1800)
### Modes
#### insert:
default.
This mode writes data to existing index.
#### replace:
1. Create new temporary index
2. Insert data into the new index
3. replace the alias with the new index. If alias doesn't exists, plugin will create new alias.
4. Delete existing (old) index if exists
Index should not exists with the same name as the alias
```yaml
out:
type: elasticsearch
mode: replace
nodes:
- {host: localhost, port: 9200}
index: # plugin generates index name like _%Y%m%d-%H%M%S
index_type:
```
### Authentication
This plugin supports Basic authentication and works with [Elastic Cloud](https://cloud.elastic.co/) and 'Security'(formally Sield).
'Security' also supports LDAP and Active Directory. This plugin doesn't supports these auth methods.
```yaml
use_ssl: true
auth_method: basic
user:
password:
```
## Example
```yaml
out:
type: elasticsearch
mode: insert
nodes:
- {host: localhost, port: 9200}
index:
index_type:
```
## Test
Firstly install Docker and Docker compose then `docker-compose up -d`,
so that an ES server will be locally launched then you can run tests with `./gradlew test`.
```sh
$ docker-compose up -d
Creating network "embulk-output-elasticsearch_default" with the default driver
Creating embulk-output-elasticsearch_server ... done
$ docker-compose ps
Name Command State Ports
------------------------------------------------------------------------------------------------------------------------------
embulk-output-elasticsearch_server /docker-entrypoint.sh elas ... Up 0.0.0.0:19200->9200/tcp, 0.0.0.0:19300->9300/tcp
$ ./gradlew test # -t to watch change of files and rebuild continuously
```
For Maintainers
----------------
### Release
Modify `version` in `build.gradle` at a detached commit, and then tag the commit with an annotation.
```
git checkout --detach master
(Edit: Remove "-SNAPSHOT" in "version" in build.gradle.)
git add build.gradle
git commit -m "Release vX.Y.Z"
git tag -a vX.Y.Z
(Edit: Write a tag annotation in the changelog format.)
```
See [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) for the changelog format. We adopt a part of it for Git's tag annotation like below.
```
## [X.Y.Z] - YYYY-MM-DD
### Added
- Added a feature.
### Changed
- Changed something.
### Fixed
- Fixed a bug.
```
Push the annotated tag, then. It triggers a release operation on GitHub Actions after approval.
```
git push -u origin vX.Y.Z
```